Testsuite: dovecot suthenticator testing
[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 .new
2814 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2815 to cleanly shut down.
2816 Subprocesses handling recceiving or delivering messages,
2817 or for scanning the queue,
2818 will not be affected by the termination of the daemon process.
2819 .wen
2820
2821 .cmdopt -bdf
2822 This option has the same effect as &%-bd%& except that it never disconnects
2823 from the controlling terminal, even when no debugging is specified.
2824
2825 .cmdopt -be
2826 .cindex "testing" "string expansion"
2827 .cindex "expansion" "testing"
2828 Run Exim in expansion testing mode. Exim discards its root privilege, to
2829 prevent ordinary users from using this mode to read otherwise inaccessible
2830 files. If no arguments are given, Exim runs interactively, prompting for lines
2831 of data. Otherwise, it processes each argument in turn.
2832
2833 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2834 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2835 used without command line arguments. If successful, it uses the &[readline()]&
2836 function, which provides extensive line-editing facilities, for reading the
2837 test data. A line history is supported.
2838
2839 Long expansion expressions can be split over several lines by using backslash
2840 continuations. As in Exim's runtime configuration, white space at the start of
2841 continuation lines is ignored. Each argument or data line is passed through the
2842 string expansion mechanism, and the result is output. Variable values from the
2843 configuration file (for example, &$qualify_domain$&) are available, but no
2844 message-specific values (such as &$message_exim_id$&) are set, because no message
2845 is being processed (but see &%-bem%& and &%-Mset%&).
2846
2847 &*Note*&: If you use this mechanism to test lookups, and you change the data
2848 files or databases you are using, you must exit and restart Exim before trying
2849 the same lookup again. Otherwise, because each Exim process caches the results
2850 of lookups, you will just get the same result as before.
2851
2852 Macro processing is done on lines before string-expansion: new macros can be
2853 defined and macros will be expanded.
2854 Because macros in the config file are often used for secrets, those are only
2855 available to admin users.
2856
2857 .new
2858 The word &"set"& at the start of a line, followed by a single space,
2859 is recognised specially as defining a value for a variable.
2860 The syntax is otherwise the same as the ACL modifier &"set ="&.
2861 .wen
2862
2863 .cmdopt -bem <&'filename'&>
2864 .cindex "testing" "string expansion"
2865 .cindex "expansion" "testing"
2866 This option operates like &%-be%& except that it must be followed by the name
2867 of a file. For example:
2868 .code
2869 exim -bem /tmp/testmessage
2870 .endd
2871 The file is read as a message (as if receiving a locally-submitted non-SMTP
2872 message) before any of the test expansions are done. Thus, message-specific
2873 variables such as &$message_size$& and &$header_from:$& are available. However,
2874 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2875 recipients are read from the headers in the normal way, and are shown in the
2876 &$recipients$& variable. Note that recipients cannot be given on the command
2877 line, because further arguments are taken as strings to expand (just like
2878 &%-be%&).
2879
2880 .cmdopt -bF <&'filename'&>
2881 .cindex "system filter" "testing"
2882 .cindex "testing" "system filter"
2883 This option is the same as &%-bf%& except that it assumes that the filter being
2884 tested is a system filter. The additional commands that are available only in
2885 system filters are recognized.
2886
2887 .cmdopt -bf <&'filename'&>
2888 .cindex "filter" "testing"
2889 .cindex "testing" "filter file"
2890 .cindex "forward file" "testing"
2891 .cindex "testing" "forward file"
2892 .cindex "Sieve filter" "testing"
2893 This option runs Exim in user filter testing mode; the file is the filter file
2894 to be tested, and a test message must be supplied on the standard input. If
2895 there are no message-dependent tests in the filter, an empty file can be
2896 supplied.
2897
2898 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2899 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2900 filter and a user filter in the same run. For example:
2901 .code
2902 exim -bF /system/filter -bf /user/filter </test/message
2903 .endd
2904 This is helpful when the system filter adds header lines or sets filter
2905 variables that are used by the user filter.
2906
2907 If the test filter file does not begin with one of the special lines
2908 .code
2909 # Exim filter
2910 # Sieve filter
2911 .endd
2912 it is taken to be a normal &_.forward_& file, and is tested for validity under
2913 that interpretation. See sections &<<SECTitenonfilred>>& to
2914 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2915 redirection lists.
2916
2917 The result of an Exim command that uses &%-bf%&, provided no errors are
2918 detected, is a list of the actions that Exim would try to take if presented
2919 with the message for real. More details of filter testing are given in the
2920 separate document entitled &'Exim's interfaces to mail filtering'&.
2921
2922 When testing a filter file,
2923 .cindex "&""From""& line"
2924 .cindex "envelope from"
2925 .cindex "envelope sender"
2926 .oindex "&%-f%&" "for filter testing"
2927 the envelope sender can be set by the &%-f%& option,
2928 or by a &"From&~"& line at the start of the test message. Various parameters
2929 that would normally be taken from the envelope recipient address of the message
2930 can be set by means of additional command line options (see the next four
2931 options).
2932
2933 .cmdopt -bfd <&'domain'&>
2934 .vindex "&$qualify_domain$&"
2935 This sets the domain of the recipient address when a filter file is being
2936 tested by means of the &%-bf%& option. The default is the value of
2937 &$qualify_domain$&.
2938
2939 .cmdopt -bfl <&'local&~part'&>
2940 This sets the local part of the recipient address when a filter file is being
2941 tested by means of the &%-bf%& option. The default is the username of the
2942 process that calls Exim. A local part should be specified with any prefix or
2943 suffix stripped, because that is how it appears to the filter when a message is
2944 actually being delivered.
2945
2946 .cmdopt -bfp <&'prefix'&>
2947 .cindex affix "filter testing"
2948 This sets the prefix of the local part of the recipient address when a filter
2949 file is being tested by means of the &%-bf%& option. The default is an empty
2950 prefix.
2951
2952 .cmdopt -bfs <&'suffix'&>
2953 .cindex affix "filter testing"
2954 This sets the suffix of the local part of the recipient address when a filter
2955 file is being tested by means of the &%-bf%& option. The default is an empty
2956 suffix.
2957
2958 .cmdopt -bh <&'IP&~address'&>
2959 .cindex "testing" "incoming SMTP"
2960 .cindex "SMTP" "testing incoming"
2961 .cindex "testing" "relay control"
2962 .cindex "relaying" "testing configuration"
2963 .cindex "policy control" "testing"
2964 .cindex "debugging" "&%-bh%& option"
2965 This option runs a fake SMTP session as if from the given IP address, using the
2966 standard input and output. The IP address may include a port number at the end,
2967 after a full stop. For example:
2968 .code
2969 exim -bh 10.9.8.7.1234
2970 exim -bh fe80::a00:20ff:fe86:a061.5678
2971 .endd
2972 When an IPv6 address is given, it is converted into canonical form. In the case
2973 of the second example above, the value of &$sender_host_address$& after
2974 conversion to the canonical form is
2975 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2976
2977 Comments as to what is going on are written to the standard error file. These
2978 include lines beginning with &"LOG"& for anything that would have been logged.
2979 This facility is provided for testing configuration options for incoming
2980 messages, to make sure they implement the required policy. For example, you can
2981 test your relay controls using &%-bh%&.
2982
2983 &*Warning 1*&:
2984 .cindex "RFC 1413"
2985 You can test features of the configuration that rely on ident (RFC 1413)
2986 information by using the &%-oMt%& option. However, Exim cannot actually perform
2987 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2988 connection.
2989
2990 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2991 are also skipped when testing using &%-bh%&. If you want these callouts to
2992 occur, use &%-bhc%& instead.
2993
2994 Messages supplied during the testing session are discarded, and nothing is
2995 written to any of the real log files. There may be pauses when DNS (and other)
2996 lookups are taking place, and of course these may time out. The &%-oMi%& option
2997 can be used to specify a specific IP interface and port if this is important,
2998 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2999 session were authenticated.
3000
3001 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3002 output just states whether a given recipient address from a given host is
3003 acceptable or not. See section &<<SECTcheckaccess>>&.
3004
3005 Features such as authentication and encryption, where the client input is not
3006 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3007 specialized SMTP test program such as
3008 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3009
3010 .cmdopt -bhc <&'IP&~address'&>
3011 This option operates in the same way as &%-bh%&, except that address
3012 verification callouts are performed if required. This includes consulting and
3013 updating the callout cache database.
3014
3015 .cmdopt -bi
3016 .cindex "alias file" "building"
3017 .cindex "building alias file"
3018 .cindex "Sendmail compatibility" "&%-bi%& option"
3019 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3020 Exim does not have the concept of a single alias file, and so it cannot mimic
3021 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3022 tend to appear in various scripts such as NIS make files, so the option must be
3023 recognized.
3024
3025 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3026 configuration option is run, under the uid and gid of the caller of Exim. If
3027 the &%-oA%& option is used, its value is passed to the command as an argument.
3028 The command set by &%bi_command%& may not contain arguments. The command can
3029 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3030 if this is required. If the &%bi_command%& option is not set, calling Exim with
3031 &%-bi%& is a no-op.
3032
3033 . // Keep :help first, then the rest in alphabetical order
3034 .cmdopt -bI:help
3035 .cindex "querying exim information"
3036 We shall provide various options starting &`-bI:`& for querying Exim for
3037 information.  The output of many of these will be intended for machine
3038 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3039 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3040 options shall cause Exim to exit after producing the requested output.
3041
3042 .cmdopt -bI:dscp
3043 .cindex "DSCP" "values"
3044 This option causes Exim to emit an alphabetically sorted list of all
3045 recognised DSCP names.
3046
3047 .cmdopt -bI:sieve
3048 .cindex "Sieve filter" "capabilities"
3049 This option causes Exim to emit an alphabetically sorted list of all supported
3050 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3051 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3052 &`SIEVE`& capability response line.  As the precise list may depend upon
3053 compile-time build options, which this option will adapt to, this is the only
3054 way to guarantee a correct response.
3055
3056 .cmdopt -bm
3057 .cindex "local message reception"
3058 This option runs an Exim receiving process that accepts an incoming,
3059 locally-generated message on the standard input. The recipients are given as the
3060 command arguments (except when &%-t%& is also present &-- see below). Each
3061 argument can be a comma-separated list of RFC 2822 addresses. This is the
3062 default option for selecting the overall action of an Exim call; it is assumed
3063 if no other conflicting option is present.
3064
3065 If any addresses in the message are unqualified (have no domain), they are
3066 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3067 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3068 suppressing this for special cases.
3069
3070 Policy checks on the contents of local messages can be enforced by means of
3071 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3072
3073 .cindex "return code" "for &%-bm%&"
3074 The return code is zero if the message is successfully accepted. Otherwise, the
3075 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3076
3077 The format
3078 .cindex "message" "format"
3079 .cindex "format" "message"
3080 .cindex "&""From""& line"
3081 .cindex "UUCP" "&""From""& line"
3082 .cindex "Sendmail compatibility" "&""From""& line"
3083 of the message must be as defined in RFC 2822, except that, for
3084 compatibility with Sendmail and Smail, a line in one of the forms
3085 .code
3086 From sender Fri Jan  5 12:55 GMT 1997
3087 From sender Fri, 5 Jan 97 12:55:01
3088 .endd
3089 (with the weekday optional, and possibly with additional text after the date)
3090 is permitted to appear at the start of the message. There appears to be no
3091 authoritative specification of the format of this line. Exim recognizes it by
3092 matching against the regular expression defined by the &%uucp_from_pattern%&
3093 option, which can be changed if necessary.
3094
3095 .oindex "&%-f%&" "overriding &""From""& line"
3096 The specified sender is treated as if it were given as the argument to the
3097 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3098 preference to the address taken from the message. The caller of Exim must be a
3099 trusted user for the sender of a message to be set in this way.
3100
3101 .cmdopt -bmalware <&'filename'&>
3102 .cindex "testing", "malware"
3103 .cindex "malware scan test"
3104 This debugging option causes Exim to scan the given file or directory
3105 (depending on the used scanner interface),
3106 using the malware scanning framework.  The option of &%av_scanner%& influences
3107 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3108 the expansion should have defaults which apply to this invocation.  ACLs are
3109 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3110 will never be populated and &%-bmalware%& will fail.
3111
3112 Exim will have changed working directory before resolving the filename, so
3113 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3114 user when it tries to open the file, rather than as the invoking user.
3115 This option requires admin privileges.
3116
3117 The &%-bmalware%& option will not be extended to be more generally useful,
3118 there are better tools for file-scanning.  This option exists to help
3119 administrators verify their Exim and AV scanner configuration.
3120
3121 .cmdopt -bnq
3122 .cindex "address qualification, suppressing"
3123 By default, Exim automatically qualifies unqualified addresses (those
3124 without domains) that appear in messages that are submitted locally (that
3125 is, not over TCP/IP). This qualification applies both to addresses in
3126 envelopes, and addresses in header lines. Sender addresses are qualified using
3127 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3128 defaults to the value of &%qualify_domain%&).
3129
3130 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3131 being used to re-submit messages that originally came from remote hosts after
3132 content scanning, you probably do not want to qualify unqualified addresses in
3133 header lines. (Such lines will be present only if you have not enabled a header
3134 syntax check in the appropriate ACL.)
3135
3136 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3137 messages that originate on the local host. When this is used, unqualified
3138 addresses in the envelope provoke errors (causing message rejection) and
3139 unqualified addresses in header lines are left alone.
3140
3141
3142 .cmdopt -bP
3143 .cindex "configuration options" "extracting"
3144 .cindex "options" "configuration &-- extracting"
3145 If this option is given with no arguments, it causes the values of all Exim's
3146 main configuration options to be written to the standard output. The values
3147 of one or more specific options can be requested by giving their names as
3148 arguments, for example:
3149 .code
3150 exim -bP qualify_domain hold_domains
3151 .endd
3152 .cindex "hiding configuration option values"
3153 .cindex "configuration options" "hiding value of"
3154 .cindex "options" "hiding value of"
3155 However, any option setting that is preceded by the word &"hide"& in the
3156 configuration file is not shown in full, except to an admin user. For other
3157 users, the output is as in this example:
3158 .code
3159 mysql_servers = <value not displayable>
3160 .endd
3161 If &%config%& is given as an argument, the config is
3162 output, as it was parsed, any include file resolved, any comment removed.
3163
3164 If &%config_file%& is given as an argument, the name of the runtime
3165 configuration file is output. (&%configure_file%& works too, for
3166 backward compatibility.)
3167 If a list of configuration files was supplied, the value that is output here
3168 is the name of the file that was actually used.
3169
3170 .cindex "options" "hiding name of"
3171 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3172 name will not be output.
3173
3174 .cindex "daemon" "process id (pid)"
3175 .cindex "pid (process id)" "of daemon"
3176 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3177 directories where log files and daemon pid files are written are output,
3178 respectively. If these values are unset, log files are written in a
3179 sub-directory of the spool directory called &%log%&, and the pid file is
3180 written directly into the spool directory.
3181
3182 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3183 .code
3184 exim -bP +local_domains
3185 .endd
3186 it searches for a matching named list of any type (domain, host, address, or
3187 local part) and outputs what it finds.
3188
3189 .cindex "options" "router &-- extracting"
3190 .cindex "options" "transport &-- extracting"
3191 .cindex "options" "authenticator &-- extracting"
3192 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3193 followed by the name of an appropriate driver instance, the option settings for
3194 that driver are output. For example:
3195 .code
3196 exim -bP transport local_delivery
3197 .endd
3198 The generic driver options are output first, followed by the driver's private
3199 options. A list of the names of drivers of a particular type can be obtained by
3200 using one of the words &%router_list%&, &%transport_list%&, or
3201 &%authenticator_list%&, and a complete list of all drivers with their option
3202 settings can be obtained by using &%routers%&, &%transports%&, or
3203 &%authenticators%&.
3204
3205 .cindex "environment"
3206 If &%environment%& is given as an argument, the set of environment
3207 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3208 variables.
3209
3210 .cindex "options" "macro &-- extracting"
3211 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3212 are available, similarly to the drivers.  Because macros are sometimes used
3213 for storing passwords, this option is restricted.
3214 The output format is one item per line.
3215 For the "-bP macro <name>" form, if no such macro is found
3216 the exit status will be nonzero.
3217
3218 .cmdopt -bp
3219 .cindex "queue" "listing messages in"
3220 .cindex "listing" "messages in the queue"
3221 This option requests a listing of the contents of the mail queue on the
3222 standard output. If the &%-bp%& option is followed by a list of message ids,
3223 just those messages are listed. By default, this option can be used only by an
3224 admin user. However, the &%queue_list_requires_admin%& option can be set false
3225 to allow any user to see the queue.
3226
3227 Each message in the queue is displayed as in the following example:
3228 .code
3229 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3230           red.king@looking-glass.fict.example
3231           <other addresses>
3232 .endd
3233 .cindex "message" "size in queue listing"
3234 .cindex "size" "of message"
3235 The first line contains the length of time the message has been in the queue
3236 (in this case 25 minutes), the size of the message (2.9K), the unique local
3237 identifier for the message, and the message sender, as contained in the
3238 envelope. For bounce messages, the sender address is empty, and appears as
3239 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3240 the default sender address, the user's login name is shown in parentheses
3241 before the sender address.
3242
3243 .cindex "frozen messages" "in queue listing"
3244 If the message is frozen (attempts to deliver it are suspended) then the text
3245 &"*** frozen ***"& is displayed at the end of this line.
3246
3247 The recipients of the message (taken from the envelope, not the headers) are
3248 displayed on subsequent lines. Those addresses to which the message has already
3249 been delivered are marked with the letter D. If an original address gets
3250 expanded into several addresses via an alias or forward file, the original is
3251 displayed with a D only when deliveries for all of its child addresses are
3252 complete.
3253
3254
3255 .cmdopt -bpa
3256 This option operates like &%-bp%&, but in addition it shows delivered addresses
3257 that were generated from the original top level address(es) in each message by
3258 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3259 of just &"D"&.
3260
3261
3262 .cmdopt -bpc
3263 .cindex "queue" "count of messages on"
3264 This option counts the number of messages in the queue, and writes the total
3265 to the standard output. It is restricted to admin users, unless
3266 &%queue_list_requires_admin%& is set false.
3267
3268
3269 .cmdopt -bpr
3270 This option operates like &%-bp%&, but the output is not sorted into
3271 chronological order of message arrival. This can speed it up when there are
3272 lots of messages in the queue, and is particularly useful if the output is
3273 going to be post-processed in a way that doesn't need the sorting.
3274
3275 .cmdopt -bpra
3276 This option is a combination of &%-bpr%& and &%-bpa%&.
3277
3278 .cmdopt -bpru
3279 This option is a combination of &%-bpr%& and &%-bpu%&.
3280
3281
3282 .cmdopt -bpu
3283 This option operates like &%-bp%& but shows only undelivered top-level
3284 addresses for each message displayed. Addresses generated by aliasing or
3285 forwarding are not shown, unless the message was deferred after processing by a
3286 router with the &%one_time%& option set.
3287
3288
3289 .cmdopt -brt
3290 .cindex "testing" "retry configuration"
3291 .cindex "retry" "configuration testing"
3292 This option is for testing retry rules, and it must be followed by up to three
3293 arguments. It causes Exim to look for a retry rule that matches the values
3294 and to write it to the standard output. For example:
3295 .code
3296 exim -brt bach.comp.mus.example
3297 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3298 .endd
3299 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3300 argument, which is required, can be a complete address in the form
3301 &'local_part@domain'&, or it can be just a domain name. If the second argument
3302 contains a dot, it is interpreted as an optional second domain name; if no
3303 retry rule is found for the first argument, the second is tried. This ties in
3304 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3305 rule is found that matches the host, one that matches the mail domain is
3306 sought. Finally, an argument that is the name of a specific delivery error, as
3307 used in setting up retry rules, can be given. For example:
3308 .code
3309 exim -brt haydn.comp.mus.example quota_3d
3310 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3311 .endd
3312
3313 .cmdopt -brw
3314 .cindex "testing" "rewriting"
3315 .cindex "rewriting" "testing"
3316 This option is for testing address rewriting rules, and it must be followed by
3317 a single argument, consisting of either a local part without a domain, or a
3318 complete address with a fully qualified domain. Exim outputs how this address
3319 would be rewritten for each possible place it might appear. See chapter
3320 &<<CHAPrewrite>>& for further details.
3321
3322 .cmdopt -bS
3323 .cindex "SMTP" "batched incoming"
3324 .cindex "batched SMTP input"
3325 This option is used for batched SMTP input, which is an alternative interface
3326 for non-interactive local message submission. A number of messages can be
3327 submitted in a single run. However, despite its name, this is not really SMTP
3328 input. Exim reads each message's envelope from SMTP commands on the standard
3329 input, but generates no responses. If the caller is trusted, or
3330 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3331 believed; otherwise the sender is always the caller of Exim.
3332
3333 The message itself is read from the standard input, in SMTP format (leading
3334 dots doubled), terminated by a line containing just a single dot. An error is
3335 provoked if the terminating dot is missing. A further message may then follow.
3336
3337 As for other local message submissions, the contents of incoming batch SMTP
3338 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3339 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3340 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3341
3342 Some other SMTP commands are recognized in the input. HELO and EHLO act
3343 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3344 QUIT quits, ignoring the rest of the standard input.
3345
3346 .cindex "return code" "for &%-bS%&"
3347 If any error is encountered, reports are written to the standard output and
3348 error streams, and Exim gives up immediately. The return code is 0 if no error
3349 was detected; it is 1 if one or more messages were accepted before the error
3350 was detected; otherwise it is 2.
3351
3352 More details of input using batched SMTP are given in section
3353 &<<SECTincomingbatchedSMTP>>&.
3354
3355 .cmdopt -bs
3356 .cindex "SMTP" "local input"
3357 .cindex "local SMTP input"
3358 This option causes Exim to accept one or more messages by reading SMTP commands
3359 on the standard input, and producing SMTP replies on the standard output. SMTP
3360 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3361 Some user agents use this interface as a way of passing locally-generated
3362 messages to the MTA.
3363
3364 In
3365 .cindex "sender" "source of"
3366 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3367 set, the senders of messages are taken from the SMTP MAIL commands.
3368 Otherwise the content of these commands is ignored and the sender is set up as
3369 the calling user. Unqualified addresses are automatically qualified using
3370 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3371 &%-bnq%& option is used.
3372
3373 .cindex "inetd"
3374 The
3375 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3376 using a listening daemon. Exim can distinguish the two cases by checking
3377 whether the standard input is a TCP/IP socket. When Exim is called from
3378 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3379 above concerning senders and qualification do not apply. In this situation,
3380 Exim behaves in exactly the same way as it does when receiving a message via
3381 the listening daemon.
3382
3383 .cmdopt -bt
3384 .cindex "testing" "addresses"
3385 .cindex "address" "testing"
3386 This option runs Exim in address testing mode, in which each argument is taken
3387 as a recipient address to be tested for deliverability. The results are
3388 written to the standard output. If a test fails, and the caller is not an admin
3389 user, no details of the failure are output, because these might contain
3390 sensitive information such as usernames and passwords for database lookups.
3391
3392 If no arguments are given, Exim runs in an interactive manner, prompting with a
3393 right angle bracket for addresses to be tested.
3394
3395 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3396 &[readline()]& function, because it is running as &'root'& and there are
3397 security issues.
3398
3399 Each address is handled as if it were the recipient address of a message
3400 (compare the &%-bv%& option). It is passed to the routers and the result is
3401 written to the standard output. However, any router that has
3402 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3403 genuine routing tests if your first router passes everything to a scanner
3404 program.
3405
3406 .cindex "return code" "for &%-bt%&"
3407 The return code is 2 if any address failed outright; it is 1 if no address
3408 failed outright but at least one could not be resolved for some reason. Return
3409 code 0 is given only when all addresses succeed.
3410
3411 .cindex "duplicate addresses"
3412 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3413 addresses after routing is complete, so that only one delivery takes place.
3414 This does not happen when testing with &%-bt%&; the full results of routing are
3415 always shown.
3416
3417 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3418 routers in the configuration makes any tests on the sender address of a
3419 message,
3420 .oindex "&%-f%&" "for address testing"
3421 you can use the &%-f%& option to set an appropriate sender when running
3422 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3423 default qualifying domain. However, if you have set up (for example) routers
3424 whose behaviour depends on the contents of an incoming message, you cannot test
3425 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3426 doing such tests.
3427
3428 .cmdopt -bV
3429 .cindex "version number of Exim"
3430 This option causes Exim to write the current version number, compilation
3431 number, and compilation date of the &'exim'& binary to the standard output.
3432 It also lists the DBM library that is being used, the optional modules (such as
3433 specific lookup types), the drivers that are included in the binary, and the
3434 name of the runtime configuration file that is in use.
3435
3436 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3437 configuration file. However, this is a static check only. It cannot check
3438 values that are to be expanded. For example, although a misspelt ACL verb is
3439 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3440 alone to discover (for example) all the typos in the configuration; some
3441 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3442 dynamic testing facilities.
3443
3444 .cmdopt -bv
3445 .cindex "verifying address" "using &%-bv%&"
3446 .cindex "address" "verification"
3447 This option runs Exim in address verification mode, in which each argument is
3448 taken as a recipient address to be verified by the routers. (This does
3449 not involve any verification callouts). During normal operation, verification
3450 happens mostly as a consequence processing a &%verify%& condition in an ACL
3451 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3452 including callouts, see the &%-bh%& and &%-bhc%& options.
3453
3454 If verification fails, and the caller is not an admin user, no details of the
3455 failure are output, because these might contain sensitive information such as
3456 usernames and passwords for database lookups.
3457
3458 If no arguments are given, Exim runs in an interactive manner, prompting with a
3459 right angle bracket for addresses to be verified.
3460
3461 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3462 &[readline()]& function, because it is running as &'exim'& and there are
3463 security issues.
3464
3465 Verification differs from address testing (the &%-bt%& option) in that routers
3466 that have &%no_verify%& set are skipped, and if the address is accepted by a
3467 router that has &%fail_verify%& set, verification fails. The address is
3468 verified as a recipient if &%-bv%& is used; to test verification for a sender
3469 address, &%-bvs%& should be used.
3470
3471 If the &%-v%& option is not set, the output consists of a single line for each
3472 address, stating whether it was verified or not, and giving a reason in the
3473 latter case. Without &%-v%&, generating more than one address by redirection
3474 causes verification to end successfully, without considering the generated
3475 addresses. However, if just one address is generated, processing continues,
3476 and the generated address must verify successfully for the overall verification
3477 to succeed.
3478
3479 When &%-v%& is set, more details are given of how the address has been handled,
3480 and in the case of address redirection, all the generated addresses are also
3481 considered. Verification may succeed for some and fail for others.
3482
3483 The
3484 .cindex "return code" "for &%-bv%&"
3485 return code is 2 if any address failed outright; it is 1 if no address
3486 failed outright but at least one could not be resolved for some reason. Return
3487 code 0 is given only when all addresses succeed.
3488
3489 If any of the routers in the configuration makes any tests on the sender
3490 address of a message, you should use the &%-f%& option to set an appropriate
3491 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3492 calling user at the default qualifying domain.
3493
3494 .cmdopt -bvs
3495 This option acts like &%-bv%&, but verifies the address as a sender rather
3496 than a recipient address. This affects any rewriting and qualification that
3497 might happen.
3498
3499 .cmdopt -bw
3500 .cindex "daemon"
3501 .cindex "inetd"
3502 .cindex "inetd" "wait mode"
3503 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3504 similarly to the &%-bd%& option.  All port specifications on the command-line
3505 and in the configuration file are ignored.  Queue-running may not be specified.
3506
3507 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3508 listening for connections.  This permits the system to start up and have
3509 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3510 each port only when the first connection is received.
3511
3512 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3513 which the daemon will exit, which should cause inetd to listen once more.
3514
3515 .cmdopt -C <&'filelist'&>
3516 .cindex "configuration file" "alternate"
3517 .cindex "CONFIGURE_FILE"
3518 .cindex "alternate configuration file"
3519 This option causes Exim to find the runtime configuration file from the given
3520 list instead of from the list specified by the CONFIGURE_FILE
3521 compile-time setting. Usually, the list will consist of just a single filename,
3522 but it can be a colon-separated list of names. In this case, the first
3523 file that exists is used. Failure to open an existing file stops Exim from
3524 proceeding any further along the list, and an error is generated.
3525
3526 When this option is used by a caller other than root, and the list is different
3527 from the compiled-in list, Exim gives up its root privilege immediately, and
3528 runs with the real and effective uid and gid set to those of the caller.
3529 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3530 file contains a list of full pathnames, one per line, for configuration files
3531 which are trusted. Root privilege is retained for any configuration file so
3532 listed, as long as the caller is the Exim user (or the user specified in the
3533 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3534 not writeable by inappropriate users or groups.
3535
3536 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3537 configuration using &%-C%& right through message reception and delivery,
3538 even if the caller is root. The reception works, but by that time, Exim is
3539 running as the Exim user, so when it re-executes to regain privilege for the
3540 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3541 test reception and delivery using two separate commands (one to put a message
3542 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3543
3544 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3545 prefix string with which any file named in a &%-C%& command line option
3546 must start. In addition, the filename must not contain the sequence &`/../`&.
3547 However, if the value of the &%-C%& option is identical to the value of
3548 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3549 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3550 unset, any filename can be used with &%-C%&.
3551
3552 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3553 to a directory to which only root has access. This prevents someone who has
3554 broken into the Exim account from running a privileged Exim with an arbitrary
3555 configuration file.
3556
3557 The &%-C%& facility is useful for ensuring that configuration files are
3558 syntactically correct, but cannot be used for test deliveries, unless the
3559 caller is privileged, or unless it is an exotic configuration that does not
3560 require privilege. No check is made on the owner or group of the files
3561 specified by this option.
3562
3563
3564 .vitem &%-D%&<&'macro'&>=<&'value'&>
3565 .oindex "&%-D%&"
3566 .cindex "macro" "setting on command line"
3567 This option can be used to override macro definitions in the configuration file
3568 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3569 unprivileged caller, it causes Exim to give up its root privilege.
3570 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3571 completely disabled, and its use causes an immediate error exit.
3572
3573 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3574 colon-separated list of macros which are considered safe and, if &%-D%& only
3575 supplies macros from this list, and the values are acceptable, then Exim will
3576 not give up root privilege if the caller is root, the Exim run-time user, or
3577 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3578 to be removed in the future.  Acceptable values for the macros satisfy the
3579 regexp: &`^[A-Za-z0-9_/.-]*$`&
3580
3581 The entire option (including equals sign if present) must all be within one
3582 command line item. &%-D%& can be used to set the value of a macro to the empty
3583 string, in which case the equals sign is optional. These two commands are
3584 synonymous:
3585 .code
3586 exim -DABC  ...
3587 exim -DABC= ...
3588 .endd
3589 To include spaces in a macro definition item, quotes must be used. If you use
3590 quotes, spaces are permitted around the macro name and the equals sign. For
3591 example:
3592 .code
3593 exim '-D ABC = something' ...
3594 .endd
3595 &%-D%& may be repeated up to 10 times on a command line.
3596 Only macro names up to 22 letters long can be set.
3597
3598
3599 .vitem &%-d%&<&'debug&~options'&>
3600 .oindex "&%-d%&"
3601 .cindex "debugging" "list of selectors"
3602 .cindex "debugging" "&%-d%& option"
3603 This option causes debugging information to be written to the standard
3604 error stream. It is restricted to admin users because debugging output may show
3605 database queries that contain password information. Also, the details of users'
3606 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3607 writes an error message to the standard error stream and exits with a non-zero
3608 return code.
3609
3610 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3611 standard debugging data is output. This can be reduced, or increased to include
3612 some more rarely needed information, by directly following &%-d%& with a string
3613 made up of names preceded by plus or minus characters. These add or remove sets
3614 of debugging data, respectively. For example, &%-d+filter%& adds filter
3615 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3616 no spaces are allowed in the debug setting. The available debugging categories
3617 are:
3618 .itable none 0 0 2 20* left 80* left
3619 .irow acl            "ACL interpretation"
3620 .irow auth           "authenticators"
3621 .irow deliver        "general delivery logic"
3622 .irow dns            "DNS lookups (see also resolver)"
3623 .irow dnsbl          "DNS black list (aka RBL) code"
3624 .irow exec           "arguments for &[execv()]& calls"
3625 .irow expand         "detailed debugging for string expansions"
3626 .irow filter         "filter handling"
3627 .irow hints_lookup   "hints data lookups"
3628 .irow host_lookup    "all types of name-to-IP address handling"
3629 .irow ident          "ident lookup"
3630 .irow interface      "lists of local interfaces"
3631 .irow lists          "matching things in lists"
3632 .irow load           "system load checks"
3633 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3634                     &<<CHAPlocalscan>>&)"
3635 .irow lookup         "general lookup code and all lookups"
3636 .irow memory         "memory handling"
3637 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3638 .irow pid            "modifier: add pid to debug output lines"
3639 .irow process_info   "setting info for the process log"
3640 .irow queue_run      "queue runs"
3641 .irow receive        "general message reception logic"
3642 .irow resolver       "turn on the DNS resolver's debugging output"
3643 .irow retry          "retry handling"
3644 .irow rewrite        "address rewriting""
3645 .irow route          "address routing"
3646 .irow timestamp      "modifier: add timestamp to debug output lines"
3647 .irow tls            "TLS logic"
3648 .irow transport      "transports"
3649 .irow uid            "changes of uid/gid and looking up uid/gid"
3650 .irow verify         "address verification logic"
3651 .irow all            "almost all of the above (see below), and also &%-v%&"
3652 .endtable
3653 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3654 for &`-all`&. The reason for this is that &`+all`& is something that people
3655 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3656 is included, an awful lot of output that is very rarely of interest is
3657 generated, so it now has to be explicitly requested. However, &`-all`& does
3658 turn everything off.
3659
3660 .cindex "resolver, debugging output"
3661 .cindex "DNS resolver, debugging output"
3662 The &`resolver`& option produces output only if the DNS resolver was compiled
3663 with DEBUG enabled. This is not the case in some operating systems. Also,
3664 unfortunately, debugging output from the DNS resolver is written to stdout
3665 rather than stderr.
3666
3667 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3668 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3669 However, the &`pid`& selector is forced when debugging is turned on for a
3670 daemon, which then passes it on to any re-executed Exims. Exim also
3671 automatically adds the pid to debug lines when several remote deliveries are
3672 run in parallel.
3673
3674 The &`timestamp`& selector causes the current time to be inserted at the start
3675 of all debug output lines. This can be useful when trying to track down delays
3676 in processing.
3677
3678 .cindex debugging "UTF-8 in"
3679 .cindex UTF-8 "in debug output"
3680 The &`noutf8`& selector disables the use of
3681 UTF-8 line-drawing characters to group related information.
3682 When disabled. ascii-art is used instead.
3683 Using the &`+all`& option does not set this modifier,
3684
3685 If the &%debug_print%& option is set in any driver, it produces output whenever
3686 any debugging is selected, or if &%-v%& is used.
3687
3688 .vitem &%-dd%&<&'debug&~options'&>
3689 .oindex "&%-dd%&"
3690 This option behaves exactly like &%-d%& except when used on a command that
3691 starts a daemon process. In that case, debugging is turned off for the
3692 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3693 behaviour of the daemon without creating as much output as full debugging does.
3694
3695 .cmdopt -dropcr
3696 This is an obsolete option that is now a no-op. It used to affect the way Exim
3697 handled CR and LF characters in incoming messages. What happens now is
3698 described in section &<<SECTlineendings>>&.
3699
3700 .cmdopt -E
3701 .cindex "bounce message" "generating"
3702 This option specifies that an incoming message is a locally-generated delivery
3703 failure report. It is used internally by Exim when handling delivery failures
3704 and is not intended for external use. Its only effect is to stop Exim
3705 generating certain messages to the postmaster, as otherwise message cascades
3706 could occur in some situations. As part of the same option, a message id may
3707 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3708 new message contains the id, following &"R="&, as a cross-reference.
3709
3710 .vitem &%-e%&&'x'&
3711 .oindex "&%-e%&&'x'&"
3712 There are a number of Sendmail options starting with &%-oe%& which seem to be
3713 called by various programs without the leading &%o%& in the option. For
3714 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3715 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3716
3717 .cmdopt -F <&'string'&>
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .cmdopt -f <&'address'&>
3727 .cindex "sender" "address"
3728 .cindex "address" "sender"
3729 .cindex "trusted users"
3730 .cindex "envelope from"
3731 .cindex "envelope sender"
3732 .cindex "user" "trusted"
3733 This option sets the address of the envelope sender of a locally-generated
3734 message (also known as the return path). The option can normally be used only
3735 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3736 users to use it.
3737
3738 Processes running as root or the Exim user are always trusted. Other
3739 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3740 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3741 of a local message is set to the caller's login name at the default qualify
3742 domain.
3743
3744 There is one exception to the restriction on the use of &%-f%&: an empty sender
3745 can be specified by any user, trusted or not, to create a message that can
3746 never provoke a bounce. An empty sender can be specified either as an empty
3747 string, or as a pair of angle brackets with nothing between them, as in these
3748 examples of shell commands:
3749 .code
3750 exim -f '<>' user@domain
3751 exim -f "" user@domain
3752 .endd
3753 In addition, the use of &%-f%& is not restricted when testing a filter file
3754 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3755 &%-bv%& options.
3756
3757 Allowing untrusted users to change the sender address does not of itself make
3758 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3759 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3760 though this can be overridden by setting &%no_local_from_check%&.
3761
3762 White
3763 .cindex "&""From""& line"
3764 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3765 given as two arguments or one combined argument). The sender of a
3766 locally-generated message can also be set (when permitted) by an initial
3767 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3768 if &%-f%& is also present, it overrides &"From&~"&.
3769
3770 .cmdopt -G
3771 .cindex "submission fixups, suppressing (command-line)"
3772 This option is equivalent to an ACL applying:
3773 .code
3774 control = suppress_local_fixups
3775 .endd
3776 for every message received.  Note that Sendmail will complain about such
3777 bad formatting, where Exim silently just does not fix it up.  This may change
3778 in future.
3779
3780 As this affects audit information, the caller must be a trusted user to use
3781 this option.
3782
3783 .cmdopt -h <&'number'&>
3784 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3785 This option is accepted for compatibility with Sendmail, but has no effect. (In
3786 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3787 headers.)
3788
3789 .cmdopt -i
3790 .cindex "Solaris" "&'mail'& command"
3791 .cindex "dot" "in incoming non-SMTP message"
3792 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3793 line by itself should not terminate an incoming, non-SMTP message.
3794 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3795 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3796 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3797 by its &'mailx'& command.
3798
3799 .cmdopt -L <&'tag'&>
3800 .cindex "syslog" "process name; set with flag"
3801 This option is equivalent to setting &%syslog_processname%& in the config
3802 file and setting &%log_file_path%& to &`syslog`&.
3803 Its use is restricted to administrators.  The configuration file has to be
3804 read and parsed, to determine access rights, before this is set and takes
3805 effect, so early configuration file errors will not honour this flag.
3806
3807 The tag should not be longer than 32 characters.
3808
3809 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3810 .cindex "forcing delivery"
3811 .cindex "delivery" "forcing attempt"
3812 .cindex "frozen messages" "forcing delivery"
3813 This option requests Exim to run a delivery attempt on each message in turn. If
3814 any of the messages are frozen, they are automatically thawed before the
3815 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3816 and &%hold_domains%& are ignored.
3817
3818 Retry
3819 .cindex "hints database" "overriding retry hints"
3820 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3821 the normal retry time has not yet been reached. This option requires the caller
3822 to be an admin user. However, there is an option called &%prod_requires_admin%&
3823 which can be set false to relax this restriction (and also the same requirement
3824 for the &%-q%&, &%-R%&, and &%-S%& options).
3825
3826 The deliveries happen synchronously, that is, the original Exim process does
3827 not terminate until all the delivery attempts have finished. No output is
3828 produced unless there is a serious error. If you want to see what is happening,
3829 use the &%-v%& option as well, or inspect Exim's main log.
3830
3831 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3832 .cindex "message" "adding recipients"
3833 .cindex "recipient" "adding"
3834 This option requests Exim to add the addresses to the list of recipients of the
3835 message (&"ar"& for &"add recipients"&). The first argument must be a message
3836 id, and the remaining ones must be email addresses. However, if the message is
3837 active (in the middle of a delivery attempt), it is not altered. This option
3838 can be used only by an admin user.
3839
3840 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3841         &~<&'host&~IP'&>&&&
3842         &~<&'sequence&~number'&>&&&
3843         &~<&'message&~id'&>"
3844 .oindex "&%-MC%&"
3845 .cindex "SMTP" "passed connection"
3846 .cindex "SMTP" "multiple deliveries"
3847 .cindex "multiple SMTP deliveries"
3848 This option is not intended for use by external callers. It is used internally
3849 by Exim to invoke another instance of itself to deliver a waiting message using
3850 an existing SMTP connection, which is passed as the standard input. Details are
3851 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3852 must be root or the Exim user in order to use it.
3853
3854 .cmdopt -MCA
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option. It signifies that the
3857 connection to the remote host has been authenticated.
3858
3859 .cmdopt -MCD
3860 This option is not intended for use by external callers. It is used internally
3861 by Exim in conjunction with the &%-MC%& option. It signifies that the
3862 remote host supports the ESMTP &_DSN_& extension.
3863
3864 .cmdopt -MCd
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-d%& option
3867 to pass on an information string on the purpose of the process.
3868
3869 .cmdopt -MCG <&'queue&~name'&>
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option. It signifies that an
3872 alternate queue is used, named by the following argument.
3873
3874 .cmdopt -MCK
3875 This option is not intended for use by external callers. It is used internally
3876 by Exim in conjunction with the &%-MC%& option. It signifies that a
3877 remote host supports the ESMTP &_CHUNKING_& extension.
3878
3879 .cmdopt -MCL
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3882 which Exim is connected advertised limits on numbers of mails, recipients or
3883 recipient domains.
3884 The limits are given by the following three arguments.
3885
3886 .cmdopt -MCP
3887 This option is not intended for use by external callers. It is used internally
3888 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3889 which Exim is connected supports pipelining.
3890
3891 .cmdopt -MCp
3892 This option is not intended for use by external callers. It is used internally
3893 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3894 t a remote server is via a SOCKS proxy, using addresses and ports given by
3895 the following four arguments.
3896
3897 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option when the original delivery was
3900 started by a queue runner. It passes on the process id of the queue runner,
3901 together with the file descriptor number of an open pipe. Closure of the pipe
3902 signals the final completion of the sequence of processes that are passing
3903 messages through the same SMTP connection.
3904
3905 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3906 This option is not intended for use by external callers. It is used internally
3907 by Exim to implement quota checking for local users.
3908
3909 .cmdopt -MCS
3910 This option is not intended for use by external callers. It is used internally
3911 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3912 ESMTP SIZE option should be used on messages delivered down the existing
3913 connection.
3914
3915 .cmdopt -MCT
3916 This option is not intended for use by external callers. It is used internally
3917 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3918 host to which Exim is connected supports TLS encryption.
3919
3920 .vitem &%-MCr%&&~<&'SNI'&> &&&
3921        &%-MCs%&&~<&'SNI'&>
3922 .oindex "&%-MCs%&"
3923 .oindex "&%-MCr%&"
3924 These options are not intended for use by external callers. It is used internally
3925 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3926 a TLS Server Name Indication was sent as part of the channel establishment.
3927 The argument gives the SNI string.
3928 The "r" variant indicates a DANE-verified connection.
3929
3930 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3931 This option is not intended for use by external callers. It is used internally
3932 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3933 connection is being proxied by a parent process for handling TLS encryption.
3934 The arguments give the local address and port being proxied, and the TLS cipher.
3935
3936 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3937 .cindex "hints database" "not overridden by &%-Mc%&"
3938 .cindex "delivery" "manually started &-- not forced"
3939 This option requests Exim to run a delivery attempt on each message, in turn,
3940 but unlike the &%-M%& option, it does check for retry hints, and respects any
3941 that are found. This option is not very useful to external callers. It is
3942 provided mainly for internal use by Exim when it needs to re-invoke itself in
3943 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3944 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3945 respects retry times and other options such as &%hold_domains%& that are
3946 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3947 If you want to run a specific delivery as if in a queue run, you should use
3948 &%-q%& with a message id argument. A distinction between queue run deliveries
3949 and other deliveries is made in one or two places.
3950
3951 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3952 .cindex "message" "changing sender"
3953 .cindex "sender" "changing"
3954 This option requests Exim to change the sender address in the message to the
3955 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3956 &"edit sender"&). There must be exactly two arguments. The first argument must
3957 be a message id, and the second one an email address. However, if the message
3958 is active (in the middle of a delivery attempt), its status is not altered.
3959 This option can be used only by an admin user.
3960
3961 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
3962 .cindex "freezing messages"
3963 .cindex "message" "manually freezing"
3964 This option requests Exim to mark each listed message as &"frozen"&. This
3965 prevents any delivery attempts taking place until the message is &"thawed"&,
3966 either manually or as a result of the &%auto_thaw%& configuration option.
3967 However, if any of the messages are active (in the middle of a delivery
3968 attempt), their status is not altered. This option can be used only by an admin
3969 user.
3970
3971 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
3972 .cindex "giving up on messages"
3973 .cindex "message" "abandoning delivery attempts"
3974 .cindex "delivery" "abandoning further attempts"
3975 This option requests Exim to give up trying to deliver the listed messages,
3976 including any that are frozen. However, if any of the messages are active,
3977 their status is not altered. For non-bounce messages, a delivery error message
3978 is sent to the sender, containing the text &"cancelled by administrator"&.
3979 Bounce messages are just discarded. This option can be used only by an admin
3980 user.
3981
3982 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .cindex queue named
3984 .cindex "named queues" "moving messages"
3985 .cindex "queue" "moving messages"
3986 This option requests that each listed message be moved from its current
3987 queue to the given named queue.
3988 The destination queue name argument is required, but can be an empty
3989 string to define the default queue.
3990 If the messages are not currently located in the default queue,
3991 a &%-qG<name>%& option will be required to define the source queue.
3992
3993 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
3994 .cindex "delivery" "cancelling all"
3995 This option requests Exim to mark all the recipient addresses in the messages
3996 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3997 message is active (in the middle of a delivery attempt), its status is not
3998 altered. This option can be used only by an admin user.
3999
4000 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4001 .cindex "delivery" "cancelling by address"
4002 .cindex "recipient" "removing"
4003 .cindex "removing recipients"
4004 This option requests Exim to mark the given addresses as already delivered
4005 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4006 the remaining ones must be email addresses. These are matched to recipient
4007 addresses in the message in a case-sensitive manner. If the message is active
4008 (in the middle of a delivery attempt), its status is not altered. This option
4009 can be used only by an admin user.
4010
4011 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4012 .cindex "removing messages"
4013 .cindex "abandoning mail"
4014 .cindex "message" "manually discarding"
4015 This option requests Exim to remove the given messages from the queue. No
4016 bounce messages are sent; each message is simply forgotten. However, if any of
4017 the messages are active, their status is not altered. This option can be used
4018 only by an admin user or by the user who originally caused the message to be
4019 placed in the queue.
4020
4021 . .new
4022 . .vitem &%-MS%&
4023 . .oindex "&%-MS%&"
4024 . .cindex REQUIRETLS
4025 . This option is used to request REQUIRETLS processing on the message.
4026 . It is used internally by Exim in conjunction with -E when generating
4027 . a bounce message.
4028 . .wen
4029
4030 .cmdopt -Mset <&'message&~id'&>
4031 .cindex "testing" "string expansion"
4032 .cindex "expansion" "testing"
4033 This option is useful only in conjunction with &%-be%& (that is, when testing
4034 string expansions). Exim loads the given message from its spool before doing
4035 the test expansions, thus setting message-specific variables such as
4036 &$message_size$& and the header variables. The &$recipients$& variable is made
4037 available. This feature is provided to make it easier to test expansions that
4038 make use of these variables. However, this option can be used only by an admin
4039 user. See also &%-bem%&.
4040
4041 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4042 .cindex "thawing messages"
4043 .cindex "unfreezing messages"
4044 .cindex "frozen messages" "thawing"
4045 .cindex "message" "thawing frozen"
4046 This option requests Exim to &"thaw"& any of the listed messages that are
4047 &"frozen"&, so that delivery attempts can resume. However, if any of the
4048 messages are active, their status is not altered. This option can be used only
4049 by an admin user.
4050
4051 .cmdopt -Mvb <&'message&~id'&>
4052 .cindex "listing" "message body"
4053 .cindex "message" "listing body of"
4054 This option causes the contents of the message body (-D) spool file to be
4055 written to the standard output. This option can be used only by an admin user.
4056
4057 .cmdopt -Mvc <&'message&~id'&>
4058 .cindex "message" "listing in RFC 2822 format"
4059 .cindex "listing" "message in RFC 2822 format"
4060 This option causes a copy of the complete message (header lines plus body) to
4061 be written to the standard output in RFC 2822 format. This option can be used
4062 only by an admin user.
4063
4064 .cmdopt -Mvh <&'message&~id'&>
4065 .cindex "listing" "message headers"
4066 .cindex "header lines" "listing"
4067 .cindex "message" "listing header lines"
4068 This option causes the contents of the message headers (-H) spool file to be
4069 written to the standard output. This option can be used only by an admin user.
4070
4071 .cmdopt -Mvl <&'message&~id'&>
4072 .cindex "listing" "message log"
4073 .cindex "message" "listing message log"
4074 This option causes the contents of the message log spool file to be written to
4075 the standard output. This option can be used only by an admin user.
4076
4077 .cmdopt -m
4078 This is a synonym for &%-om%& that is accepted by Sendmail
4079 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4080 p. 1M-258), so Exim treats it that way too.
4081
4082 .cmdopt -N
4083 .cindex "debugging" "&%-N%& option"
4084 .cindex "debugging" "suppressing delivery"
4085 This is a debugging option that inhibits delivery of a message at the transport
4086 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4087 it just doesn't actually transport the message, but instead behaves as if it
4088 had successfully done so. However, it does not make any updates to the retry
4089 database, and the log entries for deliveries are flagged with &"*>"& rather
4090 than &"=>"&.
4091
4092 Because &%-N%& discards any message to which it applies, only root or the Exim
4093 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4094 words, an ordinary user can use it only when supplying an incoming message to
4095 which it will apply. Although transportation never fails when &%-N%& is set, an
4096 address may be deferred because of a configuration problem on a transport, or a
4097 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4098 the message, and applies to any subsequent delivery attempts that may happen
4099 for that message.
4100
4101 .cmdopt -n
4102 This option is interpreted by Sendmail to mean &"no aliasing"&.
4103 For normal modes of operation, it is ignored by Exim.
4104 When combined with &%-bP%& it makes the output more terse (suppresses
4105 option names, environment values and config pretty printing).
4106
4107 .cmdopt -O <&'data'&>
4108 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4109 Exim.
4110
4111 .cmdopt -oA <&'file&~name'&>
4112 .cindex "Sendmail compatibility" "&%-oA%& option"
4113 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4114 alternative alias filename. Exim handles &%-bi%& differently; see the
4115 description above.
4116
4117 .cmdopt -oB <&'n'&>
4118 .cindex "SMTP" "passed connection"
4119 .cindex "SMTP" "multiple deliveries"
4120 .cindex "multiple SMTP deliveries"
4121 This is a debugging option which limits the maximum number of messages that can
4122 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4123 transport. If <&'n'&> is omitted, the limit is set to 1.
4124
4125 .cmdopt -odb
4126 .cindex "background delivery"
4127 .cindex "delivery" "in the background"
4128 This option applies to all modes in which Exim accepts incoming messages,
4129 including the listening daemon. It requests &"background"& delivery of such
4130 messages, which means that the accepting process automatically starts a
4131 delivery process for each message received, but does not wait for the delivery
4132 processes to finish.
4133
4134 When all the messages have been received, the reception process exits,
4135 leaving the delivery processes to finish in their own time. The standard output
4136 and error streams are closed at the start of each delivery process.
4137 This is the default action if none of the &%-od%& options are present.
4138
4139 If one of the queueing options in the configuration file
4140 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4141 overrides it if &%queue_only_override%& is set true, which is the default
4142 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4143
4144 .cmdopt -odf
4145 .cindex "foreground delivery"
4146 .cindex "delivery" "in the foreground"
4147 This option requests &"foreground"& (synchronous) delivery when Exim has
4148 accepted a locally-generated message. (For the daemon it is exactly the same as
4149 &%-odb%&.) A delivery process is automatically started to deliver the message,
4150 and Exim waits for it to complete before proceeding.
4151
4152 The original Exim reception process does not finish until the delivery
4153 process for the final message has ended. The standard error stream is left open
4154 during deliveries.
4155
4156 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4157 false and one of the queueing options in the configuration file is in effect.
4158
4159 If there is a temporary delivery error during foreground delivery, the
4160 message is left in the queue for later delivery, and the original reception
4161 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4162 restricted configuration that never queues messages.
4163
4164
4165 .cmdopt -odi
4166 This option is synonymous with &%-odf%&. It is provided for compatibility with
4167 Sendmail.
4168
4169 .cmdopt -odq
4170 .cindex "non-immediate delivery"
4171 .cindex "delivery" "suppressing immediate"
4172 .cindex "queueing incoming messages"
4173 This option applies to all modes in which Exim accepts incoming messages,
4174 including the listening daemon. It specifies that the accepting process should
4175 not automatically start a delivery process for each message received. Messages
4176 are placed in the queue, and remain there until a subsequent queue runner
4177 process encounters them. There are several configuration options (such as
4178 &%queue_only%&) that can be used to queue incoming messages under certain
4179 conditions. This option overrides all of them and also &%-odqs%&. It always
4180 forces queueing.
4181
4182 .cmdopt -odqs
4183 .cindex "SMTP" "delaying delivery"
4184 .cindex "first pass routing"
4185 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4186 However, like &%-odb%& and &%-odi%&, this option has no effect if
4187 &%queue_only_override%& is false and one of the queueing options in the
4188 configuration file is in effect.
4189
4190 When &%-odqs%& does operate, a delivery process is started for each incoming
4191 message, in the background by default, but in the foreground if &%-odi%& is
4192 also present. The recipient addresses are routed, and local deliveries are done
4193 in the normal way. However, if any SMTP deliveries are required, they are not
4194 done at this time, so the message remains in the queue until a subsequent queue
4195 runner process encounters it. Because routing was done, Exim knows which
4196 messages are waiting for which hosts, and so a number of messages for the same
4197 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4198 configuration option has the same effect for specific domains. See also the
4199 &%-qq%& option.
4200
4201 .cmdopt -oee
4202 .cindex "error" "reporting"
4203 If an error is detected while a non-SMTP message is being received (for
4204 example, a malformed address), the error is reported to the sender in a mail
4205 message.
4206
4207 .cindex "return code" "for &%-oee%&"
4208 Provided
4209 this error message is successfully sent, the Exim receiving process
4210 exits with a return code of zero. If not, the return code is 2 if the problem
4211 is that the original message has no recipients, or 1 for any other error.
4212 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4213
4214 .cmdopt -oem
4215 .cindex "error" "reporting"
4216 .cindex "return code" "for &%-oem%&"
4217 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4218 return code, whether or not the error message was successfully sent.
4219 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4220
4221 .cmdopt -oep
4222 .cindex "error" "reporting"
4223 If an error is detected while a non-SMTP message is being received, the
4224 error is reported by writing a message to the standard error file (stderr).
4225 .cindex "return code" "for &%-oep%&"
4226 The return code is 1 for all errors.
4227
4228 .cmdopt -oeq
4229 .cindex "error" "reporting"
4230 This option is supported for compatibility with Sendmail, but has the same
4231 effect as &%-oep%&.
4232
4233 .cmdopt -oew
4234 .cindex "error" "reporting"
4235 This option is supported for compatibility with Sendmail, but has the same
4236 effect as &%-oem%&.
4237
4238 .cmdopt -oi
4239 .cindex "dot" "in incoming non-SMTP message"
4240 This option, which has the same effect as &%-i%&, specifies that a dot on a
4241 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4242 single dot does terminate, though Exim does no special processing for other
4243 lines that start with a dot. This option is set by default if Exim is called as
4244 &'rmail'&. See also &%-ti%&.
4245
4246 .cmdopt -oitrue
4247 This option is treated as synonymous with &%-oi%&.
4248
4249 .cmdopt -oMa <&'host&~address'&>
4250 .cindex "sender" "host address, specifying for local message"
4251 A number of options starting with &%-oM%& can be used to set values associated
4252 with remote hosts on locally-submitted messages (that is, messages not received
4253 over TCP/IP). These options can be used by any caller in conjunction with the
4254 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4255 other circumstances, they are ignored unless the caller is trusted.
4256
4257 The &%-oMa%& option sets the sender host address. This may include a port
4258 number at the end, after a full stop (period). For example:
4259 .code
4260 exim -bs -oMa 10.9.8.7.1234
4261 .endd
4262 An alternative syntax is to enclose the IP address in square brackets,
4263 followed by a colon and the port number:
4264 .code
4265 exim -bs -oMa [10.9.8.7]:1234
4266 .endd
4267 The IP address is placed in the &$sender_host_address$& variable, and the
4268 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4269 are present on the command line, the sender host IP address is taken from
4270 whichever one is last.
4271
4272 .cmdopt -oMaa <&'name'&>
4273 .cindex "authentication" "name, specifying for local message"
4274 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4275 option sets the value of &$sender_host_authenticated$& (the authenticator
4276 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4277 This option can be used with &%-bh%& and &%-bs%& to set up an
4278 authenticated SMTP session without actually using the SMTP AUTH command.
4279
4280 .cmdopt -oMai <&'string'&>
4281 .cindex "authentication" "id, specifying for local message"
4282 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4283 option sets the value of &$authenticated_id$& (the id that was authenticated).
4284 This overrides the default value (the caller's login id, except with &%-bh%&,
4285 where there is no default) for messages from local sources. See chapter
4286 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4287
4288 .cmdopt -oMas <&'address'&>
4289 .cindex "authentication" "sender, specifying for local message"
4290 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4291 option sets the authenticated sender value in &$authenticated_sender$&. It
4292 overrides the sender address that is created from the caller's login id for
4293 messages from local sources, except when &%-bh%& is used, when there is no
4294 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4295 specified on a MAIL command overrides this value. See chapter
4296 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4297
4298 .cmdopt -oMi <&'interface&~address'&>
4299 .cindex "interface" "address, specifying for local message"
4300 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4301 option sets the IP interface address value. A port number may be included,
4302 using the same syntax as for &%-oMa%&. The interface address is placed in
4303 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4304
4305 .cmdopt -oMm <&'message&~reference'&>
4306 .cindex "message reference" "message reference, specifying for local message"
4307 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4308 option sets the message reference, e.g. message-id, and is logged during
4309 delivery. This is useful when some kind of audit trail is required to tie
4310 messages together. The format of the message reference is checked and will
4311 abort if the format is invalid. The option will only be accepted if exim is
4312 running in trusted mode, not as any regular user.
4313
4314 The best example of a message reference is when Exim sends a bounce message.
4315 The message reference is the message-id of the original message for which Exim
4316 is sending the bounce.
4317
4318 .cmdopt -oMr <&'protocol&~name'&>
4319 .cindex "protocol, specifying for local message"
4320 .vindex "&$received_protocol$&"
4321 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4322 option sets the received protocol value that is stored in
4323 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4324 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4325 SMTP protocol names (see the description of &$received_protocol$& in section
4326 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4327 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4328 be set by &%-oMr%&. Repeated use of this option is not supported.
4329
4330 .cmdopt -oMs <&'host&~name'&>
4331 .cindex "sender" "host name, specifying for local message"
4332 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4333 option sets the sender host name in &$sender_host_name$&. When this option is
4334 present, Exim does not attempt to look up a host name from an IP address; it
4335 uses the name it is given.
4336
4337 .cmdopt -oMt <&'ident&~string'&>
4338 .cindex "sender" "ident string, specifying for local message"
4339 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4340 option sets the sender ident value in &$sender_ident$&. The default setting for
4341 local callers is the login id of the calling process, except when &%-bh%& is
4342 used, when there is no default.
4343
4344 .cmdopt -om
4345 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4346 In Sendmail, this option means &"me too"&, indicating that the sender of a
4347 message should receive a copy of the message if the sender appears in an alias
4348 expansion. Exim always does this, so the option does nothing.
4349
4350 .cmdopt -oo
4351 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4352 This option is ignored. In Sendmail it specifies &"old style headers"&,
4353 whatever that means.
4354
4355 .cmdopt -oP <&'path'&>
4356 .cindex "pid (process id)" "of daemon"
4357 .cindex "daemon" "process id (pid)"
4358 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4359 value. The option specifies the file to which the process id of the daemon is
4360 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4361 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4362 because in those cases, the normal pid file is not used.
4363
4364 .cmdopt -oPX
4365 .cindex "pid (process id)" "of daemon"
4366 .cindex "daemon" "process id (pid)"
4367 This option is not intended for general use.
4368 The daemon uses it when terminating due to a SIGTEM, possibly in
4369 combination with &%-oP%&&~<&'path'&>.
4370 It causes the pid file to be removed.
4371
4372 .cmdopt -or <&'time'&>
4373 .cindex "timeout" "for non-SMTP input"
4374 This option sets a timeout value for incoming non-SMTP messages. If it is not
4375 set, Exim will wait forever for the standard input. The value can also be set
4376 by the &%receive_timeout%& option. The format used for specifying times is
4377 described in section &<<SECTtimeformat>>&.
4378
4379 .cmdopt -os <&'time'&>
4380 .cindex "timeout" "for SMTP input"
4381 .cindex "SMTP" "input timeout"
4382 This option sets a timeout value for incoming SMTP messages. The timeout
4383 applies to each SMTP command and block of data. The value can also be set by
4384 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4385 for specifying times is described in section &<<SECTtimeformat>>&.
4386
4387 .cmdopt -ov
4388 This option has exactly the same effect as &%-v%&.
4389
4390 .cmdopt -oX <&'number&~or&~string'&>
4391 .cindex "TCP/IP" "setting listening ports"
4392 .cindex "TCP/IP" "setting listening interfaces"
4393 .cindex "port" "receiving TCP/IP"
4394 This option is relevant only when the &%-bd%& (start listening daemon) option
4395 is also given. It controls which ports and interfaces the daemon uses. Details
4396 of the syntax, and how it interacts with configuration file options, are given
4397 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4398 file is written unless &%-oP%& is also present to specify a pid filename.
4399
4400 .cmdopt -oY
4401 .cindex "daemon notifier socket"
4402 This option controls the creation of an inter-process communications endpoint
4403 by the Exim daemon.
4404 It is only relevant when the &%-bd%& (start listening daemon) option is also
4405 given.
4406 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4407 option is also present.
4408 .new
4409 If this option is given then the socket will not be created.  This is required
4410 if the system is running multiple daemons, in which case it should
4411 be used on all.
4412 The features supported by the socket will not be available in such cases.
4413
4414 The socket is currently used for
4415 .ilist
4416 fast ramp-up of queue runner processes
4417 .next
4418 caching compiled regexes
4419 .next
4420 obtaining a current queue size
4421 .endlist
4422 .wen
4423
4424 .cmdopt -pd
4425 .cindex "Perl" "starting the interpreter"
4426 This option applies when an embedded Perl interpreter is linked with Exim (see
4427 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4428 option, forcing the starting of the interpreter to be delayed until it is
4429 needed.
4430
4431 .cmdopt -ps
4432 .cindex "Perl" "starting the interpreter"
4433 This option applies when an embedded Perl interpreter is linked with Exim (see
4434 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4435 option, forcing the starting of the interpreter to occur as soon as Exim is
4436 started.
4437
4438 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4439 .oindex "&%-p%&"
4440 For compatibility with Sendmail, this option is equivalent to
4441 .display
4442 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4443 .endd
4444 It sets the incoming protocol and host name (for trusted callers). The
4445 host name and its colon can be omitted when only the protocol is to be set.
4446 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4447 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4448 or &`s`& using this option (but that does not seem a real limitation).
4449 Repeated use of this option is not supported.
4450
4451 .cmdopt -q
4452 .cindex "queue runner" "starting manually"
4453 This option is normally restricted to admin users. However, there is a
4454 configuration option called &%prod_requires_admin%& which can be set false to
4455 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4456 and &%-S%& options).
4457
4458 .cindex "queue runner" "description of operation"
4459 If other commandline options do not specify an action,
4460 the &%-q%& option starts one queue runner process. This scans the queue of
4461 waiting messages, and runs a delivery process for each one in turn. It waits
4462 for each delivery process to finish before starting the next one. A delivery
4463 process may not actually do any deliveries if the retry times for the addresses
4464 have not been reached. Use &%-qf%& (see below) if you want to override this.
4465
4466 If
4467 .cindex "SMTP" "passed connection"
4468 .cindex "SMTP" "multiple deliveries"
4469 .cindex "multiple SMTP deliveries"
4470 the delivery process spawns other processes to deliver other messages down
4471 passed SMTP connections, the queue runner waits for these to finish before
4472 proceeding.
4473
4474 When all the queued messages have been considered, the original queue runner
4475 process terminates. In other words, a single pass is made over the waiting
4476 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4477 this to be repeated periodically.
4478
4479 Exim processes the waiting messages in an unpredictable order. It isn't very
4480 random, but it is likely to be different each time, which is all that matters.
4481 If one particular message screws up a remote MTA, other messages to the same
4482 MTA have a chance of getting through if they get tried first.
4483
4484 It is possible to cause the messages to be processed in lexical message id
4485 order, which is essentially the order in which they arrived, by setting the
4486 &%queue_run_in_order%& option, but this is not recommended for normal use.
4487
4488 .vitem &%-q%&<&'qflags'&>
4489 The &%-q%& option may be followed by one or more flag letters that change its
4490 behaviour. They are all optional, but if more than one is present, they must
4491 appear in the correct order. Each flag is described in a separate item below.
4492
4493 .vitem &%-qq...%&
4494 .oindex "&%-qq%&"
4495 .cindex "queue" "double scanning"
4496 .cindex "queue" "routing"
4497 .cindex "routing" "whole queue before delivery"
4498 .cindex "first pass routing"
4499 .cindex "queue runner" "two phase"
4500 An option starting with &%-qq%& requests a two-stage queue run. In the first
4501 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4502 every domain. Addresses are routed, local deliveries happen, but no remote
4503 transports are run.
4504
4505 Performance will be best if the &%queue_run_in_order%& option is false.
4506 If that is so and
4507 the &%queue_fast_ramp%& option is true
4508 and a daemon-notifier socket is available
4509 then in the first phase of the run,
4510 once a threshold number of messages are routed for a given host,
4511 a delivery process is forked in parallel with the rest of the scan.
4512
4513 .cindex "hints database" "remembering routing"
4514 The hints database that remembers which messages are waiting for specific hosts
4515 is updated, as if delivery to those hosts had been deferred.
4516
4517 After the first queue scan complete,
4518 a second, normal queue scan is done, with routing and delivery taking
4519 place as normal.
4520 Messages that are routed to the same host should mostly be
4521 delivered down a single SMTP
4522 .cindex "SMTP" "passed connection"
4523 .cindex "SMTP" "multiple deliveries"
4524 .cindex "multiple SMTP deliveries"
4525 connection because of the hints that were set up during the first queue scan.
4526
4527 .new
4528 Two-phase queue runs should be used on systems which, even intermittently,
4529 have a large queue (such as mailing-list operators).
4530 They may also be useful for hosts that are connected to the Internet
4531 intermittently.
4532 .wen
4533
4534 .vitem &%-q[q]i...%&
4535 .oindex "&%-qi%&"
4536 .cindex "queue" "initial delivery"
4537 If the &'i'& flag is present, the queue runner runs delivery processes only for
4538 those messages that haven't previously been tried. (&'i'& stands for &"initial
4539 delivery"&.) This can be helpful if you are putting messages in the queue using
4540 &%-odq%& and want a queue runner just to process the new messages.
4541
4542 .vitem &%-q[q][i]f...%&
4543 .oindex "&%-qf%&"
4544 .cindex "queue" "forcing delivery"
4545 .cindex "delivery" "forcing in queue run"
4546 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4547 message, whereas without &'f'& only those non-frozen addresses that have passed
4548 their retry times are tried.
4549
4550 .vitem &%-q[q][i]ff...%&
4551 .oindex "&%-qff%&"
4552 .cindex "frozen messages" "forcing delivery"
4553 If &'ff'& is present, a delivery attempt is forced for every message, whether
4554 frozen or not.
4555
4556 .vitem &%-q[q][i][f[f]]l%&
4557 .oindex "&%-ql%&"
4558 .cindex "queue" "local deliveries only"
4559 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4560 be done. If a message requires any remote deliveries, it remains in the queue
4561 for later delivery.
4562
4563 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4564 .oindex "&%-qG%&"
4565 .cindex queue named
4566 .cindex "named queues"  "deliver from"
4567 .cindex "queue" "delivering specific messages"
4568 If the &'G'& flag and a name is present, the queue runner operates on the
4569 queue with the given name rather than the default queue.
4570 The name should not contain a &'/'& character.
4571 For a periodic queue run (see below)
4572 append to the name a slash and a time value.
4573
4574 If other commandline options specify an action, a &'-qG<name>'& option
4575 will specify a queue to operate on.
4576 For example:
4577 .code
4578 exim -bp -qGquarantine
4579 mailq -qGquarantine
4580 exim -qGoffpeak -Rf @special.domain.example
4581 .endd
4582
4583 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4584 When scanning the queue, Exim can be made to skip over messages whose ids are
4585 lexically less than a given value by following the &%-q%& option with a
4586 starting message id. For example:
4587 .code
4588 exim -q 0t5C6f-0000c8-00
4589 .endd
4590 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4591 second message id is given, messages whose ids are lexically greater than it
4592 are also skipped. If the same id is given twice, for example,
4593 .code
4594 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4595 .endd
4596 just one delivery process is started, for that message. This differs from
4597 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4598 that it counts as a delivery from a queue run. Note that the selection
4599 mechanism does not affect the order in which the messages are scanned. There
4600 are also other ways of selecting specific sets of messages for delivery in a
4601 queue run &-- see &%-R%& and &%-S%&.
4602
4603 .vitem &%-q%&<&'qflags'&><&'time'&>
4604 .cindex "queue runner" "starting periodically"
4605 .cindex "periodic queue running"
4606 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4607 starting a queue runner process at intervals specified by the given time value
4608 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4609 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4610 single daemon process handles both functions. A common way of starting up a
4611 combined daemon at system boot time is to use a command such as
4612 .code
4613 /usr/exim/bin/exim -bd -q30m
4614 .endd
4615 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4616 process every 30 minutes.
4617
4618 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4619 pid file is written unless one is explicitly requested by the &%-oP%& option.
4620
4621 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4622 .oindex "&%-qR%&"
4623 This option is synonymous with &%-R%&. It is provided for Sendmail
4624 compatibility.
4625
4626 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4627 .oindex "&%-qS%&"
4628 This option is synonymous with &%-S%&.
4629
4630 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4631 .oindex "&%-R%&"
4632 .cindex "queue runner" "for specific recipients"
4633 .cindex "delivery" "to given domain"
4634 .cindex "domain" "delivery to"
4635 The <&'rsflags'&> may be empty, in which case the white space before the string
4636 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4637 which are the possible values for <&'rsflags'&>. White space is required if
4638 <&'rsflags'&> is not empty.
4639
4640 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4641 perform a single queue run, except that, when scanning the messages on the
4642 queue, Exim processes only those that have at least one undelivered recipient
4643 address containing the given string, which is checked in a case-independent
4644 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4645 regular expression; otherwise it is a literal string.
4646
4647 If you want to do periodic queue runs for messages with specific recipients,
4648 you can combine &%-R%& with &%-q%& and a time value. For example:
4649 .code
4650 exim -q25m -R @special.domain.example
4651 .endd
4652 This example does a queue run for messages with recipients in the given domain
4653 every 25 minutes. Any additional flags that are specified with &%-q%& are
4654 applied to each queue run.
4655
4656 Once a message is selected for delivery by this mechanism, all its addresses
4657 are processed. For the first selected message, Exim overrides any retry
4658 information and forces a delivery attempt for each undelivered address. This
4659 means that if delivery of any address in the first message is successful, any
4660 existing retry information is deleted, and so delivery attempts for that
4661 address in subsequently selected messages (which are processed without forcing)
4662 will run. However, if delivery of any address does not succeed, the retry
4663 information is updated, and in subsequently selected messages, the failing
4664 address will be skipped.
4665
4666 .cindex "frozen messages" "forcing delivery"
4667 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4668 all selected messages, not just the first; frozen messages are included when
4669 &'ff'& is present.
4670
4671 The &%-R%& option makes it straightforward to initiate delivery of all messages
4672 to a given domain after a host has been down for some time. When the SMTP
4673 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4674 effect is to run Exim with the &%-R%& option, but it can be configured to run
4675 an arbitrary command instead.
4676
4677 .cmdopt -r
4678 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4679
4680 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4681 .oindex "&%-S%&"
4682 .cindex "delivery" "from given sender"
4683 .cindex "queue runner" "for specific senders"
4684 This option acts like &%-R%& except that it checks the string against each
4685 message's sender instead of against the recipients. If &%-R%& is also set, both
4686 conditions must be met for a message to be selected. If either of the options
4687 has &'f'& or &'ff'& in its flags, the associated action is taken.
4688
4689 .cmdopt -Tqt <&'times'&>
4690 This is an option that is exclusively for use by the Exim testing suite. It is not
4691 recognized when Exim is run normally. It allows for the setting up of explicit
4692 &"queue times"& so that various warning/retry features can be tested.
4693
4694 .cmdopt -t
4695 .cindex "recipient" "extracting from header lines"
4696 .chindex Bcc:
4697 .chindex Cc:
4698 .chindex To:
4699 When Exim is receiving a locally-generated, non-SMTP message on its standard
4700 input, the &%-t%& option causes the recipients of the message to be obtained
4701 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4702 from the command arguments. The addresses are extracted before any rewriting
4703 takes place and the &'Bcc:'& header line, if present, is then removed.
4704
4705 .cindex "Sendmail compatibility" "&%-t%& option"
4706 If the command has any arguments, they specify addresses to which the message
4707 is &'not'& to be delivered. That is, the argument addresses are removed from
4708 the recipients list obtained from the headers. This is compatible with Smail 3
4709 and in accordance with the documented behaviour of several versions of
4710 Sendmail, as described in man pages on a number of operating systems (e.g.
4711 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4712 argument addresses to those obtained from the headers, and the O'Reilly
4713 Sendmail book documents it that way. Exim can be made to add argument addresses
4714 instead of subtracting them by setting the option
4715 &%extract_addresses_remove_arguments%& false.
4716
4717 .cindex "&%Resent-%& header lines" "with &%-t%&"
4718 If there are any &%Resent-%& header lines in the message, Exim extracts
4719 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4720 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4721 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4722 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4723
4724 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4725 message is resent several times). The RFC also specifies that they should be
4726 added at the front of the message, and separated by &'Received:'& lines. It is
4727 not at all clear how &%-t%& should operate in the present of multiple sets,
4728 nor indeed exactly what constitutes a &"set"&.
4729 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4730 are often added at the end of the header, and if a message is resent more than
4731 once, it is common for the original set of &%Resent-%& headers to be renamed as
4732 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4733
4734 .cmdopt -ti
4735 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4736 compatibility with Sendmail.
4737
4738 .cmdopt -tls-on-connect
4739 .cindex "TLS" "use without STARTTLS"
4740 .cindex "TLS" "automatic start"
4741 This option is available when Exim is compiled with TLS support. It forces all
4742 incoming SMTP connections to behave as if the incoming port is listed in the
4743 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4744 &<<CHAPTLS>>& for further details.
4745
4746
4747 .cmdopt -U
4748 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4749 Sendmail uses this option for &"initial message submission"&, and its
4750 documentation states that in future releases, it may complain about
4751 syntactically invalid messages rather than fixing them when this flag is not
4752 set. Exim ignores this option.
4753
4754 .cmdopt -v
4755 This option causes Exim to write information to the standard error stream,
4756 describing what it is doing. In particular, it shows the log lines for
4757 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4758 dialogue is shown. Some of the log lines shown may not actually be written to
4759 the log if the setting of &%log_selector%& discards them. Any relevant
4760 selectors are shown with each log line. If none are shown, the logging is
4761 unconditional.
4762
4763 .cmdopt -x
4764 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4765 National Language Support extended characters in the body of the mail item"&).
4766 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4767 this option.
4768
4769 .cmdopt -X <&'logfile'&>
4770 This option is interpreted by Sendmail to cause debug information to be sent
4771 to the named file.  It is ignored by Exim.
4772
4773 .cmdopt -z <&'log-line'&>
4774 This option writes its argument to Exim's logfile.
4775 Use is restricted to administrators; the intent is for operational notes.
4776 Quotes should be used to maintain a multi-word item as a single argument,
4777 under most shells.
4778 .endlist
4779
4780 .ecindex IIDclo1
4781 .ecindex IIDclo2
4782
4783
4784 . ////////////////////////////////////////////////////////////////////////////
4785 . Insert a stylized DocBook comment here, to identify the end of the command
4786 . line options. This is for the benefit of the Perl script that automatically
4787 . creates a man page for the options.
4788 . ////////////////////////////////////////////////////////////////////////////
4789
4790 .literal xml
4791 <!-- === End of command line options === -->
4792 .literal off
4793
4794
4795
4796
4797
4798 . ////////////////////////////////////////////////////////////////////////////
4799 . ////////////////////////////////////////////////////////////////////////////
4800
4801
4802 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4803          "The runtime configuration file"
4804
4805 .cindex "runtime configuration"
4806 .cindex "configuration file" "general description"
4807 .cindex "CONFIGURE_FILE"
4808 .cindex "configuration file" "errors in"
4809 .cindex "error" "in configuration file"
4810 .cindex "return code" "for bad configuration"
4811 Exim uses a single runtime configuration file that is read whenever an Exim
4812 binary is executed. Note that in normal operation, this happens frequently,
4813 because Exim is designed to operate in a distributed manner, without central
4814 control.
4815
4816 If a syntax error is detected while reading the configuration file, Exim
4817 writes a message on the standard error, and exits with a non-zero return code.
4818 The message is also written to the panic log. &*Note*&: Only simple syntax
4819 errors can be detected at this time. The values of any expanded options are
4820 not checked until the expansion happens, even when the expansion does not
4821 actually alter the string.
4822
4823 The name of the configuration file is compiled into the binary for security
4824 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4825 most configurations, this specifies a single file. However, it is permitted to
4826 give a colon-separated list of filenames, in which case Exim uses the first
4827 existing file in the list.
4828
4829 .cindex "EXIM_USER"
4830 .cindex "EXIM_GROUP"
4831 .cindex "CONFIGURE_OWNER"
4832 .cindex "CONFIGURE_GROUP"
4833 .cindex "configuration file" "ownership"
4834 .cindex "ownership" "configuration file"
4835 The runtime configuration file must be owned by root or by the user that is
4836 specified at compile time by the CONFIGURE_OWNER option (if set). The
4837 configuration file must not be world-writeable, or group-writeable unless its
4838 group is the root group or the one specified at compile time by the
4839 CONFIGURE_GROUP option.
4840
4841 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4842 to root, anybody who is able to edit the runtime configuration file has an
4843 easy way to run commands as root. If you specify a user or group in the
4844 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4845 who are members of that group will trivially be able to obtain root privileges.
4846
4847 Up to Exim version 4.72, the runtime configuration file was also permitted to
4848 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4849 since it offered a simple privilege escalation for any attacker who managed to
4850 compromise the Exim user account.
4851
4852 A default configuration file, which will work correctly in simple situations,
4853 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4854 defines just one filename, the installation process copies the default
4855 configuration to a new file of that name if it did not previously exist. If
4856 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4857 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4858 configuration.
4859
4860
4861
4862 .section "Using a different configuration file" "SECID40"
4863 .cindex "configuration file" "alternate"
4864 A one-off alternate configuration can be specified by the &%-C%& command line
4865 option, which may specify a single file or a list of files. However, when
4866 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4867 unless the argument for &%-C%& is identical to the built-in value from
4868 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4869 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4870 is useful mainly for checking the syntax of configuration files before
4871 installing them. No owner or group checks are done on a configuration file
4872 specified by &%-C%&, if root privilege has been dropped.
4873
4874 Even the Exim user is not trusted to specify an arbitrary configuration file
4875 with the &%-C%& option to be used with root privileges, unless that file is
4876 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4877 testing a configuration using &%-C%& right through message reception and
4878 delivery, even if the caller is root. The reception works, but by that time,
4879 Exim is running as the Exim user, so when it re-execs to regain privilege for
4880 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4881 can test reception and delivery using two separate commands (one to put a
4882 message in the queue, using &%-odq%&, and another to do the delivery, using
4883 &%-M%&).
4884
4885 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4886 prefix string with which any file named in a &%-C%& command line option must
4887 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4888 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4889 filename can be used with &%-C%&.
4890
4891 One-off changes to a configuration can be specified by the &%-D%& command line
4892 option, which defines and overrides values for macros used inside the
4893 configuration file. However, like &%-C%&, the use of this option by a
4894 non-privileged user causes Exim to discard its root privilege.
4895 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4896 completely disabled, and its use causes an immediate error exit.
4897
4898 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4899 to declare certain macro names trusted, such that root privilege will not
4900 necessarily be discarded.
4901 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4902 considered safe and, if &%-D%& only supplies macros from this list, and the
4903 values are acceptable, then Exim will not give up root privilege if the caller
4904 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4905 transition mechanism and is expected to be removed in the future.  Acceptable
4906 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4907
4908 Some sites may wish to use the same Exim binary on different machines that
4909 share a file system, but to use different configuration files on each machine.
4910 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4911 looks for a file whose name is the configuration filename followed by a dot
4912 and the machine's node name, as obtained from the &[uname()]& function. If this
4913 file does not exist, the standard name is tried. This processing occurs for
4914 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4915
4916 In some esoteric situations different versions of Exim may be run under
4917 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4918 help with this. See the comments in &_src/EDITME_& for details.
4919
4920
4921
4922 .section "Configuration file format" "SECTconffilfor"
4923 .cindex "configuration file" "format of"
4924 .cindex "format" "configuration file"
4925 Exim's configuration file is divided into a number of different parts. General
4926 option settings must always appear at the start of the file. The other parts
4927 are all optional, and may appear in any order. Each part other than the first
4928 is introduced by the word &"begin"& followed by at least one literal
4929 space, and the name of the part. The optional parts are:
4930
4931 .ilist
4932 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4933 &<<CHAPACL>>&).
4934 .next
4935 .cindex "AUTH" "configuration"
4936 &'authenticators'&: Configuration settings for the authenticator drivers. These
4937 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4938 .next
4939 &'routers'&: Configuration settings for the router drivers. Routers process
4940 addresses and determine how the message is to be delivered (see chapters
4941 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4942 .next
4943 &'transports'&: Configuration settings for the transport drivers. Transports
4944 define mechanisms for copying messages to destinations (see chapters
4945 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4946 .next
4947 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4948 If there is no retry section, or if it is empty (that is, no retry rules are
4949 defined), Exim will not retry deliveries. In this situation, temporary errors
4950 are treated the same as permanent errors. Retry rules are discussed in chapter
4951 &<<CHAPretry>>&.
4952 .next
4953 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4954 when new addresses are generated during delivery. Rewriting is discussed in
4955 chapter &<<CHAPrewrite>>&.
4956 .next
4957 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4958 want to use this feature, you must set
4959 .code
4960 LOCAL_SCAN_HAS_OPTIONS=yes
4961 .endd
4962 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4963 facility are given in chapter &<<CHAPlocalscan>>&.
4964 .endlist
4965
4966 .cindex "configuration file" "leading white space in"
4967 .cindex "configuration file" "trailing white space in"
4968 .cindex "white space" "in configuration file"
4969 Leading and trailing white space in configuration lines is always ignored.
4970
4971 Blank lines in the file, and lines starting with a # character (ignoring
4972 leading white space) are treated as comments and are ignored. &*Note*&: A
4973 # character other than at the beginning of a line is not treated specially,
4974 and does not introduce a comment.
4975
4976 Any non-comment line can be continued by ending it with a backslash. Note that
4977 the general rule for white space means that trailing white space after the
4978 backslash and leading white space at the start of continuation
4979 lines is ignored. Comment lines beginning with # (but not empty lines) may
4980 appear in the middle of a sequence of continuation lines.
4981
4982 A convenient way to create a configuration file is to start from the
4983 default, which is supplied in &_src/configure.default_&, and add, delete, or
4984 change settings as required.
4985
4986 The ACLs, retry rules, and rewriting rules have their own syntax which is
4987 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4988 respectively. The other parts of the configuration file have some syntactic
4989 items in common, and these are described below, from section &<<SECTcos>>&
4990 onwards. Before that, the inclusion, macro, and conditional facilities are
4991 described.
4992
4993
4994
4995 .section "File inclusions in the configuration file" "SECID41"
4996 .cindex "inclusions in configuration file"
4997 .cindex "configuration file" "including other files"
4998 .cindex "&`.include`& in configuration file"
4999 .cindex "&`.include_if_exists`& in configuration file"
5000 You can include other files inside Exim's runtime configuration file by
5001 using this syntax:
5002 .display
5003 &`.include`& <&'filename'&>
5004 &`.include_if_exists`& <&'filename'&>
5005 .endd
5006 on a line by itself. Double quotes round the filename are optional. If you use
5007 the first form, a configuration error occurs if the file does not exist; the
5008 second form does nothing for non-existent files.
5009 The first form allows a relative name. It is resolved relative to
5010 the directory of the including file. For the second form an absolute filename
5011 is required.
5012
5013 Includes may be nested to any depth, but remember that Exim reads its
5014 configuration file often, so it is a good idea to keep them to a minimum.
5015 If you change the contents of an included file, you must HUP the daemon,
5016 because an included file is read only when the configuration itself is read.
5017
5018 The processing of inclusions happens early, at a physical line level, so, like
5019 comment lines, an inclusion can be used in the middle of an option setting,
5020 for example:
5021 .code
5022 hosts_lookup = a.b.c \
5023                .include /some/file
5024 .endd
5025 Include processing happens after macro processing (see below). Its effect is to
5026 process the lines of the included file as if they occurred inline where the
5027 inclusion appears.
5028
5029
5030
5031 .section "Macros in the configuration file" "SECTmacrodefs"
5032 .cindex "macro" "description of"
5033 .cindex "configuration file" "macros"
5034 If a line in the main part of the configuration (that is, before the first
5035 &"begin"& line) begins with an upper case letter, it is taken as a macro
5036 definition, and must be of the form
5037 .display
5038 <&'name'&> = <&'rest of line'&>
5039 .endd
5040 The name must consist of letters, digits, and underscores, and need not all be
5041 in upper case, though that is recommended. The rest of the line, including any
5042 continuations, is the replacement text, and has leading and trailing white
5043 space removed. Quotes are not removed. The replacement text can never end with
5044 a backslash character, but this doesn't seem to be a serious limitation.
5045
5046 Macros may also be defined between router, transport, authenticator, or ACL
5047 definitions. They may not, however, be defined within an individual driver or
5048 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5049
5050 .section "Macro substitution" "SECID42"
5051 Once a macro is defined, all subsequent lines in the file (and any included
5052 files) are scanned for the macro name; if there are several macros, the line is
5053 scanned for each, in turn, in the order in which the macros are defined. The
5054 replacement text is not re-scanned for the current macro, though it is scanned
5055 for subsequently defined macros. For this reason, a macro name may not contain
5056 the name of a previously defined macro as a substring. You could, for example,
5057 define
5058 .display
5059 &`ABCD_XYZ = `&<&'something'&>
5060 &`ABCD = `&<&'something else'&>
5061 .endd
5062 but putting the definitions in the opposite order would provoke a configuration
5063 error. Macro expansion is applied to individual physical lines from the file,
5064 before checking for line continuation or file inclusion (see above). If a line
5065 consists solely of a macro name, and the expansion of the macro is empty, the
5066 line is ignored. A macro at the start of a line may turn the line into a
5067 comment line or a &`.include`& line.
5068
5069
5070 .section "Redefining macros" "SECID43"
5071 Once defined, the value of a macro can be redefined later in the configuration
5072 (or in an included file). Redefinition is specified by using &'=='& instead of
5073 &'='&. For example:
5074 .code
5075 MAC =  initial value
5076 ...
5077 MAC == updated value
5078 .endd
5079 Redefinition does not alter the order in which the macros are applied to the
5080 subsequent lines of the configuration file. It is still the same order in which
5081 the macros were originally defined. All that changes is the macro's value.
5082 Redefinition makes it possible to accumulate values. For example:
5083 .code
5084 MAC =  initial value
5085 ...
5086 MAC == MAC and something added
5087 .endd
5088 This can be helpful in situations where the configuration file is built
5089 from a number of other files.
5090
5091 .section "Overriding macro values" "SECID44"
5092 The values set for macros in the configuration file can be overridden by the
5093 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5094 used, unless called by root or the Exim user. A definition on the command line
5095 using the &%-D%& option causes all definitions and redefinitions within the
5096 file to be ignored.
5097
5098
5099
5100 .section "Example of macro usage" "SECID45"
5101 As an example of macro usage, consider a configuration where aliases are looked
5102 up in a MySQL database. It helps to keep the file less cluttered if long
5103 strings such as SQL statements are defined separately as macros, for example:
5104 .code
5105 ALIAS_QUERY = select mailbox from user where \
5106               login='${quote_mysql:$local_part}';
5107 .endd
5108 This can then be used in a &(redirect)& router setting like this:
5109 .code
5110 data = ${lookup mysql{ALIAS_QUERY}}
5111 .endd
5112 In earlier versions of Exim macros were sometimes used for domain, host, or
5113 address lists. In Exim 4 these are handled better by named lists &-- see
5114 section &<<SECTnamedlists>>&.
5115
5116
5117 .section "Builtin macros" "SECTbuiltinmacros"
5118 Exim defines some macros depending on facilities available, which may
5119 differ due to build-time definitions and from one release to another.
5120 All of these macros start with an underscore.
5121 They can be used to conditionally include parts of a configuration
5122 (see below).
5123
5124 The following classes of macros are defined:
5125 .display
5126 &` _HAVE_*                    `&  build-time defines
5127 &` _DRIVER_ROUTER_*           `&  router drivers
5128 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5129 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5130 &` _EXP_COND_*                `&  expansion conditions
5131 &` _EXP_ITEM_*                `&  expansion items
5132 &` _EXP_OP_*                  `&  expansion operators
5133 &` _EXP_VAR_*                 `&  expansion variables
5134 &` _LOG_*                     `&  log_selector values
5135 &` _OPT_MAIN_*                `&  main config options
5136 &` _OPT_ROUTERS_*             `&  generic router options
5137 &` _OPT_TRANSPORTS_*          `&  generic transport options
5138 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5139 &` _OPT_ROUTER_*_*            `&  private router options
5140 &` _OPT_TRANSPORT_*_*         `&  private transport options
5141 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5142 .endd
5143
5144 Use an &"exim -bP macros"& command to get the list of macros.
5145
5146
5147 .section "Conditional skips in the configuration file" "SECID46"
5148 .cindex "configuration file" "conditional skips"
5149 .cindex "&`.ifdef`&"
5150 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5151 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5152 portions of the configuration file. The processing happens whenever the file is
5153 read (that is, when an Exim binary starts to run).
5154
5155 The implementation is very simple. Instances of the first four directives must
5156 be followed by text that includes the names of one or macros. The condition
5157 that is tested is whether or not any macro substitution has taken place in the
5158 line. Thus:
5159 .code
5160 .ifdef AAA
5161 message_size_limit = 50M
5162 .else
5163 message_size_limit = 100M
5164 .endif
5165 .endd
5166 sets a message size limit of 50M if the macro &`AAA`& is defined
5167 (or &`A`& or &`AA`&), and 100M
5168 otherwise. If there is more than one macro named on the line, the condition
5169 is true if any of them are defined. That is, it is an &"or"& condition. To
5170 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5171
5172 Although you can use a macro expansion to generate one of these directives,
5173 it is not very useful, because the condition &"there was a macro substitution
5174 in this line"& will always be true.
5175
5176 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5177 to clarify complicated nestings.
5178
5179
5180
5181 .section "Common option syntax" "SECTcos"
5182 .cindex "common option syntax"
5183 .cindex "syntax of common options"
5184 .cindex "configuration file" "common option syntax"
5185 For the main set of options, driver options, and &[local_scan()]& options,
5186 each setting is on a line by itself, and starts with a name consisting of
5187 lower-case letters and underscores. Many options require a data value, and in
5188 these cases the name must be followed by an equals sign (with optional white
5189 space) and then the value. For example:
5190 .code
5191 qualify_domain = mydomain.example.com
5192 .endd
5193 .cindex "hiding configuration option values"
5194 .cindex "configuration options" "hiding value of"
5195 .cindex "options" "hiding value of"
5196 Some option settings may contain sensitive data, for example, passwords for
5197 accessing databases. To stop non-admin users from using the &%-bP%& command
5198 line option to read these values, you can precede the option settings with the
5199 word &"hide"&. For example:
5200 .code
5201 hide mysql_servers = localhost/users/admin/secret-password
5202 .endd
5203 For non-admin users, such options are displayed like this:
5204 .code
5205 mysql_servers = <value not displayable>
5206 .endd
5207 If &"hide"& is used on a driver option, it hides the value of that option on
5208 all instances of the same driver.
5209
5210 The following sections describe the syntax used for the different data types
5211 that are found in option settings.
5212
5213
5214 .section "Boolean options" "SECID47"
5215 .cindex "format" "boolean"
5216 .cindex "boolean configuration values"
5217 .oindex "&%no_%&&'xxx'&"
5218 .oindex "&%not_%&&'xxx'&"
5219 Options whose type is given as boolean are on/off switches. There are two
5220 different ways of specifying such options: with and without a data value. If
5221 the option name is specified on its own without data, the switch is turned on;
5222 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5223 boolean options may be followed by an equals sign and one of the words
5224 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5225 the following two settings have exactly the same effect:
5226 .code
5227 queue_only
5228 queue_only = true
5229 .endd
5230 The following two lines also have the same (opposite) effect:
5231 .code
5232 no_queue_only
5233 queue_only = false
5234 .endd
5235 You can use whichever syntax you prefer.
5236
5237
5238
5239
5240 .section "Integer values" "SECID48"
5241 .cindex "integer configuration values"
5242 .cindex "format" "integer"
5243 If an option's type is given as &"integer"&, the value can be given in decimal,
5244 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5245 number is assumed. Otherwise, it is treated as an octal number unless it starts
5246 with the characters &"0x"&, in which case the remainder is interpreted as a
5247 hexadecimal number.
5248
5249 If an integer value is followed by the letter K, it is multiplied by 1024; if
5250 it is followed by the letter M, it is multiplied by 1024x1024;
5251 if by the letter G, 1024x1024x1024.
5252 When the values
5253 of integer option settings are output, values which are an exact multiple of
5254 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5255 and M. The printing style is independent of the actual input format that was
5256 used.
5257
5258
5259 .section "Octal integer values" "SECID49"
5260 .cindex "integer format"
5261 .cindex "format" "octal integer"
5262 If an option's type is given as &"octal integer"&, its value is always
5263 interpreted as an octal number, whether or not it starts with the digit zero.
5264 Such options are always output in octal.
5265
5266
5267 .section "Fixed point numbers" "SECID50"
5268 .cindex "fixed point configuration values"
5269 .cindex "format" "fixed point"
5270 If an option's type is given as &"fixed-point"&, its value must be a decimal
5271 integer, optionally followed by a decimal point and up to three further digits.
5272
5273
5274
5275 .section "Time intervals" "SECTtimeformat"
5276 .cindex "time interval" "specifying in configuration"
5277 .cindex "format" "time interval"
5278 A time interval is specified as a sequence of numbers, each followed by one of
5279 the following letters, with no intervening white space:
5280
5281 .table2 30pt
5282 .irow &%s%& seconds
5283 .irow &%m%& minutes
5284 .irow &%h%& hours
5285 .irow &%d%& days
5286 .irow &%w%& weeks
5287 .endtable
5288
5289 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5290 intervals are output in the same format. Exim does not restrict the values; it
5291 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5292
5293
5294
5295 .section "String values" "SECTstrings"
5296 .cindex "string" "format of configuration values"
5297 .cindex "format" "string"
5298 If an option's type is specified as &"string"&, the value can be specified with
5299 or without double-quotes. If it does not start with a double-quote, the value
5300 consists of the remainder of the line plus any continuation lines, starting at
5301 the first character after any leading white space, with trailing white space
5302 removed, and with no interpretation of the characters in the string. Because
5303 Exim removes comment lines (those beginning with #) at an early stage, they can
5304 appear in the middle of a multi-line string. The following two settings are
5305 therefore equivalent:
5306 .code
5307 trusted_users = uucp:mail
5308 trusted_users = uucp:\
5309                 # This comment line is ignored
5310                 mail
5311 .endd
5312 .cindex "string" "quoted"
5313 .cindex "escape characters in quoted strings"
5314 If a string does start with a double-quote, it must end with a closing
5315 double-quote, and any backslash characters other than those used for line
5316 continuation are interpreted as escape characters, as follows:
5317
5318 .table2 100pt
5319 .irow &`\\`&                     "single backslash"
5320 .irow &`\n`&                     "newline"
5321 .irow &`\r`&                     "carriage return"
5322 .irow &`\t`&                     "tab"
5323 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5324 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5325                                    character"
5326 .endtable
5327
5328 If a backslash is followed by some other character, including a double-quote
5329 character, that character replaces the pair.
5330
5331 Quoting is necessary only if you want to make use of the backslash escapes to
5332 insert special characters, or if you need to specify a value with leading or
5333 trailing spaces. These cases are rare, so quoting is almost never needed in
5334 current versions of Exim. In versions of Exim before 3.14, quoting was required
5335 in order to continue lines, so you may come across older configuration files
5336 and examples that apparently quote unnecessarily.
5337
5338
5339 .section "Expanded strings" "SECID51"
5340 .cindex "expansion" "definition of"
5341 Some strings in the configuration file are subjected to &'string expansion'&,
5342 by which means various parts of the string may be changed according to the
5343 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5344 is as just described; in particular, the handling of backslashes in quoted
5345 strings is done as part of the input process, before expansion takes place.
5346 However, backslash is also an escape character for the expander, so any
5347 backslashes that are required for that reason must be doubled if they are
5348 within a quoted configuration string.
5349
5350
5351 .section "User and group names" "SECID52"
5352 .cindex "user name" "format of"
5353 .cindex "format" "user name"
5354 .cindex "groups" "name format"
5355 .cindex "format" "group name"
5356 User and group names are specified as strings, using the syntax described
5357 above, but the strings are interpreted specially. A user or group name must
5358 either consist entirely of digits, or be a name that can be looked up using the
5359 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5360
5361
5362 .section "List construction" "SECTlistconstruct"
5363 .cindex "list" "syntax of in configuration"
5364 .cindex "format" "list item in configuration"
5365 .cindex "string" "list, definition of"
5366 The data for some configuration options is a list of items, with colon as the
5367 default separator. Many of these options are shown with type &"string list"& in
5368 the descriptions later in this document. Others are listed as &"domain list"&,
5369 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5370 are all the same; however, those other than &"string list"& are subject to
5371 particular kinds of interpretation, as described in chapter
5372 &<<CHAPdomhosaddlists>>&.
5373
5374 In all these cases, the entire list is treated as a single string as far as the
5375 input syntax is concerned. The &%trusted_users%& setting in section
5376 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5377 in a list, it must be entered as two colons. Leading and trailing white space
5378 on each item in a list is ignored. This makes it possible to include items that
5379 start with a colon, and in particular, certain forms of IPv6 address. For
5380 example, the list
5381 .code
5382 local_interfaces = 127.0.0.1 : ::::1
5383 .endd
5384 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5385
5386 &*Note*&: Although leading and trailing white space is ignored in individual
5387 list items, it is not ignored when parsing the list. The spaces around the first
5388 colon in the example above are necessary. If they were not there, the list would
5389 be interpreted as the two items 127.0.0.1:: and 1.
5390
5391 .section "Changing list separators" "SECTlistsepchange"
5392 .cindex "list separator" "changing"
5393 .cindex "IPv6" "addresses in lists"
5394 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5395 introduced to allow the separator character to be changed. If a list begins
5396 with a left angle bracket, followed by any punctuation character, that
5397 character is used instead of colon as the list separator. For example, the list
5398 above can be rewritten to use a semicolon separator like this:
5399 .code
5400 local_interfaces = <; 127.0.0.1 ; ::1
5401 .endd
5402 This facility applies to all lists, with the exception of the list in
5403 &%log_file_path%&. It is recommended that the use of non-colon separators be
5404 confined to circumstances where they really are needed.
5405
5406 .cindex "list separator" "newline as"
5407 .cindex "newline" "as list separator"
5408 It is also possible to use newline and other control characters (those with
5409 code values less than 32, plus DEL) as separators in lists. Such separators
5410 must be provided literally at the time the list is processed. For options that
5411 are string-expanded, you can write the separator using a normal escape
5412 sequence. This will be processed by the expander before the string is
5413 interpreted as a list. For example, if a newline-separated list of domains is
5414 generated by a lookup, you can process it directly by a line such as this:
5415 .code
5416 domains = <\n ${lookup mysql{.....}}
5417 .endd
5418 This avoids having to change the list separator in such data. You are unlikely
5419 to want to use a control character as a separator in an option that is not
5420 expanded, because the value is literal text. However, it can be done by giving
5421 the value in quotes. For example:
5422 .code
5423 local_interfaces = "<\n 127.0.0.1 \n ::1"
5424 .endd
5425 Unlike printing character separators, which can be included in list items by
5426 doubling, it is not possible to include a control character as data when it is
5427 set as the separator. Two such characters in succession are interpreted as
5428 enclosing an empty list item.
5429
5430
5431
5432 .section "Empty items in lists" "SECTempitelis"
5433 .cindex "list" "empty item in"
5434 An empty item at the end of a list is always ignored. In other words, trailing
5435 separator characters are ignored. Thus, the list in
5436 .code
5437 senders = user@domain :
5438 .endd
5439 contains only a single item. If you want to include an empty string as one item
5440 in a list, it must not be the last item. For example, this list contains three
5441 items, the second of which is empty:
5442 .code
5443 senders = user1@domain : : user2@domain
5444 .endd
5445 &*Note*&: There must be white space between the two colons, as otherwise they
5446 are interpreted as representing a single colon data character (and the list
5447 would then contain just one item). If you want to specify a list that contains
5448 just one, empty item, you can do it as in this example:
5449 .code
5450 senders = :
5451 .endd
5452 In this case, the first item is empty, and the second is discarded because it
5453 is at the end of the list.
5454
5455
5456
5457
5458 .section "Format of driver configurations" "SECTfordricon"
5459 .cindex "drivers" "configuration format"
5460 There are separate parts in the configuration for defining routers, transports,
5461 and authenticators. In each part, you are defining a number of driver
5462 instances, each with its own set of options. Each driver instance is defined by
5463 a sequence of lines like this:
5464 .display
5465 <&'instance name'&>:
5466   <&'option'&>
5467   ...
5468   <&'option'&>
5469 .endd
5470 In the following example, the instance name is &(localuser)&, and it is
5471 followed by three options settings:
5472 .code
5473 localuser:
5474   driver = accept
5475   check_local_user
5476   transport = local_delivery
5477 .endd
5478 For each driver instance, you specify which Exim code module it uses &-- by the
5479 setting of the &%driver%& option &-- and (optionally) some configuration
5480 settings. For example, in the case of transports, if you want a transport to
5481 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5482 a local file you would use the &(appendfile)& driver. Each of the drivers is
5483 described in detail in its own separate chapter later in this manual.
5484
5485 You can have several routers, transports, or authenticators that are based on
5486 the same underlying driver (each must have a different instance name).
5487
5488 The order in which routers are defined is important, because addresses are
5489 passed to individual routers one by one, in order. The order in which
5490 transports are defined does not matter at all. The order in which
5491 authenticators are defined is used only when Exim, as a client, is searching
5492 them to find one that matches an authentication mechanism offered by the
5493 server.
5494
5495 .cindex "generic options"
5496 .cindex "options" "generic &-- definition of"
5497 Within a driver instance definition, there are two kinds of option: &'generic'&
5498 and &'private'&. The generic options are those that apply to all drivers of the
5499 same type (that is, all routers, all transports or all authenticators). The
5500 &%driver%& option is a generic option that must appear in every definition.
5501 .cindex "private options"
5502 The private options are special for each driver, and none need appear, because
5503 they all have default values.
5504
5505 The options may appear in any order, except that the &%driver%& option must
5506 precede any private options, since these depend on the particular driver. For
5507 this reason, it is recommended that &%driver%& always be the first option.
5508
5509 Driver instance names, which are used for reference in log entries and
5510 elsewhere, can be any sequence of letters, digits, and underscores (starting
5511 with a letter) and must be unique among drivers of the same type. A router and
5512 a transport (for example) can each have the same name, but no two router
5513 instances can have the same name. The name of a driver instance should not be
5514 confused with the name of the underlying driver module. For example, the
5515 configuration lines:
5516 .code
5517 remote_smtp:
5518   driver = smtp
5519 .endd
5520 create an instance of the &(smtp)& transport driver whose name is
5521 &(remote_smtp)&. The same driver code can be used more than once, with
5522 different instance names and different option settings each time. A second
5523 instance of the &(smtp)& transport, with different options, might be defined
5524 thus:
5525 .code
5526 special_smtp:
5527   driver = smtp
5528   port = 1234
5529   command_timeout = 10s
5530 .endd
5531 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5532 these transport instances from routers, and these names would appear in log
5533 lines.
5534
5535 Comment lines may be present in the middle of driver specifications. The full
5536 list of option settings for any particular driver instance, including all the
5537 defaulted values, can be extracted by making use of the &%-bP%& command line
5538 option.
5539
5540
5541
5542
5543
5544
5545 . ////////////////////////////////////////////////////////////////////////////
5546 . ////////////////////////////////////////////////////////////////////////////
5547
5548 .chapter "The default configuration file" "CHAPdefconfil"
5549 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5550 .cindex "default" "configuration file &""walk through""&"
5551 The default configuration file supplied with Exim as &_src/configure.default_&
5552 is sufficient for a host with simple mail requirements. As an introduction to
5553 the way Exim is configured, this chapter &"walks through"& the default
5554 configuration, giving brief explanations of the settings. Detailed descriptions
5555 of the options are given in subsequent chapters. The default configuration file
5556 itself contains extensive comments about ways you might want to modify the
5557 initial settings. However, note that there are many options that are not
5558 mentioned at all in the default configuration.
5559
5560
5561
5562 .section "Macros" "SECTdefconfmacros"
5563 All macros should be defined before any options.
5564
5565 One macro is specified, but commented out, in the default configuration:
5566 .code
5567 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5568 .endd
5569 If all off-site mail is expected to be delivered to a "smarthost", then set the
5570 hostname here and uncomment the macro.  This will affect which router is used
5571 later on.  If this is left commented out, then Exim will perform direct-to-MX
5572 deliveries using a &(dnslookup)& router.
5573
5574 In addition to macros defined here, Exim includes a number of built-in macros
5575 to enable configuration to be guarded by a binary built with support for a
5576 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5577
5578
5579 .section "Main configuration settings" "SECTdefconfmain"
5580 The main (global) configuration option settings section must always come first
5581 in the file, after the macros.
5582 The first thing you'll see in the file, after some initial comments, is the line
5583 .code
5584 # primary_hostname =
5585 .endd
5586 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5587 to know the official, fully qualified name of your host, and this is where you
5588 can specify it. However, in most cases you do not need to set this option. When
5589 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5590
5591 The first three non-comment configuration lines are as follows:
5592 .code
5593 domainlist local_domains    = @
5594 domainlist relay_to_domains =
5595 hostlist   relay_from_hosts = 127.0.0.1
5596 .endd
5597 These are not, in fact, option settings. They are definitions of two named
5598 domain lists and one named host list. Exim allows you to give names to lists of
5599 domains, hosts, and email addresses, in order to make it easier to manage the
5600 configuration file (see section &<<SECTnamedlists>>&).
5601
5602 The first line defines a domain list called &'local_domains'&; this is used
5603 later in the configuration to identify domains that are to be delivered
5604 on the local host.
5605
5606 .cindex "@ in a domain list"
5607 There is just one item in this list, the string &"@"&. This is a special form
5608 of entry which means &"the name of the local host"&. Thus, if the local host is
5609 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5610 be delivered locally. Because the local host's name is referenced indirectly,
5611 the same configuration file can be used on different hosts.
5612
5613 The second line defines a domain list called &'relay_to_domains'&, but the
5614 list itself is empty. Later in the configuration we will come to the part that
5615 controls mail relaying through the local host; it allows relaying to any
5616 domains in this list. By default, therefore, no relaying on the basis of a mail
5617 domain is permitted.
5618
5619 The third line defines a host list called &'relay_from_hosts'&. This list is
5620 used later in the configuration to permit relaying from any host or IP address
5621 that matches the list. The default contains just the IP address of the IPv4
5622 loopback interface, which means that processes on the local host are able to
5623 submit mail for relaying by sending it over TCP/IP to that interface. No other
5624 hosts are permitted to submit messages for relaying.
5625
5626 Just to be sure there's no misunderstanding: at this point in the configuration
5627 we aren't actually setting up any controls. We are just defining some domains
5628 and hosts that will be used in the controls that are specified later.
5629
5630 The next two configuration lines are genuine option settings:
5631 .code
5632 acl_smtp_rcpt = acl_check_rcpt
5633 acl_smtp_data = acl_check_data
5634 .endd
5635 These options specify &'Access Control Lists'& (ACLs) that are to be used
5636 during an incoming SMTP session for every recipient of a message (every RCPT
5637 command), and after the contents of the message have been received,
5638 respectively. The names of the lists are &'acl_check_rcpt'& and
5639 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5640 section of the configuration. The RCPT ACL controls which recipients are
5641 accepted for an incoming message &-- if a configuration does not provide an ACL
5642 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5643 contents of a message to be checked.
5644
5645 Two commented-out option settings are next:
5646 .code
5647 # av_scanner = clamd:/tmp/clamd
5648 # spamd_address = 127.0.0.1 783
5649 .endd
5650 These are example settings that can be used when Exim is compiled with the
5651 content-scanning extension. The first specifies the interface to the virus
5652 scanner, and the second specifies the interface to SpamAssassin. Further
5653 details are given in chapter &<<CHAPexiscan>>&.
5654
5655 Three more commented-out option settings follow:
5656 .code
5657 # tls_advertise_hosts = *
5658 # tls_certificate = /etc/ssl/exim.crt
5659 # tls_privatekey = /etc/ssl/exim.pem
5660 .endd
5661 These are example settings that can be used when Exim is compiled with
5662 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5663 first one specifies the list of clients that are allowed to use TLS when
5664 connecting to this server; in this case, the wildcard means all clients. The
5665 other options specify where Exim should find its TLS certificate and private
5666 key, which together prove the server's identity to any clients that connect.
5667 More details are given in chapter &<<CHAPTLS>>&.
5668
5669 Another two commented-out option settings follow:
5670 .code
5671 # daemon_smtp_ports = 25 : 465 : 587
5672 # tls_on_connect_ports = 465
5673 .endd
5674 .cindex "port" "465 and 587"
5675 .cindex "port" "for message submission"
5676 .cindex "message" "submission, ports for"
5677 .cindex "submissions protocol"
5678 .cindex "smtps protocol"
5679 .cindex "ssmtp protocol"
5680 .cindex "SMTP" "submissions protocol"
5681 .cindex "SMTP" "ssmtp protocol"
5682 .cindex "SMTP" "smtps protocol"
5683 These options provide better support for roaming users who wish to use this
5684 server for message submission. They are not much use unless you have turned on
5685 TLS (as described in the previous paragraph) and authentication (about which
5686 more in section &<<SECTdefconfauth>>&).
5687 Mail submission from mail clients (MUAs) should be separate from inbound mail
5688 to your domain (MX delivery) for various good reasons (eg, ability to impose
5689 much saner TLS protocol and ciphersuite requirements without unintended
5690 consequences).
5691 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5692 which uses STARTTLS, so this is the &"submission"& port.
5693 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5694 which should be used in preference to 587.
5695 You should also consider deploying SRV records to help clients find
5696 these ports.
5697 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5698
5699 Two more commented-out options settings follow:
5700 .code
5701 # qualify_domain =
5702 # qualify_recipient =
5703 .endd
5704 The first of these specifies a domain that Exim uses when it constructs a
5705 complete email address from a local login name. This is often needed when Exim
5706 receives a message from a local process. If you do not set &%qualify_domain%&,
5707 the value of &%primary_hostname%& is used. If you set both of these options,
5708 you can have different qualification domains for sender and recipient
5709 addresses. If you set only the first one, its value is used in both cases.
5710
5711 .cindex "domain literal" "recognizing format"
5712 The following line must be uncommented if you want Exim to recognize
5713 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5714 (an IP address within square brackets) instead of a named domain.
5715 .code
5716 # allow_domain_literals
5717 .endd
5718 The RFCs still require this form, but many people think that in the modern
5719 Internet it makes little sense to permit mail to be sent to specific hosts by
5720 quoting their IP addresses. This ancient format has been used by people who
5721 try to abuse hosts by using them for unwanted relaying. However, some
5722 people believe there are circumstances (for example, messages addressed to
5723 &'postmaster'&) where domain literals are still useful.
5724
5725 The next configuration line is a kind of trigger guard:
5726 .code
5727 never_users = root
5728 .endd
5729 It specifies that no delivery must ever be run as the root user. The normal
5730 convention is to set up &'root'& as an alias for the system administrator. This
5731 setting is a guard against slips in the configuration.
5732 The list of users specified by &%never_users%& is not, however, the complete
5733 list; the build-time configuration in &_Local/Makefile_& has an option called
5734 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5735 contents of &%never_users%& are added to this list. By default
5736 FIXED_NEVER_USERS also specifies root.
5737
5738 When a remote host connects to Exim in order to send mail, the only information
5739 Exim has about the host's identity is its IP address. The next configuration
5740 line,
5741 .code
5742 host_lookup = *
5743 .endd
5744 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5745 in order to get a host name. This improves the quality of the logging
5746 information, but if you feel it is too expensive, you can remove it entirely,
5747 or restrict the lookup to hosts on &"nearby"& networks.
5748 Note that it is not always possible to find a host name from an IP address,
5749 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5750 unreachable.
5751
5752 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5753 1413 (hence their names):
5754 .code
5755 rfc1413_hosts = *
5756 rfc1413_query_timeout = 0s
5757 .endd
5758 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5759 Few hosts offer RFC1413 service these days; calls have to be
5760 terminated by a timeout and this needlessly delays the startup
5761 of an incoming SMTP connection.
5762 If you have hosts for which you trust RFC1413 and need this
5763 information, you can change this.
5764
5765 This line enables an efficiency SMTP option.  It is negotiated by clients
5766 and not expected to cause problems but can be disabled if needed.
5767 .code
5768 prdr_enable = true
5769 .endd
5770
5771 When Exim receives messages over SMTP connections, it expects all addresses to
5772 be fully qualified with a domain, as required by the SMTP definition. However,
5773 if you are running a server to which simple clients submit messages, you may
5774 find that they send unqualified addresses. The two commented-out options:
5775 .code
5776 # sender_unqualified_hosts =
5777 # recipient_unqualified_hosts =
5778 .endd
5779 show how you can specify hosts that are permitted to send unqualified sender
5780 and recipient addresses, respectively.
5781
5782 The &%log_selector%& option is used to increase the detail of logging
5783 over the default:
5784 .code
5785 log_selector = +smtp_protocol_error +smtp_syntax_error \
5786                +tls_certificate_verified
5787 .endd
5788
5789 The &%percent_hack_domains%& option is also commented out:
5790 .code
5791 # percent_hack_domains =
5792 .endd
5793 It provides a list of domains for which the &"percent hack"& is to operate.
5794 This is an almost obsolete form of explicit email routing. If you do not know
5795 anything about it, you can safely ignore this topic.
5796
5797 The next two settings in the main part of the default configuration are
5798 concerned with messages that have been &"frozen"& on Exim's queue. When a
5799 message is frozen, Exim no longer continues to try to deliver it. Freezing
5800 occurs when a bounce message encounters a permanent failure because the sender
5801 address of the original message that caused the bounce is invalid, so the
5802 bounce cannot be delivered. This is probably the most common case, but there
5803 are also other conditions that cause freezing, and frozen messages are not
5804 always bounce messages.
5805 .code
5806 ignore_bounce_errors_after = 2d
5807 timeout_frozen_after = 7d
5808 .endd
5809 The first of these options specifies that failing bounce messages are to be
5810 discarded after 2 days in the queue. The second specifies that any frozen
5811 message (whether a bounce message or not) is to be timed out (and discarded)
5812 after a week. In this configuration, the first setting ensures that no failing
5813 bounce message ever lasts a week.
5814
5815 Exim queues it's messages in a spool directory. If you expect to have
5816 large queues, you may consider using this option. It splits the spool
5817 directory into subdirectories to avoid file system degradation from
5818 many files in a single directory, resulting in better performance.
5819 Manual manipulation of queued messages becomes more complex (though fortunately
5820 not often needed).
5821 .code
5822 # split_spool_directory = true
5823 .endd
5824
5825 In an ideal world everybody follows the standards. For non-ASCII
5826 messages RFC 2047 is a standard, allowing a maximum line length of 76
5827 characters. Exim adheres that standard and won't process messages which
5828 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5829 In particular, the Exim maintainers have had multiple reports of
5830 problems from Russian administrators of issues until they disable this
5831 check, because of some popular, yet buggy, mail composition software.
5832 .code
5833 # check_rfc2047_length = false
5834 .endd
5835
5836 If you need to be strictly RFC compliant you may wish to disable the
5837 8BITMIME advertisement. Use this, if you exchange mails with systems
5838 that are not 8-bit clean.
5839 .code
5840 # accept_8bitmime = false
5841 .endd
5842
5843 Libraries you use may depend on specific environment settings.  This
5844 imposes a security risk (e.g. PATH). There are two lists:
5845 &%keep_environment%& for the variables to import as they are, and
5846 &%add_environment%& for variables we want to set to a fixed value.
5847 Note that TZ is handled separately, by the &%timezone%& runtime
5848 option and by the TIMEZONE_DEFAULT buildtime option.
5849 .code
5850 # keep_environment = ^LDAP
5851 # add_environment = PATH=/usr/bin::/bin
5852 .endd
5853
5854
5855 .section "ACL configuration" "SECID54"
5856 .cindex "default" "ACLs"
5857 .cindex "&ACL;" "default configuration"
5858 In the default configuration, the ACL section follows the main configuration.
5859 It starts with the line
5860 .code
5861 begin acl
5862 .endd
5863 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5864 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5865 and &%acl_smtp_data%& above.
5866
5867 .cindex "RCPT" "ACL for"
5868 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5869 RCPT command specifies one of the message's recipients. The ACL statements
5870 are considered in order, until the recipient address is either accepted or
5871 rejected. The RCPT command is then accepted or rejected, according to the
5872 result of the ACL processing.
5873 .code
5874 acl_check_rcpt:
5875 .endd
5876 This line, consisting of a name terminated by a colon, marks the start of the
5877 ACL, and names it.
5878 .code
5879 accept  hosts = :
5880 .endd
5881 This ACL statement accepts the recipient if the sending host matches the list.
5882 But what does that strange list mean? It doesn't actually contain any host
5883 names or IP addresses. The presence of the colon puts an empty item in the
5884 list; Exim matches this only if the incoming message did not come from a remote
5885 host, because in that case, the remote hostname is empty. The colon is
5886 important. Without it, the list itself is empty, and can never match anything.
5887
5888 What this statement is doing is to accept unconditionally all recipients in
5889 messages that are submitted by SMTP from local processes using the standard
5890 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5891 manner.
5892 .code
5893 deny    domains       = +local_domains
5894         local_parts   = ^[.] : ^.*[@%!/|]
5895         message       = Restricted characters in address
5896
5897 deny    domains       = !+local_domains
5898         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5899         message       = Restricted characters in address
5900 .endd
5901 These statements are concerned with local parts that contain any of the
5902 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5903 Although these characters are entirely legal in local parts (in the case of
5904 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5905 in Internet mail addresses.
5906
5907 The first three have in the past been associated with explicitly routed
5908 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5909 option). Addresses containing these characters are regularly tried by spammers
5910 in an attempt to bypass relaying restrictions, and also by open relay testing
5911 programs. Unless you really need them it is safest to reject these characters
5912 at this early stage. This configuration is heavy-handed in rejecting these
5913 characters for all messages it accepts from remote hosts. This is a deliberate
5914 policy of being as safe as possible.
5915
5916 The first rule above is stricter, and is applied to messages that are addressed
5917 to one of the local domains handled by this host. This is implemented by the
5918 first condition, which restricts it to domains that are listed in the
5919 &'local_domains'& domain list. The &"+"& character is used to indicate a
5920 reference to a named list. In this configuration, there is just one domain in
5921 &'local_domains'&, but in general there may be many.
5922
5923 The second condition on the first statement uses two regular expressions to
5924 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5925 or &"|"&. If you have local accounts that include these characters, you will
5926 have to modify this rule.
5927
5928 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5929 allows them because they have been encountered in practice. (Consider the
5930 common convention of local parts constructed as
5931 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5932 the author of Exim, who has no second initial.) However, a local part starting
5933 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5934 filename (for example, for a mailing list). This is also true for local parts
5935 that contain slashes. A pipe symbol can also be troublesome if the local part
5936 is incorporated unthinkingly into a shell command line.
5937
5938 The second rule above applies to all other domains, and is less strict. This
5939 allows your own users to send outgoing messages to sites that use slashes
5940 and vertical bars in their local parts. It blocks local parts that begin
5941 with a dot, slash, or vertical bar, but allows these characters within the
5942 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5943 and &"!"& is blocked, as before. The motivation here is to prevent your users
5944 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5945 .code
5946 accept  local_parts   = postmaster
5947         domains       = +local_domains
5948 .endd
5949 This statement, which has two conditions, accepts an incoming address if the
5950 local part is &'postmaster'& and the domain is one of those listed in the
5951 &'local_domains'& domain list. The &"+"& character is used to indicate a
5952 reference to a named list. In this configuration, there is just one domain in
5953 &'local_domains'&, but in general there may be many.
5954
5955 The presence of this statement means that mail to postmaster is never blocked
5956 by any of the subsequent tests. This can be helpful while sorting out problems
5957 in cases where the subsequent tests are incorrectly denying access.
5958 .code
5959 require verify        = sender
5960 .endd
5961 This statement requires the sender address to be verified before any subsequent
5962 ACL statement can be used. If verification fails, the incoming recipient
5963 address is refused. Verification consists of trying to route the address, to
5964 see if a bounce message could be delivered to it. In the case of remote
5965 addresses, basic verification checks only the domain, but &'callouts'& can be
5966 used for more verification if required. Section &<<SECTaddressverification>>&
5967 discusses the details of address verification.
5968 .code
5969 accept  hosts         = +relay_from_hosts
5970         control       = submission
5971 .endd
5972 This statement accepts the address if the message is coming from one of the
5973 hosts that are defined as being allowed to relay through this host. Recipient
5974 verification is omitted here, because in many cases the clients are dumb MUAs
5975 that do not cope well with SMTP error responses. For the same reason, the
5976 second line specifies &"submission mode"& for messages that are accepted. This
5977 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5978 messages that are deficient in some way, for example, because they lack a
5979 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5980 probably add recipient verification here, and disable submission mode.
5981 .code
5982 accept  authenticated = *
5983         control       = submission
5984 .endd
5985 This statement accepts the address if the client host has authenticated itself.
5986 Submission mode is again specified, on the grounds that such messages are most
5987 likely to come from MUAs. The default configuration does not define any
5988 authenticators, though it does include some nearly complete commented-out
5989 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5990 fact authenticate until you complete the authenticator definitions.
5991 .code
5992 require message = relay not permitted
5993         domains = +local_domains : +relay_to_domains
5994 .endd
5995 This statement rejects the address if its domain is neither a local domain nor
5996 one of the domains for which this host is a relay.
5997 .code
5998 require verify = recipient
5999 .endd
6000 This statement requires the recipient address to be verified; if verification
6001 fails, the address is rejected.
6002 .code
6003 # deny    dnslists    = black.list.example
6004 #         message     = rejected because $sender_host_address \
6005 #                       is in a black list at $dnslist_domain\n\
6006 #                       $dnslist_text
6007 #
6008 # warn    dnslists    = black.list.example
6009 #         add_header  = X-Warning: $sender_host_address is in \
6010 #                       a black list at $dnslist_domain
6011 #         log_message = found in $dnslist_domain
6012 .endd
6013 These commented-out lines are examples of how you could configure Exim to check
6014 sending hosts against a DNS black list. The first statement rejects messages
6015 from blacklisted hosts, whereas the second just inserts a warning header
6016 line.
6017 .code
6018 # require verify = csa
6019 .endd
6020 This commented-out line is an example of how you could turn on client SMTP
6021 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6022 records.
6023 .code
6024 accept
6025 .endd
6026 The final statement in the first ACL unconditionally accepts any recipient
6027 address that has successfully passed all the previous tests.
6028 .code
6029 acl_check_data:
6030 .endd
6031 This line marks the start of the second ACL, and names it. Most of the contents
6032 of this ACL are commented out:
6033 .code
6034 # deny    malware   = *
6035 #         message   = This message contains a virus \
6036 #                     ($malware_name).
6037 .endd
6038 These lines are examples of how to arrange for messages to be scanned for
6039 viruses when Exim has been compiled with the content-scanning extension, and a
6040 suitable virus scanner is installed. If the message is found to contain a
6041 virus, it is rejected with the given custom error message.
6042 .code
6043 # warn    spam      = nobody
6044 #         message   = X-Spam_score: $spam_score\n\
6045 #                     X-Spam_score_int: $spam_score_int\n\
6046 #                     X-Spam_bar: $spam_bar\n\
6047 #                     X-Spam_report: $spam_report
6048 .endd
6049 These lines are an example of how to arrange for messages to be scanned by
6050 SpamAssassin when Exim has been compiled with the content-scanning extension,
6051 and SpamAssassin has been installed. The SpamAssassin check is run with
6052 &`nobody`& as its user parameter, and the results are added to the message as a
6053 series of extra header line. In this case, the message is not rejected,
6054 whatever the spam score.
6055 .code
6056 accept
6057 .endd
6058 This final line in the DATA ACL accepts the message unconditionally.
6059
6060
6061 .section "Router configuration" "SECID55"
6062 .cindex "default" "routers"
6063 .cindex "routers" "default"
6064 The router configuration comes next in the default configuration, introduced
6065 by the line
6066 .code
6067 begin routers
6068 .endd
6069 Routers are the modules in Exim that make decisions about where to send
6070 messages. An address is passed to each router, in turn, until it is either
6071 accepted, or failed. This means that the order in which you define the routers
6072 matters. Each router is fully described in its own chapter later in this
6073 manual. Here we give only brief overviews.
6074 .code
6075 # domain_literal:
6076 #   driver = ipliteral
6077 #   domains = !+local_domains
6078 #   transport = remote_smtp
6079 .endd
6080 .cindex "domain literal" "default router"
6081 This router is commented out because the majority of sites do not want to
6082 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6083 you uncomment this router, you also need to uncomment the setting of
6084 &%allow_domain_literals%& in the main part of the configuration.
6085
6086 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6087 macro has been defined, per
6088 .code
6089 .ifdef ROUTER_SMARTHOST
6090 smarthost:
6091 #...
6092 .else
6093 dnslookup:
6094 #...
6095 .endif
6096 .endd
6097
6098 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6099 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6100 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6101 skip these routers because of the &%domains%& option.
6102
6103 .code
6104 smarthost:
6105   driver = manualroute
6106   domains = ! +local_domains
6107   transport = smarthost_smtp
6108   route_data = ROUTER_SMARTHOST
6109   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6110   no_more
6111 .endd
6112 This router only handles mail which is not to any local domains; this is
6113 specified by the line
6114 .code
6115 domains = ! +local_domains
6116 .endd
6117 The &%domains%& option lists the domains to which this router applies, but the
6118 exclamation mark is a negation sign, so the router is used only for domains
6119 that are not in the domain list called &'local_domains'& (which was defined at
6120 the start of the configuration). The plus sign before &'local_domains'&
6121 indicates that it is referring to a named list. Addresses in other domains are
6122 passed on to the following routers.
6123
6124 The name of the router driver is &(manualroute)& because we are manually
6125 specifying how mail should be routed onwards, instead of using DNS MX.
6126 While the name of this router instance is arbitrary, the &%driver%& option must
6127 be one of the driver modules that is in the Exim binary.
6128
6129 With no pre-conditions other than &%domains%&, all mail for non-local domains
6130 will be handled by this router, and the &%no_more%& setting will ensure that no
6131 other routers will be used for messages matching the pre-conditions.  See
6132 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6133 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6134 and the macro supplies the value; the address is then queued for the
6135 &(smarthost_smtp)& transport.
6136
6137 .code
6138 dnslookup:
6139   driver = dnslookup
6140   domains = ! +local_domains
6141   transport = remote_smtp
6142   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6143   no_more
6144 .endd
6145 The &%domains%& option behaves as per smarthost, above.
6146
6147 The name of the router driver is &(dnslookup)&,
6148 and is specified by the &%driver%& option. Do not be confused by the fact that
6149 the name of this router instance is the same as the name of the driver. The
6150 instance name is arbitrary, but the name set in the &%driver%& option must be
6151 one of the driver modules that is in the Exim binary.
6152
6153 The &(dnslookup)& router routes addresses by looking up their domains in the
6154 DNS in order to obtain a list of hosts to which the address is routed. If the
6155 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6156 specified by the &%transport%& option. If the router does not find the domain
6157 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6158 the address fails and is bounced.
6159
6160 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6161 be entirely ignored. This option is present because a number of cases have been
6162 encountered where MX records in the DNS point to host names
6163 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6164 Completely ignoring these IP addresses causes Exim to fail to route the
6165 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6166 continue to try to deliver the message periodically until the address timed
6167 out.
6168 .code
6169 system_aliases:
6170   driver = redirect
6171   allow_fail
6172   allow_defer
6173   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6174 # user = exim
6175   file_transport = address_file
6176   pipe_transport = address_pipe
6177 .endd
6178 Control reaches this and subsequent routers only for addresses in the local
6179 domains. This router checks to see whether the local part is defined as an
6180 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6181 data that it looks up from that file. If no data is found for the local part,
6182 the value of the &%data%& option is empty, causing the address to be passed to
6183 the next router.
6184
6185 &_/etc/aliases_& is a conventional name for the system aliases file that is
6186 often used. That is why it is referenced by from the default configuration
6187 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6188 &_Local/Makefile_& before building Exim.
6189 .code
6190 userforward:
6191   driver = redirect
6192   check_local_user
6193 # local_part_suffix = +* : -*
6194 # local_part_suffix_optional
6195   file = $home/.forward
6196 # allow_filter
6197   no_verify
6198   no_expn
6199   check_ancestor
6200   file_transport = address_file
6201   pipe_transport = address_pipe
6202   reply_transport = address_reply
6203 .endd
6204 This is the most complicated router in the default configuration. It is another
6205 redirection router, but this time it is looking for forwarding data set up by
6206 individual users. The &%check_local_user%& setting specifies a check that the
6207 local part of the address is the login name of a local user. If it is not, the
6208 router is skipped. The two commented options that follow &%check_local_user%&,
6209 namely:
6210 .code
6211 # local_part_suffix = +* : -*
6212 # local_part_suffix_optional
6213 .endd
6214 .vindex "&$local_part_suffix$&"
6215 show how you can specify the recognition of local part suffixes. If the first
6216 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6217 by any sequence of characters, is removed from the local part and placed in the
6218 variable &$local_part_suffix$&. The second suffix option specifies that the
6219 presence of a suffix in the local part is optional. When a suffix is present,
6220 the check for a local login uses the local part with the suffix removed.
6221
6222 When a local user account is found, the file called &_.forward_& in the user's
6223 home directory is consulted. If it does not exist, or is empty, the router
6224 declines. Otherwise, the contents of &_.forward_& are interpreted as
6225 redirection data (see chapter &<<CHAPredirect>>& for more details).
6226
6227 .cindex "Sieve filter" "enabling in default router"
6228 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6229 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6230 is commented out by default), the contents of the file are interpreted as a set
6231 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6232 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6233 separate document entitled &'Exim's interfaces to mail filtering'&.
6234
6235 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6236 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6237 There are two reasons for doing this:
6238
6239 .olist
6240 Whether or not a local user has a &_.forward_& file is not really relevant when
6241 checking an address for validity; it makes sense not to waste resources doing
6242 unnecessary work.
6243 .next
6244 More importantly, when Exim is verifying addresses or handling an EXPN
6245 command during an SMTP session, it is running as the Exim user, not as root.
6246 The group is the Exim group, and no additional groups are set up.
6247 It may therefore not be possible for Exim to read users' &_.forward_& files at
6248 this time.
6249 .endlist
6250
6251 The setting of &%check_ancestor%& prevents the router from generating a new
6252 address that is the same as any previous address that was redirected. (This
6253 works round a problem concerning a bad interaction between aliasing and
6254 forwarding &-- see section &<<SECTredlocmai>>&).
6255
6256 The final three option settings specify the transports that are to be used when
6257 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6258 auto-reply, respectively. For example, if a &_.forward_& file contains
6259 .code
6260 a.nother@elsewhere.example, /home/spqr/archive
6261 .endd
6262 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6263 transport.
6264 .code
6265 localuser:
6266   driver = accept
6267   check_local_user
6268 # local_part_suffix = +* : -*
6269 # local_part_suffix_optional
6270   transport = local_delivery
6271 .endd
6272 The final router sets up delivery into local mailboxes, provided that the local
6273 part is the name of a local login, by accepting the address and assigning it to
6274 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6275 routers, so the address is bounced. The commented suffix settings fulfil the
6276 same purpose as they do for the &(userforward)& router.
6277
6278
6279 .section "Transport configuration" "SECID56"
6280 .cindex "default" "transports"
6281 .cindex "transports" "default"
6282 Transports define mechanisms for actually delivering messages. They operate
6283 only when referenced from routers, so the order in which they are defined does
6284 not matter. The transports section of the configuration starts with
6285 .code
6286 begin transports
6287 .endd
6288 Two remote transports and four local transports are defined.
6289 .code
6290 remote_smtp:
6291   driver = smtp
6292   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6293 .ifdef _HAVE_PRDR
6294   hosts_try_prdr = *
6295 .endif
6296 .endd
6297 This transport is used for delivering messages over SMTP connections.
6298 The list of remote hosts comes from the router.
6299 The &%message_size_limit%& usage is a hack to avoid sending on messages
6300 with over-long lines.
6301
6302 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6303 negotiated between client and server and not expected to cause problems
6304 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6305 use of the &%hosts_try_prdr%& configuration option.
6306
6307 The other remote transport is used when delivering to a specific smarthost
6308 with whom there must be some kind of existing relationship, instead of the
6309 usual federated system.
6310
6311 .code
6312 smarthost_smtp:
6313   driver = smtp
6314   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6315   multi_domain
6316   #
6317 .ifdef _HAVE_TLS
6318   # Comment out any of these which you have to, then file a Support
6319   # request with your smarthost provider to get things fixed:
6320   hosts_require_tls = *
6321   tls_verify_hosts = *
6322   # As long as tls_verify_hosts is enabled, this this will have no effect,
6323   # but if you have to comment it out then this will at least log whether
6324   # you succeed or not:
6325   tls_try_verify_hosts = *
6326   #
6327   # The SNI name should match the name which we'll expect to verify;
6328   # many mail systems don't use SNI and this doesn't matter, but if it does,
6329   # we need to send a name which the remote site will recognize.
6330   # This _should_ be the name which the smarthost operators specified as
6331   # the hostname for sending your mail to.
6332   tls_sni = ROUTER_SMARTHOST
6333   #
6334 .ifdef _HAVE_OPENSSL
6335   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6336 .endif
6337 .ifdef _HAVE_GNUTLS
6338   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6339 .endif
6340 .endif
6341 .ifdef _HAVE_PRDR
6342   hosts_try_prdr = *
6343 .endif
6344 .endd
6345 After the same &%message_size_limit%& hack, we then specify that this Transport
6346 can handle messages to multiple domains in one run.  The assumption here is
6347 that you're routing all non-local mail to the same place and that place is
6348 happy to take all messages from you as quickly as possible.
6349 All other options depend upon built-in macros; if Exim was built without TLS support
6350 then no other options are defined.
6351 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6352 and versions using the &%tls_require_ciphers%& option, where the value to be
6353 used depends upon the library providing TLS.
6354 Beyond that, the options adopt the stance that you should have TLS support available
6355 from your smarthost on today's Internet, so we turn on requiring TLS for the
6356 mail to be delivered, and requiring that the certificate be valid, and match
6357 the expected hostname.  The &%tls_sni%& option can be used by service providers
6358 to select an appropriate certificate to present to you and here we re-use the
6359 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6360 You want to specify the hostname which you'll expect to validate for, and that
6361 should not be subject to insecure tampering via DNS results.
6362
6363 For the &%hosts_try_prdr%& option see the previous transport.
6364
6365 All other options are defaulted.
6366 .code
6367 local_delivery:
6368   driver = appendfile
6369   file = /var/mail/$local_part_data
6370   delivery_date_add
6371   envelope_to_add
6372   return_path_add
6373 # group = mail
6374 # mode = 0660
6375 .endd
6376 This &(appendfile)& transport is used for local delivery to user mailboxes in
6377 traditional BSD mailbox format.
6378
6379 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6380 as it is provided by a potential bad actor.
6381 Instead we use &$local_part_data$&,
6382 the result of looking up &$local_part$& in the user database
6383 (done by using &%check_local_user%& in the the router).
6384
6385 By default &(appendfile)& runs under the uid and gid of the
6386 local user, which requires the sticky bit to be set on the &_/var/mail_&
6387 directory. Some systems use the alternative approach of running mail deliveries
6388 under a particular group instead of using the sticky bit. The commented options
6389 show how this can be done.
6390
6391 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6392 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6393 similarly-named options above.
6394 .code
6395 address_pipe:
6396   driver = pipe
6397   return_output
6398 .endd
6399 This transport is used for handling deliveries to pipes that are generated by
6400 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6401 option specifies that any output on stdout or stderr generated by the pipe is to
6402 be returned to the sender.
6403 .code
6404 address_file:
6405   driver = appendfile
6406   delivery_date_add
6407   envelope_to_add
6408   return_path_add
6409 .endd
6410 This transport is used for handling deliveries to files that are generated by
6411 redirection. The name of the file is not specified in this instance of
6412 &(appendfile)&, because it comes from the &(redirect)& router.
6413 .code
6414 address_reply:
6415   driver = autoreply
6416 .endd
6417 This transport is used for handling automatic replies generated by users'
6418 filter files.
6419
6420
6421
6422 .section "Default retry rule" "SECID57"
6423 .cindex "retry" "default rule"
6424 .cindex "default" "retry rule"
6425 The retry section of the configuration file contains rules which affect the way
6426 Exim retries deliveries that cannot be completed at the first attempt. It is
6427 introduced by the line
6428 .code
6429 begin retry
6430 .endd
6431 In the default configuration, there is just one rule, which applies to all
6432 errors:
6433 .code
6434 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6435 .endd
6436 This causes any temporarily failing address to be retried every 15 minutes for
6437 2 hours, then at intervals starting at one hour and increasing by a factor of
6438 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6439 is not delivered after 4 days of temporary failure, it is bounced. The time is
6440 measured from first failure, not from the time the message was received.
6441
6442 If the retry section is removed from the configuration, or is empty (that is,
6443 if no retry rules are defined), Exim will not retry deliveries. This turns
6444 temporary errors into permanent errors.
6445
6446
6447 .section "Rewriting configuration" "SECID58"
6448 The rewriting section of the configuration, introduced by
6449 .code
6450 begin rewrite
6451 .endd
6452 contains rules for rewriting addresses in messages as they arrive. There are no
6453 rewriting rules in the default configuration file.
6454
6455
6456
6457 .section "Authenticators configuration" "SECTdefconfauth"
6458 .cindex "AUTH" "configuration"
6459 The authenticators section of the configuration, introduced by
6460 .code
6461 begin authenticators
6462 .endd
6463 defines mechanisms for the use of the SMTP AUTH command. The default
6464 configuration file contains two commented-out example authenticators
6465 which support plaintext username/password authentication using the
6466 standard PLAIN mechanism and the traditional but non-standard LOGIN
6467 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6468 to support most MUA software.
6469
6470 The example PLAIN authenticator looks like this:
6471 .code
6472 #PLAIN:
6473 #  driver                  = plaintext
6474 #  server_set_id           = $auth2
6475 #  server_prompts          = :
6476 #  server_condition        = Authentication is not yet configured
6477 #  server_advertise_condition = ${if def:tls_in_cipher }
6478 .endd
6479 And the example LOGIN authenticator looks like this:
6480 .code
6481 #LOGIN:
6482 #  driver                  = plaintext
6483 #  server_set_id           = $auth1
6484 #  server_prompts          = <| Username: | Password:
6485 #  server_condition        = Authentication is not yet configured
6486 #  server_advertise_condition = ${if def:tls_in_cipher }
6487 .endd
6488
6489 The &%server_set_id%& option makes Exim remember the authenticated username
6490 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6491 &%server_prompts%& option configures the &(plaintext)& authenticator so
6492 that it implements the details of the specific authentication mechanism,
6493 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6494 when Exim offers authentication to clients; in the examples, this is only
6495 when TLS or SSL has been started, so to enable the authenticators you also
6496 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6497
6498 The &%server_condition%& setting defines how to verify that the username and
6499 password are correct. In the examples it just produces an error message.
6500 To make the authenticators work, you can use a string expansion
6501 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6502
6503 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6504 usercode and password are in different positions.
6505 Chapter &<<CHAPplaintext>>& covers both.
6506
6507 .ecindex IIDconfiwal
6508
6509
6510
6511 . ////////////////////////////////////////////////////////////////////////////
6512 . ////////////////////////////////////////////////////////////////////////////
6513
6514 .chapter "Regular expressions" "CHAPregexp"
6515
6516 .cindex "regular expressions" "library"
6517 .cindex "PCRE2"
6518 Exim supports the use of regular expressions in many of its options. It
6519 uses the PCRE2 regular expression library; this provides regular expression
6520 matching that is compatible with Perl 5. The syntax and semantics of
6521 regular expressions is discussed in
6522 online Perl manpages, in
6523 many Perl reference books, and also in
6524 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6525 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6526 . --- the http: URL here redirects to another page with the ISBN in the URL
6527 . --- where trying to use https: just redirects back to http:, so sticking
6528 . --- to the old URL for now.  2018-09-07.
6529
6530 The documentation for the syntax and semantics of the regular expressions that
6531 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6532 description is included here. The PCRE2 functions are called from Exim using
6533 the default option settings (that is, with no PCRE2 options set), except that
6534 the PCRE2_CASELESS option is set when the matching is required to be
6535 case-insensitive.
6536
6537 In most cases, when a regular expression is required in an Exim configuration,
6538 it has to start with a circumflex, in order to distinguish it from plain text
6539 or an &"ends with"& wildcard. In this example of a configuration setting, the
6540 second item in the colon-separated list is a regular expression.
6541 .code
6542 domains = a.b.c : ^\\d{3} : *.y.z : ...
6543 .endd
6544 The doubling of the backslash is required because of string expansion that
6545 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6546 of this issue, and a way of avoiding the need for doubling backslashes. The
6547 regular expression that is eventually used in this example contains just one
6548 backslash. The circumflex is included in the regular expression, and has the
6549 normal effect of &"anchoring"& it to the start of the string that is being
6550 matched.
6551
6552 There are, however, two cases where a circumflex is not required for the
6553 recognition of a regular expression: these are the &%match%& condition in a
6554 string expansion, and the &%matches%& condition in an Exim filter file. In
6555 these cases, the relevant string is always treated as a regular expression; if
6556 it does not start with a circumflex, the expression is not anchored, and can
6557 match anywhere in the subject string.
6558
6559 In all cases, if you want a regular expression to match at the end of a string,
6560 you must code the $ metacharacter to indicate this. For example:
6561 .code
6562 domains = ^\\d{3}\\.example
6563 .endd
6564 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6565 You need to use:
6566 .code
6567 domains = ^\\d{3}\\.example\$
6568 .endd
6569 if you want &'example'& to be the top-level domain. The backslash before the
6570 $ is needed because string expansion also interprets dollar characters.
6571
6572
6573
6574 . ////////////////////////////////////////////////////////////////////////////
6575 . ////////////////////////////////////////////////////////////////////////////
6576
6577 .chapter "File and database lookups" "CHAPfdlookup"
6578 .scindex IIDfidalo1 "file" "lookups"
6579 .scindex IIDfidalo2 "database" "lookups"
6580 .cindex "lookup" "description of"
6581 Exim can be configured to look up data in files or databases as it processes
6582 messages. Two different kinds of syntax are used:
6583
6584 .olist
6585 A string that is to be expanded may contain explicit lookup requests. These
6586 cause parts of the string to be replaced by data that is obtained from the
6587 lookup. Lookups of this type are conditional expansion items. Different results
6588 can be defined for the cases of lookup success and failure. See chapter
6589 &<<CHAPexpand>>&, where string expansions are described in detail.
6590 The key for the lookup is &*specified*& as part of the string to be expanded.
6591 .next
6592 Lists of domains, hosts, and email addresses can contain lookup requests as a
6593 way of avoiding excessively long linear lists. In this case, the data that is
6594 returned by the lookup is often (but not always) discarded; whether the lookup
6595 succeeds or fails is what really counts. These kinds of list are described in
6596 chapter &<<CHAPdomhosaddlists>>&.
6597 Depending on the lookup type (see below)
6598 the key for the lookup may need to be &*specified*& as above
6599 or may be &*implicit*&,
6600 given by the context in which the list is being checked.
6601 .endlist
6602
6603 String expansions, lists, and lookups interact with each other in such a way
6604 that there is no order in which to describe any one of them that does not
6605 involve references to the others. Each of these three chapters makes more sense
6606 if you have read the other two first. If you are reading this for the first
6607 time, be aware that some of it will make a lot more sense after you have read
6608 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6609
6610 .section "Examples of different lookup syntax" "SECID60"
6611 It is easy to confuse the two different kinds of lookup, especially as the
6612 lists that may contain the second kind are always expanded before being
6613 processed as lists. Therefore, they may also contain lookups of the first kind.
6614 Be careful to distinguish between the following two examples:
6615 .code
6616 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6617 domains = lsearch;/some/file
6618 .endd
6619 .ilist
6620 The first uses a string expansion, the result of which must be a domain list.
6621 The key for an expansion-style lookup must be given explicitly.
6622 No strings have been specified for a successful or a failing lookup; the
6623 defaults in this case are the looked-up data and an empty string, respectively.
6624 The expansion takes place before the string is processed as a list, and the
6625 file that is searched could contain lines like this:
6626 .code
6627 192.168.3.4: domain1:domain2:...
6628 192.168.1.9: domain3:domain4:...
6629 .endd
6630 When the lookup succeeds, the result of the expansion is a list of domains (and
6631 possibly other types of item that are allowed in domain lists).
6632 .cindex "tainted data" "de-tainting"
6633 .cindex "de-tainting" "using a lookup expansion"
6634 The result of the expansion is not tainted.
6635
6636 .next
6637 In the second example, the lookup is a single item in a domain list. It causes
6638 Exim to use a lookup to see if the domain that is being processed can be found
6639 in the file.
6640 The file could contains lines like this:
6641 .code
6642 domain1:
6643 domain2:
6644 .endd
6645 Any data that follows the keys is not relevant when checking that the domain
6646 matches the list item.
6647
6648 The key for a list-style lookup is implicit, from the lookup context, if
6649 the lookup is a single-key type (see below).
6650 For query-style lookup types the query must be given explicitly.
6651 .endlist
6652
6653 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6654 Consider a file containing lines like this:
6655 .code
6656 192.168.5.6: lsearch;/another/file
6657 .endd
6658 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6659 first &%domains%& setting above generates the second setting, which therefore
6660 causes a second lookup to occur.
6661
6662 The lookup type may optionally be followed by a comma
6663 and a comma-separated list of options.
6664 Each option is a &"name=value"& pair.
6665 Whether an option is meaningful depends on the lookup type.
6666
6667 All lookups support the option &"cache=no_rd"&.
6668 If this is given then the cache that Exim manages for lookup results
6669 is not checked before doing the lookup.
6670 The result of the lookup is still written to the cache.
6671
6672 The rest of this chapter describes the different lookup types that are
6673 available. Any of them can be used in any part of the configuration where a
6674 lookup is permitted.
6675
6676
6677 .section "Lookup types" "SECID61"
6678 .cindex "lookup" "types of"
6679 .cindex "single-key lookup" "definition of"
6680 Two different types of data lookup are implemented:
6681
6682 .ilist
6683 The &'single-key'& type requires the specification of a file in which to look,
6684 and a single key to search for. The key must be a non-empty string for the
6685 lookup to succeed. The lookup type determines how the file is searched.
6686 .cindex "tainted data" "single-key lookups"
6687 The file string may not be tainted.
6688
6689 .cindex "tainted data" "de-tainting"
6690 .cindex "de-tainting" "using a single-key lookup"
6691 All single-key lookups support the option &"ret=key"&.
6692 If this is given and the lookup
6693 (either underlying implementation or cached value)
6694 returns data, the result is replaced with a non-tainted
6695 version of the lookup key.
6696
6697 .next
6698 .cindex "query-style lookup" "definition of"
6699 The &'query-style'& type accepts a generalized database query. No particular
6700 key value is assumed by Exim for query-style lookups. You can use whichever
6701 Exim variables you need to construct the database query.
6702 .cindex "tainted data" "quoting for lookups"
6703 If tainted data is used in the query then it should be quuted by
6704 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6705 appropriate for the lookup.
6706 .endlist
6707
6708 The code for each lookup type is in a separate source file that is included in
6709 the binary of Exim only if the corresponding compile-time option is set. The
6710 default settings in &_src/EDITME_& are:
6711 .code
6712 LOOKUP_DBM=yes
6713 LOOKUP_LSEARCH=yes
6714 .endd
6715 which means that only linear searching and DBM lookups are included by default.
6716 For some types of lookup (e.g. SQL databases), you need to install appropriate
6717 libraries and header files before building Exim.
6718
6719
6720
6721
6722 .section "Single-key lookup types" "SECTsinglekeylookups"
6723 .cindex "lookup" "single-key types"
6724 .cindex "single-key lookup" "list of types"
6725 The following single-key lookup types are implemented:
6726
6727 .subsection cdb
6728 .cindex "cdb" "description of"
6729 .cindex "lookup" "cdb"
6730 .cindex "binary zero" "in lookup key"
6731 The given file is searched as a Constant DataBase file, using the key
6732 string without a terminating binary zero. The cdb format is designed for
6733 indexed files that are read frequently and never updated, except by total
6734 re-creation. As such, it is particularly suitable for large files containing
6735 aliases or other indexed data referenced by an MTA. Information about cdb and
6736 tools for building the files can be found in several places:
6737 .display
6738 &url(https://cr.yp.to/cdb.html)
6739 &url(https://www.corpit.ru/mjt/tinycdb.html)
6740 &url(https://packages.debian.org/stable/utils/freecdb)
6741 &url(https://github.com/philpennock/cdbtools) (in Go)
6742 .endd
6743 A cdb distribution is not needed in order to build Exim with cdb support,
6744 because the code for reading cdb files is included directly in Exim itself.
6745 However, no means of building or testing cdb files is provided with Exim, so
6746 you need to obtain a cdb distribution in order to do this.
6747
6748 .subsection dbm
6749 .cindex "DBM" "lookup type"
6750 .cindex "lookup" "dbm"
6751 .cindex "binary zero" "in lookup key"
6752 Calls to DBM library functions are used to extract data from the given
6753 DBM file by looking up the record with the given key. A terminating binary
6754 zero is included in the key that is passed to the DBM library. See section
6755 &<<SECTdb>>& for a discussion of DBM libraries.
6756
6757 .cindex "Berkeley DB library" "file format"
6758 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6759 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6760 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6761 the DB_UNKNOWN option. This enables it to handle any of the types of database
6762 that the library supports, and can be useful for accessing DBM files created by
6763 other applications. (For earlier DB versions, DB_HASH is always used.)
6764
6765 .subsection dbmjz
6766 .cindex "lookup" "dbmjz"
6767 .cindex "lookup" "dbm &-- embedded NULs"
6768 .cindex "sasldb2"
6769 .cindex "dbmjz lookup type"
6770 This is the same as &(dbm)&, except that the lookup key is
6771 interpreted as an Exim list; the elements of the list are joined together with
6772 ASCII NUL characters to form the lookup key.  An example usage would be to
6773 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6774 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6775 &(cram_md5)& authenticator.
6776
6777 .subsection dbmnz
6778 .cindex "lookup" "dbmnz"
6779 .cindex "lookup" "dbm &-- terminating zero"
6780 .cindex "binary zero" "in lookup key"
6781 .cindex "Courier"
6782 .cindex "&_/etc/userdbshadow.dat_&"
6783 .cindex "dbmnz lookup type"
6784 This is the same as &(dbm)&, except that a terminating binary zero
6785 is not included in the key that is passed to the DBM library. You may need this
6786 if you want to look up data in files that are created by or shared with some
6787 other application that does not use terminating zeros. For example, you need to
6788 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6789 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6790 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6791 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6792
6793 .subsection dsearch
6794 .cindex "lookup" "dsearch"
6795 .cindex "dsearch lookup type"
6796 The given file must be an absolute directory path; this is searched for an entry
6797 whose name is the key by calling the &[lstat()]& function.
6798 The key may not contain any forward slash characters.
6799 If &[lstat()]& succeeds then so does the lookup.
6800 .cindex "tainted data" "dsearch result"
6801 The result is regarded as untainted.
6802
6803 Options for the lookup can be given by appending them after the word "dsearch",
6804 separated by a comma.  Options, if present, are a comma-separated list having
6805 each element starting with a tag name and an equals.
6806
6807 Two options are supported, for the return value and for filtering match
6808 candidates.
6809 The "ret" option requests an alternate result value of
6810 the entire path for the entry. Example:
6811 .code
6812 ${lookup {passwd} dsearch,ret=full {/etc}}
6813 .endd
6814 The default result is just the requested entry.
6815 The "filter" option requests that only directory entries of a given type
6816 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6817 not matching "." or ".."). Example:
6818 .code
6819 ${lookup {passwd} dsearch,filter=file {/etc}}
6820 .endd
6821 The default matching is for any entry type, including directories
6822 and symlinks.
6823
6824 An example of how this
6825 lookup can be used to support virtual domains is given in section
6826 &<<SECTvirtualdomains>>&.
6827
6828 .subsection iplsearch
6829 .cindex "lookup" "iplsearch"
6830 .cindex "iplsearch lookup type"
6831 The given file is a text file containing keys and data. A key is
6832 terminated by a colon or white space or the end of the line. The keys in the
6833 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6834 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6835 being interpreted as a key terminator. For example:
6836 .code
6837 1.2.3.4:           data for 1.2.3.4
6838 192.168.0.0/16:    data for 192.168.0.0/16
6839 "abcd::cdab":      data for abcd::cdab
6840 "abcd:abcd::/32"   data for abcd:abcd::/32
6841 .endd
6842 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6843 file is searched linearly, using the CIDR masks where present, until a matching
6844 key is found. The first key that matches is used; there is no attempt to find a
6845 &"best"& match. Apart from the way the keys are matched, the processing for
6846 &(iplsearch)& is the same as for &(lsearch)&.
6847
6848 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6849 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6850 lookup types support only literal keys.
6851
6852 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6853 the implicit key is the host's IP address rather than its name (see section
6854 &<<SECThoslispatsikey>>&).
6855
6856 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6857 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6858 notation before executing the lookup.)
6859
6860 One option is supported, "ret=full", to request the return of the entire line
6861 rather than omitting the key portion.
6862 Note however that the key portion will have been de-quoted.
6863
6864 .subsection json
6865 .cindex lookup json
6866 .cindex json "lookup type"
6867 .cindex JSON expansions
6868 The given file is a text file with a JSON structure.
6869 An element of the structure is extracted, defined by the search key.
6870 The key is a list of subelement selectors
6871 (colon-separated by default but changeable in the usual way)
6872 which are applied in turn to select smaller and smaller portions
6873 of the JSON structure.
6874 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6875 nunbered array element is selected.
6876 Otherwise it must apply to a JSON object; the named element is selected.
6877 The final resulting element can be a simple JSON type or a JSON object
6878 or array; for the latter two a string-representation of the JSON
6879 is returned.
6880 For elements of type string, the returned value is de-quoted.
6881
6882
6883 .subsection lmdb
6884 .cindex LMDB
6885 .cindex lookup lmdb
6886 .cindex database lmdb
6887 The given file is an LMDB database.
6888 LMDB is a memory-mapped key-value store,
6889 with API modeled loosely on that of BerkeleyDB.
6890 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6891 for the feature set and operation modes.
6892
6893 Exim provides read-only access via the LMDB C library.
6894 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6895 or your operating system package repository.
6896 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6897
6898 You will need to separately create the LMDB database file,
6899 possibly using the &"mdb_load"& utility.
6900
6901
6902 .subsection lsearch
6903 .cindex "linear search"
6904 .cindex "lookup" "lsearch"
6905 .cindex "lsearch lookup type"
6906 .cindex "case sensitivity" "in lsearch lookup"
6907 The given file is a text file that is searched linearly for a
6908 line beginning with the search key, terminated by a colon or white space or the
6909 end of the line. The search is case-insensitive; that is, upper and lower case
6910 letters are treated as the same. The first occurrence of the key that is found
6911 in the file is used.
6912
6913 White space between the key and the colon is permitted. The remainder of the
6914 line, with leading and trailing white space removed, is the data. This can be
6915 continued onto subsequent lines by starting them with any amount of white
6916 space, but only a single space character is included in the data at such a
6917 junction. If the data begins with a colon, the key must be terminated by a
6918 colon, for example:
6919 .code
6920 baduser:  :fail:
6921 .endd
6922 Empty lines and lines beginning with # are ignored, even if they occur in the
6923 middle of an item. This is the traditional textual format of alias files. Note
6924 that the keys in an &(lsearch)& file are literal strings. There is no
6925 wildcarding of any kind.
6926
6927 .cindex "lookup" "lsearch &-- colons in keys"
6928 .cindex "white space" "in lsearch key"
6929 In most &(lsearch)& files, keys are not required to contain colons or #
6930 characters, or white space. However, if you need this feature, it is available.
6931 If a key begins with a doublequote character, it is terminated only by a
6932 matching quote (or end of line), and the normal escaping rules apply to its
6933 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6934 quoted keys (exactly as for unquoted keys). There is no special handling of
6935 quotes for the data part of an &(lsearch)& line.
6936
6937 .subsection nis
6938 .cindex "NIS lookup type"
6939 .cindex "lookup" "NIS"
6940 .cindex "binary zero" "in lookup key"
6941 The given file is the name of a NIS map, and a NIS lookup is done with
6942 the given key, without a terminating binary zero. There is a variant called
6943 &(nis0)& which does include the terminating binary zero in the key. This is
6944 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6945 aliases; the full map names must be used.
6946
6947 .subsection (n)wildlsearch
6948 .cindex "wildlsearch lookup type"
6949 .cindex "lookup" "wildlsearch"
6950 .cindex "nwildlsearch lookup type"
6951 .cindex "lookup" "nwildlsearch"
6952 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6953 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6954 the file may be wildcarded. The difference between these two lookup types is
6955 that for &(wildlsearch)&, each key in the file is string-expanded before being
6956 used, whereas for &(nwildlsearch)&, no expansion takes place.
6957
6958 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6959 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6960 file that are regular expressions can be made case-sensitive by the use of
6961 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6962
6963 .olist
6964 The string may begin with an asterisk to mean &"ends with"&. For example:
6965 .code
6966 *.a.b.c       data for anything.a.b.c
6967 *fish         data for anythingfish
6968 .endd
6969 .next
6970 The string may begin with a circumflex to indicate a regular expression. For
6971 example, for &(wildlsearch)&:
6972 .code
6973 ^\N\d+\.a\.b\N    data for <digits>.a.b
6974 .endd
6975 Note the use of &`\N`& to disable expansion of the contents of the regular
6976 expression. If you are using &(nwildlsearch)&, where the keys are not
6977 string-expanded, the equivalent entry is:
6978 .code
6979 ^\d+\.a\.b        data for <digits>.a.b
6980 .endd
6981 The case-insensitive flag is set at the start of compiling the regular
6982 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6983 For example, to make the entire pattern case-sensitive:
6984 .code
6985 ^(?-i)\d+\.a\.b        data for <digits>.a.b
6986 .endd
6987
6988 If the regular expression contains white space or colon characters, you must
6989 either quote it (see &(lsearch)& above), or represent these characters in other
6990 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6991 colon. This may be easier than quoting, because if you quote, you have to
6992 escape all the backslashes inside the quotes.
6993
6994 &*Note*&: It is not possible to capture substrings in a regular expression
6995 match for later use, because the results of all lookups are cached. If a lookup
6996 is repeated, the result is taken from the cache, and no actual pattern matching
6997 takes place. The values of all the numeric variables are unset after a
6998 &((n)wildlsearch)& match.
6999
7000 .next
7001 Although I cannot see it being of much use, the general matching function that
7002 is used to implement &((n)wildlsearch)& means that the string may begin with a
7003 lookup name terminated by a semicolon, and followed by lookup data. For
7004 example:
7005 .code
7006 cdb;/some/file  data for keys that match the file
7007 .endd
7008 The data that is obtained from the nested lookup is discarded.
7009 .endlist olist
7010
7011 Keys that do not match any of these patterns are interpreted literally. The
7012 continuation rules for the data are the same as for &(lsearch)&, and keys may
7013 be followed by optional colons.
7014
7015 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7016 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7017 lookup types support only literal keys.
7018
7019 .subsection spf
7020 .cindex "spf lookup type"
7021 .cindex "lookup" "spf"
7022 If Exim is built with SPF support, manual lookups can be done
7023 (as opposed to the standard ACL condition method).
7024 For details see section &<<SECSPF>>&.
7025
7026
7027 .section "Query-style lookup types" "SECTquerystylelookups"
7028 .cindex "lookup" "query-style types"
7029 .cindex "query-style lookup" "list of types"
7030 The supported query-style lookup types are listed below. Further details about
7031 many of them are given in later sections.
7032
7033 .subsection dnsdb
7034 .cindex "DNS" "as a lookup type"
7035 .cindex "lookup" "DNS"
7036 This does a DNS search for one or more records whose domain names
7037 are given in the supplied query. The resulting data is the contents of the
7038 records. See section &<<SECTdnsdb>>&.
7039
7040 .subsection ibase
7041 .cindex "InterBase lookup type"
7042 .cindex "lookup" "InterBase"
7043 This does a lookup in an InterBase database.
7044
7045 .subsection ldap
7046 .cindex "LDAP" "lookup type"
7047 .cindex "lookup" "LDAP"
7048 This does an LDAP lookup using a query in the form of a URL, and
7049 returns attributes from a single entry. There is a variant called &(ldapm)&
7050 that permits values from multiple entries to be returned. A third variant
7051 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7052 any attribute values. See section &<<SECTldap>>&.
7053
7054 .subsection mysql
7055 .cindex "MySQL" "lookup type"
7056 .cindex "lookup" "MySQL"
7057 The format of the query is an SQL statement that is passed to a
7058 MySQL database. See section &<<SECTsql>>&.
7059
7060 .subsection nisplus
7061 .cindex "NIS+ lookup type"
7062 .cindex "lookup" "NIS+"
7063 This does a NIS+ lookup using a query that can specify the name of
7064 the field to be returned. See section &<<SECTnisplus>>&.
7065
7066 .subsection oracle
7067 .cindex "Oracle" "lookup type"
7068 .cindex "lookup" "Oracle"
7069 The format of the query is an SQL statement that is passed to an
7070 Oracle database. See section &<<SECTsql>>&.
7071
7072 .subsection passwd
7073 .cindex "lookup" "passwd"
7074 .cindex "passwd lookup type"
7075 .cindex "&_/etc/passwd_&"
7076 This is a query-style lookup with queries that are just user names. The
7077 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7078 success, the result string is the same as you would get from an &(lsearch)&
7079 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7080 password value. For example:
7081 .code
7082 *:42:42:King Rat:/home/kr:/bin/bash
7083 .endd
7084
7085 .subsection pgsql
7086 .cindex "PostgreSQL lookup type"
7087 .cindex "lookup" "PostgreSQL"
7088 The format of the query is an SQL statement that is passed to a
7089 PostgreSQL database. See section &<<SECTsql>>&.
7090
7091 .subsection redis
7092 .cindex "Redis lookup type"
7093 .cindex lookup Redis
7094 The format of the query is either a simple get or simple set,
7095 passed to a Redis database. See section &<<SECTsql>>&.
7096
7097 .subsection sqlite
7098 .cindex "sqlite lookup type"
7099 .cindex "lookup" "sqlite"
7100 The format of the query is
7101 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7102
7103 .subsection testdb
7104 This is a lookup type that is used for testing Exim. It is
7105 not likely to be useful in normal operation.
7106
7107 .subsection whoson
7108 .cindex "whoson lookup type"
7109 .cindex "lookup" "whoson"
7110 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7111 allows a server to check whether a particular (dynamically allocated) IP
7112 address is currently allocated to a known (trusted) user and, optionally, to
7113 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7114 at one time for &"POP before SMTP"& authentication, but that approach has been
7115 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7116 &"POP before SMTP"& checking using ACL statements such as
7117 .code
7118 require condition = \
7119   ${lookup whoson {$sender_host_address}{yes}{no}}
7120 .endd
7121 The query consists of a single IP address. The value returned is the name of
7122 the authenticated user, which is stored in the variable &$value$&. However, in
7123 this example, the data in &$value$& is not used; the result of the lookup is
7124 one of the fixed strings &"yes"& or &"no"&.
7125
7126
7127
7128 .section "Temporary errors in lookups" "SECID63"
7129 .cindex "lookup" "temporary error in"
7130 Lookup functions can return temporary error codes if the lookup cannot be
7131 completed. For example, an SQL or LDAP database might be unavailable. For this
7132 reason, it is not advisable to use a lookup that might do this for critical
7133 options such as a list of local domains.
7134
7135 When a lookup cannot be completed in a router or transport, delivery
7136 of the message (to the relevant address) is deferred, as for any other
7137 temporary error. In other circumstances Exim may assume the lookup has failed,
7138 or may give up altogether.
7139
7140
7141
7142 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7143 .cindex "wildcard lookups"
7144 .cindex "lookup" "default values"
7145 .cindex "lookup" "wildcard"
7146 .cindex "lookup" "* added to type"
7147 .cindex "default" "in single-key lookups"
7148 In this context, a &"default value"& is a value specified by the administrator
7149 that is to be used if a lookup fails.
7150
7151 &*Note:*& This section applies only to single-key lookups. For query-style
7152 lookups, the facilities of the query language must be used. An attempt to
7153 specify a default for a query-style lookup provokes an error.
7154
7155 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7156 and the initial lookup fails, the key &"*"& is looked up in the file to
7157 provide a default value. See also the section on partial matching below.
7158
7159 .cindex "*@ with single-key lookup"
7160 .cindex "lookup" "*@ added to type"
7161 .cindex "alias file" "per-domain default"
7162 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7163 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7164 character, a second lookup is done with everything before the last @ replaced
7165 by *. This makes it possible to provide per-domain defaults in alias files
7166 that include the domains in the keys. If the second lookup fails (or doesn't
7167 take place because there is no @ in the key), &"*"& is looked up.
7168 For example, a &(redirect)& router might contain:
7169 .code
7170 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7171 .endd
7172 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7173 looks up these keys, in this order:
7174 .code
7175 jane@eyre.example
7176 *@eyre.example
7177 *
7178 .endd
7179 The data is taken from whichever key it finds first. &*Note*&: In an
7180 &(lsearch)& file, this does not mean the first of these keys in the file. A
7181 complete scan is done for each key, and only if it is not found at all does
7182 Exim move on to try the next key.
7183
7184
7185
7186 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7187 .cindex "partial matching"
7188 .cindex "wildcard lookups"
7189 .cindex "lookup" "partial matching"
7190 .cindex "lookup" "wildcard"
7191 .cindex "asterisk" "in search type"
7192 The normal operation of a single-key lookup is to search the file for an exact
7193 match with the given key. However, in a number of situations where domains are
7194 being looked up, it is useful to be able to do partial matching. In this case,
7195 information in the file that has a key starting with &"*."& is matched by any
7196 domain that ends with the components that follow the full stop. For example, if
7197 a key in a DBM file is
7198 .code
7199 *.dates.fict.example
7200 .endd
7201 then when partial matching is enabled this is matched by (amongst others)
7202 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7203 by &'dates.fict.example'&, if that does not appear as a separate key in the
7204 file.
7205
7206 &*Note*&: Partial matching is not available for query-style lookups. It is
7207 also not available for any lookup items in address lists (see section
7208 &<<SECTaddresslist>>&).
7209
7210 Partial matching is implemented by doing a series of separate lookups using
7211 keys constructed by modifying the original subject key. This means that it can
7212 be used with any of the single-key lookup types, provided that
7213 partial matching keys
7214 beginning with a special prefix (default &"*."&) are included in the data file.
7215 Keys in the file that do not begin with the prefix are matched only by
7216 unmodified subject keys when partial matching is in use.
7217
7218 Partial matching is requested by adding the string &"partial-"& to the front of
7219 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7220 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7221 is added at the start of the subject key, and it is looked up again. If that
7222 fails, further lookups are tried with dot-separated components removed from the
7223 start of the subject key, one-by-one, and &"*."& added on the front of what
7224 remains.
7225
7226 A minimum number of two non-* components are required. This can be adjusted
7227 by including a number before the hyphen in the search type. For example,
7228 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7229 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7230 subject key is &'2250.dates.fict.example'& then the following keys are looked
7231 up when the minimum number of non-* components is two:
7232 .code
7233 2250.dates.fict.example
7234 *.2250.dates.fict.example
7235 *.dates.fict.example
7236 *.fict.example
7237 .endd
7238 As soon as one key in the sequence is successfully looked up, the lookup
7239 finishes.
7240
7241 .cindex "lookup" "partial matching &-- changing prefix"
7242 .cindex "prefix" "for partial matching"
7243 The use of &"*."& as the partial matching prefix is a default that can be
7244 changed. The motivation for this feature is to allow Exim to operate with file
7245 formats that are used by other MTAs. A different prefix can be supplied in
7246 parentheses instead of the hyphen after &"partial"&. For example:
7247 .code
7248 domains = partial(.)lsearch;/some/file
7249 .endd
7250 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7251 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7252 components is unchanged). The prefix may consist of any punctuation characters
7253 other than a closing parenthesis. It may be empty, for example:
7254 .code
7255 domains = partial1()cdb;/some/file
7256 .endd
7257 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7258 &`a.b.c`&, &`b.c`&, and &`c`&.
7259
7260 If &"partial0"& is specified, what happens at the end (when the lookup with
7261 just one non-wild component has failed, and the original key is shortened right
7262 down to the null string) depends on the prefix:
7263
7264 .ilist
7265 If the prefix has zero length, the whole lookup fails.
7266 .next
7267 If the prefix has length 1, a lookup for just the prefix is done. For
7268 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7269 .next
7270 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7271 remainder is looked up. With the default prefix, therefore, the final lookup is
7272 for &"*"& on its own.
7273 .next
7274 Otherwise, the whole prefix is looked up.
7275 .endlist
7276
7277
7278 If the search type ends in &"*"& or &"*@"& (see section
7279 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7280 this implies happens after all partial lookups have failed. If &"partial0"& is
7281 specified, adding &"*"& to the search type has no effect with the default
7282 prefix, because the &"*"& key is already included in the sequence of partial
7283 lookups. However, there might be a use for lookup types such as
7284 &"partial0(.)lsearch*"&.
7285
7286 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7287 in domain lists and the like. Partial matching works only in terms of
7288 dot-separated components; a key such as &`*fict.example`&
7289 in a database file is useless, because the asterisk in a partial matching
7290 subject key is always followed by a dot.
7291
7292
7293
7294
7295 .section "Lookup caching" "SECID64"
7296 .cindex "lookup" "caching"
7297 .cindex "caching" "lookup data"
7298 Exim caches all lookup results in order to avoid needless repetition of
7299 lookups. However, because (apart from the daemon) Exim operates as a collection
7300 of independent, short-lived processes, this caching applies only within a
7301 single Exim process. There is no inter-process lookup caching facility.
7302
7303 If an option &"cache=no_rd"& is used on the lookup then
7304 the cache is only written to, cached data is not used for the operation
7305 and a real lookup is done.
7306
7307 For single-key lookups, Exim keeps the relevant files open in case there is
7308 another lookup that needs them. In some types of configuration this can lead to
7309 many files being kept open for messages with many recipients. To avoid hitting
7310 the operating system limit on the number of simultaneously open files, Exim
7311 closes the least recently used file when it needs to open more files than its
7312 own internal limit, which can be changed via the &%lookup_open_max%& option.
7313
7314 The single-key lookup files are closed and the lookup caches are flushed at
7315 strategic points during delivery &-- for example, after all routing is
7316 complete.
7317
7318
7319
7320
7321 .section "Quoting lookup data" "SECID65"
7322 .cindex "lookup" "quoting"
7323 .cindex "quoting" "in lookups"
7324 When data from an incoming message is included in a query-style lookup, there
7325 is the possibility of special characters in the data messing up the syntax of
7326 the query. For example, a NIS+ query that contains
7327 .code
7328 [name=$local_part]
7329 .endd
7330 will be broken if the local part happens to contain a closing square bracket.
7331 For NIS+, data can be enclosed in double quotes like this:
7332 .code
7333 [name="$local_part"]
7334 .endd
7335 but this still leaves the problem of a double quote in the data. The rule for
7336 NIS+ is that double quotes must be doubled. Other lookup types have different
7337 rules, and to cope with the differing requirements, an expansion operator
7338 of the following form is provided:
7339 .code
7340 ${quote_<lookup-type>:<string>}
7341 .endd
7342 For example, the safest way to write the NIS+ query is
7343 .code
7344 [name="${quote_nisplus:$local_part}"]
7345 .endd
7346 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7347 operator can be used for all lookup types, but has no effect for single-key
7348 lookups, since no quoting is ever needed in their key strings.
7349
7350
7351
7352
7353 .section "More about dnsdb" "SECTdnsdb"
7354 .cindex "dnsdb lookup"
7355 .cindex "lookup" "dnsdb"
7356 .cindex "DNS" "as a lookup type"
7357 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7358 of a record type and a domain name, separated by an equals sign. For example,
7359 an expansion string could contain:
7360 .code
7361 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7362 .endd
7363 If the lookup succeeds, the result is placed in &$value$&, which in this case
7364 is used on its own as the result. If the lookup does not succeed, the
7365 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7366 &<<SECTforexpfai>>& for an explanation of what this means.
7367
7368 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7369 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7370 If no type is given, TXT is assumed.
7371
7372 For any record type, if multiple records are found, the data is returned as a
7373 concatenation, with newline as the default separator. The order, of course,
7374 depends on the DNS resolver. You can specify a different separator character
7375 between multiple records by putting a right angle-bracket followed immediately
7376 by the new separator at the start of the query. For example:
7377 .code
7378 ${lookup dnsdb{>: a=host1.example}}
7379 .endd
7380 It is permitted to specify a space as the separator character. Further
7381 white space is ignored.
7382 For lookup types that return multiple fields per record,
7383 an alternate field separator can be specified using a comma after the main
7384 separator character, followed immediately by the field separator.
7385
7386 .cindex "PTR record" "in &(dnsdb)& lookup"
7387 When the type is PTR,
7388 the data can be an IP address, written as normal; inversion and the addition of
7389 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7390 .code
7391 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7392 .endd
7393 If the data for a PTR record is not a syntactically valid IP address, it is not
7394 altered and nothing is added.
7395
7396 .cindex "MX record" "in &(dnsdb)& lookup"
7397 .cindex "SRV record" "in &(dnsdb)& lookup"
7398 For an MX lookup, both the preference value and the host name are returned for
7399 each record, separated by a space. For an SRV lookup, the priority, weight,
7400 port, and host name are returned for each record, separated by spaces.
7401 The field separator can be modified as above.
7402
7403 .cindex "TXT record" "in &(dnsdb)& lookup"
7404 .cindex "SPF record" "in &(dnsdb)& lookup"
7405 For TXT records with multiple items of data, only the first item is returned,
7406 unless a field separator is specified.
7407 To concatenate items without a separator, use a semicolon instead.
7408 For SPF records the
7409 default behaviour is to concatenate multiple items without using a separator.
7410 .code
7411 ${lookup dnsdb{>\n,: txt=a.b.example}}
7412 ${lookup dnsdb{>\n; txt=a.b.example}}
7413 ${lookup dnsdb{spf=example.org}}
7414 .endd
7415 It is permitted to specify a space as the separator character. Further
7416 white space is ignored.
7417
7418 .cindex "SOA record" "in &(dnsdb)& lookup"
7419 For an SOA lookup, while no result is obtained the lookup is redone with
7420 successively more leading components dropped from the given domain.
7421 Only the primary-nameserver field is returned unless a field separator is
7422 specified.
7423 .code
7424 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7425 .endd
7426
7427 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7428 .cindex "dnsdb modifiers"
7429 .cindex "modifiers" "dnsdb"
7430 .cindex "options" "dnsdb"
7431 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7432 each followed by a comma,
7433 that may appear before the record type.
7434
7435 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7436 temporary DNS error for any of them, the behaviour is controlled by
7437 a defer-option modifier.
7438 The possible keywords are
7439 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7440 With &"strict"& behaviour, any temporary DNS error causes the
7441 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7442 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7443 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7444 error causes the whole lookup to defer only if none of the other lookups
7445 succeed. The default is &"lax"&, so the following lookups are equivalent:
7446 .code
7447 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7448 ${lookup dnsdb{a=one.host.com:two.host.com}}
7449 .endd
7450 Thus, in the default case, as long as at least one of the DNS lookups
7451 yields some data, the lookup succeeds.
7452
7453 .cindex "DNSSEC" "dns lookup"
7454 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7455 The possible keywords are
7456 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7457 With &"strict"& or &"lax"& DNSSEC information is requested
7458 with the lookup.
7459 With &"strict"& a response from the DNS resolver that
7460 is not labelled as authenticated data
7461 is treated as equivalent to a temporary DNS error.
7462 The default is &"lax"&.
7463
7464 See also the &$lookup_dnssec_authenticated$& variable.
7465
7466 .cindex timeout "dns lookup"
7467 .cindex "DNS" timeout
7468 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7469 The form is &"retrans_VAL"& where VAL is an Exim time specification
7470 (e.g. &"5s"&).
7471 The default value is set by the main configuration option &%dns_retrans%&.
7472
7473 Retries for the dnsdb lookup can be controlled by a retry modifier.
7474 The form if &"retry_VAL"& where VAL is an integer.
7475 The default count is set by the main configuration option &%dns_retry%&.
7476
7477 .cindex caching "of dns lookup"
7478 .cindex TTL "of dns lookup"
7479 .cindex DNS TTL
7480 Dnsdb lookup results are cached within a single process (and its children).
7481 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7482 value of the set of returned DNS records.
7483
7484
7485 .subsection "Pseudo dnsdb record types" SECID66
7486 .cindex "MX record" "in &(dnsdb)& lookup"
7487 By default, both the preference value and the host name are returned for
7488 each MX record, separated by a space. If you want only host names, you can use
7489 the pseudo-type MXH:
7490 .code
7491 ${lookup dnsdb{mxh=a.b.example}}
7492 .endd
7493 In this case, the preference values are omitted, and just the host names are
7494 returned.
7495
7496 .cindex "name server for enclosing domain"
7497 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7498 records on the given domain, but if none are found, it removes the first
7499 component of the domain name, and tries again. This process continues until NS
7500 records are found or there are no more components left (or there is a DNS
7501 error). In other words, it may return the name servers for a top-level domain,
7502 but it never returns the root name servers. If there are no NS records for the
7503 top-level domain, the lookup fails. Consider these examples:
7504 .code
7505 ${lookup dnsdb{zns=xxx.quercite.com}}
7506 ${lookup dnsdb{zns=xxx.edu}}
7507 .endd
7508 Assuming that in each case there are no NS records for the full domain name,
7509 the first returns the name servers for &%quercite.com%&, and the second returns
7510 the name servers for &%edu%&.
7511
7512 You should be careful about how you use this lookup because, unless the
7513 top-level domain does not exist, the lookup always returns some host names. The
7514 sort of use to which this might be put is for seeing if the name servers for a
7515 given domain are on a blacklist. You can probably assume that the name servers
7516 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7517 such a list.
7518
7519 .cindex "CSA" "in &(dnsdb)& lookup"
7520 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7521 records according to the CSA rules, which are described in section
7522 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7523 not sufficient because of the extra parent domain search behaviour of CSA. The
7524 result of a successful lookup such as:
7525 .code
7526 ${lookup dnsdb {csa=$sender_helo_name}}
7527 .endd
7528 has two space-separated fields: an authorization code and a target host name.
7529 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7530 authorization required but absent, or &"?"& for unknown.
7531
7532 .cindex "A+" "in &(dnsdb)& lookup"
7533 The pseudo-type A+ performs an AAAA
7534 and then an A lookup.  All results are returned; defer processing
7535 (see below) is handled separately for each lookup.  Example:
7536 .code
7537 ${lookup dnsdb {>; a+=$sender_helo_name}}
7538 .endd
7539
7540
7541 .subsection "Multiple dnsdb lookups" SECID67
7542 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7543 However, you can specify a list of domains or IP addresses in a single
7544 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7545 the default separator, but with the ability to change this. For example:
7546 .code
7547 ${lookup dnsdb{one.domain.com:two.domain.com}}
7548 ${lookup dnsdb{a=one.host.com:two.host.com}}
7549 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7550 .endd
7551 In order to retain backwards compatibility, there is one special case: if
7552 the lookup type is PTR and no change of separator is specified, Exim looks
7553 to see if the rest of the string is precisely one IPv6 address. In this
7554 case, it does not treat it as a list.
7555
7556 The data from each lookup is concatenated, with newline separators by default,
7557 in the same way that multiple DNS records for a single item are handled. A
7558 different separator can be specified, as described above.
7559
7560
7561
7562
7563 .section "More about LDAP" "SECTldap"
7564 .cindex "LDAP" "lookup, more about"
7565 .cindex "lookup" "LDAP"
7566 .cindex "Solaris" "LDAP"
7567 The original LDAP implementation came from the University of Michigan; this has
7568 become &"Open LDAP"&, and there are now two different releases. Another
7569 implementation comes from Netscape, and Solaris 7 and subsequent releases
7570 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7571 the lookup function level, their error handling is different. For this reason
7572 it is necessary to set a compile-time variable when building Exim with LDAP, to
7573 indicate which LDAP library is in use. One of the following should appear in
7574 your &_Local/Makefile_&:
7575 .code
7576 LDAP_LIB_TYPE=UMICHIGAN
7577 LDAP_LIB_TYPE=OPENLDAP1
7578 LDAP_LIB_TYPE=OPENLDAP2
7579 LDAP_LIB_TYPE=NETSCAPE
7580 LDAP_LIB_TYPE=SOLARIS
7581 .endd
7582 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7583 same interface as the University of Michigan version.
7584
7585 There are three LDAP lookup types in Exim. These behave slightly differently in
7586 the way they handle the results of a query:
7587
7588 .ilist
7589 &(ldap)& requires the result to contain just one entry; if there are more, it
7590 gives an error.
7591 .next
7592 &(ldapdn)& also requires the result to contain just one entry, but it is the
7593 Distinguished Name that is returned rather than any attribute values.
7594 .next
7595 &(ldapm)& permits the result to contain more than one entry; the attributes
7596 from all of them are returned.
7597 .endlist
7598
7599
7600 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7601 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7602 the data returned by a successful lookup is described in the next section.
7603 First we explain how LDAP queries are coded.
7604
7605
7606 .subsection "Format of LDAP queries" SECTforldaque
7607 .cindex "LDAP" "query format"
7608 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7609 the configuration of a &(redirect)& router one might have this setting:
7610 .code
7611 data = ${lookup ldap \
7612   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7613   c=UK?mailbox?base?}}
7614 .endd
7615 .cindex "LDAP" "with TLS"
7616 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7617 secure (encrypted) LDAP connections. The second of these ensures that an
7618 encrypted TLS connection is used.
7619
7620 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7621 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7622 See the &%ldap_start_tls%& option.
7623
7624 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7625 controlled. Every part of the TLS configuration can be configured by settings in
7626 &_exim.conf_&. Depending on the version of the client libraries installed on
7627 your system, some of the initialization may have required setting options in
7628 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7629 certificates. This revealed a nuance where the current UID that exim was
7630 running as could affect which config files it read. With Exim 4.83, these
7631 methods become optional, only taking effect if not specifically set in
7632 &_exim.conf_&.
7633
7634
7635 .subsection "LDAP quoting" SECID68
7636 .cindex "LDAP" "quoting"
7637 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7638 and the second because the LDAP query is represented as a URL. Furthermore,
7639 within an LDAP query, two different kinds of quoting are required. For this
7640 reason, there are two different LDAP-specific quoting operators.
7641
7642 The &%quote_ldap%& operator is designed for use on strings that are part of
7643 filter specifications. Conceptually, it first does the following conversions on
7644 the string:
7645 .code
7646 *   =>   \2A
7647 (   =>   \28
7648 )   =>   \29
7649 \   =>   \5C
7650 .endd
7651 in accordance with RFC 2254. The resulting string is then quoted according
7652 to the rules for URLs, that is, all non-alphanumeric characters except
7653 .code
7654 ! $ ' - . _ ( ) * +
7655 .endd
7656 are converted to their hex values, preceded by a percent sign. For example:
7657 .code
7658 ${quote_ldap: a(bc)*, a<yz>; }
7659 .endd
7660 yields
7661 .code
7662 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7663 .endd
7664 Removing the URL quoting, this is (with a leading and a trailing space):
7665 .code
7666 a\28bc\29\2A, a<yz>;
7667 .endd
7668 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7669 base DN specifications in queries. Conceptually, it first converts the string
7670 by inserting a backslash in front of any of the following characters:
7671 .code
7672 , + " \ < > ;
7673 .endd
7674 It also inserts a backslash before any leading spaces or # characters, and
7675 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7676 is then quoted according to the rules for URLs. For example:
7677 .code
7678 ${quote_ldap_dn: a(bc)*, a<yz>; }
7679 .endd
7680 yields
7681 .code
7682 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7683 .endd
7684 Removing the URL quoting, this is (with a trailing space):
7685 .code
7686 \ a(bc)*\, a\<yz\>\;\
7687 .endd
7688 There are some further comments about quoting in the section on LDAP
7689 authentication below.
7690
7691
7692 .subsection "LDAP connections" SECID69
7693 .cindex "LDAP" "connections"
7694 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7695 is in use, via a Unix domain socket. The example given above does not specify
7696 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7697 by starting it with
7698 .code
7699 ldap://<hostname>:<port>/...
7700 .endd
7701 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7702 used. When no server is specified in a query, a list of default servers is
7703 taken from the &%ldap_default_servers%& configuration option. This supplies a
7704 colon-separated list of servers which are tried in turn until one successfully
7705 handles a query, or there is a serious error. Successful handling either
7706 returns the requested data, or indicates that it does not exist. Serious errors
7707 are syntactical, or multiple values when only a single value is expected.
7708 Errors which cause the next server to be tried are connection failures, bind
7709 failures, and timeouts.
7710
7711 For each server name in the list, a port number can be given. The standard way
7712 of specifying a host and port is to use a colon separator (RFC 1738). Because
7713 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7714 doubled. For example
7715 .code
7716 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7717 .endd
7718 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7719 to the LDAP library with no server name, and the library's default (normally
7720 the local host) is used.
7721
7722 If you are using the OpenLDAP library, you can connect to an LDAP server using
7723 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7724 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7725 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7726 not available.
7727
7728 For this type of connection, instead of a host name for the server, a pathname
7729 for the socket is required, and the port number is not relevant. The pathname
7730 can be specified either as an item in &%ldap_default_servers%&, or inline in
7731 the query. In the former case, you can have settings such as
7732 .code
7733 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7734 .endd
7735 When the pathname is given in the query, you have to escape the slashes as
7736 &`%2F`& to fit in with the LDAP URL syntax. For example:
7737 .code
7738 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7739 .endd
7740 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7741 a pathname, it uses the Unix domain socket code, even if the query actually
7742 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7743 socket connection. This behaviour means that you can use a setting of
7744 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7745 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7746 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7747 backup host.
7748
7749 If an explicit &`ldapi`& type is given in a query when a host name is
7750 specified, an error is diagnosed. However, if there are more items in
7751 &%ldap_default_servers%&, they are tried. In other words:
7752
7753 .ilist
7754 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7755 interface.
7756 .next
7757 Using &`ldapi`& with a host name causes an error.
7758 .endlist
7759
7760
7761 Using &`ldapi`& with no host or path in the query, and no setting of
7762 &%ldap_default_servers%&, does whatever the library does by default.
7763
7764
7765
7766 .subsection "LDAP authentication and control information" SECID70
7767 .cindex "LDAP" "authentication"
7768 The LDAP URL syntax provides no way of passing authentication and other control
7769 information to the server. To make this possible, the URL in an LDAP query may
7770 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7771 spaces. If a value contains spaces it must be enclosed in double quotes, and
7772 when double quotes are used, backslash is interpreted in the usual way inside
7773 them. The following names are recognized:
7774 .itable none 0 0 2 20* left 80* left
7775 .irow DEREFERENCE "set the dereferencing parameter"
7776 .irow NETTIME     "set a timeout for a network operation"
7777 .irow USER        "set the DN, for authenticating the LDAP bind"
7778 .irow PASS        "set the password, likewise"
7779 .irow REFERRALS   "set the referrals parameter"
7780 .irow SERVERS     "set alternate server list for this query only"
7781 .irow SIZE        "set the limit for the number of entries returned"
7782 .irow TIME        "set the maximum waiting time for a query"
7783 .endtable
7784 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7785 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7786 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7787 library from trying to follow referrals issued by the LDAP server.
7788
7789 .cindex LDAP timeout
7790 .cindex timeout "LDAP lookup"
7791 The name CONNECT is an obsolete name for NETTIME, retained for
7792 backwards compatibility. This timeout (specified as a number of seconds) is
7793 enforced from the client end for operations that can be carried out over a
7794 network. Specifically, it applies to network connections and calls to the
7795 &'ldap_result()'& function. If the value is greater than zero, it is used if
7796 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7797 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7798 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7799 Netscape SDK; for OpenLDAP no action is taken.
7800
7801 The TIME parameter (also a number of seconds) is passed to the server to
7802 set a server-side limit on the time taken to complete a search.
7803
7804 The SERVERS parameter allows you to specify an alternate list of ldap servers
7805 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7806 default list of ldap servers, and a single lookup can specify a single ldap
7807 server to use.  But when you need to do a lookup with a list of servers that is
7808 different than the default list (maybe different order, maybe a completely
7809 different set of servers), the SERVERS parameter allows you to specify this
7810 alternate list (colon-separated).
7811
7812 Here is an example of an LDAP query in an Exim lookup that uses some of these
7813 values. This is a single line, folded to fit on the page:
7814 .code
7815 ${lookup ldap
7816   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7817   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7818   {$value}fail}
7819 .endd
7820 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7821 any of the auxiliary data. Exim configuration settings that include lookups
7822 which contain password information should be preceded by &"hide"& to prevent
7823 non-admin users from using the &%-bP%& option to see their values.
7824
7825 The auxiliary data items may be given in any order. The default is no
7826 connection timeout (the system timeout is used), no user or password, no limit
7827 on the number of entries returned, and no time limit on queries.
7828
7829 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7830 removes any URL quoting that it may contain before passing it to the LDAP library.
7831 Apparently
7832 some libraries do this for themselves, but some do not. Removing the URL
7833 quoting has two advantages:
7834
7835 .ilist
7836 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7837 DNs as with DNs inside actual queries.
7838 .next
7839 It permits spaces inside USER= DNs.
7840 .endlist
7841
7842 For example, a setting such as
7843 .code
7844 USER=cn=${quote_ldap_dn:$1}
7845 .endd
7846 should work even if &$1$& contains spaces.
7847
7848 Expanded data for the PASS= value should be quoted using the &%quote%&
7849 expansion operator, rather than the LDAP quote operators. The only reason this
7850 field needs quoting is to ensure that it conforms to the Exim syntax, which
7851 does not allow unquoted spaces. For example:
7852 .code
7853 PASS=${quote:$3}
7854 .endd
7855 The LDAP authentication mechanism can be used to check passwords as part of
7856 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7857 &<<CHAPexpand>>&.
7858
7859
7860
7861 .subsection "Format of data returned by LDAP" SECID71
7862 .cindex "LDAP" "returned data formats"
7863 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7864 as a sequence of values, for example
7865 .code
7866 cn=manager,o=University of Cambridge,c=UK
7867 .endd
7868 The &(ldap)& lookup type generates an error if more than one entry matches the
7869 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7870 the result between the data from different entries. It is possible for multiple
7871 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7872 you know that whatever values are returned all came from a single entry in the
7873 directory.
7874
7875 In the common case where you specify a single attribute in your LDAP query, the
7876 result is not quoted, and does not contain the attribute name. If the attribute
7877 has multiple values, they are separated by commas. Any comma that is
7878 part of an attribute's value is doubled.
7879
7880 If you specify multiple attributes, the result contains space-separated, quoted
7881 strings, each preceded by the attribute name and an equals sign. Within the
7882 quotes, the quote character, backslash, and newline are escaped with
7883 backslashes, and commas are used to separate multiple values for the attribute.
7884 Any commas in attribute values are doubled
7885 (permitting treatment of the values as a comma-separated list).
7886 Apart from the escaping, the string within quotes takes the same form as the
7887 output when a single attribute is requested. Specifying no attributes is the
7888 same as specifying all of an entry's attributes.
7889
7890 Here are some examples of the output format. The first line of each pair is an
7891 LDAP query, and the second is the data that is returned. The attribute called
7892 &%attr1%& has two values, one of them with an embedded comma, whereas
7893 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7894 (they have SUP &%attr%& in their schema definitions).
7895
7896 .code
7897 ldap:///o=base?attr1?sub?(uid=fred)
7898 value1.1,value1,,2
7899
7900 ldap:///o=base?attr2?sub?(uid=fred)
7901 value two
7902
7903 ldap:///o=base?attr?sub?(uid=fred)
7904 value1.1,value1,,2,value two
7905
7906 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7907 attr1="value1.1,value1,,2" attr2="value two"
7908
7909 ldap:///o=base??sub?(uid=fred)
7910 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7911 .endd
7912 You can
7913 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7914 results of LDAP lookups.
7915 The &%extract%& operator in string expansions can be used to pick out
7916 individual fields from data that consists of &'key'&=&'value'& pairs.
7917 The &%listextract%& operator should be used to pick out individual values
7918 of attributes, even when only a single value is expected.
7919 The doubling of embedded commas allows you to use the returned data as a
7920 comma separated list (using the "<," syntax for changing the input list separator).
7921
7922
7923
7924
7925 .section "More about NIS+" "SECTnisplus"
7926 .cindex "NIS+ lookup type"
7927 .cindex "lookup" "NIS+"
7928 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7929 and field name. If this is given, the result of a successful query is the
7930 contents of the named field; otherwise the result consists of a concatenation
7931 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7932 values containing spaces are quoted. For example, the query
7933 .code
7934 [name=mg1456],passwd.org_dir
7935 .endd
7936 might return the string
7937 .code
7938 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7939 home=/home/mg1456 shell=/bin/bash shadow=""
7940 .endd
7941 (split over two lines here to fit on the page), whereas
7942 .code
7943 [name=mg1456],passwd.org_dir:gcos
7944 .endd
7945 would just return
7946 .code
7947 Martin Guerre
7948 .endd
7949 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7950 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7951 operator is to double any quote characters within the text.
7952
7953
7954
7955 .section "SQL lookups" "SECTsql"
7956 .cindex "SQL lookup types"
7957 .cindex "MySQL" "lookup type"
7958 .cindex "PostgreSQL lookup type"
7959 .cindex "lookup" "MySQL"
7960 .cindex "lookup" "PostgreSQL"
7961 .cindex "Oracle" "lookup type"
7962 .cindex "lookup" "Oracle"
7963 .cindex "InterBase lookup type"
7964 .cindex "lookup" "InterBase"
7965 .cindex "Redis lookup type"
7966 .cindex lookup Redis
7967 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7968 and SQLite
7969 databases. Queries for these databases contain SQL statements, so an example
7970 might be
7971 .code
7972 ${lookup mysql{select mailbox from users where id='userx'}\
7973   {$value}fail}
7974 .endd
7975 If the result of the query contains more than one field, the data for each
7976 field in the row is returned, preceded by its name, so the result of
7977 .code
7978 ${lookup pgsql{select home,name from users where id='userx'}\
7979   {$value}}
7980 .endd
7981 might be
7982 .code
7983 home=/home/userx name="Mister X"
7984 .endd
7985 Empty values and values containing spaces are double quoted, with embedded
7986 quotes escaped by a backslash. If the result of the query contains just one
7987 field, the value is passed back verbatim, without a field name, for example:
7988 .code
7989 Mister X
7990 .endd
7991 If the result of the query yields more than one row, it is all concatenated,
7992 with a newline between the data for each row.
7993
7994
7995 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
7996 .cindex "MySQL" "lookup type"
7997 .cindex "PostgreSQL lookup type"
7998 .cindex "lookup" "MySQL"
7999 .cindex "lookup" "PostgreSQL"
8000 .cindex "Oracle" "lookup type"
8001 .cindex "lookup" "Oracle"
8002 .cindex "InterBase lookup type"
8003 .cindex "lookup" "InterBase"
8004 .cindex "Redis lookup type"
8005 .cindex lookup Redis
8006 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8007 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8008 or &%redis_servers%&
8009 option (as appropriate) must be set to a colon-separated list of server
8010 information.
8011 .oindex &%mysql_servers%&
8012 .oindex &%pgsql_servers%&
8013 .oindex &%oracle_servers%&
8014 .oindex &%ibase_servers%&
8015 .oindex &%redis_servers%&
8016 (For MySQL and PostgreSQL, the global option need not be set if all
8017 queries contain their own server information &-- see section
8018 &<<SECTspeserque>>&.)
8019 For all but Redis
8020 each item in the list is a slash-separated list of four
8021 items: host name, database name, user name, and password. In the case of
8022 Oracle, the host name field is used for the &"service name"&, and the database
8023 name field is not used and should be empty. For example:
8024 .code
8025 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8026 .endd
8027 Because password data is sensitive, you should always precede the setting with
8028 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8029 option. Here is an example where two MySQL servers are listed:
8030 .code
8031 hide mysql_servers = localhost/users/root/secret:\
8032                      otherhost/users/root/othersecret
8033 .endd
8034 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8035 because this is a colon-separated list, the colon has to be doubled. For each
8036 query, these parameter groups are tried in order until a connection is made and
8037 a query is successfully processed. The result of a query may be that no data is
8038 found, but that is still a successful query. In other words, the list of
8039 servers provides a backup facility, not a list of different places to look.
8040
8041 For Redis the global option need not be specified if all queries contain their
8042 own server information &-- see section &<<SECTspeserque>>&.
8043 If specified, the option must be set to a colon-separated list of server
8044 information.
8045 Each item in the list is a slash-separated list of three items:
8046 host, database number, and password.
8047 .olist
8048 The host is required and may be either an IPv4 address and optional
8049 port number (separated by a colon, which needs doubling due to the
8050 higher-level list), or a Unix socket pathname enclosed in parentheses
8051 .next
8052 The database number is optional; if present that number is selected in the backend
8053 .next
8054 The password is optional; if present it is used to authenticate to the backend
8055 .endlist
8056
8057 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8058 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8059 respectively, and the characters single-quote, double-quote, and backslash
8060 itself are escaped with backslashes.
8061
8062 The &%quote_redis%& expansion operator
8063 escapes whitespace and backslash characters with a backslash.
8064
8065 .subsection "Specifying the server in the query" SECTspeserque
8066 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8067 it is possible to specify a list of servers with an individual query. This is
8068 done by appending a comma-separated option to the query type:
8069 .display
8070 &`,servers=`&&'server1:server2:server3:...'&
8071 .endd
8072 Each item in the list may take one of two forms:
8073 .olist
8074 If it contains no slashes it is assumed to be just a host name. The appropriate
8075 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8076 of the same name, and the remaining parameters (database, user, password) are
8077 taken from there.
8078 .next
8079 If it contains any slashes, it is taken as a complete parameter set.
8080 .endlist
8081 The list of servers is used in exactly the same way as the global list.
8082 Once a connection to a server has happened and a query has been
8083 successfully executed, processing of the lookup ceases.
8084
8085 This feature is intended for use in master/slave situations where updates
8086 are occurring and you want to update the master rather than a slave. If the
8087 master is in the list as a backup for reading, you might have a global setting
8088 like this:
8089 .code
8090 mysql_servers = slave1/db/name/pw:\
8091                 slave2/db/name/pw:\
8092                 master/db/name/pw
8093 .endd
8094 In an updating lookup, you could then write:
8095 .code
8096 ${lookup mysql,servers=master {UPDATE ...} }
8097 .endd
8098 That query would then be sent only to the master server. If, on the other hand,
8099 the master is not to be used for reading, and so is not present in the global
8100 option, you can still update it by a query of this form:
8101 .code
8102 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8103 .endd
8104
8105 An older syntax places the servers specification before the query,
8106 semicolon separated:
8107 .code
8108 ${lookup mysql{servers=master; UPDATE ...} }
8109 .endd
8110 The new version avoids potential issues with tainted
8111 arguments in the query, for explicit expansion.
8112 &*Note*&: server specifications in list-style lookups are still problematic.
8113
8114
8115 .subsection "Special MySQL features" SECID73
8116 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8117 causes a connection to the server on the local host by means of a Unix domain
8118 socket. An alternate socket can be specified in parentheses.
8119 An option group name for MySQL option files can be specified in square brackets;
8120 the default value is &"exim"&.
8121 The full syntax of each item in &%mysql_servers%& is:
8122 .display
8123 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8124   <&'database'&>/<&'user'&>/<&'password'&>
8125 .endd
8126 Any of the four sub-parts of the first field can be omitted. For normal use on
8127 the local host it can be left blank or set to just &"localhost"&.
8128
8129 No database need be supplied &-- but if it is absent here, it must be given in
8130 the queries.
8131
8132 If a MySQL query is issued that does not request any data (an insert, update,
8133 or delete command), the result of the lookup is the number of rows affected.
8134
8135 &*Warning*&: This can be misleading. If an update does not actually change
8136 anything (for example, setting a field to the value it already has), the result
8137 is zero because no rows are affected.
8138
8139
8140 .subsection "Special PostgreSQL features" SECID74
8141 PostgreSQL lookups can also use Unix domain socket connections to the database.
8142 This is usually faster and costs less CPU time than a TCP/IP connection.
8143 However it can be used only if the mail server runs on the same machine as the
8144 database server. A configuration line for PostgreSQL via Unix domain sockets
8145 looks like this:
8146 .code
8147 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8148 .endd
8149 In other words, instead of supplying a host name, a path to the socket is
8150 given. The path name is enclosed in parentheses so that its slashes aren't
8151 visually confused with the delimiters for the other server parameters.
8152
8153 If a PostgreSQL query is issued that does not request any data (an insert,
8154 update, or delete command), the result of the lookup is the number of rows
8155 affected.
8156
8157 .subsection "More about SQLite" SECTsqlite
8158 .cindex "lookup" "SQLite"
8159 .cindex "sqlite lookup type"
8160 SQLite is different to the other SQL lookups because a filename is required in
8161 addition to the SQL query. An SQLite database is a single file, and there is no
8162 daemon as in the other SQL databases.
8163
8164 .oindex &%sqlite_dbfile%&
8165 There are two ways of
8166 specifying the file.
8167 The first is is by using the &%sqlite_dbfile%& main option.
8168 The second, which allows separate files for each query,
8169 is to use an option appended, comma-separated, to the &"sqlite"&
8170 lookup type word.  The option is the word &"file"&, then an equals,
8171 then the filename.
8172 The filename in this case cannot contain whitespace or open-brace charachters.
8173
8174 A deprecated method is available, prefixing the query with the filename
8175 separated by white space.
8176 This means that
8177 .cindex "tainted data" "sqlite file"
8178 the query cannot use any tainted values, as that taints
8179 the entire query including the filename - resulting in a refusal to open
8180 the file.
8181
8182 In all the above cases the filename must be an absolute path.
8183
8184 Here is a lookup expansion example:
8185 .code
8186 sqlite_dbfile = /some/thing/sqlitedb
8187 ...
8188 ${lookup sqlite {select name from aliases where id='userx';}}
8189 .endd
8190 In a list, the syntax is similar. For example:
8191 .code
8192 domainlist relay_to_domains = sqlite;\
8193    select * from relays where ip='$sender_host_address';
8194 .endd
8195 The only character affected by the &%quote_sqlite%& operator is a single
8196 quote, which it doubles.
8197
8198 .cindex timeout SQLite
8199 .cindex sqlite "lookup timeout"
8200 The SQLite library handles multiple simultaneous accesses to the database
8201 internally. Multiple readers are permitted, but only one process can
8202 update at once. Attempts to access the database while it is being updated
8203 are rejected after a timeout period, during which the SQLite library
8204 waits for the lock to be released. In Exim, the default timeout is set
8205 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8206 option.
8207
8208 .subsection "More about Redis" SECTredis
8209 .cindex "lookup" "Redis"
8210 .cindex "redis lookup type"
8211 Redis is a non-SQL database. Commands are simple get and set.
8212 Examples:
8213 .code
8214 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8215 ${lookup redis{get keyname}}
8216 .endd
8217
8218 As of release 4.91, "lightweight" support for Redis Cluster is available.
8219 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8220 of which must be reachable from the running exim instance. If the cluster has
8221 master/slave replication, the list must contain all the master and slave
8222 servers.
8223
8224 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8225 immediately follow the redirection but treats the response as a DEFER, moving on
8226 to the next server in the &%redis_servers%& list until the correct server is
8227 reached.
8228
8229 .ecindex IIDfidalo1
8230 .ecindex IIDfidalo2
8231
8232
8233 . ////////////////////////////////////////////////////////////////////////////
8234 . ////////////////////////////////////////////////////////////////////////////
8235
8236 .chapter "Domain, host, address, and local part lists" &&&
8237          "CHAPdomhosaddlists" &&&
8238          "Domain, host, and address lists"
8239 .scindex IIDdohoadli "lists of domains; hosts; etc."
8240 A number of Exim configuration options contain lists of domains, hosts,
8241 email addresses, or local parts. For example, the &%hold_domains%& option
8242 contains a list of domains whose delivery is currently suspended. These lists
8243 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8244 arguments to expansion conditions such as &%match_domain%&.
8245
8246 Each item in one of these lists is a pattern to be matched against a domain,
8247 host, email address, or local part, respectively. In the sections below, the
8248 different types of pattern for each case are described, but first we cover some
8249 general facilities that apply to all four kinds of list.
8250
8251 Note that other parts of Exim use a &'string list'& which does not
8252 support all the complexity available in
8253 domain, host, address and local part lists.
8254
8255
8256
8257 .section "Results of list checking" SECTlistresults
8258 The primary result of doing a list check is a truth value.
8259 In some contexts additional information is stored
8260 about the list element that matched:
8261 .vlist
8262 .vitem hosts
8263 A &%hosts%& ACL condition
8264 will store a result in the &$host_data$& variable.
8265 .vitem local_parts
8266 A &%local_parts%& router option or &%local_parts%& ACL condition
8267 will store a result in the &$local_part_data$& variable.
8268 .vitem domains
8269 A &%domains%& router option or &%domains%& ACL condition
8270 will store a result in the &$domain_data$& variable.
8271 .vitem senders
8272 A &%senders%& router option or &%senders%& ACL condition
8273 will store a result in the &$sender_data$& variable.
8274 .vitem recipients
8275 A &%recipients%& ACL condition
8276 will store a result in the &$recipient_data$& variable.
8277 .endlist
8278
8279 The detail of the additional information depends on the
8280 type of match and is given below as the &*value*& information.
8281
8282
8283
8284
8285 .section "Expansion of lists" "SECTlistexpand"
8286 .cindex "expansion" "of lists"
8287 Each list is expanded as a single string before it is used.
8288
8289 &'Exception: the router headers_remove option, where list-item
8290 splitting is done before string-expansion.'&
8291
8292 The result of
8293 expansion must be a list, possibly containing empty items, which is split up
8294 into separate items for matching. By default, colon is the separator character,
8295 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8296 &<<SECTempitelis>>& for details of the list syntax; the second of these
8297 discusses the way to specify empty list items.
8298
8299
8300 If the string expansion is forced to fail, Exim behaves as if the item it is
8301 testing (domain, host, address, or local part) is not in the list. Other
8302 expansion failures cause temporary errors.
8303
8304 If an item in a list is a regular expression, backslashes, dollars and possibly
8305 other special characters in the expression must be protected against
8306 misinterpretation by the string expander. The easiest way to do this is to use
8307 the &`\N`& expansion feature to indicate that the contents of the regular
8308 expression should not be expanded. For example, in an ACL you might have:
8309 .code
8310 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8311                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8312 .endd
8313 The first item is a regular expression that is protected from expansion by
8314 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8315 senders based on the receiving domain.
8316
8317
8318
8319
8320 .subsection "Negated items in lists" SECID76
8321 .cindex "list" "negation"
8322 .cindex "negation" "in lists"
8323 Items in a list may be positive or negative. Negative items are indicated by a
8324 leading exclamation mark, which may be followed by optional white space. A list
8325 defines a set of items (domains, etc). When Exim processes one of these lists,
8326 it is trying to find out whether a domain, host, address, or local part
8327 (respectively) is in the set that is defined by the list. It works like this:
8328
8329 The list is scanned from left to right. If a positive item is matched, the
8330 subject that is being checked is in the set; if a negative item is matched, the
8331 subject is not in the set. If the end of the list is reached without the
8332 subject having matched any of the patterns, it is in the set if the last item
8333 was a negative one, but not if it was a positive one. For example, the list in
8334 .code
8335 domainlist relay_to_domains = !a.b.c : *.b.c
8336 .endd
8337 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8338 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8339 list is positive. However, if the setting were
8340 .code
8341 domainlist relay_to_domains = !a.b.c
8342 .endd
8343 then all domains other than &'a.b.c'& would match because the last item in the
8344 list is negative. In other words, a list that ends with a negative item behaves
8345 as if it had an extra item &`:*`& on the end.
8346
8347 Another way of thinking about positive and negative items in lists is to read
8348 the connector as &"or"& after a positive item and as &"and"& after a negative
8349 item.
8350
8351
8352
8353 .subsection "File names in lists" SECTfilnamlis
8354 .cindex "list" "filename in"
8355 If an item in a domain, host, address, or local part list is an absolute
8356 filename (beginning with a slash character), each line of the file is read and
8357 processed as if it were an independent item in the list, except that further
8358 filenames are not allowed,
8359 and no expansion of the data from the file takes place.
8360 Empty lines in the file are ignored, and the file may also contain comment
8361 lines:
8362
8363 .ilist
8364 For domain and host lists, if a # character appears anywhere in a line of the
8365 file, it and all following characters are ignored.
8366 .next
8367 Because local parts may legitimately contain # characters, a comment in an
8368 address list or local part list file is recognized only if # is preceded by
8369 white space or the start of the line. For example:
8370 .code
8371 not#comment@x.y.z   # but this is a comment
8372 .endd
8373 .endlist
8374
8375 Putting a filename in a list has the same effect as inserting each line of the
8376 file as an item in the list (blank lines and comments excepted). However, there
8377 is one important difference: the file is read each time the list is processed,
8378 so if its contents vary over time, Exim's behaviour changes.
8379
8380 If a filename is preceded by an exclamation mark, the sense of any match
8381 within the file is inverted. For example, if
8382 .code
8383 hold_domains = !/etc/nohold-domains
8384 .endd
8385 and the file contains the lines
8386 .code
8387 !a.b.c
8388 *.b.c
8389 .endd
8390 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8391 any domain matching &`*.b.c`& is not.
8392
8393
8394
8395 .subsection "An lsearch file is not an out-of-line list" SECID77
8396 As will be described in the sections that follow, lookups can be used in lists
8397 to provide indexed methods of checking list membership. There has been some
8398 confusion about the way &(lsearch)& lookups work in lists. Because
8399 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8400 sometimes thought that it is allowed to contain wild cards and other kinds of
8401 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8402 always fixed strings, just as for any other single-key lookup type.
8403
8404 If you want to use a file to contain wild-card patterns that form part of a
8405 list, just give the filename on its own, without a search type, as described
8406 in the previous section. You could also use the &(wildlsearch)& or
8407 &(nwildlsearch)&, but there is no advantage in doing this.
8408
8409
8410
8411
8412 .subsection "Named lists" SECTnamedlists
8413 .cindex "named lists"
8414 .cindex "list" "named"
8415 A list of domains, hosts, email addresses, or local parts can be given a name
8416 which is then used to refer to the list elsewhere in the configuration. This is
8417 particularly convenient if the same list is required in several different
8418 places. It also allows lists to be given meaningful names, which can improve
8419 the readability of the configuration. For example, it is conventional to define
8420 a domain list called &'local_domains'& for all the domains that are handled
8421 locally on a host, using a configuration line such as
8422 .code
8423 domainlist local_domains = localhost:my.dom.example
8424 .endd
8425 Named lists are referenced by giving their name preceded by a plus sign, so,
8426 for example, a router that is intended to handle local domains would be
8427 configured with the line
8428 .code
8429 domains = +local_domains
8430 .endd
8431 The first router in a configuration is often one that handles all domains
8432 except the local ones, using a configuration with a negated item like this:
8433 .code
8434 dnslookup:
8435   driver = dnslookup
8436   domains = ! +local_domains
8437   transport = remote_smtp
8438   no_more
8439 .endd
8440 The four kinds of named list are created by configuration lines starting with
8441 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8442 respectively. Then there follows the name that you are defining, followed by an
8443 equals sign and the list itself. For example:
8444 .code
8445 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8446 addresslist bad_senders = cdb;/etc/badsenders
8447 .endd
8448 A named list may refer to other named lists:
8449 .code
8450 domainlist  dom1 = first.example : second.example
8451 domainlist  dom2 = +dom1 : third.example
8452 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8453 .endd
8454 &*Warning*&: If the last item in a referenced list is a negative one, the
8455 effect may not be what you intended, because the negation does not propagate
8456 out to the higher level. For example, consider:
8457 .code
8458 domainlist  dom1 = !a.b
8459 domainlist  dom2 = +dom1 : *.b
8460 .endd
8461 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8462 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8463 means it matches the second list as well. The effect is not the same as
8464 .code
8465 domainlist  dom2 = !a.b : *.b
8466 .endd
8467 where &'x.y'& does not match. It's best to avoid negation altogether in
8468 referenced lists if you can.
8469
8470 .cindex "hiding named list values"
8471 .cindex "named lists" "hiding value of"
8472 Some named list definitions may contain sensitive data, for example, passwords for
8473 accessing databases. To stop non-admin users from using the &%-bP%& command
8474 line option to read these values, you can precede the definition with the
8475 word &"hide"&. For example:
8476 .code
8477 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8478 .endd
8479
8480
8481 Named lists may have a performance advantage. When Exim is routing an
8482 address or checking an incoming message, it caches the result of tests on named
8483 lists. So, if you have a setting such as
8484 .code
8485 domains = +local_domains
8486 .endd
8487 on several of your routers
8488 or in several ACL statements,
8489 the actual test is done only for the first one. However, the caching works only
8490 if there are no expansions within the list itself or any sublists that it
8491 references. In other words, caching happens only for lists that are known to be
8492 the same each time they are referenced.
8493
8494 By default, there may be up to 16 named lists of each type. This limit can be
8495 extended by changing a compile-time variable. The use of domain and host lists
8496 is recommended for concepts such as local domains, relay domains, and relay
8497 hosts. The default configuration is set up like this.
8498
8499
8500
8501 .subsection "Named lists compared with macros" SECID78
8502 .cindex "list" "named compared with macro"
8503 .cindex "macro" "compared with named list"
8504 At first sight, named lists might seem to be no different from macros in the
8505 configuration file. However, macros are just textual substitutions. If you
8506 write
8507 .code
8508 ALIST = host1 : host2
8509 auth_advertise_hosts = !ALIST
8510 .endd
8511 it probably won't do what you want, because that is exactly the same as
8512 .code
8513 auth_advertise_hosts = !host1 : host2
8514 .endd
8515 Notice that the second host name is not negated. However, if you use a host
8516 list, and write
8517 .code
8518 hostlist alist = host1 : host2
8519 auth_advertise_hosts = ! +alist
8520 .endd
8521 the negation applies to the whole list, and so that is equivalent to
8522 .code
8523 auth_advertise_hosts = !host1 : !host2
8524 .endd
8525
8526
8527 .subsection "Named list caching" SECID79
8528 .cindex "list" "caching of named"
8529 .cindex "caching" "named lists"
8530 While processing a message, Exim caches the result of checking a named list if
8531 it is sure that the list is the same each time. In practice, this means that
8532 the cache operates only if the list contains no $ characters, which guarantees
8533 that it will not change when it is expanded. Sometimes, however, you may have
8534 an expanded list that you know will be the same each time within a given
8535 message. For example:
8536 .code
8537 domainlist special_domains = \
8538            ${lookup{$sender_host_address}cdb{/some/file}}
8539 .endd
8540 This provides a list of domains that depends only on the sending host's IP
8541 address. If this domain list is referenced a number of times (for example,
8542 in several ACL lines, or in several routers) the result of the check is not
8543 cached by default, because Exim does not know that it is going to be the
8544 same list each time.
8545
8546 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8547 cache the result anyway. For example:
8548 .code
8549 domainlist_cache special_domains = ${lookup{...
8550 .endd
8551 If you do this, you should be absolutely sure that caching is going to do
8552 the right thing in all cases. When in doubt, leave it out.
8553
8554
8555
8556 .section "Domain lists" "SECTdomainlist"
8557 .cindex "domain list" "patterns for"
8558 .cindex "list" "domain list"
8559 Domain lists contain patterns that are to be matched against a mail domain.
8560 The following types of item may appear in domain lists:
8561
8562 .ilist
8563 .cindex "primary host name"
8564 .cindex "host name" "matched in domain list"
8565 .oindex "&%primary_hostname%&"
8566 .cindex "domain list" "matching primary host name"
8567 .cindex "@ in a domain list"
8568 If a pattern consists of a single @ character, it matches the local host name,
8569 as set by the &%primary_hostname%& option (or defaulted). This makes it
8570 possible to use the same configuration file on several different hosts that
8571 differ only in their names.
8572
8573 The value for a match will be the primary host name.
8574
8575
8576 .next
8577 .cindex "@[] in a domain list"
8578 .cindex "domain list" "matching local IP interfaces"
8579 .cindex "domain literal"
8580 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8581 in square brackets (as in an email address that contains a domain literal), but
8582 only if that IP address is recognized as local for email routing purposes. The
8583 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8584 control which of a host's several IP addresses are treated as local.
8585 In today's Internet, the use of domain literals is controversial;
8586 see the &%allow_domain_literals%& main option.
8587
8588 The value for a match will be the string &`@[]`&.
8589
8590
8591 .next
8592 .cindex "@mx_any"
8593 .cindex "@mx_primary"
8594 .cindex "@mx_secondary"
8595 .cindex "domain list" "matching MX pointers to local host"
8596 If a pattern consists of the string &`@mx_any`& it matches any domain that
8597 has an MX record pointing to the local host or to any host that is listed in
8598 .oindex "&%hosts_treat_as_local%&"
8599 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8600 are similar, except that the first matches only when a primary MX target is the
8601 local host, and the second only when no primary MX target is the local host,
8602 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8603 preference value &-- there may of course be more than one of them.
8604
8605 The MX lookup that takes place when matching a pattern of this type is
8606 performed with the resolver options for widening names turned off. Thus, for
8607 example, a single-component domain will &'not'& be expanded by adding the
8608 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8609 options of the &(dnslookup)& router for a discussion of domain widening.
8610
8611 Sometimes you may want to ignore certain IP addresses when using one of these
8612 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8613 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8614 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8615 on a router). For example:
8616 .code
8617 domains = @mx_any/ignore=127.0.0.1
8618 .endd
8619 This example matches any domain that has an MX record pointing to one of
8620 the local host's IP addresses other than 127.0.0.1.
8621
8622 The list of IP addresses is in fact processed by the same code that processes
8623 host lists, so it may contain CIDR-coded network specifications and it may also
8624 contain negative items.
8625
8626 Because the list of IP addresses is a sublist within a domain list, you have to
8627 be careful about delimiters if there is more than one address. Like any other
8628 list, the default delimiter can be changed. Thus, you might have:
8629 .code
8630 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8631           an.other.domain : ...
8632 .endd
8633 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8634 involved, it is easiest to change the delimiter for the main list as well:
8635 .code
8636 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8637           an.other.domain ? ...
8638 .endd
8639 The value for a match will be the list element string (starting &`@mx_`&).
8640
8641
8642 .next
8643 .cindex "asterisk" "in domain list"
8644 .cindex "domain list" "asterisk in"
8645 .cindex "domain list" "matching &""ends with""&"
8646 If a pattern starts with an asterisk, the remaining characters of the pattern
8647 are compared with the terminating characters of the domain. The use of &"*"& in
8648 domain lists differs from its use in partial matching lookups. In a domain
8649 list, the character following the asterisk need not be a dot, whereas partial
8650 matching works only in terms of dot-separated components. For example, a domain
8651 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8652 &'cipher.key.ex'&.
8653
8654 The value for a match will be the list element string (starting with the asterisk).
8655 Additionally, &$0$& will be set to the matched string
8656 and &$1$& to the variable portion which the asterisk matched.
8657
8658 .next
8659 .cindex "regular expressions" "in domain list"
8660 .cindex "domain list" "matching regular expression"
8661 If a pattern starts with a circumflex character, it is treated as a regular
8662 expression, and matched against the domain using a regular expression matching
8663 function. The circumflex is treated as part of the regular expression.
8664 Email domains are case-independent, so this regular expression match is by
8665 default case-independent, but you can make it case-dependent by starting it
8666 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8667 are given in chapter &<<CHAPregexp>>&.
8668
8669 &*Warning*&: Because domain lists are expanded before being processed, you
8670 must escape any backslash and dollar characters in the regular expression, or
8671 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8672 it is not to be expanded (unless you really do want to build a regular
8673 expression by expansion, of course).
8674
8675 The value for a match will be the list element string (starting with the circumflex).
8676 Additionally, &$0$& will be set to the string matching the regular expression,
8677 and &$1$& (onwards) to any submatches identified by parentheses.
8678
8679
8680
8681 .next
8682 .cindex "lookup" "in domain list"
8683 .cindex "domain list" "matching by lookup"
8684 If a pattern starts with the name of a single-key lookup type followed by a
8685 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8686 must be a filename in a suitable format for the lookup type. For example, for
8687 &"cdb;"& it must be an absolute path:
8688 .code
8689 domains = cdb;/etc/mail/local_domains.cdb
8690 .endd
8691 The appropriate type of lookup is done on the file using the domain name as the
8692 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8693 only in whether or not the key is present in the file. However, when a lookup
8694 is used for the &%domains%& option on a router
8695 or a &%domains%& condition in an ACL statement, the value is preserved in the
8696 &$domain_data$& variable and can be referred to in other router options or
8697 other statements in the same ACL.
8698 .cindex "tainted data" "de-tainting"
8699 .cindex "de-tainting" "using ACL domains condition"
8700 The value will be untainted.
8701
8702 &*Note*&: If the data result of the lookup (as opposed to the key)
8703 is empty, then this empty value is stored in &$domain_data$&.
8704 The option to return the key for the lookup, as the value,
8705 may be what is wanted.
8706
8707
8708 .next
8709 Any of the single-key lookup type names may be preceded by
8710 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8711 .code
8712 domains = partial-dbm;/partial/domains
8713 .endd
8714 This causes partial matching logic to be invoked; a description of how this
8715 works is given in section &<<SECTpartiallookup>>&.
8716
8717 .next
8718 .cindex "asterisk" "in lookup type"
8719 Any of the single-key lookup types may be followed by an asterisk. This causes
8720 a default lookup for a key consisting of a single asterisk to be done if the
8721 original lookup fails. This is not a useful feature when using a domain list to
8722 select particular domains (because any domain would match), but it might have
8723 value if the result of the lookup is being used via the &$domain_data$&
8724 expansion variable.
8725
8726 .next
8727 If the pattern starts with the name of a query-style lookup type followed by a
8728 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8729 pattern must be an appropriate query for the lookup type, as described in
8730 chapter &<<CHAPfdlookup>>&. For example:
8731 .code
8732 hold_domains = mysql;select domain from holdlist \
8733   where domain = '${quote_mysql:$domain}';
8734 .endd
8735 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8736 example, it doesn't matter what field you select). Exim is interested only in
8737 whether or not the query succeeds. However, when a lookup is used for the
8738 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8739 variable and can be referred to in other options.
8740 .cindex "tainted data" "de-tainting"
8741 .cindex "de-tainting" "using router domains option"
8742 The value will be untainted.
8743
8744 .next
8745 If the pattern starts with the name of a lookup type
8746 of either kind (single-key or query-style) it may be
8747 followed by a comma and options,
8748 The options are lookup-type specific and consist of a comma-separated list.
8749 Each item starts with a tag and and equals "=" sign.
8750
8751 .next
8752 .cindex "domain list" "matching literal domain name"
8753 If none of the above cases apply, a caseless textual comparison is made
8754 between the pattern and the domain.
8755
8756 The value for a match will be the list element string.
8757 .cindex "tainted data" "de-tainting"
8758 Note that this is commonly untainted
8759 (depending on the way the list was created).
8760 Specifically, explicit text in the configuration file in not tainted.
8761 This is a useful way of obtaining an untainted equivalent to
8762 the domain, for later operations.
8763
8764 However if the list (including one-element lists)
8765 is created by expanding a variable containing tainted data,
8766 it is tainted and so will the match value be.
8767 .endlist
8768
8769
8770 Here is an example that uses several different kinds of pattern:
8771 .code
8772 domainlist funny_domains = \
8773   @ : \
8774   lib.unseen.edu : \
8775   *.foundation.fict.example : \
8776   \N^[1-2]\d{3}\.fict\.example$\N : \
8777   partial-dbm;/opt/data/penguin/book : \
8778   nis;domains.byname : \
8779   nisplus;[name=$domain,status=local],domains.org_dir
8780 .endd
8781 There are obvious processing trade-offs among the various matching modes. Using
8782 an asterisk is faster than a regular expression, and listing a few names
8783 explicitly probably is too. The use of a file or database lookup is expensive,
8784 but may be the only option if hundreds of names are required. Because the
8785 patterns are tested in order, it makes sense to put the most commonly matched
8786 patterns earlier.
8787
8788
8789
8790 .section "Host lists" "SECThostlist"
8791 .cindex "host list" "patterns in"
8792 .cindex "list" "host list"
8793 Host lists are used to control what remote hosts are allowed to do. For
8794 example, some hosts may be allowed to use the local host as a relay, and some
8795 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8796 two different ways, by name or by IP address. In a host list, some types of
8797 pattern are matched to a host name, and some are matched to an IP address.
8798 You need to be particularly careful with this when single-key lookups are
8799 involved, to ensure that the right value is being used as the key.
8800
8801
8802 .subsection "Special host list patterns" SECID80
8803 .cindex "empty item in hosts list"
8804 .cindex "host list" "empty string in"
8805 If a host list item is the empty string, it matches only when no remote host is
8806 involved. This is the case when a message is being received from a local
8807 process using SMTP on the standard input, that is, when a TCP/IP connection is
8808 not used.
8809
8810 .cindex "asterisk" "in host list"
8811 The special pattern &"*"& in a host list matches any host or no host. Neither
8812 the IP address nor the name is actually inspected.
8813
8814
8815
8816 .subsection "Host list patterns that match by IP address" SECThoslispatip
8817 .cindex "host list" "matching IP addresses"
8818 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8819 the incoming address actually appears in the IPv6 host as
8820 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8821 list, it is converted into a traditional IPv4 address first. (Not all operating
8822 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8823 concerns.)
8824
8825 The following types of pattern in a host list check the remote host by
8826 inspecting its IP address:
8827
8828 .ilist
8829 If the pattern is a plain domain name (not a regular expression, not starting
8830 with *, not a lookup of any kind), Exim calls the operating system function
8831 to find the associated IP address(es). Exim uses the newer
8832 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8833 This typically causes a forward DNS lookup of the name. The result is compared
8834 with the IP address of the subject host.
8835
8836 If there is a temporary problem (such as a DNS timeout) with the host name
8837 lookup, a temporary error occurs. For example, if the list is being used in an
8838 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8839 temporary SMTP error code. If no IP address can be found for the host name,
8840 what happens is described in section &<<SECTbehipnot>>& below.
8841
8842 .next
8843 .cindex "@ in a host list"
8844 If the pattern is &"@"&, the primary host name is substituted and used as a
8845 domain name, as just described.
8846
8847 .next
8848 If the pattern is an IP address, it is matched against the IP address of the
8849 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8850 IPv6 addresses can be given in colon-separated format, but the colons have to
8851 be doubled so as not to be taken as item separators when the default list
8852 separator is used. IPv6 addresses are recognized even when Exim is compiled
8853 without IPv6 support. This means that if they appear in a host list on an
8854 IPv4-only host, Exim will not treat them as host names. They are just addresses
8855 that can never match a client host.
8856
8857 .next
8858 .cindex "@[] in a host list"
8859 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8860 the local host. For example, if the local host is an IPv4 host with one
8861 interface address 10.45.23.56, these two ACL statements have the same effect:
8862 .code
8863 accept hosts = 127.0.0.1 : 10.45.23.56
8864 accept hosts = @[]
8865 .endd
8866 .next
8867 .cindex "CIDR notation"
8868 If the pattern is an IP address followed by a slash and a mask length, for
8869 example
8870 .code
8871 10.11.42.0/24
8872 .endd
8873 , it is matched against the IP address of the subject
8874 host under the given mask. This allows an entire network of hosts to be
8875 included (or excluded) by a single item. The mask uses CIDR notation; it
8876 specifies the number of address bits that must match, starting from the most
8877 significant end of the address.
8878
8879 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8880 of a range of addresses. It is the number of bits in the network portion of the
8881 address. The above example specifies a 24-bit netmask, so it matches all 256
8882 addresses in the 10.11.42.0 network. An item such as
8883 .code
8884 192.168.23.236/31
8885 .endd
8886 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8887 32 for an IPv4 address is the same as no mask at all; just a single address
8888 matches.
8889
8890 Here is another example which shows an IPv4 and an IPv6 network:
8891 .code
8892 recipient_unqualified_hosts = 192.168.0.0/16: \
8893                               3ffe::ffff::836f::::/48
8894 .endd
8895 The doubling of list separator characters applies only when these items
8896 appear inline in a host list. It is not required when indirecting via a file.
8897 For example:
8898 .code
8899 recipient_unqualified_hosts = /opt/exim/unqualnets
8900 .endd
8901 could make use of a file containing
8902 .code
8903 172.16.0.0/12
8904 3ffe:ffff:836f::/48
8905 .endd
8906 to have exactly the same effect as the previous example. When listing IPv6
8907 addresses inline, it is usually more convenient to use the facility for
8908 changing separator characters. This list contains the same two networks:
8909 .code
8910 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8911                                  3ffe:ffff:836f::/48
8912 .endd
8913 The separator is changed to semicolon by the leading &"<;"& at the start of the
8914 list.
8915 .endlist
8916
8917
8918
8919 .subsection "Host list patterns for single-key lookups by host address" &&&
8920          SECThoslispatsikey
8921 .cindex "host list" "lookup of IP address"
8922 When a host is to be identified by a single-key lookup of its complete IP
8923 address, the pattern takes this form:
8924 .display
8925 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8926 .endd
8927 For example:
8928 .code
8929 hosts_lookup = net-cdb;/hosts-by-ip.db
8930 .endd
8931 The text form of the IP address of the subject host is used as the lookup key.
8932 IPv6 addresses are converted to an unabbreviated form, using lower case
8933 letters, with dots as separators because colon is the key terminator in
8934 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8935 quoting the keys, but this is a facility that was added later.] The data
8936 returned by the lookup is not used.
8937
8938 .cindex "IP address" "masking"
8939 .cindex "host list" "masked IP address"
8940 Single-key lookups can also be performed using masked IP addresses, using
8941 patterns of this form:
8942 .display
8943 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8944 .endd
8945 For example:
8946 .code
8947 net24-dbm;/networks.db
8948 .endd
8949 The IP address of the subject host is masked using <&'number'&> as the mask
8950 length. A textual string is constructed from the masked value, followed by the
8951 mask, and this is used as the lookup key. For example, if the host's IP address
8952 is 192.168.34.6, the key that is looked up for the above example is
8953 &"192.168.34.0/24"&.
8954
8955 When an IPv6 address is converted to a string, dots are normally used instead
8956 of colons, so that keys in &(lsearch)& files need not contain colons (which
8957 terminate &(lsearch)& keys). This was implemented some time before the ability
8958 to quote keys was made available in &(lsearch)& files. However, the more
8959 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8960 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8961 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8962 converted using colons and not dots.
8963 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8964 addresses are always used.
8965 The latter are converted to IPv4 addresses, in dotted-quad form.
8966
8967 Ideally, it would be nice to tidy up this anomalous situation by changing to
8968 colons in all cases, given that quoting is now available for &(lsearch)&.
8969 However, this would be an incompatible change that might break some existing
8970 configurations.
8971
8972 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8973 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8974 the former case the key strings include the mask value, whereas in the latter
8975 case the IP address is used on its own.
8976
8977
8978
8979 .subsection "Host list patterns that match by host name" SECThoslispatnam
8980 .cindex "host" "lookup failures"
8981 .cindex "unknown host name"
8982 .cindex "host list" "matching host name"
8983 There are several types of pattern that require Exim to know the name of the
8984 remote host. These are either wildcard patterns or lookups by name. (If a
8985 complete hostname is given without any wildcarding, it is used to find an IP
8986 address to match against, as described in section &<<SECThoslispatip>>&
8987 above.)
8988
8989 If the remote host name is not already known when Exim encounters one of these
8990 patterns, it has to be found from the IP address.
8991 Although many sites on the Internet are conscientious about maintaining reverse
8992 DNS data for their hosts, there are also many that do not do this.
8993 Consequently, a name cannot always be found, and this may lead to unwanted
8994 effects. Take care when configuring host lists with wildcarded name patterns.
8995 Consider what will happen if a name cannot be found.
8996
8997 Because of the problems of determining host names from IP addresses, matching
8998 against host names is not as common as matching against IP addresses.
8999
9000 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9001 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9002 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9003 are done can be changed by setting the &%host_lookup_order%& option. For
9004 security, once Exim has found one or more names, it looks up the IP addresses
9005 for these names and compares them with the IP address that it started with.
9006 Only those names whose IP addresses match are accepted. Any other names are
9007 discarded. If no names are left, Exim behaves as if the host name cannot be
9008 found. In the most common case there is only one name and one IP address.
9009
9010 There are some options that control what happens if a host name cannot be
9011 found. These are described in section &<<SECTbehipnot>>& below.
9012
9013 .cindex "host" "alias for"
9014 .cindex "alias for host"
9015 As a result of aliasing, hosts may have more than one name. When processing any
9016 of the following types of pattern, all the host's names are checked:
9017
9018 .ilist
9019 .cindex "asterisk" "in host list"
9020 If a pattern starts with &"*"& the remainder of the item must match the end of
9021 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9022 &'.b.c'&. This special simple form is provided because this is a very common
9023 requirement. Other kinds of wildcarding require the use of a regular
9024 expression.
9025 .next
9026 .cindex "regular expressions" "in host list"
9027 .cindex "host list" "regular expression in"
9028 If the item starts with &"^"& it is taken to be a regular expression which is
9029 matched against the host name. Host names are case-independent, so this regular
9030 expression match is by default case-independent, but you can make it
9031 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9032 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9033 example,
9034 .code
9035 ^(a|b)\.c\.d$
9036 .endd
9037 is a regular expression that matches either of the two hosts &'a.c.d'& or
9038 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9039 that backslash and dollar characters are not misinterpreted as part of the
9040 string expansion. The simplest way to do this is to use &`\N`& to mark that
9041 part of the string as non-expandable. For example:
9042 .code
9043 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9044 .endd
9045 &*Warning*&: If you want to match a complete host name, you must include the
9046 &`$`& terminating metacharacter in the regular expression, as in the above
9047 example. Without it, a match at the start of the host name is all that is
9048 required.
9049 .endlist
9050
9051
9052
9053
9054 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9055 .cindex "host" "lookup failures, permanent"
9056 While processing a host list, Exim may need to look up an IP address from a
9057 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9058 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9059 behaviour when it fails to find the information it is seeking is the same.
9060
9061 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9062 apply to temporary DNS errors, whose handling is described in the next section.
9063
9064 .cindex "&`+include_unknown`&"
9065 .cindex "&`+ignore_unknown`&"
9066 Exim parses a host list from left to right. If it encounters a permanent
9067 lookup failure in any item in the host list before it has found a match,
9068 Exim treats it as a failure and the default behavior is as if the host
9069 does not match the list. This may not always be what you want to happen.
9070 To change Exim's behaviour, the special items &`+include_unknown`& or
9071 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9072 not recognized in an indirected file).
9073
9074 .ilist
9075 If any item that follows &`+include_unknown`& requires information that
9076 cannot found, Exim behaves as if the host does match the list. For example,
9077 .code
9078 host_reject_connection = +include_unknown:*.enemy.ex
9079 .endd
9080 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9081 any hosts whose name it cannot find.
9082
9083 .next
9084 If any item that follows &`+ignore_unknown`& requires information that cannot
9085 be found, Exim ignores that item and proceeds to the rest of the list. For
9086 example:
9087 .code
9088 accept hosts = +ignore_unknown : friend.example : \
9089                192.168.4.5
9090 .endd
9091 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9092 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9093 name can be found for 192.168.4.5, it is rejected.
9094 .endlist
9095
9096 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9097 list. The effect of each one lasts until the next, or until the end of the
9098 list.
9099
9100 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9101          SECTmixwilhos
9102 .cindex "host list" "mixing names and addresses in"
9103
9104 This section explains the host/ip processing logic with the same concepts
9105 as the previous section, but specifically addresses what happens when a
9106 wildcarded hostname is one of the items in the hostlist.
9107
9108 .ilist
9109 If you have name lookups or wildcarded host names and
9110 IP addresses in the same host list, you should normally put the IP
9111 addresses first. For example, in an ACL you could have:
9112 .code
9113 accept hosts = 10.9.8.7 : *.friend.example
9114 .endd
9115 The reason you normally would order it this way lies in the
9116 left-to-right way that Exim processes lists.  It can test IP addresses
9117 without doing any DNS lookups, but when it reaches an item that requires
9118 a host name, it fails if it cannot find a host name to compare with the
9119 pattern. If the above list is given in the opposite order, the
9120 &%accept%& statement fails for a host whose name cannot be found, even
9121 if its IP address is 10.9.8.7.
9122
9123 .next
9124 If you really do want to do the name check first, and still recognize the IP
9125 address, you can rewrite the ACL like this:
9126 .code
9127 accept hosts = *.friend.example
9128 accept hosts = 10.9.8.7
9129 .endd
9130 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9131 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9132 &`+ignore_unknown`&, which was discussed in depth in the first example in
9133 this section.
9134 .endlist
9135
9136
9137 .subsection "Temporary DNS errors when looking up host information" &&&
9138          SECTtemdnserr
9139 .cindex "host" "lookup failures, temporary"
9140 .cindex "&`+include_defer`&"
9141 .cindex "&`+ignore_defer`&"
9142 A temporary DNS lookup failure normally causes a defer action (except when
9143 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9144 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9145 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9146 section. These options should be used with care, probably only in non-critical
9147 host lists such as whitelists.
9148
9149
9150
9151 .subsection "Host list patterns for single-key lookups by host name" &&&
9152          SECThoslispatnamsk
9153 .cindex "unknown host name"
9154 .cindex "host list" "matching host name"
9155 If a pattern is of the form
9156 .display
9157 <&'single-key-search-type'&>;<&'search-data'&>
9158 .endd
9159 for example
9160 .code
9161 dbm;/host/accept/list
9162 .endd
9163 a single-key lookup is performed, using the host name as its key. If the
9164 lookup succeeds, the host matches the item. The actual data that is looked up
9165 is not used.
9166
9167 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9168 keys in the file, not IP addresses. If you want to do lookups based on IP
9169 addresses, you must precede the search type with &"net-"& (see section
9170 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9171 two items in the same list, one doing an address lookup and one doing a name
9172 lookup, both using the same file.
9173
9174
9175
9176 .subsection "Host list patterns for query-style lookups" SECID81
9177 If a pattern is of the form
9178 .display
9179 <&'query-style-search-type'&>;<&'query'&>
9180 .endd
9181 the query is obeyed, and if it succeeds, the host matches the item. The actual
9182 data that is looked up is not used. The variables &$sender_host_address$& and
9183 &$sender_host_name$& can be used in the query. For example:
9184 .code
9185 hosts_lookup = pgsql;\
9186   select ip from hostlist where ip='$sender_host_address'
9187 .endd
9188 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9189 can use the &%sg%& expansion item to change this if you need to. If you want to
9190 use masked IP addresses in database queries, you can use the &%mask%& expansion
9191 operator.
9192
9193 If the query contains a reference to &$sender_host_name$&, Exim automatically
9194 looks up the host name if it has not already done so. (See section
9195 &<<SECThoslispatnam>>& for comments on finding host names.)
9196
9197 Historical note: prior to release 4.30, Exim would always attempt to find a
9198 host name before running the query, unless the search type was preceded by
9199 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9200 still recognized for query-style lookups, but its presence or absence has no
9201 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9202 See section &<<SECThoslispatsikey>>&.)
9203
9204
9205
9206
9207
9208 .section "Address lists" "SECTaddresslist"
9209 .cindex "list" "address list"
9210 .cindex "address list" "empty item"
9211 .cindex "address list" "patterns"
9212 Address lists contain patterns that are matched against mail addresses. There
9213 is one special case to be considered: the sender address of a bounce message is
9214 always empty. You can test for this by providing an empty item in an address
9215 list. For example, you can set up a router to process bounce messages by
9216 using this option setting:
9217 .code
9218 senders = :
9219 .endd
9220 The presence of the colon creates an empty item. If you do not provide any
9221 data, the list is empty and matches nothing. The empty sender can also be
9222 detected by a regular expression that matches an empty string,
9223 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9224
9225 Non-empty items in an address list can be straightforward email addresses. For
9226 example:
9227 .code
9228 senders = jbc@askone.example : hs@anacreon.example
9229 .endd
9230 A certain amount of wildcarding is permitted. If a pattern contains an @
9231 character, but is not a regular expression and does not begin with a
9232 semicolon-terminated lookup type (described below), the local part of the
9233 subject address is compared with the local part of the pattern, which may start
9234 with an asterisk. If the local parts match, the domain is checked in exactly
9235 the same way as for a pattern in a domain list. For example, the domain can be
9236 wildcarded, refer to a named list, or be a lookup:
9237 .code
9238 deny senders = *@*.spamming.site:\
9239                *@+hostile_domains:\
9240                bozo@partial-lsearch;/list/of/dodgy/sites:\
9241                *@dbm;/bad/domains.db
9242 .endd
9243 .cindex "local part" "starting with !"
9244 .cindex "address list" "local part starting with !"
9245 If a local part that begins with an exclamation mark is required, it has to be
9246 specified using a regular expression, because otherwise the exclamation mark is
9247 treated as a sign of negation, as is standard in lists.
9248
9249 If a non-empty pattern that is not a regular expression or a lookup does not
9250 contain an @ character, it is matched against the domain part of the subject
9251 address. The only two formats that are recognized this way are a literal
9252 domain, or a domain pattern that starts with *. In both these cases, the effect
9253 is the same as if &`*@`& preceded the pattern. For example:
9254 .code
9255 deny senders = enemy.domain : *.enemy.domain
9256 .endd
9257
9258 The following kinds of more complicated address list pattern can match any
9259 address, including the empty address that is characteristic of bounce message
9260 senders:
9261
9262 .ilist
9263 .cindex "regular expressions" "in address list"
9264 .cindex "address list" "regular expression in"
9265 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9266 done against the complete address, with the pattern as the regular expression.
9267 You must take care that backslash and dollar characters are not misinterpreted
9268 as part of the string expansion. The simplest way to do this is to use &`\N`&
9269 to mark that part of the string as non-expandable. For example:
9270 .code
9271 deny senders = \N^.*this.*@example\.com$\N : \
9272                \N^\d{8}.+@spamhaus.example$\N : ...
9273 .endd
9274 The &`\N`& sequences are removed by the expansion, so these items do indeed
9275 start with &"^"& by the time they are being interpreted as address patterns.
9276
9277 .next
9278 .cindex "address list" "lookup for complete address"
9279 Complete addresses can be looked up by using a pattern that starts with a
9280 lookup type terminated by a semicolon, followed by the data for the lookup. For
9281 example:
9282 .code
9283 deny senders = cdb;/etc/blocked.senders : \
9284   mysql;select address from blocked where \
9285   address='${quote_mysql:$sender_address}'
9286 .endd
9287 Both query-style and single-key lookup types can be used. For a single-key
9288 lookup type, Exim uses the complete address as the key. However, empty keys are
9289 not supported for single-key lookups, so a match against the empty address
9290 always fails. This restriction does not apply to query-style lookups.
9291
9292 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9293 cannot be used, and is ignored if specified, with an entry being written to the
9294 panic log.
9295 .cindex "*@ with single-key lookup"
9296 However, you can configure lookup defaults, as described in section
9297 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9298 default. For example, with this lookup:
9299 .code
9300 accept senders = lsearch*@;/some/file
9301 .endd
9302 the file could contains lines like this:
9303 .code
9304 user1@domain1.example
9305 *@domain2.example
9306 .endd
9307 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9308 that are tried is:
9309 .code
9310 nimrod@jaeger.example
9311 *@jaeger.example
9312 *
9313 .endd
9314 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9315 would mean that every address matches, thus rendering the test useless.
9316
9317 &*Warning 2*&: Do not confuse these two kinds of item:
9318 .code
9319 deny recipients = dbm*@;/some/file
9320 deny recipients = *@dbm;/some/file
9321 .endd
9322 The first does a whole address lookup, with defaulting, as just described,
9323 because it starts with a lookup type. The second matches the local part and
9324 domain independently, as described in a bullet point below.
9325 .endlist
9326
9327
9328 The following kinds of address list pattern can match only non-empty addresses.
9329 If the subject address is empty, a match against any of these pattern types
9330 always fails.
9331
9332
9333 .ilist
9334 .cindex "@@ with single-key lookup"
9335 .cindex "address list" "@@ lookup type"
9336 .cindex "address list" "split local part and domain"
9337 If a pattern starts with &"@@"& followed by a single-key lookup item
9338 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9339 split into a local part and a domain. The domain is looked up in the file. If
9340 it is not found, there is no match. If it is found, the data that is looked up
9341 from the file is treated as a colon-separated list of local part patterns, each
9342 of which is matched against the subject local part in turn.
9343
9344 .cindex "asterisk" "in address list"
9345 The lookup may be a partial one, and/or one involving a search for a default
9346 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9347 patterns that are looked up can be regular expressions or begin with &"*"&, or
9348 even be further lookups. They may also be independently negated. For example,
9349 with
9350 .code
9351 deny senders = @@dbm;/etc/reject-by-domain
9352 .endd
9353 the data from which the DBM file is built could contain lines like
9354 .code
9355 baddomain.com:  !postmaster : *
9356 .endd
9357 to reject all senders except &%postmaster%& from that domain.
9358
9359 .cindex "local part" "starting with !"
9360 If a local part that actually begins with an exclamation mark is required, it
9361 has to be specified using a regular expression. In &(lsearch)& files, an entry
9362 may be split over several lines by indenting the second and subsequent lines,
9363 but the separating colon must still be included at line breaks. White space
9364 surrounding the colons is ignored. For example:
9365 .code
9366 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9367   spammer3 : spammer4
9368 .endd
9369 As in all colon-separated lists in Exim, a colon can be included in an item by
9370 doubling.
9371
9372 If the last item in the list starts with a right angle-bracket, the remainder
9373 of the item is taken as a new key to look up in order to obtain a continuation
9374 list of local parts. The new key can be any sequence of characters. Thus one
9375 might have entries like
9376 .code
9377 aol.com: spammer1 : spammer 2 : >*
9378 xyz.com: spammer3 : >*
9379 *:       ^\d{8}$
9380 .endd
9381 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9382 local parts for all domains, in addition to the specific local parts listed for
9383 each domain. Of course, using this feature costs another lookup each time a
9384 chain is followed, but the effort needed to maintain the data is reduced.
9385
9386 .cindex "loop" "in lookups"
9387 It is possible to construct loops using this facility, and in order to catch
9388 them, the chains may be no more than fifty items long.
9389
9390 .next
9391 The @@<&'lookup'&> style of item can also be used with a query-style
9392 lookup, but in this case, the chaining facility is not available. The lookup
9393 can only return a single list of local parts.
9394 .endlist
9395
9396 &*Warning*&: There is an important difference between the address list items
9397 in these two examples:
9398 .code
9399 senders = +my_list
9400 senders = *@+my_list
9401 .endd
9402 In the first one, &`my_list`& is a named address list, whereas in the second
9403 example it is a named domain list.
9404
9405
9406
9407
9408 .subsection "Case of letters in address lists" SECTcasletadd
9409 .cindex "case of local parts"
9410 .cindex "address list" "case forcing"
9411 .cindex "case forcing in address lists"
9412 Domains in email addresses are always handled caselessly, but for local parts
9413 case may be significant on some systems (see &%caseful_local_part%& for how
9414 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9415 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9416 blocking lists should be done in a case-independent manner. Since most address
9417 lists in Exim are used for this kind of control, Exim attempts to do this by
9418 default.
9419
9420 The domain portion of an address is always lowercased before matching it to an
9421 address list. The local part is lowercased by default, and any string
9422 comparisons that take place are done caselessly. This means that the data in
9423 the address list itself, in files included as plain filenames, and in any file
9424 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9425 keys in files that are looked up by a search type other than &(lsearch)& (which
9426 works caselessly) must be in lower case, because these lookups are not
9427 case-independent.
9428
9429 .cindex "&`+caseful`&"
9430 To allow for the possibility of caseful address list matching, if an item in
9431 an address list is the string &"+caseful"&, the original case of the local
9432 part is restored for any comparisons that follow, and string comparisons are no
9433 longer case-independent. This does not affect the domain, which remains in
9434 lower case. However, although independent matches on the domain alone are still
9435 performed caselessly, regular expressions that match against an entire address
9436 become case-sensitive after &"+caseful"& has been seen.
9437
9438
9439
9440 .section "Local part lists" "SECTlocparlis"
9441 .cindex "list" "local part list"
9442 .cindex "local part" "list"
9443 These behave in the same way as domain and host lists, with the following
9444 changes:
9445
9446 Case-sensitivity in local part lists is handled in the same way as for address
9447 lists, as just described. The &"+caseful"& item can be used if required. In a
9448 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9449 set false, the subject is lowercased and the matching is initially
9450 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9451 matching in the local part list, but not elsewhere in the router. If
9452 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9453 option is case-sensitive from the start.
9454
9455 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9456 comments are handled in the same way as address lists &-- they are recognized
9457 only if the # is preceded by white space or the start of the line.
9458 Otherwise, local part lists are matched in the same way as domain lists, except
9459 that the special items that refer to the local host (&`@`&, &`@[]`&,
9460 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9461 Refer to section &<<SECTdomainlist>>& for details of the other available item
9462 types.
9463 .ecindex IIDdohoadli
9464
9465
9466
9467
9468 . ////////////////////////////////////////////////////////////////////////////
9469 . ////////////////////////////////////////////////////////////////////////////
9470
9471 .chapter "String expansions" "CHAPexpand"
9472 .scindex IIDstrexp "expansion" "of strings"
9473 Many strings in Exim's runtime configuration are expanded before use. Some of
9474 them are expanded every time they are used; others are expanded only once.
9475
9476 When a string is being expanded it is copied verbatim from left to right except
9477 .cindex expansion "string concatenation"
9478 when a dollar or backslash character is encountered. A dollar specifies the
9479 start of a portion of the string that is interpreted and replaced as described
9480 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9481 escape character, as described in the following section.
9482
9483 Whether a string is expanded depends upon the context.  Usually this is solely
9484 dependent upon the option for which a value is sought; in this documentation,
9485 options for which string expansion is performed are marked with &dagger; after
9486 the data type.  ACL rules always expand strings.  A couple of expansion
9487 conditions do not expand some of the brace-delimited branches, for security
9488 reasons,
9489 .cindex "tainted data" expansion
9490 .cindex "tainted data" definition
9491 .cindex expansion "tainted data"
9492 and expansion of data deriving from the sender (&"tainted data"&)
9493 is not permitted (including acessing a file using a tainted name).
9494
9495 Common ways of obtaining untainted equivalents of variables with
9496 tainted values
9497 .cindex "tainted data" "de-tainting"
9498 come down to using the tainted value as a lookup key in a trusted database.
9499 This database could be the filesystem structure,
9500 or the password file,
9501 or accessed via a DBMS.
9502 Specific methods are indexed under &"de-tainting"&.
9503
9504
9505
9506 .section "Literal text in expanded strings" "SECTlittext"
9507 .cindex "expansion" "including literal text"
9508 An uninterpreted dollar can be included in an expanded string by putting a
9509 backslash in front of it. A backslash can be used to prevent any special
9510 character being treated specially in an expansion, including backslash itself.
9511 If the string appears in quotes in the configuration file, two backslashes are
9512 required because the quotes themselves cause interpretation of backslashes when
9513 the string is read in (see section &<<SECTstrings>>&).
9514
9515 .cindex "expansion" "non-expandable substrings"
9516 A portion of the string can specified as non-expandable by placing it between
9517 two occurrences of &`\N`&. This is particularly useful for protecting regular
9518 expressions, which often contain backslashes and dollar signs. For example:
9519 .code
9520 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9521 .endd
9522 On encountering the first &`\N`&, the expander copies subsequent characters
9523 without interpretation until it reaches the next &`\N`& or the end of the
9524 string.
9525
9526
9527
9528 .section "Character escape sequences in expanded strings" "SECID82"
9529 .cindex "expansion" "escape sequences"
9530 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9531 expanded string is recognized as an escape sequence for the character newline,
9532 carriage return, or tab, respectively. A backslash followed by up to three
9533 octal digits is recognized as an octal encoding for a single character, and a
9534 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9535 encoding.
9536
9537 These escape sequences are also recognized in quoted strings when they are read
9538 in. Their interpretation in expansions as well is useful for unquoted strings,
9539 and for other cases such as looked-up strings that are then expanded.
9540
9541
9542 .section "Testing string expansions" "SECID83"
9543 .cindex "expansion" "testing"
9544 .cindex "testing" "string expansion"
9545 .oindex "&%-be%&"
9546 Many expansions can be tested by calling Exim with the &%-be%& option. This
9547 takes the command arguments, or lines from the standard input if there are no
9548 arguments, runs them through the string expansion code, and writes the results
9549 to the standard output. Variables based on configuration values are set up, but
9550 since no message is being processed, variables such as &$local_part$& have no
9551 value. Nevertheless the &%-be%& option can be useful for checking out file and
9552 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9553 and &%nhash%&.
9554
9555 .new
9556 When reading lines from the standard input,
9557 macros can be defined and ACL variables can be set.
9558 For example:
9559 .code
9560 MY_MACRO = foo
9561 set acl_m_myvar = bar
9562 .endd
9563 Such macros and variables can then be used in later input lines.
9564 .wen
9565
9566 Exim gives up its root privilege when it is called with the &%-be%& option, and
9567 instead runs under the uid and gid it was called with, to prevent users from
9568 using &%-be%& for reading files to which they do not have access.
9569
9570 .oindex "&%-bem%&"
9571 If you want to test expansions that include variables whose values are taken
9572 from a message, there are two other options that can be used. The &%-bem%&
9573 option is like &%-be%& except that it is followed by a filename. The file is
9574 read as a message before doing the test expansions. For example:
9575 .code
9576 exim -bem /tmp/test.message '$h_subject:'
9577 .endd
9578 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9579 Exim message identifier. For example:
9580 .code
9581 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9582 .endd
9583 This loads the message from Exim's spool before doing the test expansions, and
9584 is therefore restricted to admin users.
9585
9586
9587 .section "Forced expansion failure" "SECTforexpfai"
9588 .cindex "expansion" "forced failure"
9589 A number of expansions that are described in the following section have
9590 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9591 (which are sometimes called &"curly brackets"&). Which of the two strings is
9592 used depends on some condition that is evaluated as part of the expansion. If,
9593 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9594 the entire string expansion fails in a way that can be detected by the code
9595 that requested the expansion. This is called &"forced expansion failure"&, and
9596 its consequences depend on the circumstances. In some cases it is no different
9597 from any other expansion failure, but in others a different action may be
9598 taken. Such variations are mentioned in the documentation of the option that is
9599 being expanded.
9600
9601
9602
9603
9604 .section "Expansion items" "SECTexpansionitems"
9605 The following items are recognized in expanded strings. White space may be used
9606 between sub-items that are keywords or substrings enclosed in braces inside an
9607 outer set of braces, to improve readability. &*Warning*&: Within braces,
9608 white space is significant.
9609
9610 .vlist
9611 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9612 .cindex "expansion" "variables"
9613 Substitute the contents of the named variable, for example:
9614 .code
9615 $local_part
9616 ${domain}
9617 .endd
9618 The second form can be used to separate the name from subsequent alphanumeric
9619 characters. This form (using braces) is available only for variables; it does
9620 &'not'& apply to message headers. The names of the variables are given in
9621 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9622 given, the expansion fails.
9623
9624 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9625 .cindex "expansion" "operators"
9626 The string is first itself expanded, and then the operation specified by
9627 <&'op'&> is applied to it. For example:
9628 .code
9629 ${lc:$local_part}
9630 .endd
9631 The string starts with the first character after the colon, which may be
9632 leading white space. A list of operators is given in section &<<SECTexpop>>&
9633 below. The operator notation is used for simple expansion items that have just
9634 one argument, because it reduces the number of braces and therefore makes the
9635 string easier to understand.
9636
9637 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9638 This item inserts &"basic"& header lines. It is described with the &%header%&
9639 expansion item below.
9640
9641
9642 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9643 .cindex "expansion" "calling an acl"
9644 .cindex "&%acl%&" "call from expansion"
9645 The name and zero to nine argument strings are first expanded separately.  The expanded
9646 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9647 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9648 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9649 and may use the variables; if another acl expansion is used the values
9650 are restored after it returns.  If the ACL sets
9651 a value using a "message =" modifier and returns accept or deny, the value becomes
9652 the result of the expansion.
9653 If no message is set and the ACL returns accept or deny
9654 the expansion result is an empty string.
9655 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9656
9657
9658 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9659 .cindex authentication "results header"
9660 .chindex Authentication-Results:
9661 .cindex authentication "expansion item"
9662 This item returns a string suitable for insertion as an
9663 &'Authentication-Results:'&
9664 header line.
9665 The given <&'authserv-id'&> is included in the result; typically this
9666 will be a domain name identifying the system performing the authentications.
9667 Methods that might be present in the result include:
9668 .code
9669 none
9670 iprev
9671 auth
9672 spf
9673 dkim
9674 .endd
9675
9676 Example use (as an ACL modifier):
9677 .code
9678       add_header = :at_start:${authresults {$primary_hostname}}
9679 .endd
9680 This is safe even if no authentication results are available
9681 .new
9682 and would generally be placed in the DATA ACL.
9683 .wen
9684
9685
9686 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9687        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9688 .cindex "expansion" "extracting certificate fields"
9689 .cindex "&%certextract%&" "certificate fields"
9690 .cindex "certificate" "extracting fields"
9691 The <&'certificate'&> must be a variable of type certificate.
9692 The field name is expanded and used to retrieve the relevant field from
9693 the certificate.  Supported fields are:
9694 .display
9695 &`version        `&
9696 &`serial_number  `&
9697 &`subject        `& RFC4514 DN
9698 &`issuer         `& RFC4514 DN
9699 &`notbefore      `& time
9700 &`notafter       `& time
9701 &`sig_algorithm  `&
9702 &`signature      `&
9703 &`subj_altname   `& tagged list
9704 &`ocsp_uri       `& list
9705 &`crl_uri        `& list
9706 .endd
9707 If the field is found,
9708 <&'string2'&> is expanded, and replaces the whole item;
9709 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9710 variable &$value$& contains the value that has been extracted. Afterwards, it
9711 is restored to any previous value it might have had.
9712
9713 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9714 key is not found. If {<&'string2'&>} is also omitted, the value that was
9715 extracted is used.
9716
9717 Some field names take optional modifiers, appended and separated by commas.
9718
9719 The field selectors marked as "RFC4514" above
9720 output a Distinguished Name string which is
9721 not quite
9722 parseable by Exim as a comma-separated tagged list
9723 (the exceptions being elements containing commas).
9724 RDN elements of a single type may be selected by
9725 a modifier of the type label; if so the expansion
9726 result is a list (newline-separated by default).
9727 The separator may be changed by another modifier of
9728 a right angle-bracket followed immediately by the new separator.
9729 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9730
9731 The field selectors marked as "time" above
9732 take an optional modifier of "int"
9733 for which the result is the number of seconds since epoch.
9734 Otherwise the result is a human-readable string
9735 in the timezone selected by the main "timezone" option.
9736
9737 The field selectors marked as "list" above return a list,
9738 newline-separated by default,
9739 (embedded separator characters in elements are doubled).
9740 The separator may be changed by a modifier of
9741 a right angle-bracket followed immediately by the new separator.
9742
9743 The field selectors marked as "tagged" above
9744 prefix each list element with a type string and an equals sign.
9745 Elements of only one type may be selected by a modifier
9746 which is one of "dns", "uri" or "mail";
9747 if so the element tags are omitted.
9748
9749 If not otherwise noted field values are presented in human-readable form.
9750
9751 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9752        {*&<&'arg'&>&*}...}*&"
9753 .cindex &%dlfunc%&
9754 This expansion dynamically loads and then calls a locally-written C function.
9755 This functionality is available only if Exim is compiled with
9756 .code
9757 EXPAND_DLFUNC=yes
9758 .endd
9759 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9760 object so that it doesn't reload the same object file in the same Exim process
9761 (but of course Exim does start new processes frequently).
9762
9763 There may be from zero to eight arguments to the function.
9764
9765 When compiling
9766 a local function that is to be called in this way,
9767 first &_DLFUNC_IMPL_& should be defined,
9768 and second &_local_scan.h_& should be included.
9769 The Exim variables and functions that are defined by that API
9770 are also available for dynamically loaded functions. The function itself
9771 must have the following type:
9772 .code
9773 int dlfunction(uschar **yield, int argc, uschar *argv[])
9774 .endd
9775 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9776 function should return one of the following values:
9777
9778 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9779 into the expanded string that is being built.
9780
9781 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9782 from &'yield'&, if it is set.
9783
9784 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9785 taken from &'yield'& if it is set.
9786
9787 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9788
9789 When compiling a function that is to be used in this way with gcc,
9790 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9791 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9792
9793
9794 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9795 .cindex "expansion" "extracting value from environment"
9796 .cindex "environment" "values from"
9797 The key is first expanded separately, and leading and trailing white space
9798 removed.
9799 This is then searched for as a name in the environment.
9800 If a variable is found then its value is placed in &$value$&
9801 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9802
9803 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9804 appear, for example:
9805 .code
9806 ${env{USER}{$value} fail }
9807 .endd
9808 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9809 {<&'string1'&>} must be present for &"fail"& to be recognized.
9810
9811 If {<&'string2'&>} is omitted an empty string is substituted on
9812 search failure.
9813 If {<&'string1'&>} is omitted the search result is substituted on
9814 search success.
9815
9816 The environment is adjusted by the &%keep_environment%& and
9817 &%add_environment%& main section options.
9818
9819
9820 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9821        {*&<&'string3'&>&*}}*&"
9822 .cindex "expansion" "extracting substrings by key"
9823 .cindex "&%extract%&" "substrings by key"
9824 The key and <&'string1'&> are first expanded separately. Leading and trailing
9825 white space is removed from the key (but not from any of the strings). The key
9826 must not be empty and must not consist entirely of digits.
9827 The expanded <&'string1'&> must be of the form:
9828 .display
9829 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9830 .endd
9831 .vindex "&$value$&"
9832 where the equals signs and spaces (but not both) are optional. If any of the
9833 values contain white space, they must be enclosed in double quotes, and any
9834 values that are enclosed in double quotes are subject to escape processing as
9835 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9836 for the value that corresponds to the key. The search is case-insensitive. If
9837 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9838 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9839 variable &$value$& contains the value that has been extracted. Afterwards, it
9840 is restored to any previous value it might have had.
9841
9842 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9843 key is not found. If {<&'string2'&>} is also omitted, the value that was
9844 extracted is used. Thus, for example, these two expansions are identical, and
9845 yield &"2001"&:
9846 .code
9847 ${extract{gid}{uid=1984 gid=2001}}
9848 ${extract{gid}{uid=1984 gid=2001}{$value}}
9849 .endd
9850 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9851 appear, for example:
9852 .code
9853 ${extract{Z}{A=... B=...}{$value} fail }
9854 .endd
9855 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9856 {<&'string2'&>} must be present for &"fail"& to be recognized.
9857
9858 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9859        {*&<&'string3'&>&*}}*&" &&&
9860        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9861        {*&<&'string3'&>&*}}*&"
9862 .cindex "expansion" "extracting from JSON object"
9863 .cindex JSON expansions
9864 The key and <&'string1'&> are first expanded separately. Leading and trailing
9865 white space is removed from the key (but not from any of the strings). The key
9866 must not be empty and must not consist entirely of digits.
9867 The expanded <&'string1'&> must be of the form:
9868 .display
9869 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9870 .endd
9871 .vindex "&$value$&"
9872 The braces, commas and colons, and the quoting of the member name are required;
9873 the spaces are optional.
9874 Matching of the key against the member names is done case-sensitively.
9875 For the &"json"& variant,
9876 if a returned value is a JSON string, it retains its leading and
9877 trailing quotes.
9878 For the &"jsons"& variant, which is intended for use with JSON strings, the
9879 leading and trailing quotes are removed from the returned value.
9880 . XXX should be a UTF-8 compare
9881
9882 The results of matching are handled as above.
9883
9884
9885 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9886         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9887 .cindex "expansion" "extracting substrings by number"
9888 .cindex "&%extract%&" "substrings by number"
9889 The <&'number'&> argument must consist entirely of decimal digits,
9890 apart from leading and trailing white space, which is ignored.
9891 This is what distinguishes this form of &%extract%& from the previous kind. It
9892 behaves in the same way, except that, instead of extracting a named field, it
9893 extracts from <&'string1'&> the field whose number is given as the first
9894 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9895 <&'string3'&> as before.
9896
9897 The fields in the string are separated by any one of the characters in the
9898 separator string. These may include space or tab characters.
9899 The first field is numbered one. If the number is negative, the fields are
9900 counted from the end of the string, with the rightmost one numbered -1. If the
9901 number given is zero, the entire string is returned. If the modulus of the
9902 number is greater than the number of fields in the string, the result is the
9903 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9904 provided. For example:
9905 .code
9906 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9907 .endd
9908 yields &"42"&, and
9909 .code
9910 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9911 .endd
9912 yields &"99"&. Two successive separators mean that the field between them is
9913 empty (for example, the fifth field above).
9914
9915
9916 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9917         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9918        "&*${extract jsons{*&<&'number'&>&*}}&&&
9919         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9920 .cindex "expansion" "extracting from JSON array"
9921 .cindex JSON expansions
9922 The <&'number'&> argument must consist entirely of decimal digits,
9923 apart from leading and trailing white space, which is ignored.
9924
9925 Field selection and result handling is as above;
9926 there is no choice of field separator.
9927 For the &"json"& variant,
9928 if a returned value is a JSON string, it retains its leading and
9929 trailing quotes.
9930 For the &"jsons"& variant, which is intended for use with JSON strings, the
9931 leading and trailing quotes are removed from the returned value.
9932
9933
9934 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9935 .cindex "list" "selecting by condition"
9936 .cindex "expansion" "selecting from list by condition"
9937 .vindex "&$item$&"
9938 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9939 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9940 For each item
9941 in this list, its value is place in &$item$&, and then the condition is
9942 evaluated.
9943 .new
9944 Any modification of &$value$& by this evaluation is discarded.
9945 .wen
9946 If the condition is true, &$item$& is added to the output as an
9947 item in a new list; if the condition is false, the item is discarded. The
9948 separator used for the output list is the same as the one used for the
9949 input, but a separator setting is not included in the output. For example:
9950 .code
9951 ${filter{a:b:c}{!eq{$item}{b}}}
9952 .endd
9953 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9954 to what it was before.
9955 See also the &%map%& and &%reduce%& expansion items.
9956
9957
9958 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9959 .cindex "hash function" "textual"
9960 .cindex "expansion" "textual hash"
9961 This is a textual hashing function, and was the first to be implemented in
9962 early versions of Exim. In current releases, there are other hashing functions
9963 (numeric, MD5, and SHA-1), which are described below.
9964
9965 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9966 <&'n'&>. If you are using fixed values for these numbers, that is, if
9967 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9968 use the simpler operator notation that avoids some of the braces:
9969 .code
9970 ${hash_<n>_<m>:<string>}
9971 .endd
9972 The second number is optional (in both notations). If <&'n'&> is greater than
9973 or equal to the length of the string, the expansion item returns the string.
9974 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9975 function to the string. The new string consists of characters taken from the
9976 first <&'m'&> characters of the string
9977 .code
9978 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9979 .endd
9980 If <&'m'&> is not present the value 26 is used, so that only lower case
9981 letters appear. For example:
9982 .display
9983 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9984 &`$hash{5}{monty}}           `&   yields  &`monty`&
9985 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9986 .endd
9987
9988 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9989         &*$h_*&<&'header&~name'&>&*:*&" &&&
9990        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9991         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9992        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9993         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9994        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9995         &*$rh_*&<&'header&~name'&>&*:*&"
9996 .cindex "expansion" "header insertion"
9997 .vindex "&$header_$&"
9998 .vindex "&$bheader_$&"
9999 .vindex "&$lheader_$&"
10000 .vindex "&$rheader_$&"
10001 .cindex "header lines" "in expansion strings"
10002 .cindex "header lines" "character sets"
10003 .cindex "header lines" "decoding"
10004 Substitute the contents of the named message header line, for example
10005 .code
10006 $header_reply-to:
10007 .endd
10008 The newline that terminates a header line is not included in the expansion, but
10009 internal newlines (caused by splitting the header line over several physical
10010 lines) may be present.
10011
10012 The difference between the four pairs of expansions is in the way
10013 the data in the header line is interpreted.
10014
10015 .ilist
10016 .cindex "white space" "in header lines"
10017 &%rheader%& gives the original &"raw"& content of the header line, with no
10018 processing at all, and without the removal of leading and trailing white space.
10019
10020 .next
10021 .cindex "list" "of header lines"
10022 &%lheader%& gives a colon-separated list, one element per header when there
10023 are multiple headers with a given name.
10024 Any embedded colon characters within an element are doubled, so normal Exim
10025 list-processing facilities can be used.
10026 The terminating newline of each element is removed; in other respects
10027 the content is &"raw"&.
10028
10029 .next
10030 .cindex "base64 encoding" "in header lines"
10031 &%bheader%& removes leading and trailing white space, and then decodes base64
10032 or quoted-printable MIME &"words"& within the header text, but does no
10033 character set translation. If decoding of what looks superficially like a MIME
10034 &"word"& fails, the raw string is returned. If decoding
10035 .cindex "binary zero" "in header line"
10036 produces a binary zero character, it is replaced by a question mark &-- this is
10037 what Exim does for binary zeros that are actually received in header lines.
10038
10039 .next
10040 &%header%& tries to translate the string as decoded by &%bheader%& to a
10041 standard character set. This is an attempt to produce the same string as would
10042 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10043 returned. Translation is attempted only on operating systems that support the
10044 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10045 a system Makefile or in &_Local/Makefile_&.
10046 .endlist ilist
10047
10048 In a filter file, the target character set for &%header%& can be specified by a
10049 command of the following form:
10050 .code
10051 headers charset "UTF-8"
10052 .endd
10053 This command affects all references to &$h_$& (or &$header_$&) expansions in
10054 subsequently obeyed filter commands. In the absence of this command, the target
10055 character set in a filter is taken from the setting of the &%headers_charset%&
10056 option in the runtime configuration. The value of this option defaults to the
10057 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10058 ISO-8859-1.
10059
10060 Header names follow the syntax of RFC 2822, which states that they may contain
10061 any printing characters except space and colon. Consequently, curly brackets
10062 &'do not'& terminate header names, and should not be used to enclose them as
10063 if they were variables. Attempting to do so causes a syntax error.
10064
10065 Only header lines that are common to all copies of a message are visible to
10066 this mechanism. These are the original header lines that are received with the
10067 message, and any that are added by an ACL statement or by a system
10068 filter. Header lines that are added to a particular copy of a message by a
10069 router or transport are not accessible.
10070
10071 For incoming SMTP messages, no header lines are visible in
10072 ACLs that are obeyed before the data phase completes,
10073 because the header structure is not set up until the message is received.
10074 They are visible in DKIM, PRDR and DATA ACLs.
10075 Header lines that are added in a RCPT ACL (for example)
10076 are saved until the message's incoming header lines are available, at which
10077 point they are added.
10078 When any of the above ACLs are
10079 running, however, header lines added by earlier ACLs are visible.
10080
10081 Upper case and lower case letters are synonymous in header names. If the
10082 following character is white space, the terminating colon may be omitted, but
10083 this is not recommended, because you may then forget it when it is needed. When
10084 white space terminates the header name, this white space is included in the
10085 expanded string.  If the message does not contain the given header, the
10086 expansion item is replaced by an empty string. (See the &%def%& condition in
10087 section &<<SECTexpcond>>& for a means of testing for the existence of a
10088 header.)
10089
10090 If there is more than one header with the same name, they are all concatenated
10091 to form the substitution string, up to a maximum length of 64K. Unless
10092 &%rheader%& is being used, leading and trailing white space is removed from
10093 each header before concatenation, and a completely empty header is ignored. A
10094 newline character is then inserted between non-empty headers, but there is no
10095 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10096 those headers that contain lists of addresses, a comma is also inserted at the
10097 junctions between headers. This does not happen for the &%rheader%& expansion.
10098
10099 .cindex "tainted data" "message headers"
10100 When the headers are from an incoming message,
10101 the result of expanding any of these variables is tainted.
10102
10103
10104 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10105 .cindex "expansion" "hmac hashing"
10106 .cindex &%hmac%&
10107 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10108 shared secret and some text into a message authentication code, as specified in
10109 RFC 2104. This differs from &`${md5:secret_text...}`& or
10110 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10111 cryptographic hash, allowing for authentication that is not possible with MD5
10112 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10113 present. For example:
10114 .code
10115 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10116 .endd
10117 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10118 produces:
10119 .code
10120 dd97e3ba5d1a61b5006108f8c8252953
10121 .endd
10122 As an example of how this might be used, you might put in the main part of
10123 an Exim configuration:
10124 .code
10125 SPAMSCAN_SECRET=cohgheeLei2thahw
10126 .endd
10127 In a router or a transport you could then have:
10128 .code
10129 headers_add = \
10130   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10131   ${hmac{md5}{SPAMSCAN_SECRET}\
10132   {${primary_hostname},${message_exim_id},$h_message-id:}}
10133 .endd
10134 Then given a message, you can check where it was scanned by looking at the
10135 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10136 this header line is authentic by recomputing the authentication code from the
10137 host name, message ID and the &'Message-id:'& header line. This can be done
10138 using Exim's &%-be%& option, or by other means, for example, by using the
10139 &'hmac_md5_hex()'& function in Perl.
10140
10141
10142 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10143 .cindex "expansion" "conditional"
10144 .cindex "&%if%&, expansion item"
10145 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10146 item; otherwise <&'string2'&> is used. The available conditions are described
10147 in section &<<SECTexpcond>>& below. For example:
10148 .code
10149 ${if eq {$local_part}{postmaster} {yes}{no} }
10150 .endd
10151 The second string need not be present; if it is not and the condition is not
10152 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10153 be present instead of the second string (without any curly brackets). In this
10154 case, the expansion is forced to fail if the condition is not true (see section
10155 &<<SECTforexpfai>>&).
10156
10157 If both strings are omitted, the result is the string &`true`& if the condition
10158 is true, and the empty string if the condition is false. This makes it less
10159 cumbersome to write custom ACL and router conditions. For example, instead of
10160 .code
10161 condition = ${if >{$acl_m4}{3}{true}{false}}
10162 .endd
10163 you can use
10164 .code
10165 condition = ${if >{$acl_m4}{3}}
10166 .endd
10167
10168
10169
10170 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10171 .cindex expansion "imap folder"
10172 .cindex "&%imapfolder%& expansion item"
10173 This item converts a (possibly multilevel, or with non-ASCII characters)
10174 folder specification to a Maildir name for filesystem use.
10175 For information on internationalisation support see &<<SECTi18nMDA>>&.
10176
10177
10178
10179 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10180 .cindex "expansion" "string truncation"
10181 .cindex "&%length%& expansion item"
10182 The &%length%& item is used to extract the initial portion of a string. Both
10183 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10184 you are using a fixed value for the number, that is, if <&'string1'&> does not
10185 change when expanded, you can use the simpler operator notation that avoids
10186 some of the braces:
10187 .code
10188 ${length_<n>:<string>}
10189 .endd
10190 The result of this item is either the first <&'n'&> bytes or the whole
10191 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10192 &%strlen%&, which gives the length of a string.
10193 All measurement is done in bytes and is not UTF-8 aware.
10194
10195
10196 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10197         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10198 .cindex "expansion" "extracting list elements by number"
10199 .cindex "&%listextract%&" "extract list elements by number"
10200 .cindex "list" "extracting elements by number"
10201 The <&'number'&> argument must consist entirely of decimal digits,
10202 apart from an optional leading minus,
10203 and leading and trailing white space (which is ignored).
10204
10205 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10206 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10207
10208 The first field of the list is numbered one.
10209 If the number is negative, the fields are
10210 counted from the end of the list, with the rightmost one numbered -1.
10211 The numbered element of the list is extracted and placed in &$value$&,
10212 then <&'string2'&> is expanded as the result.
10213
10214 If the modulus of the
10215 number is zero or greater than the number of fields in the string,
10216 the result is the expansion of <&'string3'&>.
10217
10218 For example:
10219 .code
10220 ${listextract{2}{x:42:99}}
10221 .endd
10222 yields &"42"&, and
10223 .code
10224 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10225 .endd
10226 yields &"result: 42"&.
10227
10228 If {<&'string3'&>} is omitted, an empty string is used for string3.
10229 If {<&'string2'&>} is also omitted, the value that was
10230 extracted is used.
10231 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10232
10233
10234 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10235 .cindex quoting "for list"
10236 .cindex list quoting
10237 This item doubles any occurrence of the separator character
10238 in the given string.
10239 An empty string is replaced with a single space.
10240 This converts the string into a safe form for use as a list element,
10241 in a list using the given separator.
10242
10243
10244 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10245         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10246        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10247         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10248 .cindex "expansion" "lookup in"
10249 .cindex "file" "lookups"
10250 .cindex "lookup" "in expanded string"
10251 The two forms of lookup item specify data lookups in files and databases, as
10252 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10253 lookups, and the second is used for query-style lookups. The <&'key'&>,
10254 <&'file'&>, and <&'query'&> strings are expanded before use.
10255
10256 If there is any white space in a lookup item which is part of a filter command,
10257 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10258 other place where white space is significant, the lookup item must be enclosed
10259 in double quotes. The use of data lookups in users' filter files may be locked
10260 out by the system administrator.
10261
10262 .vindex "&$value$&"
10263 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10264 During its expansion, the variable &$value$& contains the data returned by the
10265 lookup. Afterwards it reverts to the value it had previously (at the outer
10266 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10267 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10268 string on failure. If <&'string2'&> is provided, it can itself be a nested
10269 lookup, thus providing a mechanism for looking up a default value when the
10270 original lookup fails.
10271
10272 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10273 data for the outer lookup while the parameters of the second lookup are
10274 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10275 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10276 appear, and in this case, if the lookup fails, the entire expansion is forced
10277 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10278 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10279 successful lookup, and nothing in the case of failure.
10280
10281 For single-key lookups, the string &"partial"& is permitted to precede the
10282 search type in order to do partial matching, and * or *@ may follow a search
10283 type to request default lookups if the key does not match (see sections
10284 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10285
10286 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10287 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10288 and non-wild parts of the key during the expansion of the replacement text.
10289 They return to their previous values at the end of the lookup item.
10290
10291 This example looks up the postmaster alias in the conventional alias file:
10292 .code
10293 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10294 .endd
10295 This example uses NIS+ to look up the full name of the user corresponding to
10296 the local part of an address, forcing the expansion to fail if it is not found:
10297 .code
10298 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10299   {$value}fail}
10300 .endd
10301
10302
10303 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10304 .cindex "expansion" "list creation"
10305 .vindex "&$item$&"
10306 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10307 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10308 For each item
10309 in this list, its value is place in &$item$&, and then <&'string2'&> is
10310 expanded and added to the output as an item in a new list. The separator used
10311 for the output list is the same as the one used for the input, but a separator
10312 setting is not included in the output. For example:
10313 .code
10314 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10315 .endd
10316 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10317 value of &$item$& is restored to what it was before. See also the &%filter%&
10318 and &%reduce%& expansion items.
10319
10320 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10321 .cindex "expansion" "numeric hash"
10322 .cindex "hash function" "numeric"
10323 The three strings are expanded; the first two must yield numbers. Call them
10324 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10325 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10326 can use the simpler operator notation that avoids some of the braces:
10327 .code
10328 ${nhash_<n>_<m>:<string>}
10329 .endd
10330 The second number is optional (in both notations). If there is only one number,
10331 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10332 processed by a div/mod hash function that returns two numbers, separated by a
10333 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10334 example,
10335 .code
10336 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10337 .endd
10338 returns the string &"6/33"&.
10339
10340
10341
10342 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10343 .cindex "Perl" "use in expanded string"
10344 .cindex "expansion" "calling Perl from"
10345 This item is available only if Exim has been built to include an embedded Perl
10346 interpreter. The subroutine name and the arguments are first separately
10347 expanded, and then the Perl subroutine is called with those arguments. No
10348 additional arguments need be given; the maximum number permitted, including the
10349 name of the subroutine, is nine.
10350
10351 The return value of the subroutine is inserted into the expanded string, unless
10352 the return value is &%undef%&. In that case, the entire expansion is
10353 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10354 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10355 in a scalar context, thus the return value is a scalar.  For example, if you
10356 return a Perl vector, the return value is the size of the vector,
10357 not its contents.
10358
10359 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10360 with the error message that was passed to &%die%&. More details of the embedded
10361 Perl facility are given in chapter &<<CHAPperl>>&.
10362
10363 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10364 out the use of this expansion item in filter files.
10365
10366
10367 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10368 .cindex "&%prvs%& expansion item"
10369 The first argument is a complete email address and the second is secret
10370 keystring. The third argument, specifying a key number, is optional. If absent,
10371 it defaults to 0. The result of the expansion is a prvs-signed email address,
10372 to be typically used with the &%return_path%& option on an &(smtp)& transport
10373 as part of a bounce address tag validation (BATV) scheme. For more discussion
10374 and an example, see section &<<SECTverifyPRVS>>&.
10375
10376 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10377         {*&<&'string'&>&*}}*&"
10378 .cindex "&%prvscheck%& expansion item"
10379 This expansion item is the complement of the &%prvs%& item. It is used for
10380 checking prvs-signed addresses. If the expansion of the first argument does not
10381 yield a syntactically valid prvs-signed address, the whole item expands to the
10382 empty string. When the first argument does expand to a syntactically valid
10383 prvs-signed address, the second argument is expanded, with the prvs-decoded
10384 version of the address and the key number extracted from the address in the
10385 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10386
10387 These two variables can be used in the expansion of the second argument to
10388 retrieve the secret. The validity of the prvs-signed address is then checked
10389 against the secret. The result is stored in the variable &$prvscheck_result$&,
10390 which is empty for failure or &"1"& for success.
10391
10392 The third argument is optional; if it is missing, it defaults to an empty
10393 string. This argument is now expanded. If the result is an empty string, the
10394 result of the expansion is the decoded version of the address. This is the case
10395 whether or not the signature was valid. Otherwise, the result of the expansion
10396 is the expansion of the third argument.
10397
10398 All three variables can be used in the expansion of the third argument.
10399 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10400 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10401
10402 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10403 .cindex "expansion" "inserting an entire file"
10404 .cindex "file" "inserting into expansion"
10405 .cindex "&%readfile%& expansion item"
10406 The filename and end-of-line (eol) string are first expanded separately. The file is
10407 then read, and its contents replace the entire item. All newline characters in
10408 the file are replaced by the end-of-line string if it is present. Otherwise,
10409 newlines are left in the string.
10410 String expansion is not applied to the contents of the file. If you want this,
10411 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10412 the string expansion fails.
10413
10414 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10415 locks out the use of this expansion item in filter files.
10416
10417
10418
10419 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10420         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10421 .cindex "expansion" "inserting from a socket"
10422 .cindex "socket, use of in expansion"
10423 .cindex "&%readsocket%& expansion item"
10424 This item inserts data from a Unix domain or TCP socket into the expanded
10425 string. The minimal way of using it uses just two arguments, as in these
10426 examples:
10427 .code
10428 ${readsocket{/socket/name}{request string}}
10429 ${readsocket{inet:some.host:1234}{request string}}
10430 .endd
10431 For a Unix domain socket, the first substring must be the path to the socket.
10432 For an Internet socket, the first substring must contain &`inet:`& followed by
10433 a host name or IP address, followed by a colon and a port, which can be a
10434 number or the name of a TCP port in &_/etc/services_&. An IP address may
10435 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10436 example:
10437 .code
10438 ${readsocket{inet:[::1]:1234}{request string}}
10439 .endd
10440 Only a single host name may be given, but if looking it up yields more than
10441 one IP address, they are each tried in turn until a connection is made. For
10442 both kinds of socket, Exim makes a connection, writes the request string
10443 (unless it is an empty string; no terminating NUL is ever sent)
10444 and reads from the socket until an end-of-file
10445 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10446 extend what can be done. Firstly, you can vary the timeout. For example:
10447 .code
10448 ${readsocket{/socket/name}{request string}{3s}}
10449 .endd
10450
10451 The third argument is a list of options, of which the first element is the timeout
10452 and must be present if any options are given.
10453 Further elements are options of form &'name=value'&.
10454 Example:
10455 .code
10456 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10457 .endd
10458
10459 The following option names are recognised:
10460 .ilist
10461 &*cache*&
10462 Defines if the result data can be cached for use by a later identical
10463 request in the same process.
10464 Values are &"yes"& or &"no"& (the default).
10465 If not, all cached results for this connection specification
10466 will be invalidated.
10467
10468 .next
10469 &*shutdown*&
10470 Defines whether or not a write-shutdown is done on the connection after
10471 sending the request. Values are &"yes"& (the default) or &"no"&
10472 (preferred, eg. by some webservers).
10473
10474 .next
10475 &*tls*&
10476 Controls the use of TLS on the connection.
10477 Values are &"yes"& or &"no"& (the default).
10478 If it is enabled, a shutdown as described above is never done.
10479 .endlist
10480
10481
10482 A fourth argument allows you to change any newlines that are in the data
10483 that is read, in the same way as for &%readfile%& (see above). This example
10484 turns them into spaces:
10485 .code
10486 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10487 .endd
10488 As with all expansions, the substrings are expanded before the processing
10489 happens. Errors in these sub-expansions cause the expansion to fail. In
10490 addition, the following errors can occur:
10491
10492 .ilist
10493 Failure to create a socket file descriptor;
10494 .next
10495 Failure to connect the socket;
10496 .next
10497 Failure to write the request string;
10498 .next
10499 Timeout on reading from the socket.
10500 .endlist
10501
10502 By default, any of these errors causes the expansion to fail. However, if
10503 you supply a fifth substring, it is expanded and used when any of the above
10504 errors occurs. For example:
10505 .code
10506 ${readsocket{/socket/name}{request string}{3s}{\n}\
10507   {socket failure}}
10508 .endd
10509 You can test for the existence of a Unix domain socket by wrapping this
10510 expansion in &`${if exists`&, but there is a race condition between that test
10511 and the actual opening of the socket, so it is safer to use the fifth argument
10512 if you want to be absolutely sure of avoiding an expansion error for a
10513 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10514
10515 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10516 locks out the use of this expansion item in filter files.
10517
10518
10519 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10520 .cindex "expansion" "reducing a list to a scalar"
10521 .cindex "list" "reducing to a scalar"
10522 .vindex "&$value$&"
10523 .vindex "&$item$&"
10524 This operation reduces a list to a single, scalar string. After expansion,
10525 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10526 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10527 Then <&'string2'&> is expanded and
10528 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10529 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10530 them. The result of that expansion is assigned to &$value$& before the next
10531 iteration. When the end of the list is reached, the final value of &$value$& is
10532 added to the expansion output. The &%reduce%& expansion item can be used in a
10533 number of ways. For example, to add up a list of numbers:
10534 .code
10535 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10536 .endd
10537 The result of that expansion would be &`6`&. The maximum of a list of numbers
10538 can be found:
10539 .code
10540 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10541 .endd
10542 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10543 restored to what they were before. See also the &%filter%& and &%map%&
10544 expansion items.
10545
10546 . A bit of a special-case logic error in writing an expansion;
10547 . probably not worth including in the mainline of documentation.
10548 . If only we had footnotes (the html output variant is the problem).
10549 .
10550 . .new
10551 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10552 . and that condition modifies &$value$&,
10553 . then the string expansions dependent on the condition cannot use
10554 . the &$value$& of the reduce iteration.
10555 . .wen
10556
10557 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10558 This item inserts &"raw"& header lines. It is described with the &%header%&
10559 expansion item in section &<<SECTexpansionitems>>& above.
10560
10561 .vitem "&*${run <&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10562         {*&<&'string2'&>&*}}*&"
10563 .cindex "expansion" "running a command"
10564 .cindex "&%run%& expansion item"
10565 This item runs an external command, as a subprocess.
10566 One option is supported after the word &'run'&, comma-separated.
10567
10568 If the option &'preexpand'& is not used,
10569 the command string is split into individual arguments by spaces
10570 and then each argument is expanded.
10571 Then the command is run
10572 in a separate process, but under the same uid and gid.  As in other command
10573 executions from Exim, a shell is not used by default. If the command requires
10574 a shell, you must explicitly code it.
10575 The command name may not be tainted, but the remaining arguments can be.
10576
10577 &*Note*&: if tainted arguments are used, they are supplied by a
10578 potential attacker;
10579 a careful assessment for security vulnerabilities should be done.
10580
10581 If the option &'preexpand'& is used,
10582 the command and its arguments are first expanded as one string. The result is
10583 split apart into individual arguments by spaces, and then the command is run
10584 as above.
10585 Since the arguments are split by spaces, when there is a variable expansion
10586 which has an empty result, it will cause the situation that the argument will
10587 simply be omitted when the program is actually executed by Exim. If the
10588 script/program requires a specific number of arguments and the expanded
10589 variable could possibly result in this empty expansion, the variable must be
10590 quoted. This is more difficult if the expanded variable itself could result
10591 in a string containing quotes, because it would interfere with the quotes
10592 around the command arguments. A possible guard against this is to wrap the
10593 variable in the &%sg%& operator to change any quote marks to some other
10594 character.
10595 Neither the command nor any argument may be tainted.
10596
10597 The standard input for the command exists, but is empty. The standard output
10598 and standard error are set to the same file descriptor.
10599 .cindex "return code" "from &%run%& expansion"
10600 .vindex "&$value$&"
10601 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10602 and replaces the entire item; during this expansion, the standard output/error
10603 from the command is in the variable &$value$&. If the command fails,
10604 <&'string2'&>, if present, is expanded and used. Once again, during the
10605 expansion, the standard output/error from the command is in the variable
10606 &$value$&.
10607
10608 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10609 can be the word &"fail"& (not in braces) to force expansion failure if the
10610 command does not succeed. If both strings are omitted, the result is contents
10611 of the standard output/error on success, and nothing on failure.
10612
10613 .vindex "&$run_in_acl$&"
10614 The standard output/error of the command is put in the variable &$value$&.
10615 In this ACL example, the output of a command is logged for the admin to
10616 troubleshoot:
10617 .code
10618 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10619       log_message  = Output of id: $value
10620 .endd
10621 If the command requires shell idioms, such as the > redirect operator, the
10622 shell must be invoked directly, such as with:
10623 .code
10624 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10625 .endd
10626
10627 .vindex "&$runrc$&"
10628 The return code from the command is put in the variable &$runrc$&, and this
10629 remains set afterwards, so in a filter file you can do things like this:
10630 .code
10631 if "${run{x y z}{}}$runrc" is 1 then ...
10632   elif $runrc is 2 then ...
10633   ...
10634 endif
10635 .endd
10636 If execution of the command fails (for example, the command does not exist),
10637 the return code is 127 &-- the same code that shells use for non-existent
10638 commands.
10639
10640 &*Warning*&: In a router or transport, you cannot assume the order in which
10641 option values are expanded, except for those preconditions whose order of
10642 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10643 by the expansion of one option, and use it in another.
10644
10645 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10646 out the use of this expansion item in filter files.
10647
10648
10649 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10650 .cindex "expansion" "string substitution"
10651 .cindex "&%sg%& expansion item"
10652 This item works like Perl's substitution operator (s) with the global (/g)
10653 option; hence its name. However, unlike the Perl equivalent, Exim does not
10654 modify the subject string; instead it returns the modified string for insertion
10655 into the overall expansion. The item takes three arguments: the subject string,
10656 a regular expression, and a substitution string. For example:
10657 .code
10658 ${sg{abcdefabcdef}{abc}{xyz}}
10659 .endd
10660 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10661 if any $, } or \ characters are required in the regular expression or in the
10662 substitution string, they have to be escaped. For example:
10663 .code
10664 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10665 .endd
10666 yields &"defabc"&, and
10667 .code
10668 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10669 .endd
10670 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10671 the regular expression from string expansion.
10672
10673 The regular expression is compiled in 8-bit mode, working against bytes
10674 rather than any Unicode-aware character handling.
10675
10676
10677 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10678 .cindex sorting "a list"
10679 .cindex list sorting
10680 .cindex expansion "list sorting"
10681 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10682 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10683 The <&'comparator'&> argument is interpreted as the operator
10684 of a two-argument expansion condition.
10685 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10686 The comparison should return true when applied to two values
10687 if the first value should sort before the second value.
10688 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10689 the element being placed in &$item$&,
10690 to give values for comparison.
10691
10692 The item result is a sorted list,
10693 with the original list separator,
10694 of the list elements (in full) of the original.
10695
10696 Examples:
10697 .code
10698 ${sort{3:2:1:4}{<}{$item}}
10699 .endd
10700 sorts a list of numbers, and
10701 .code
10702 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10703 .endd
10704 will sort an MX lookup into priority order.
10705
10706
10707
10708 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10709 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10710
10711
10712
10713 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10714 .cindex "&%substr%& expansion item"
10715 .cindex "substring extraction"
10716 .cindex "expansion" "substring extraction"
10717 The three strings are expanded; the first two must yield numbers. Call them
10718 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10719 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10720 can use the simpler operator notation that avoids some of the braces:
10721 .code
10722 ${substr_<n>_<m>:<subject>}
10723 .endd
10724 The second number is optional (in both notations).
10725 If it is absent in the simpler format, the preceding underscore must also be
10726 omitted.
10727
10728 The &%substr%& item can be used to extract more general substrings than
10729 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10730 length required. For example
10731 .code
10732 ${substr{3}{2}{$local_part}}
10733 .endd
10734 If the starting offset is greater than the string length the result is the
10735 null string; if the length plus starting offset is greater than the string
10736 length, the result is the right-hand part of the string, starting from the
10737 given offset. The first byte (character) in the string has offset zero.
10738
10739 The &%substr%& expansion item can take negative offset values to count
10740 from the right-hand end of its operand. The last byte (character) is offset -1,
10741 the second-last is offset -2, and so on. Thus, for example,
10742 .code
10743 ${substr{-5}{2}{1234567}}
10744 .endd
10745 yields &"34"&. If the absolute value of a negative offset is greater than the
10746 length of the string, the substring starts at the beginning of the string, and
10747 the length is reduced by the amount of overshoot. Thus, for example,
10748 .code
10749 ${substr{-5}{2}{12}}
10750 .endd
10751 yields an empty string, but
10752 .code
10753 ${substr{-3}{2}{12}}
10754 .endd
10755 yields &"1"&.
10756
10757 When the second number is omitted from &%substr%&, the remainder of the string
10758 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10759 string preceding the offset point are taken. For example, an offset of -1 and
10760 no length, as in these semantically identical examples:
10761 .code
10762 ${substr_-1:abcde}
10763 ${substr{-1}{abcde}}
10764 .endd
10765 yields all but the last character of the string, that is, &"abcd"&.
10766
10767 All measurement is done in bytes and is not UTF-8 aware.
10768
10769
10770
10771 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10772         {*&<&'replacements'&>&*}}*&"
10773 .cindex "expansion" "character translation"
10774 .cindex "&%tr%& expansion item"
10775 This item does single-character (in bytes) translation on its subject string. The second
10776 argument is a list of characters to be translated in the subject string. Each
10777 matching character is replaced by the corresponding character from the
10778 replacement list. For example
10779 .code
10780 ${tr{abcdea}{ac}{13}}
10781 .endd
10782 yields &`1b3de1`&. If there are duplicates in the second character string, the
10783 last occurrence is used. If the third string is shorter than the second, its
10784 last character is replicated. However, if it is empty, no translation takes
10785 place.
10786
10787 All character handling is done in bytes and is not UTF-8 aware.
10788
10789 .endlist
10790
10791
10792
10793 .section "Expansion operators" "SECTexpop"
10794 .cindex "expansion" "operators"
10795 For expansion items that perform transformations on a single argument string,
10796 the &"operator"& notation is used because it is simpler and uses fewer braces.
10797 The substring is first expanded before the operation is applied to it. The
10798 following operations can be performed:
10799
10800 .vlist
10801 .vitem &*${address:*&<&'string'&>&*}*&
10802 .cindex "expansion" "RFC 2822 address handling"
10803 .cindex "&%address%& expansion item"
10804 The string is interpreted as an RFC 2822 address, as it might appear in a
10805 header line, and the effective address is extracted from it. If the string does
10806 not parse successfully, the result is empty.
10807
10808 The parsing correctly handles SMTPUTF8 Unicode in the string.
10809
10810
10811 .vitem &*${addresses:*&<&'string'&>&*}*&
10812 .cindex "expansion" "RFC 2822 address handling"
10813 .cindex "&%addresses%& expansion item"
10814 The string (after expansion) is interpreted as a list of addresses in RFC
10815 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10816 operative address (&'local-part@domain'&) is extracted from each item, and the
10817 result of the expansion is a colon-separated list, with appropriate
10818 doubling of colons should any happen to be present in the email addresses.
10819 Syntactically invalid RFC2822 address items are omitted from the output.
10820
10821 It is possible to specify a character other than colon for the output
10822 separator by starting the string with > followed by the new separator
10823 character. For example:
10824 .code
10825 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10826 .endd
10827 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10828 first, so if the expanded string starts with >, it may change the output
10829 separator unintentionally. This can be avoided by setting the output
10830 separator explicitly:
10831 .code
10832 ${addresses:>:$h_from:}
10833 .endd
10834
10835 Compare the &%address%& (singular)
10836 expansion item, which extracts the working address from a single RFC2822
10837 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10838 processing lists.
10839
10840 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10841 a strict interpretation of header line formatting.  Exim parses the bare,
10842 unquoted portion of an email address and if it finds a comma, treats it as an
10843 email address separator. For the example header line:
10844 .code
10845 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10846 .endd
10847 The first example below demonstrates that Q-encoded email addresses are parsed
10848 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10849 It does not see the comma because it's still encoded as "=2C".  The second
10850 example below is passed the contents of &`$header_from:`&, meaning it gets
10851 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10852 The third example shows that the presence of a comma is skipped when it is
10853 quoted.  The fourth example shows SMTPUTF8 handling.
10854 .code
10855 # exim -be '${addresses:From: \
10856 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10857 user@example.com
10858 # exim -be '${addresses:From: Last, First <user@example.com>}'
10859 Last:user@example.com
10860 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10861 user@example.com
10862 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10863 フィリップ@example.jp
10864 .endd
10865
10866 .vitem &*${base32:*&<&'digits'&>&*}*&
10867 .cindex "&%base32%& expansion item"
10868 .cindex "expansion" "conversion to base 32"
10869 The string must consist entirely of decimal digits. The number is converted to
10870 base 32 and output as a (empty, for zero) string of characters.
10871 Only lowercase letters are used.
10872
10873 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10874 .cindex "&%base32d%& expansion item"
10875 .cindex "expansion" "conversion to base 32"
10876 The string must consist entirely of base-32 digits.
10877 The number is converted to decimal and output as a string.
10878
10879 .vitem &*${base62:*&<&'digits'&>&*}*&
10880 .cindex "&%base62%& expansion item"
10881 .cindex "expansion" "conversion to base 62"
10882 The string must consist entirely of decimal digits. The number is converted to
10883 base 62 and output as a string of six characters, including leading zeros. In
10884 the few operating environments where Exim uses base 36 instead of base 62 for
10885 its message identifiers (because those systems do not have case-sensitive
10886 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10887 to be absolutely clear: this is &'not'& base64 encoding.
10888
10889 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10890 .cindex "&%base62d%& expansion item"
10891 .cindex "expansion" "conversion to base 62"
10892 The string must consist entirely of base-62 digits, or, in operating
10893 environments where Exim uses base 36 instead of base 62 for its message
10894 identifiers, base-36 digits. The number is converted to decimal and output as a
10895 string.
10896
10897 .vitem &*${base64:*&<&'string'&>&*}*&
10898 .cindex "expansion" "base64 encoding"
10899 .cindex "base64 encoding" "in string expansion"
10900 .cindex "&%base64%& expansion item"
10901 .cindex certificate "base64 of DER"
10902 This operator converts a string into one that is base64 encoded.
10903
10904 If the string is a single variable of type certificate,
10905 returns the base64 encoding of the DER form of the certificate.
10906
10907
10908 .vitem &*${base64d:*&<&'string'&>&*}*&
10909 .cindex "expansion" "base64 decoding"
10910 .cindex "base64 decoding" "in string expansion"
10911 .cindex "&%base64d%& expansion item"
10912 This operator converts a base64-encoded string into the un-coded form.
10913
10914
10915 .vitem &*${domain:*&<&'string'&>&*}*&
10916 .cindex "domain" "extraction"
10917 .cindex "expansion" "domain extraction"
10918 The string is interpreted as an RFC 2822 address and the domain is extracted
10919 from it. If the string does not parse successfully, the result is empty.
10920
10921
10922 .vitem &*${escape:*&<&'string'&>&*}*&
10923 .cindex "expansion" "escaping non-printing characters"
10924 .cindex "&%escape%& expansion item"
10925 If the string contains any non-printing characters, they are converted to
10926 escape sequences starting with a backslash. Whether characters with the most
10927 significant bit set (so-called &"8-bit characters"&) count as printing or not
10928 is controlled by the &%print_topbitchars%& option.
10929
10930 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10931 .cindex "expansion" "escaping 8-bit characters"
10932 .cindex "&%escape8bit%& expansion item"
10933 If the string contains any characters with the most significant bit set,
10934 they are converted to escape sequences starting with a backslash.
10935 Backslashes and DEL characters are also converted.
10936
10937
10938 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10939 .cindex "expansion" "expression evaluation"
10940 .cindex "expansion" "arithmetic expression"
10941 .cindex "&%eval%& expansion item"
10942 These items supports simple arithmetic and bitwise logical operations in
10943 expansion strings. The string (after expansion) must be a conventional
10944 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10945 logical operators, and parentheses. All operations are carried out using
10946 integer arithmetic. The operator priorities are as follows (the same as in the
10947 C programming language):
10948 .table2 70pt 300pt
10949 .irow &'highest:'& "not (~), negate (-)"
10950 .irow ""   "multiply (*), divide (/), remainder (%)"
10951 .irow ""   "plus (+), minus (-)"
10952 .irow ""   "shift-left (<<), shift-right (>>)"
10953 .irow ""   "and (&&)"
10954 .irow ""   "xor (^)"
10955 .irow &'lowest:'&  "or (|)"
10956 .endtable
10957 Binary operators with the same priority are evaluated from left to right. White
10958 space is permitted before or after operators.
10959
10960 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10961 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10962 decimal, even if they start with a leading zero; hexadecimal numbers are not
10963 permitted. This can be useful when processing numbers extracted from dates or
10964 times, which often do have leading zeros.
10965
10966 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10967 or 1024*1024*1024,
10968 respectively. Negative numbers are supported. The result of the computation is
10969 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10970
10971 .display
10972 &`${eval:1+1}            `&  yields 2
10973 &`${eval:1+2*3}          `&  yields 7
10974 &`${eval:(1+2)*3}        `&  yields 9
10975 &`${eval:2+42%5}         `&  yields 4
10976 &`${eval:0xc&amp;5}          `&  yields 4
10977 &`${eval:0xc|5}          `&  yields 13
10978 &`${eval:0xc^5}          `&  yields 9
10979 &`${eval:0xc>>1}         `&  yields 6
10980 &`${eval:0xc<<1}         `&  yields 24
10981 &`${eval:~255&amp;0x1234}    `&  yields 4608
10982 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10983 .endd
10984
10985 As a more realistic example, in an ACL you might have
10986 .code
10987 deny   condition =                    \
10988          ${if and {                   \
10989            {>{$rcpt_count}{10}}       \
10990            {                          \
10991            <                          \
10992              {$recipients_count}      \
10993              {${eval:$rcpt_count/2}}  \
10994            }                          \
10995          }{yes}{no}}
10996        message = Too many bad recipients
10997 .endd
10998 The condition is true if there have been more than 10 RCPT commands and
10999 fewer than half of them have resulted in a valid recipient.
11000
11001
11002 .vitem &*${expand:*&<&'string'&>&*}*&
11003 .cindex "expansion" "re-expansion of substring"
11004 The &%expand%& operator causes a string to be expanded for a second time. For
11005 example,
11006 .code
11007 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11008 .endd
11009 first looks up a string in a file while expanding the operand for &%expand%&,
11010 and then re-expands what it has found.
11011
11012
11013 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11014 .cindex "Unicode"
11015 .cindex "UTF-8" "conversion from"
11016 .cindex "expansion" "UTF-8 conversion"
11017 .cindex "&%from_utf8%& expansion item"
11018 The world is slowly moving towards Unicode, although there are no standards for
11019 email yet. However, other applications (including some databases) are starting
11020 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11021 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11022 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11023 the result is an undefined sequence of bytes.
11024
11025 Unicode code points with values less than 256 are compatible with ASCII and
11026 ISO-8859-1 (also known as Latin-1).
11027 For example, character 169 is the copyright symbol in both cases, though the
11028 way it is encoded is different. In UTF-8, more than one byte is needed for
11029 characters with code values greater than 127, whereas ISO-8859-1 is a
11030 single-byte encoding (but thereby limited to 256 characters). This makes
11031 translation from UTF-8 to ISO-8859-1 straightforward.
11032
11033
11034 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11035 .cindex "hash function" "textual"
11036 .cindex "expansion" "textual hash"
11037 The &%hash%& operator is a simpler interface to the hashing function that can
11038 be used when the two parameters are fixed numbers (as opposed to strings that
11039 change when expanded). The effect is the same as
11040 .code
11041 ${hash{<n>}{<m>}{<string>}}
11042 .endd
11043 See the description of the general &%hash%& item above for details. The
11044 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11045
11046
11047
11048 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11049 .cindex "base64 encoding" "conversion from hex"
11050 .cindex "expansion" "hex to base64"
11051 .cindex "&%hex2b64%& expansion item"
11052 This operator converts a hex string into one that is base64 encoded. This can
11053 be useful for processing the output of the various hashing functions.
11054
11055
11056
11057 .vitem &*${hexquote:*&<&'string'&>&*}*&
11058 .cindex "quoting" "hex-encoded unprintable characters"
11059 .cindex "&%hexquote%& expansion item"
11060 This operator converts non-printable characters in a string into a hex
11061 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11062 as is, and other byte values are converted to &`\xNN`&, for example, a
11063 byte value 127 is converted to &`\x7f`&.
11064
11065
11066 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11067 .cindex "&%ipv6denorm%& expansion item"
11068 .cindex "IP address" normalisation
11069 This expands an IPv6 address to a full eight-element colon-separated set
11070 of hex digits including leading zeroes.
11071 A trailing ipv4-style dotted-decimal set is converted to hex.
11072 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11073
11074 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11075 .cindex "&%ipv6norm%& expansion item"
11076 .cindex "IP address" normalisation
11077 .cindex "IP address" "canonical form"
11078 This converts an IPv6 address to canonical form.
11079 Leading zeroes of groups are omitted, and the longest
11080 set of zero-valued groups is replaced with a double colon.
11081 A trailing ipv4-style dotted-decimal set is converted to hex.
11082 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11083
11084
11085 .vitem &*${lc:*&<&'string'&>&*}*&
11086 .cindex "case forcing in strings"
11087 .cindex "string" "case forcing"
11088 .cindex "lower casing"
11089 .cindex "expansion" "case forcing"
11090 .cindex "&%lc%& expansion item"
11091 This forces the letters in the string into lower-case, for example:
11092 .code
11093 ${lc:$local_part}
11094 .endd
11095 Case is defined per the system C locale.
11096
11097 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11098 .cindex "expansion" "string truncation"
11099 .cindex "&%length%& expansion item"
11100 The &%length%& operator is a simpler interface to the &%length%& function that
11101 can be used when the parameter is a fixed number (as opposed to a string that
11102 changes when expanded). The effect is the same as
11103 .code
11104 ${length{<number>}{<string>}}
11105 .endd
11106 See the description of the general &%length%& item above for details. Note that
11107 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11108 when &%length%& is used as an operator.
11109 All measurement is done in bytes and is not UTF-8 aware.
11110
11111
11112 .vitem &*${listcount:*&<&'string'&>&*}*&
11113 .cindex "expansion" "list item count"
11114 .cindex "list" "item count"
11115 .cindex "list" "count of items"
11116 .cindex "&%listcount%& expansion item"
11117 The string is interpreted as a list and the number of items is returned.
11118
11119
11120 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11121 .cindex "expansion" "named list"
11122 .cindex "&%listnamed%& expansion item"
11123 The name is interpreted as a named list and the content of the list is returned,
11124 expanding any referenced lists, re-quoting as needed for colon-separation.
11125 If the optional type is given it must be one of "a", "d", "h" or "l"
11126 and selects address-, domain-, host- or localpart- lists to search among respectively.
11127 Otherwise all types are searched in an undefined order and the first
11128 matching list is returned.
11129 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11130 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11131
11132
11133 .vitem &*${local_part:*&<&'string'&>&*}*&
11134 .cindex "expansion" "local part extraction"
11135 .cindex "&%local_part%& expansion item"
11136 The string is interpreted as an RFC 2822 address and the local part is
11137 extracted from it. If the string does not parse successfully, the result is
11138 empty.
11139 The parsing correctly handles SMTPUTF8 Unicode in the string.
11140
11141
11142 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11143        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11144 .cindex "masked IP address"
11145 .cindex "IP address" "masking"
11146 .cindex "CIDR notation"
11147 .cindex "expansion" "IP address masking"
11148 .cindex "&%mask%& expansion item"
11149 If the form of the string to be operated on is not an IP address followed by a
11150 slash and an integer (that is, a network address in CIDR notation), the
11151 expansion fails. Otherwise, this operator converts the IP address to binary,
11152 masks off the least significant bits according to the bit count, and converts
11153 the result back to text, with mask appended. For example,
11154 .code
11155 ${mask:10.111.131.206/28}
11156 .endd
11157 returns the string &"10.111.131.192/28"&.
11158
11159 Since this operation is expected to
11160 be mostly used for looking up masked addresses in files, the
11161 normal
11162 result for an IPv6
11163 address uses dots to separate components instead of colons, because colon
11164 terminates a key string in lsearch files. So, for example,
11165 .code
11166 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11167 .endd
11168 returns the string
11169 .code
11170 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11171 .endd
11172 If the optional form &*mask_n*& is used, IPv6 address result are instead
11173 returned in normailsed form, using colons and with zero-compression.
11174 Letters in IPv6 addresses are always output in lower case.
11175
11176
11177 .vitem &*${md5:*&<&'string'&>&*}*&
11178 .cindex "MD5 hash"
11179 .cindex "expansion" "MD5 hash"
11180 .cindex certificate fingerprint
11181 .cindex "&%md5%& expansion item"
11182 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11183 as a 32-digit hexadecimal number, in which any letters are in lower case.
11184
11185 If the string is a single variable of type certificate,
11186 returns the MD5 hash fingerprint of the certificate.
11187
11188
11189 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11190 .cindex "expansion" "numeric hash"
11191 .cindex "hash function" "numeric"
11192 The &%nhash%& operator is a simpler interface to the numeric hashing function
11193 that can be used when the two parameters are fixed numbers (as opposed to
11194 strings that change when expanded). The effect is the same as
11195 .code
11196 ${nhash{<n>}{<m>}{<string>}}
11197 .endd
11198 See the description of the general &%nhash%& item above for details.
11199
11200
11201 .vitem &*${quote:*&<&'string'&>&*}*&
11202 .cindex "quoting" "in string expansions"
11203 .cindex "expansion" "quoting"
11204 .cindex "&%quote%& expansion item"
11205 The &%quote%& operator puts its argument into double quotes if it
11206 is an empty string or
11207 contains anything other than letters, digits, underscores, dots, and hyphens.
11208 Any occurrences of double quotes and backslashes are escaped with a backslash.
11209 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11210 respectively For example,
11211 .code
11212 ${quote:ab"*"cd}
11213 .endd
11214 becomes
11215 .code
11216 "ab\"*\"cd"
11217 .endd
11218 The place where this is useful is when the argument is a substitution from a
11219 variable or a message header.
11220
11221 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11222 .cindex "&%quote_local_part%& expansion item"
11223 This operator is like &%quote%&, except that it quotes the string only if
11224 required to do so by the rules of RFC 2822 for quoting local parts. For
11225 example, a plus sign would not cause quoting (but it would for &%quote%&).
11226 If you are creating a new email address from the contents of &$local_part$&
11227 (or any other unknown data), you should always use this operator.
11228
11229 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11230 will likely use the quoting form.
11231 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11232
11233
11234 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11235 .cindex "quoting" "lookup-specific"
11236 This operator applies lookup-specific quoting rules to the string. Each
11237 query-style lookup type has its own quoting rules which are described with
11238 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11239 .code
11240 ${quote_ldap:two * two}
11241 .endd
11242 returns
11243 .code
11244 two%20%5C2A%20two
11245 .endd
11246 For single-key lookup types, no quoting is ever necessary and this operator
11247 yields an unchanged string.
11248
11249
11250 .vitem &*${randint:*&<&'n'&>&*}*&
11251 .cindex "random number"
11252 This operator returns a somewhat random number which is less than the
11253 supplied number and is at least 0.  The quality of this randomness depends
11254 on how Exim was built; the values are not suitable for keying material.
11255 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11256 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11257 for versions of GnuTLS with that function.
11258 Otherwise, the implementation may be arc4random(), random() seeded by
11259 srandomdev() or srandom(), or a custom implementation even weaker than
11260 random().
11261
11262
11263 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11264 .cindex "expansion" "IP address"
11265 This operator reverses an IP address; for IPv4 addresses, the result is in
11266 dotted-quad decimal form, while for IPv6 addresses the result is in
11267 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11268 for DNS.  For example,
11269 .code
11270 ${reverse_ip:192.0.2.4}
11271 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11272 .endd
11273 returns
11274 .code
11275 4.2.0.192
11276 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
11277 .endd
11278
11279
11280 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11281 .cindex "expansion" "RFC 2047"
11282 .cindex "RFC 2047" "expansion operator"
11283 .cindex "&%rfc2047%& expansion item"
11284 This operator encodes text according to the rules of RFC 2047. This is an
11285 encoding that is used in header lines to encode non-ASCII characters. It is
11286 assumed that the input string is in the encoding specified by the
11287 &%headers_charset%& option, which gets its default at build time. If the string
11288 contains only characters in the range 33&--126, and no instances of the
11289 characters
11290 .code
11291 ? = ( ) < > @ , ; : \ " . [ ] _
11292 .endd
11293 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11294 string, using as many &"encoded words"& as necessary to encode all the
11295 characters.
11296
11297
11298 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11299 .cindex "expansion" "RFC 2047"
11300 .cindex "RFC 2047" "decoding"
11301 .cindex "&%rfc2047d%& expansion item"
11302 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11303 bytes are replaced by question marks. Characters are converted into the
11304 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11305 not recognized unless &%check_rfc2047_length%& is set false.
11306
11307 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11308 access a header line, RFC 2047 decoding is done automatically. You do not need
11309 to use this operator as well.
11310
11311
11312
11313 .vitem &*${rxquote:*&<&'string'&>&*}*&
11314 .cindex "quoting" "in regular expressions"
11315 .cindex "regular expressions" "quoting"
11316 .cindex "&%rxquote%& expansion item"
11317 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11318 characters in its argument. This is useful when substituting the values of
11319 variables or headers inside regular expressions.
11320
11321
11322 .vitem &*${sha1:*&<&'string'&>&*}*&
11323 .cindex "SHA-1 hash"
11324 .cindex "expansion" "SHA-1 hashing"
11325 .cindex certificate fingerprint
11326 .cindex "&%sha1%& expansion item"
11327 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11328 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11329
11330 If the string is a single variable of type certificate,
11331 returns the SHA-1 hash fingerprint of the certificate.
11332
11333
11334 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11335        &*${sha2:*&<&'string'&>&*}*& &&&
11336        &*${sha2_<n>:*&<&'string'&>&*}*&
11337 .cindex "SHA-256 hash"
11338 .cindex "SHA-2 hash"
11339 .cindex certificate fingerprint
11340 .cindex "expansion" "SHA-256 hashing"
11341 .cindex "&%sha256%& expansion item"
11342 .cindex "&%sha2%& expansion item"
11343 The &%sha256%& operator computes the SHA-256 hash value of the string
11344 and returns
11345 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11346
11347 If the string is a single variable of type certificate,
11348 returns the SHA-256 hash fingerprint of the certificate.
11349
11350 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11351 (except for certificates, which are not supported).
11352 Finally, if an underbar
11353 and a number is appended it specifies the output length, selecting a
11354 member of the SHA-2 family of hash functions.
11355 Values of 256, 384 and 512 are accepted, with 256 being the default.
11356
11357
11358 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11359        &*${sha3_<n>:*&<&'string'&>&*}*&
11360 .cindex "SHA3 hash"
11361 .cindex "expansion" "SHA3 hashing"
11362 .cindex "&%sha3%& expansion item"
11363 The &%sha3%& operator computes the SHA3-256 hash value of the string
11364 and returns
11365 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11366
11367 If a number is appended, separated by an underbar, it specifies
11368 the output length.  Values of 224, 256, 384 and 512 are accepted;
11369 with 256 being the default.
11370
11371 The &%sha3%& expansion item is only supported if Exim has been
11372 compiled with GnuTLS 3.5.0 or later,
11373 or OpenSSL 1.1.1 or later.
11374 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11375
11376
11377 .vitem &*${stat:*&<&'string'&>&*}*&
11378 .cindex "expansion" "statting a file"
11379 .cindex "file" "extracting characteristics"
11380 .cindex "&%stat%& expansion item"
11381 The string, after expansion, must be a file path. A call to the &[stat()]&
11382 function is made for this path. If &[stat()]& fails, an error occurs and the
11383 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11384 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11385 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11386 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11387 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11388 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11389 can extract individual fields using the &%extract%& expansion item.
11390
11391 The use of the &%stat%& expansion in users' filter files can be locked out by
11392 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11393 systems for files larger than 2GB.
11394
11395 .vitem &*${str2b64:*&<&'string'&>&*}*&
11396 .cindex "&%str2b64%& expansion item"
11397 Now deprecated, a synonym for the &%base64%& expansion operator.
11398
11399
11400
11401 .vitem &*${strlen:*&<&'string'&>&*}*&
11402 .cindex "expansion" "string length"
11403 .cindex "string" "length in expansion"
11404 .cindex "&%strlen%& expansion item"
11405 The item is replaced by the length of the expanded string, expressed as a
11406 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11407 All measurement is done in bytes and is not UTF-8 aware.
11408
11409
11410 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11411 .cindex "&%substr%& expansion item"
11412 .cindex "substring extraction"
11413 .cindex "expansion" "substring expansion"
11414 The &%substr%& operator is a simpler interface to the &%substr%& function that
11415 can be used when the two parameters are fixed numbers (as opposed to strings
11416 that change when expanded). The effect is the same as
11417 .code
11418 ${substr{<start>}{<length>}{<string>}}
11419 .endd
11420 See the description of the general &%substr%& item above for details. The
11421 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11422 All measurement is done in bytes and is not UTF-8 aware.
11423
11424 .vitem &*${time_eval:*&<&'string'&>&*}*&
11425 .cindex "&%time_eval%& expansion item"
11426 .cindex "time interval" "decoding"
11427 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11428 seconds.
11429
11430 .vitem &*${time_interval:*&<&'string'&>&*}*&
11431 .cindex "&%time_interval%& expansion item"
11432 .cindex "time interval" "formatting"
11433 The argument (after sub-expansion) must be a sequence of decimal digits that
11434 represents an interval of time as a number of seconds. It is converted into a
11435 number of larger units and output in Exim's normal time format, for example,
11436 &`1w3d4h2m6s`&.
11437
11438 .vitem &*${uc:*&<&'string'&>&*}*&
11439 .cindex "case forcing in strings"
11440 .cindex "string" "case forcing"
11441 .cindex "upper casing"
11442 .cindex "expansion" "case forcing"
11443 .cindex "&%uc%& expansion item"
11444 This forces the letters in the string into upper-case.
11445 Case is defined per the system C locale.
11446
11447 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11448 .cindex "correction of invalid utf-8 sequences in strings"
11449 .cindex "utf-8" "utf-8 sequences"
11450 .cindex "incorrect utf-8"
11451 .cindex "expansion" "utf-8 forcing"
11452 .cindex "&%utf8clean%& expansion item"
11453 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11454 In versions of Exim before 4.92, this did not correctly do so for a truncated
11455 final codepoint's encoding, and the character would be silently dropped.
11456 If you must handle detection of this scenario across both sets of Exim behavior,
11457 the complexity will depend upon the task.
11458 For instance, to detect if the first character is multibyte and a 1-byte
11459 extraction can be successfully used as a path component (as is common for
11460 dividing up delivery folders), you might use:
11461 .code
11462 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11463 .endd
11464 (which will false-positive if the first character of the local part is a
11465 literal question mark).
11466
11467 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11468        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11469        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11470        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11471 .cindex expansion UTF-8
11472 .cindex UTF-8 expansion
11473 .cindex EAI
11474 .cindex internationalisation
11475 .cindex "&%utf8_domain_to_alabel%& expansion item"
11476 .cindex "&%utf8_domain_from_alabel%& expansion item"
11477 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11478 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11479 These convert EAI mail name components between UTF-8 and a-label forms.
11480 For information on internationalisation support see &<<SECTi18nMTA>>&.
11481 .endlist
11482
11483
11484
11485
11486
11487
11488 .section "Expansion conditions" "SECTexpcond"
11489 .scindex IIDexpcond "expansion" "conditions"
11490 The following conditions are available for testing by the &%${if%& construct
11491 while expanding strings:
11492
11493 .vlist
11494 .vitem &*!*&<&'condition'&>
11495 .cindex "expansion" "negating a condition"
11496 .cindex "negation" "in expansion condition"
11497 Preceding any condition with an exclamation mark negates the result of the
11498 condition.
11499
11500 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11501 .cindex "numeric comparison"
11502 .cindex "expansion" "numeric comparison"
11503 There are a number of symbolic operators for doing numeric comparisons. They
11504 are:
11505 .itable none 0 0 2 10* left 90* left
11506 .irow "=   " "equal"
11507 .irow "==  " "equal"
11508 .irow ">   " "greater"
11509 .irow ">=  " "greater or equal"
11510 .irow "<   " "less"
11511 .irow "<=  " "less or equal"
11512 .endtable
11513 For example:
11514 .code
11515 ${if >{$message_size}{10M} ...
11516 .endd
11517 Note that the general negation operator provides for inequality testing. The
11518 two strings must take the form of optionally signed decimal integers,
11519 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11520 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11521 As a special case, the numerical value of an empty string is taken as
11522 zero.
11523
11524 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11525 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11526 10M, not if 10M is larger than &$message_size$&.
11527
11528
11529 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11530         {*&<&'arg2'&>&*}...}*&
11531 .cindex "expansion" "calling an acl"
11532 .cindex "&%acl%&" "expansion condition"
11533 The name and zero to nine argument strings are first expanded separately.  The expanded
11534 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11535 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11536 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11537 and may use the variables; if another acl expansion is used the values
11538 are restored after it returns.  If the ACL sets
11539 a value using a "message =" modifier the variable $value becomes
11540 the result of the expansion, otherwise it is empty.
11541 If the ACL returns accept the condition is true; if deny, false.
11542 If the ACL returns defer the result is a forced-fail.
11543
11544 .vitem &*bool&~{*&<&'string'&>&*}*&
11545 .cindex "expansion" "boolean parsing"
11546 .cindex "&%bool%& expansion condition"
11547 This condition turns a string holding a true or false representation into
11548 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11549 (case-insensitively); also integer numbers map to true if non-zero,
11550 false if zero.
11551 An empty string is treated as false.
11552 Leading and trailing whitespace is ignored;
11553 thus a string consisting only of whitespace is false.
11554 All other string values will result in expansion failure.
11555
11556 When combined with ACL variables, this expansion condition will let you
11557 make decisions in one place and act on those decisions in another place.
11558 For example:
11559 .code
11560 ${if bool{$acl_m_privileged_sender} ...
11561 .endd
11562
11563
11564 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11565 .cindex "expansion" "boolean parsing"
11566 .cindex "&%bool_lax%& expansion condition"
11567 Like &%bool%&, this condition turns a string into a boolean state.  But
11568 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11569 loose definition that the Router &%condition%& option uses.  The empty string
11570 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11571 true.  Leading and trailing whitespace is ignored.
11572
11573 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11574
11575 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11576 .cindex "expansion" "encrypted comparison"
11577 .cindex "encrypted strings, comparing"
11578 .cindex "&%crypteq%& expansion condition"
11579 This condition is included in the Exim binary if it is built to support any
11580 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11581 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11582 included in the binary.
11583
11584 The &%crypteq%& condition has two arguments. The first is encrypted and
11585 compared against the second, which is already encrypted. The second string may
11586 be in the LDAP form for storing encrypted strings, which starts with the
11587 encryption type in curly brackets, followed by the data. If the second string
11588 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11589 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11590 Typically this will be a field from a password file. An example of an encrypted
11591 string in LDAP form is:
11592 .code
11593 {md5}CY9rzUYh03PK3k6DJie09g==
11594 .endd
11595 If such a string appears directly in an expansion, the curly brackets have to
11596 be quoted, because they are part of the expansion syntax. For example:
11597 .code
11598 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11599 .endd
11600 The following encryption types (whose names are matched case-independently) are
11601 supported:
11602
11603 .ilist
11604 .cindex "MD5 hash"
11605 .cindex "base64 encoding" "in encrypted password"
11606 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11607 printable characters to compare with the remainder of the second string. If the
11608 length of the comparison string is 24, Exim assumes that it is base64 encoded
11609 (as in the above example). If the length is 32, Exim assumes that it is a
11610 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11611 comparison fails.
11612
11613 .next
11614 .cindex "SHA-1 hash"
11615 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11616 printable characters to compare with the remainder of the second string. If the
11617 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11618 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11619 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11620
11621 .next
11622 .cindex "&[crypt()]&"
11623 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11624 only the first eight characters of the password. However, in modern operating
11625 systems this is no longer true, and in many cases the entire password is used,
11626 whatever its length.
11627
11628 .next
11629 .cindex "&[crypt16()]&"
11630 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11631 use up to 16 characters of the password in some operating systems. Again, in
11632 modern operating systems, more characters may be used.
11633 .endlist
11634 Exim has its own version of &[crypt16()]&, which is just a double call to
11635 &[crypt()]&. For operating systems that have their own version, setting
11636 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11637 operating system version instead of its own. This option is set by default in
11638 the OS-dependent &_Makefile_& for those operating systems that are known to
11639 support &[crypt16()]&.
11640
11641 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11642 it was not using the same algorithm as some operating systems' versions. It
11643 turns out that as well as &[crypt16()]& there is a function called
11644 &[bigcrypt()]& in some operating systems. This may or may not use the same
11645 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11646
11647 However, since there is now a move away from the traditional &[crypt()]&
11648 functions towards using SHA1 and other algorithms, tidying up this area of
11649 Exim is seen as very low priority.
11650
11651 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11652 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11653 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11654 default is &`{crypt}`&. Whatever the default, you can always use either
11655 function by specifying it explicitly in curly brackets.
11656
11657 .vitem &*def:*&<&'variable&~name'&>
11658 .cindex "expansion" "checking for empty variable"
11659 .cindex "&%def%& expansion condition"
11660 The &%def%& condition must be followed by the name of one of the expansion
11661 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11662 variable does not contain the empty string. For example:
11663 .code
11664 ${if def:sender_ident {from $sender_ident}}
11665 .endd
11666 Note that the variable name is given without a leading &%$%& character. If the
11667 variable does not exist, the expansion fails.
11668
11669 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11670         &~&*def:h_*&<&'header&~name'&>&*:*&"
11671 .cindex "expansion" "checking header line existence"
11672 This condition is true if a message is being processed and the named header
11673 exists in the message. For example,
11674 .code
11675 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11676 .endd
11677 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11678 the header name must be terminated by a colon if white space does not follow.
11679
11680 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11681        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11682 .cindex "string" "comparison"
11683 .cindex "expansion" "string comparison"
11684 .cindex "&%eq%& expansion condition"
11685 .cindex "&%eqi%& expansion condition"
11686 The two substrings are first expanded. The condition is true if the two
11687 resulting strings are identical. For &%eq%& the comparison includes the case of
11688 letters, whereas for &%eqi%& the comparison is case-independent, where
11689 case is defined per the system C locale.
11690
11691 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11692 .cindex "expansion" "file existence test"
11693 .cindex "file" "existence test"
11694 .cindex "&%exists%&, expansion condition"
11695 The substring is first expanded and then interpreted as an absolute path. The
11696 condition is true if the named file (or directory) exists. The existence test
11697 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11698 users' filter files may be locked out by the system administrator.
11699
11700 &*Note:*& Testing a path using this condition is not a sufficient way of
11701 de-tainting it.
11702 Consider using a dsearch lookup.
11703
11704 .vitem &*first_delivery*&
11705 .cindex "delivery" "first"
11706 .cindex "first delivery"
11707 .cindex "expansion" "first delivery test"
11708 .cindex "&%first_delivery%& expansion condition"
11709 .cindex retry condition
11710 This condition, which has no data, is true during a message's first delivery
11711 attempt. It is false during any subsequent delivery attempts.
11712
11713
11714 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11715        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11716 .cindex "list" "iterative conditions"
11717 .cindex "expansion" "&*forall*& condition"
11718 .cindex "expansion" "&*forany*& condition"
11719 .vindex "&$item$&"
11720 These conditions iterate over a list. The first argument is expanded to form
11721 the list. By default, the list separator is a colon, but it can be changed by
11722 the normal method (&<<SECTlistsepchange>>&).
11723 The second argument is interpreted as a condition that is to
11724 be applied to each item in the list in turn. During the interpretation of the
11725 condition, the current list item is placed in a variable called &$item$&.
11726 .ilist
11727 For &*forany*&, interpretation stops if the condition is true for any item, and
11728 the result of the whole condition is true. If the condition is false for all
11729 items in the list, the overall condition is false.
11730 .next
11731 For &*forall*&, interpretation stops if the condition is false for any item,
11732 and the result of the whole condition is false. If the condition is true for
11733 all items in the list, the overall condition is true.
11734 .endlist
11735 Note that negation of &*forany*& means that the condition must be false for all
11736 items for the overall condition to succeed, and negation of &*forall*& means
11737 that the condition must be false for at least one item. In this example, the
11738 list separator is changed to a comma:
11739 .code
11740 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11741 .endd
11742 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11743 being processed, to enable these expansion items to be nested.
11744
11745 To scan a named list, expand it with the &*listnamed*& operator.
11746
11747 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11748        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11749        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11750        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11751 .cindex JSON "iterative conditions"
11752 .cindex JSON expansions
11753 .cindex expansion "&*forall_json*& condition"
11754 .cindex expansion "&*forany_json*& condition"
11755 .cindex expansion "&*forall_jsons*& condition"
11756 .cindex expansion "&*forany_jsons*& condition"
11757 As for the above, except that the first argument must, after expansion,
11758 be a JSON array.
11759 The array separator is not changeable.
11760 For the &"jsons"& variants the elements are expected to be JSON strings
11761 and have their quotes removed before the evaluation of the condition.
11762
11763
11764
11765 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11766        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11767 .cindex "string" "comparison"
11768 .cindex "expansion" "string comparison"
11769 .cindex "&%ge%& expansion condition"
11770 .cindex "&%gei%& expansion condition"
11771 The two substrings are first expanded. The condition is true if the first
11772 string is lexically greater than or equal to the second string. For &%ge%& the
11773 comparison includes the case of letters, whereas for &%gei%& the comparison is
11774 case-independent.
11775 Case and collation order are defined per the system C locale.
11776
11777 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11778        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11779 .cindex "string" "comparison"
11780 .cindex "expansion" "string comparison"
11781 .cindex "&%gt%& expansion condition"
11782 .cindex "&%gti%& expansion condition"
11783 The two substrings are first expanded. The condition is true if the first
11784 string is lexically greater than the second string. For &%gt%& the comparison
11785 includes the case of letters, whereas for &%gti%& the comparison is
11786 case-independent.
11787 Case and collation order are defined per the system C locale.
11788
11789
11790 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11791 SRS decode.  See SECT &<<SECTSRS>>& for details.
11792
11793
11794 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11795        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11796 .cindex "string" "comparison"
11797 .cindex "list" "iterative conditions"
11798 Both strings are expanded; the second string is treated as a list of simple
11799 strings; if the first string is a member of the second, then the condition
11800 is true.
11801 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11802
11803 These are simpler to use versions of the more powerful &*forany*& condition.
11804 Examples, and the &*forany*& equivalents:
11805 .code
11806 ${if inlist{needle}{foo:needle:bar}}
11807   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11808 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11809   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11810 .endd
11811
11812 The variable &$value$& will be set for a successful match and can be
11813 used in the success clause of an &%if%& expansion item using the condition.
11814 .cindex "tainted data" "de-tainting"
11815 .cindex "de-tainting" "using an inlist expansion condition"
11816 It will have the same taint status as the list; expansions such as
11817 .code
11818 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11819 .endd
11820 can be used for de-tainting.
11821 Any previous &$value$& is restored after the if.
11822
11823
11824 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11825        &*isip4&~{*&<&'string'&>&*}*& &&&
11826        &*isip6&~{*&<&'string'&>&*}*&
11827 .cindex "IP address" "testing string format"
11828 .cindex "string" "testing for IP address"
11829 .cindex "&%isip%& expansion condition"
11830 .cindex "&%isip4%& expansion condition"
11831 .cindex "&%isip6%& expansion condition"
11832 The substring is first expanded, and then tested to see if it has the form of
11833 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11834 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11835
11836 For an IPv4 address, the test is for four dot-separated components, each of
11837 which consists of from one to three digits. For an IPv6 address, up to eight
11838 colon-separated components are permitted, each containing from one to four
11839 hexadecimal digits. There may be fewer than eight components if an empty
11840 component (adjacent colons) is present. Only one empty component is permitted.
11841
11842 &*Note*&: The checks used to be just on the form of the address; actual numerical
11843 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11844 check.
11845 This is no longer the case.
11846
11847 The main use of these tests is to distinguish between IP addresses and
11848 host names, or between IPv4 and IPv6 addresses. For example, you could use
11849 .code
11850 ${if isip4{$sender_host_address}...
11851 .endd
11852 to test which IP version an incoming SMTP connection is using.
11853
11854 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11855 .cindex "LDAP" "use for authentication"
11856 .cindex "expansion" "LDAP authentication test"
11857 .cindex "&%ldapauth%& expansion condition"
11858 This condition supports user authentication using LDAP. See section
11859 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11860 queries. For this use, the query must contain a user name and password. The
11861 query itself is not used, and can be empty. The condition is true if the
11862 password is not empty, and the user name and password are accepted by the LDAP
11863 server. An empty password is rejected without calling LDAP because LDAP binds
11864 with an empty password are considered anonymous regardless of the username, and
11865 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11866 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11867 this can be used.
11868
11869
11870 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11871        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11872 .cindex "string" "comparison"
11873 .cindex "expansion" "string comparison"
11874 .cindex "&%le%& expansion condition"
11875 .cindex "&%lei%& expansion condition"
11876 The two substrings are first expanded. The condition is true if the first
11877 string is lexically less than or equal to the second string. For &%le%& the
11878 comparison includes the case of letters, whereas for &%lei%& the comparison is
11879 case-independent.
11880 Case and collation order are defined per the system C locale.
11881
11882 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11883        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11884 .cindex "string" "comparison"
11885 .cindex "expansion" "string comparison"
11886 .cindex "&%lt%& expansion condition"
11887 .cindex "&%lti%& expansion condition"
11888 The two substrings are first expanded. The condition is true if the first
11889 string is lexically less than the second string. For &%lt%& the comparison
11890 includes the case of letters, whereas for &%lti%& the comparison is
11891 case-independent.
11892 Case and collation order are defined per the system C locale.
11893
11894
11895 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11896 .cindex "expansion" "regular expression comparison"
11897 .cindex "regular expressions" "match in expanded string"
11898 .cindex "&%match%& expansion condition"
11899 The two substrings are first expanded. The second is then treated as a regular
11900 expression and applied to the first. Because of the pre-expansion, if the
11901 regular expression contains dollar, or backslash characters, they must be
11902 escaped. Care must also be taken if the regular expression contains braces
11903 (curly brackets). A closing brace must be escaped so that it is not taken as a
11904 premature termination of <&'string2'&>. The easiest approach is to use the
11905 &`\N`& feature to disable expansion of the regular expression.
11906 For example,
11907 .code
11908 ${if match {$local_part}{\N^\d{3}\N} ...
11909 .endd
11910 If the whole expansion string is in double quotes, further escaping of
11911 backslashes is also required.
11912
11913 The condition is true if the regular expression match succeeds.
11914 The regular expression is not required to begin with a circumflex
11915 metacharacter, but if there is no circumflex, the expression is not anchored,
11916 and it may match anywhere in the subject, not just at the start. If you want
11917 the pattern to match at the end of the subject, you must include the &`$`&
11918 metacharacter at an appropriate point.
11919 All character handling is done in bytes and is not UTF-8 aware,
11920 but we might change this in a future Exim release.
11921
11922 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11923 At the start of an &%if%& expansion the values of the numeric variable
11924 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11925 succeeds causes them to be reset to the substrings of that condition and they
11926 will have these values during the expansion of the success string. At the end
11927 of the &%if%& expansion, the previous values are restored. After testing a
11928 combination of conditions using &%or%&, the subsequent values of the numeric
11929 variables are those of the condition that succeeded.
11930
11931 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11932 .cindex "&%match_address%& expansion condition"
11933 See &*match_local_part*&.
11934
11935 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11936 .cindex "&%match_domain%& expansion condition"
11937 See &*match_local_part*&.
11938
11939 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11940 .cindex "&%match_ip%& expansion condition"
11941 This condition matches an IP address to a list of IP address patterns. It must
11942 be followed by two argument strings. The first (after expansion) must be an IP
11943 address or an empty string. The second (not expanded) is a restricted host
11944 list that can match only an IP address, not a host name. For example:
11945 .code
11946 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11947 .endd
11948 The specific types of host list item that are permitted in the list are:
11949
11950 .ilist
11951 An IP address, optionally with a CIDR mask.
11952 .next
11953 A single asterisk, which matches any IP address.
11954 .next
11955 An empty item, which matches only if the IP address is empty. This could be
11956 useful for testing for a locally submitted message or one from specific hosts
11957 in a single test such as
11958 . ==== As this is a nested list, any displays it contains must be indented
11959 . ==== as otherwise they are too far to the left. This comment applies to
11960 . ==== the use of xmlto plus fop. There's no problem when formatting with
11961 . ==== sdop, with or without the extra indent.
11962 .code
11963   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11964 .endd
11965 where the first item in the list is the empty string.
11966 .next
11967 The item @[] matches any of the local host's interface addresses.
11968 .next
11969 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11970 even if &`net-`& is not specified. There is never any attempt to turn the IP
11971 address into a host name. The most common type of linear search for
11972 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11973 masks. For example:
11974 .code
11975   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11976 .endd
11977 It is of course possible to use other kinds of lookup, and in such a case, you
11978 do need to specify the &`net-`& prefix if you want to specify a specific
11979 address mask, for example:
11980 .code
11981   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11982 .endd
11983 However, unless you are combining a &%match_ip%& condition with others, it is
11984 just as easy to use the fact that a lookup is itself a condition, and write:
11985 .code
11986   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11987 .endd
11988 .endlist ilist
11989
11990 Note that <&'string2'&> is not itself subject to string expansion, unless
11991 Exim was built with the EXPAND_LISTMATCH_RHS option.
11992
11993 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11994
11995 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11996 .cindex "domain list" "in expansion condition"
11997 .cindex "address list" "in expansion condition"
11998 .cindex "local part" "list, in expansion condition"
11999 .cindex "&%match_local_part%& expansion condition"
12000 This condition, together with &%match_address%& and &%match_domain%&, make it
12001 possible to test domain, address, and local part lists within expansions. Each
12002 condition requires two arguments: an item and a list to match. A trivial
12003 example is:
12004 .code
12005 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12006 .endd
12007 In each case, the second argument may contain any of the allowable items for a
12008 list of the appropriate type. Also, because the second argument
12009 is a standard form of list, it is possible to refer to a named list.
12010 Thus, you can use conditions like this:
12011 .code
12012 ${if match_domain{$domain}{+local_domains}{...
12013 .endd
12014 .cindex "&`+caseful`&"
12015 For address lists, the matching starts off caselessly, but the &`+caseful`&
12016 item can be used, as in all address lists, to cause subsequent items to
12017 have their local parts matched casefully. Domains are always matched
12018 caselessly.
12019
12020 The variable &$value$& will be set for a successful match and can be
12021 used in the success clause of an &%if%& expansion item using the condition.
12022 .cindex "tainted data" "de-tainting"
12023 .cindex "de-tainting" "using a match_local_part expansion condition"
12024 It will have the same taint status as the list; expansions such as
12025 .code
12026 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12027 .endd
12028 can be used for de-tainting.
12029 Any previous &$value$& is restored after the if.
12030
12031 Note that <&'string2'&> is not itself subject to string expansion, unless
12032 Exim was built with the EXPAND_LISTMATCH_RHS option.
12033
12034 &*Note*&: Host lists are &'not'& supported in this way. This is because
12035 hosts have two identities: a name and an IP address, and it is not clear
12036 how to specify cleanly how such a test would work. However, IP addresses can be
12037 matched using &%match_ip%&.
12038
12039 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12040 .cindex "PAM authentication"
12041 .cindex "AUTH" "with PAM"
12042 .cindex "Solaris" "PAM support"
12043 .cindex "expansion" "PAM authentication test"
12044 .cindex "&%pam%& expansion condition"
12045 &'Pluggable Authentication Modules'&
12046 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12047 available in Solaris
12048 and in some GNU/Linux distributions.
12049 The Exim support, which is intended for use in conjunction with
12050 the SMTP AUTH command, is available only if Exim is compiled with
12051 .code
12052 SUPPORT_PAM=yes
12053 .endd
12054 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12055 in some releases of GNU/Linux &%-ldl%& is also needed.
12056
12057 The argument string is first expanded, and the result must be a
12058 colon-separated list of strings. Leading and trailing white space is ignored.
12059 The PAM module is initialized with the service name &"exim"& and the user name
12060 taken from the first item in the colon-separated data string (<&'string1'&>).
12061 The remaining items in the data string are passed over in response to requests
12062 from the authentication function. In the simple case there will only be one
12063 request, for a password, so the data consists of just two strings.
12064
12065 There can be problems if any of the strings are permitted to contain colon
12066 characters. In the usual way, these have to be doubled to avoid being taken as
12067 separators.
12068 The &%listquote%& expansion item can be used for this.
12069 For example, the configuration
12070 of a LOGIN authenticator might contain this setting:
12071 .code
12072 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12073 .endd
12074 In some operating systems, PAM authentication can be done only from a process
12075 running as root. Since Exim is running as the Exim user when receiving
12076 messages, this means that PAM cannot be used directly in those systems.
12077 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12078
12079
12080 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12081 .cindex "&'pwcheck'& daemon"
12082 .cindex "Cyrus"
12083 .cindex "expansion" "&'pwcheck'& authentication test"
12084 .cindex "&%pwcheck%& expansion condition"
12085 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12086 This is one way of making it possible for passwords to be checked by a process
12087 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12088 deprecated. Its replacement is &'saslauthd'& (see below).
12089
12090 The pwcheck support is not included in Exim by default. You need to specify
12091 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12092 building Exim. For example:
12093 .code
12094 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12095 .endd
12096 You do not need to install the full Cyrus software suite in order to use
12097 the pwcheck daemon. You can compile and install just the daemon alone
12098 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12099 access to the &_/var/pwcheck_& directory.
12100
12101 The &%pwcheck%& condition takes one argument, which must be the user name and
12102 password, separated by a colon. For example, in a LOGIN authenticator
12103 configuration, you might have this:
12104 .code
12105 server_condition = ${if pwcheck{$auth1:$auth2}}
12106 .endd
12107 Again, for a PLAIN authenticator configuration, this would be:
12108 .code
12109 server_condition = ${if pwcheck{$auth2:$auth3}}
12110 .endd
12111 .vitem &*queue_running*&
12112 .cindex "queue runner" "detecting when delivering from"
12113 .cindex "expansion" "queue runner test"
12114 .cindex "&%queue_running%& expansion condition"
12115 This condition, which has no data, is true during delivery attempts that are
12116 initiated by queue runner processes, and false otherwise.
12117
12118
12119 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12120 .cindex "Radius"
12121 .cindex "expansion" "Radius authentication"
12122 .cindex "&%radius%& expansion condition"
12123 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12124 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12125 the Radius client configuration file in order to build Exim with Radius
12126 support.
12127
12128 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12129 library, using the original API. If you are using release 0.4.0 or later of
12130 this library, you need to set
12131 .code
12132 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12133 .endd
12134 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12135 &%libradius%& library that comes with FreeBSD. To do this, set
12136 .code
12137 RADIUS_LIB_TYPE=RADLIB
12138 .endd
12139 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12140 You may also have to supply a suitable setting in EXTRALIBS so that the
12141 Radius library can be found when Exim is linked.
12142
12143 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12144 Radius client library, which calls the Radius server. The condition is true if
12145 the authentication is successful. For example:
12146 .code
12147 server_condition = ${if radius{<arguments>}}
12148 .endd
12149
12150
12151 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12152         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12153 .cindex "&'saslauthd'& daemon"
12154 .cindex "Cyrus"
12155 .cindex "expansion" "&'saslauthd'& authentication test"
12156 .cindex "&%saslauthd%& expansion condition"
12157 This condition supports user authentication using the Cyrus &'saslauthd'&
12158 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12159 Using this daemon is one way of making it possible for passwords to be checked
12160 by a process that is not running as root.
12161
12162 The saslauthd support is not included in Exim by default. You need to specify
12163 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12164 building Exim. For example:
12165 .code
12166 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12167 .endd
12168 You do not need to install the full Cyrus software suite in order to use
12169 the saslauthd daemon. You can compile and install just the daemon alone
12170 from the Cyrus SASL library.
12171
12172 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12173 two are mandatory. For example:
12174 .code
12175 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12176 .endd
12177 The service and the realm are optional (which is why the arguments are enclosed
12178 in their own set of braces). For details of the meaning of the service and
12179 realm, and how to run the daemon, consult the Cyrus documentation.
12180 .endlist vlist
12181
12182
12183
12184 .section "Combining expansion conditions" "SECID84"
12185 .cindex "expansion" "combining conditions"
12186 Several conditions can be tested at once by combining them using the &%and%&
12187 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12188 conditions on their own, and precede their lists of sub-conditions. Each
12189 sub-condition must be enclosed in braces within the overall braces that contain
12190 the list. No repetition of &%if%& is used.
12191
12192
12193 .vlist
12194 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12195 .cindex "&""or""& expansion condition"
12196 .cindex "expansion" "&""or""& of conditions"
12197 The sub-conditions are evaluated from left to right. The condition is true if
12198 any one of the sub-conditions is true.
12199 For example,
12200 .code
12201 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12202 .endd
12203 When a true sub-condition is found, the following ones are parsed but not
12204 evaluated. If there are several &"match"& sub-conditions the values of the
12205 numeric variables afterwards are taken from the first one that succeeds.
12206
12207 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12208 .cindex "&""and""& expansion condition"
12209 .cindex "expansion" "&""and""& of conditions"
12210 The sub-conditions are evaluated from left to right. The condition is true if
12211 all of the sub-conditions are true. If there are several &"match"&
12212 sub-conditions, the values of the numeric variables afterwards are taken from
12213 the last one. When a false sub-condition is found, the following ones are
12214 parsed but not evaluated.
12215 .endlist
12216 .ecindex IIDexpcond
12217
12218
12219
12220
12221 .section "Expansion variables" "SECTexpvar"
12222 .cindex "expansion" "variables, list of"
12223 This section contains an alphabetical list of all the expansion variables. Some
12224 of them are available only when Exim is compiled with specific options such as
12225 support for TLS or the content scanning extension.
12226 .cindex "tainted data"
12227 Variables marked as &'tainted'& are likely to carry data supplied by
12228 a potential attacker.
12229 Variables without such marking may also, depending on how their
12230 values are created.
12231 Such variables should not be further expanded,
12232 used as filenames
12233 or used as command-line arguments for external commands.
12234
12235 .vlist
12236 .vitem "&$0$&, &$1$&, etc"
12237 .cindex "numerical variables (&$1$& &$2$& etc)"
12238 When a &%match%& expansion condition succeeds, these variables contain the
12239 captured substrings identified by the regular expression during subsequent
12240 processing of the success string of the containing &%if%& expansion item.
12241 In the expansion condition case
12242 they do not retain their values afterwards; in fact, their previous
12243 values are restored at the end of processing an &%if%& item. The numerical
12244 variables may also be set externally by some other matching process which
12245 precedes the expansion of the string. For example, the commands available in
12246 Exim filter files include an &%if%& command with its own regular expression
12247 matching condition.
12248 If the subject string was tainted then any captured substring will also be.
12249
12250 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12251 Within an acl condition, expansion condition or expansion item
12252 any arguments are copied to these variables,
12253 any unused variables being made empty.
12254
12255 .vitem "&$acl_c...$&"
12256 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12257 can be given any name that starts with &$acl_c$& and is at least six characters
12258 long, but the sixth character must be either a digit or an underscore. For
12259 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12260 variables persist throughout the lifetime of an SMTP connection. They can be
12261 used to pass information between ACLs and between different invocations of the
12262 same ACL. When a message is received, the values of these variables are saved
12263 with the message, and can be accessed by filters, routers, and transports
12264 during subsequent delivery.
12265
12266 .vitem "&$acl_m...$&"
12267 These variables are like the &$acl_c...$& variables, except that their values
12268 are reset after a message has been received. Thus, if several messages are
12269 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12270 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12271 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12272 message is received, the values of these variables are saved with the message,
12273 and can be accessed by filters, routers, and transports during subsequent
12274 delivery.
12275
12276 .vitem &$acl_narg$&
12277 Within an acl condition, expansion condition or expansion item
12278 this variable has the number of arguments.
12279
12280 .vitem &$acl_verify_message$&
12281 .vindex "&$acl_verify_message$&"
12282 After an address verification has failed, this variable contains the failure
12283 message. It retains its value for use in subsequent modifiers of the verb.
12284 The message can be preserved by coding like this:
12285 .code
12286 warn !verify = sender
12287      set acl_m0 = $acl_verify_message
12288 .endd
12289 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12290 &%log_message%& modifiers, to include information about the verification
12291 failure.
12292 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12293
12294 .vitem &$address_data$&
12295 .vindex "&$address_data$&"
12296 This variable is set by means of the &%address_data%& option in routers. The
12297 value then remains with the address while it is processed by subsequent routers
12298 and eventually a transport. If the transport is handling multiple addresses,
12299 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12300 for more details. &*Note*&: The contents of &$address_data$& are visible in
12301 user filter files.
12302
12303 If &$address_data$& is set when the routers are called from an ACL to verify
12304 a recipient address, the final value is still in the variable for subsequent
12305 conditions and modifiers of the ACL statement. If routing the address caused it
12306 to be redirected to just one address, the child address is also routed as part
12307 of the verification, and in this case the final value of &$address_data$& is
12308 from the child's routing.
12309
12310 If &$address_data$& is set when the routers are called from an ACL to verify a
12311 sender address, the final value is also preserved, but this time in
12312 &$sender_address_data$&, to distinguish it from data from a recipient
12313 address.
12314
12315 In both cases (recipient and sender verification), the value does not persist
12316 after the end of the current ACL statement. If you want to preserve
12317 these values for longer, you can save them in ACL variables.
12318
12319 .vitem &$address_file$&
12320 .vindex "&$address_file$&"
12321 When, as a result of aliasing, forwarding, or filtering, a message is directed
12322 to a specific file, this variable holds the name of the file when the transport
12323 is running. At other times, the variable is empty. For example, using the
12324 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12325 .code
12326 /home/r2d2/savemail
12327 .endd
12328 then when the &(address_file)& transport is running, &$address_file$&
12329 contains the text string &`/home/r2d2/savemail`&.
12330 .cindex "Sieve filter" "value of &$address_file$&"
12331 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12332 then up to the transport configuration to generate an appropriate absolute path
12333 to the relevant file.
12334
12335 .vitem &$address_pipe$&
12336 .vindex "&$address_pipe$&"
12337 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12338 this variable holds the pipe command when the transport is running.
12339
12340 .vitem "&$auth1$& &-- &$auth4$&"
12341 .vindex "&$auth1$&, &$auth2$&, etc"
12342 These variables are used in SMTP authenticators (see chapters
12343 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12344
12345 .vitem &$authenticated_id$&
12346 .cindex "authentication" "id"
12347 .vindex "&$authenticated_id$&"
12348 When a server successfully authenticates a client it may be configured to
12349 preserve some of the authentication information in the variable
12350 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12351 user/password authenticator configuration might preserve the user name for use
12352 in the routers. Note that this is not the same information that is saved in
12353 &$sender_host_authenticated$&.
12354
12355 When a message is submitted locally (that is, not over a TCP connection)
12356 the value of &$authenticated_id$& is normally the login name of the calling
12357 process. However, a trusted user can override this by means of the &%-oMai%&
12358 command line option.
12359 This second case also sets up information used by the
12360 &$authresults$& expansion item.
12361
12362 .vitem &$authenticated_fail_id$&
12363 .cindex "authentication" "fail" "id"
12364 .vindex "&$authenticated_fail_id$&"
12365 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12366 will contain the failed authentication id. If more than one authentication
12367 id is attempted, it will contain only the last one. The variable is
12368 available for processing in the ACL's, generally the quit or notquit ACL.
12369 A message to a local recipient could still be accepted without requiring
12370 authentication, which means this variable could also be visible in all of
12371 the ACL's as well.
12372
12373
12374 .tvar &$authenticated_sender$&
12375 .cindex "sender" "authenticated"
12376 .cindex "authentication" "sender"
12377 .cindex "AUTH" "on MAIL command"
12378 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12379 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12380 described in section &<<SECTauthparamail>>&. Unless the data is the string
12381 &"<>"&, it is set as the authenticated sender of the message, and the value is
12382 available during delivery in the &$authenticated_sender$& variable. If the
12383 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12384
12385 .vindex "&$qualify_domain$&"
12386 When a message is submitted locally (that is, not over a TCP connection), the
12387 value of &$authenticated_sender$& is an address constructed from the login
12388 name of the calling process and &$qualify_domain$&, except that a trusted user
12389 can override this by means of the &%-oMas%& command line option.
12390
12391
12392 .vitem &$authentication_failed$&
12393 .cindex "authentication" "failure"
12394 .vindex "&$authentication_failed$&"
12395 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12396 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12397 possible to distinguish between &"did not try to authenticate"&
12398 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12399 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12400 is empty and &$authentication_failed$& is set to &"1"&).
12401 Failure includes cancellation of a authentication attempt,
12402 and any negative response to an AUTH command,
12403 (including, for example, an attempt to use an undefined mechanism).
12404
12405 .vitem &$av_failed$&
12406 .cindex "content scanning" "AV scanner failure"
12407 This variable is available when Exim is compiled with the content-scanning
12408 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12409 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12410 the ACL malware condition.
12411
12412 .vitem &$body_linecount$&
12413 .cindex "message body" "line count"
12414 .cindex "body of message" "line count"
12415 .vindex "&$body_linecount$&"
12416 When a message is being received or delivered, this variable contains the
12417 number of lines in the message's body. See also &$message_linecount$&.
12418
12419 .vitem &$body_zerocount$&
12420 .cindex "message body" "binary zero count"
12421 .cindex "body of message" "binary zero count"
12422 .cindex "binary zero" "in message body"
12423 .vindex "&$body_zerocount$&"
12424 When a message is being received or delivered, this variable contains the
12425 number of binary zero bytes (ASCII NULs) in the message's body.
12426
12427 .vitem &$bounce_recipient$&
12428 .vindex "&$bounce_recipient$&"
12429 This is set to the recipient address of a bounce message while Exim is creating
12430 it. It is useful if a customized bounce message text file is in use (see
12431 chapter &<<CHAPemsgcust>>&).
12432
12433 .vitem &$bounce_return_size_limit$&
12434 .vindex "&$bounce_return_size_limit$&"
12435 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12436 up to a multiple of 1000. It is useful when a customized error message text
12437 file is in use (see chapter &<<CHAPemsgcust>>&).
12438
12439 .vitem &$caller_gid$&
12440 .cindex "gid (group id)" "caller"
12441 .vindex "&$caller_gid$&"
12442 The real group id under which the process that called Exim was running. This is
12443 not the same as the group id of the originator of a message (see
12444 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12445 incarnation normally contains the Exim gid.
12446
12447 .vitem &$caller_uid$&
12448 .cindex "uid (user id)" "caller"
12449 .vindex "&$caller_uid$&"
12450 The real user id under which the process that called Exim was running. This is
12451 not the same as the user id of the originator of a message (see
12452 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12453 incarnation normally contains the Exim uid.
12454
12455 .vitem &$callout_address$&
12456 .vindex "&$callout_address$&"
12457 After a callout for verification, spamd or malware daemon service, the
12458 address that was connected to.
12459
12460 .vitem &$compile_number$&
12461 .vindex "&$compile_number$&"
12462 The building process for Exim keeps a count of the number
12463 of times it has been compiled. This serves to distinguish different
12464 compilations of the same version of Exim.
12465
12466 .vitem &$config_dir$&
12467 .vindex "&$config_dir$&"
12468 The directory name of the main configuration file. That is, the content of
12469 &$config_file$& with the last component stripped. The value does not
12470 contain the trailing slash. If &$config_file$& does not contain a slash,
12471 &$config_dir$& is ".".
12472
12473 .vitem &$config_file$&
12474 .vindex "&$config_file$&"
12475 The name of the main configuration file Exim is using.
12476
12477 .vitem &$dkim_verify_status$&
12478 Results of DKIM verification.
12479 For details see section &<<SECDKIMVFY>>&.
12480
12481 .vitem &$dkim_cur_signer$& &&&
12482        &$dkim_verify_reason$& &&&
12483        &$dkim_domain$& &&&
12484        &$dkim_identity$& &&&
12485        &$dkim_selector$& &&&
12486        &$dkim_algo$& &&&
12487        &$dkim_canon_body$& &&&
12488        &$dkim_canon_headers$& &&&
12489        &$dkim_copiedheaders$& &&&
12490        &$dkim_bodylength$& &&&
12491        &$dkim_created$& &&&
12492        &$dkim_expires$& &&&
12493        &$dkim_headernames$& &&&
12494        &$dkim_key_testing$& &&&
12495        &$dkim_key_nosubdomains$& &&&
12496        &$dkim_key_srvtype$& &&&
12497        &$dkim_key_granularity$& &&&
12498        &$dkim_key_notes$& &&&
12499        &$dkim_key_length$&
12500 These variables are only available within the DKIM ACL.
12501 For details see section &<<SECDKIMVFY>>&.
12502
12503 .vitem &$dkim_signers$&
12504 .vindex &$dkim_signers$&
12505 When a message has been received this variable contains
12506 a colon-separated list of signer domains and identities for the message.
12507 For details see section &<<SECDKIMVFY>>&.
12508
12509 .vitem &$dmarc_domain_policy$& &&&
12510        &$dmarc_status$& &&&
12511        &$dmarc_status_text$& &&&
12512        &$dmarc_used_domains$&
12513 Results of DMARC verification.
12514 For details see section &<<SECDMARC>>&.
12515
12516 .vitem &$dnslist_domain$& &&&
12517        &$dnslist_matched$& &&&
12518        &$dnslist_text$& &&&
12519        &$dnslist_value$&
12520 .vindex "&$dnslist_domain$&"
12521 .vindex "&$dnslist_matched$&"
12522 .vindex "&$dnslist_text$&"
12523 .vindex "&$dnslist_value$&"
12524 .cindex "black list (DNS)"
12525 When a DNS (black) list lookup succeeds, these variables are set to contain
12526 the following data from the lookup: the list's domain name, the key that was
12527 looked up, the contents of any associated TXT record, and the value from the
12528 main A record. See section &<<SECID204>>& for more details.
12529
12530 .tvar &$domain$&
12531 When an address is being routed, or delivered on its own, this variable
12532 contains the domain. Uppercase letters in the domain are converted into lower
12533 case for &$domain$&.
12534
12535 Global address rewriting happens when a message is received, so the value of
12536 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12537 is set during user filtering, but not during system filtering, because a
12538 message may have many recipients and the system filter is called just once.
12539
12540 When more than one address is being delivered at once (for example, several
12541 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12542 have the same domain. Transports can be restricted to handling only one domain
12543 at a time if the value of &$domain$& is required at transport time &-- this is
12544 the default for local transports. For further details of the environment in
12545 which local transports are run, see chapter &<<CHAPenvironment>>&.
12546
12547 .oindex "&%delay_warning_condition%&"
12548 At the end of a delivery, if all deferred addresses have the same domain, it is
12549 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12550
12551 The &$domain$& variable is also used in some other circumstances:
12552
12553 .ilist
12554 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12555 the recipient address. The domain of the &'sender'& address is in
12556 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12557 normally set during the running of the MAIL ACL. However, if the sender address
12558 is verified with a callout during the MAIL ACL, the sender domain is placed in
12559 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12560 the &(smtp)& transport.
12561
12562 .next
12563 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12564 &$domain$& contains the domain portion of the address that is being rewritten;
12565 it can be used in the expansion of the replacement address, for example, to
12566 rewrite domains by file lookup.
12567
12568 .next
12569 With one important exception, whenever a domain list is being scanned,
12570 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12571 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12572 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12573 that, in a RCPT ACL, the sender domain list can be dependent on the
12574 recipient domain (which is what is in &$domain$& at this time).
12575
12576 .next
12577 .cindex "ETRN" "value of &$domain$&"
12578 .oindex "&%smtp_etrn_command%&"
12579 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12580 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12581 .endlist
12582
12583 .cindex "tainted data"
12584 If the origin of the data is an incoming message,
12585 the result of expanding this variable is tainted and may not
12586 be further expanded or used as a filename.
12587 When an untainted version is needed, one should be obtained from
12588 looking up the value in a local (therefore trusted) database.
12589 Often &$domain_data$& is usable in this role.
12590
12591
12592 .vitem &$domain_data$&
12593 .vindex "&$domain_data$&"
12594 When the &%domains%& condition on a router
12595 or an ACL
12596 matches a domain
12597 against a list, the match value is copied to &$domain_data$&.
12598 This is an enhancement over previous versions of Exim, when it only
12599 applied to the data read by a lookup.
12600 For details on match values see section &<<SECTlistresults>>& et. al.
12601
12602 If the router routes the
12603 address to a transport, the value is available in that transport. If the
12604 transport is handling multiple addresses, the value from the first address is
12605 used.
12606
12607 &$domain_data$& set in an ACL is available during
12608 the rest of the ACL statement.
12609
12610 .vitem &$exim_gid$&
12611 .vindex "&$exim_gid$&"
12612 This variable contains the numerical value of the Exim group id.
12613
12614 .vitem &$exim_path$&
12615 .vindex "&$exim_path$&"
12616 This variable contains the path to the Exim binary.
12617
12618 .vitem &$exim_uid$&
12619 .vindex "&$exim_uid$&"
12620 This variable contains the numerical value of the Exim user id.
12621
12622 .vitem &$exim_version$&
12623 .vindex "&$exim_version$&"
12624 This variable contains the version string of the Exim build.
12625 The first character is a major version number, currently 4.
12626 Then after a dot, the next group of digits is a minor version number.
12627 There may be other characters following the minor version.
12628 This value may be overridden by the &%exim_version%& main config option.
12629
12630 .vitem &$header_$&<&'name'&>
12631 .tmark
12632 This is not strictly an expansion variable. It is expansion syntax for
12633 inserting the message header line with the given name. Note that the name must
12634 be terminated by colon or white space, because it may contain a wide variety of
12635 characters. Note also that braces must &'not'& be used.
12636 See the full description in section &<<SECTexpansionitems>>& above.
12637
12638 .vitem &$headers_added$&
12639 .vindex "&$headers_added$&"
12640 Within an ACL this variable contains the headers added so far by
12641 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12642 The headers are a newline-separated list.
12643
12644 .vitem &$home$&
12645 .vindex "&$home$&"
12646 When the &%check_local_user%& option is set for a router, the user's home
12647 directory is placed in &$home$& when the check succeeds. In particular, this
12648 means it is set during the running of users' filter files. A router may also
12649 explicitly set a home directory for use by a transport; this can be overridden
12650 by a setting on the transport itself.
12651
12652 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12653 of the environment variable HOME, which is subject to the
12654 &%keep_environment%& and &%add_environment%& main config options.
12655
12656 .vitem &$host$&
12657 .vindex "&$host$&"
12658 If a router assigns an address to a transport (any transport), and passes a
12659 list of hosts with the address, the value of &$host$& when the transport starts
12660 to run is the name of the first host on the list. Note that this applies both
12661 to local and remote transports.
12662
12663 .cindex "transport" "filter"
12664 .cindex "filter" "transport filter"
12665 For the &(smtp)& transport, if there is more than one host, the value of
12666 &$host$& changes as the transport works its way through the list. In
12667 particular, when the &(smtp)& transport is expanding its options for encryption
12668 using TLS, or for specifying a transport filter (see chapter
12669 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12670 is connected.
12671
12672 When used in the client part of an authenticator configuration (see chapter
12673 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12674 client is connected.
12675
12676
12677 .vitem &$host_address$&
12678 .vindex "&$host_address$&"
12679 This variable is set to the remote host's IP address whenever &$host$& is set
12680 for a remote connection. It is also set to the IP address that is being checked
12681 when the &%ignore_target_hosts%& option is being processed.
12682
12683 .vitem &$host_data$&
12684 .vindex "&$host_data$&"
12685 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12686 result of the lookup is made available in the &$host_data$& variable. This
12687 allows you, for example, to do things like this:
12688 .code
12689 deny  hosts = net-lsearch;/some/file
12690       message = $host_data
12691 .endd
12692
12693 .vitem &$host_lookup_deferred$&
12694 .cindex "host name" "lookup, failure of"
12695 .vindex "&$host_lookup_deferred$&"
12696 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12697 message comes from a remote host and there is an attempt to look up the host's
12698 name from its IP address, and the attempt is not successful, one of these
12699 variables is set to &"1"&.
12700
12701 .ilist
12702 If the lookup receives a definite negative response (for example, a DNS lookup
12703 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12704
12705 .next
12706 If there is any kind of problem during the lookup, such that Exim cannot
12707 tell whether or not the host name is defined (for example, a timeout for a DNS
12708 lookup), &$host_lookup_deferred$& is set to &"1"&.
12709 .endlist ilist
12710
12711 Looking up a host's name from its IP address consists of more than just a
12712 single reverse lookup. Exim checks that a forward lookup of at least one of the
12713 names it receives from a reverse lookup yields the original IP address. If this
12714 is not the case, Exim does not accept the looked up name(s), and
12715 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12716 IP address (for example, the existence of a PTR record in the DNS) is not
12717 sufficient on its own for the success of a host name lookup. If the reverse
12718 lookup succeeds, but there is a lookup problem such as a timeout when checking
12719 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12720 &"1"&. See also &$sender_host_name$&.
12721
12722 .cindex authentication "expansion item"
12723 Performing these checks sets up information used by the
12724 &%authresults%& expansion item.
12725
12726
12727 .vitem &$host_lookup_failed$&
12728 .vindex "&$host_lookup_failed$&"
12729 See &$host_lookup_deferred$&.
12730
12731 .vitem &$host_port$&
12732 .vindex "&$host_port$&"
12733 This variable is set to the remote host's TCP port whenever &$host$& is set
12734 for an outbound connection.
12735
12736 .vitem &$initial_cwd$&
12737 .vindex "&$initial_cwd$&
12738 This variable contains the full path name of the initial working
12739 directory of the current Exim process. This may differ from the current
12740 working directory, as Exim changes this to "/" during early startup, and
12741 to &$spool_directory$& later.
12742
12743 .vitem &$inode$&
12744 .vindex "&$inode$&"
12745 The only time this variable is set is while expanding the &%directory_file%&
12746 option in the &(appendfile)& transport. The variable contains the inode number
12747 of the temporary file which is about to be renamed. It can be used to construct
12748 a unique name for the file.
12749
12750 .vitem &$interface_address$& &&&
12751        &$interface_port$&
12752 .vindex "&$interface_address$&"
12753 .vindex "&$interface_port$&"
12754 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12755
12756 .vitem &$item$&
12757 .vindex "&$item$&"
12758 This variable is used during the expansion of &*forall*& and &*forany*&
12759 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12760 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12761 empty.
12762
12763 .vitem &$ldap_dn$&
12764 .vindex "&$ldap_dn$&"
12765 This variable, which is available only when Exim is compiled with LDAP support,
12766 contains the DN from the last entry in the most recently successful LDAP
12767 lookup.
12768
12769 .vitem &$load_average$&
12770 .vindex "&$load_average$&"
12771 This variable contains the system load average, multiplied by 1000 so that it
12772 is an integer. For example, if the load average is 0.21, the value of the
12773 variable is 210. The value is recomputed every time the variable is referenced.
12774
12775 .tvar &$local_part$&
12776 When an address is being routed, or delivered on its own, this
12777 variable contains the local part. When a number of addresses are being
12778 delivered together (for example, multiple RCPT commands in an SMTP
12779 session), &$local_part$& is not set.
12780
12781 Global address rewriting happens when a message is received, so the value of
12782 &$local_part$& during routing and delivery is the value after rewriting.
12783 &$local_part$& is set during user filtering, but not during system filtering,
12784 because a message may have many recipients and the system filter is called just
12785 once.
12786
12787 .cindex "tainted data"
12788 If the origin of the data is an incoming message,
12789 the result of expanding this variable is tainted and
12790 may not be further expanded or used as a filename.
12791
12792 &*Warning*&: the content of this variable is usually provided by a potential
12793 attacker.
12794 Consider carefully the implications of using it unvalidated as a name
12795 for file access.
12796 This presents issues for users' &_.forward_& and filter files.
12797 For traditional full user accounts, use &%check_local_users%& and the
12798 &$local_part_data$& variable rather than this one.
12799 For virtual users, store a suitable pathname component in the database
12800 which is used for account name validation, and use that retrieved value
12801 rather than this variable.
12802 Often &$local_part_data$& is usable in this role.
12803 If needed, use a router &%address_data%& or &%set%& option for
12804 the retrieved data.
12805
12806 When a message is being delivered to a file, pipe, or autoreply transport as a
12807 result of aliasing or forwarding, &$local_part$& is set to the local part of
12808 the parent address, not to the filename or command (see &$address_file$& and
12809 &$address_pipe$&).
12810
12811 When an ACL is running for a RCPT command, &$local_part$& contains the
12812 local part of the recipient address.
12813
12814 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12815 &$local_part$& contains the local part of the address that is being rewritten;
12816 it can be used in the expansion of the replacement address, for example.
12817
12818 In all cases, all quoting is removed from the local part. For example, for both
12819 the addresses
12820 .code
12821 "abc:xyz"@test.example
12822 abc\:xyz@test.example
12823 .endd
12824 the value of &$local_part$& is
12825 .code
12826 abc:xyz
12827 .endd
12828 If you use &$local_part$& to create another address, you should always wrap it
12829 inside a quoting operator. For example, in a &(redirect)& router you could
12830 have:
12831 .code
12832 data = ${quote_local_part:$local_part}@new.domain.example
12833 .endd
12834 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12835 to process local parts in a case-dependent manner in a router, you can set the
12836 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12837
12838 .vitem &$local_part_data$&
12839 .vindex "&$local_part_data$&"
12840 When the &%local_parts%& condition on a router or ACL
12841 matches a local part list
12842 the match value is copied to &$local_part_data$&.
12843 This is an enhancement over previous versions of Exim, when it only
12844 applied to the data read by a lookup.
12845 For details on match values see section &<<SECTlistresults>>& et. al.
12846
12847 The &%check_local_user%& router option also sets this variable.
12848
12849 .vindex &$local_part_prefix$& &&&
12850         &$local_part_prefix_v$& &&&
12851         &$local_part_suffix$& &&&
12852         &$local_part_suffix_v$&
12853 .cindex affix variables
12854 If a local part prefix or suffix has been recognized, it is not included in the
12855 value of &$local_part$& during routing and subsequent delivery. The values of
12856 any prefix or suffix are in &$local_part_prefix$& and
12857 &$local_part_suffix$&, respectively.
12858 .cindex "tainted data"
12859 If the specification did not include a wildcard then
12860 the affix variable value is not tainted.
12861
12862 If the affix specification included a wildcard then the portion of
12863 the affix matched by the wildcard is in
12864 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12865 and both the whole and varying values are tainted.
12866
12867 .vitem &$local_scan_data$&
12868 .vindex "&$local_scan_data$&"
12869 This variable contains the text returned by the &[local_scan()]& function when
12870 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12871
12872 .vitem &$local_user_gid$&
12873 .vindex "&$local_user_gid$&"
12874 See &$local_user_uid$&.
12875
12876 .vitem &$local_user_uid$&
12877 .vindex "&$local_user_uid$&"
12878 This variable and &$local_user_gid$& are set to the uid and gid after the
12879 &%check_local_user%& router precondition succeeds. This means that their values
12880 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12881 and &%condition%&), for the &%address_data%& expansion, and for any
12882 router-specific expansions. At all other times, the values in these variables
12883 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12884
12885 .vitem &$localhost_number$&
12886 .vindex "&$localhost_number$&"
12887 This contains the expanded value of the
12888 &%localhost_number%& option. The expansion happens after the main options have
12889 been read.
12890
12891 .vitem &$log_inodes$&
12892 .vindex "&$log_inodes$&"
12893 The number of free inodes in the disk partition where Exim's
12894 log files are being written. The value is recalculated whenever the variable is
12895 referenced. If the relevant file system does not have the concept of inodes,
12896 the value of is -1. See also the &%check_log_inodes%& option.
12897
12898 .vitem &$log_space$&
12899 .vindex "&$log_space$&"
12900 The amount of free space (as a number of kilobytes) in the disk
12901 partition where Exim's log files are being written. The value is recalculated
12902 whenever the variable is referenced. If the operating system does not have the
12903 ability to find the amount of free space (only true for experimental systems),
12904 the space value is -1. See also the &%check_log_space%& option.
12905
12906
12907 .vitem &$lookup_dnssec_authenticated$&
12908 .vindex "&$lookup_dnssec_authenticated$&"
12909 This variable is set after a DNS lookup done by
12910 a dnsdb lookup expansion, dnslookup router or smtp transport.
12911 .cindex "DNS" "DNSSEC"
12912 It will be empty if &(DNSSEC)& was not requested,
12913 &"no"& if the result was not labelled as authenticated data
12914 and &"yes"& if it was.
12915 Results that are labelled as authoritative answer that match
12916 the &%dns_trust_aa%& configuration variable count also
12917 as authenticated data.
12918
12919 .vitem &$mailstore_basename$&
12920 .vindex "&$mailstore_basename$&"
12921 This variable is set only when doing deliveries in &"mailstore"& format in the
12922 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12923 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12924 contains the basename of the files that are being written, that is, the name
12925 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12926 variable is empty.
12927
12928 .vitem &$malware_name$&
12929 .vindex "&$malware_name$&"
12930 This variable is available when Exim is compiled with the
12931 content-scanning extension. It is set to the name of the virus that was found
12932 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12933
12934 .vitem &$max_received_linelength$&
12935 .vindex "&$max_received_linelength$&"
12936 .cindex "maximum" "line length"
12937 .cindex "line length" "maximum"
12938 This variable contains the number of bytes in the longest line that was
12939 received as part of the message, not counting the line termination
12940 character(s).
12941 It is not valid if the &%spool_wireformat%& option is used.
12942
12943 .vitem &$message_age$&
12944 .cindex "message" "age of"
12945 .vindex "&$message_age$&"
12946 This variable is set at the start of a delivery attempt to contain the number
12947 of seconds since the message was received. It does not change during a single
12948 delivery attempt.
12949
12950 .tvar &$message_body$&
12951 .cindex "body of message" "expansion variable"
12952 .cindex "message body" "in expansion"
12953 .cindex "binary zero" "in message body"
12954 .oindex "&%message_body_visible%&"
12955 This variable contains the initial portion of a message's body while it is
12956 being delivered, and is intended mainly for use in filter files. The maximum
12957 number of characters of the body that are put into the variable is set by the
12958 &%message_body_visible%& configuration option; the default is 500.
12959
12960 .oindex "&%message_body_newlines%&"
12961 By default, newlines are converted into spaces in &$message_body$&, to make it
12962 easier to search for phrases that might be split over a line break. However,
12963 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12964 zeros are always converted into spaces.
12965
12966 .tvar &$message_body_end$&
12967 .cindex "body of message" "expansion variable"
12968 .cindex "message body" "in expansion"
12969 This variable contains the final portion of a message's
12970 body while it is being delivered. The format and maximum size are as for
12971 &$message_body$&.
12972
12973 .vitem &$message_body_size$&
12974 .cindex "body of message" "size"
12975 .cindex "message body" "size"
12976 .vindex "&$message_body_size$&"
12977 When a message is being delivered, this variable contains the size of the body
12978 in bytes. The count starts from the character after the blank line that
12979 separates the body from the header. Newlines are included in the count. See
12980 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12981
12982 If the spool file is wireformat
12983 (see the &%spool_wireformat%& main option)
12984 the CRLF line-terminators are included in the count.
12985
12986 .vitem &$message_exim_id$&
12987 .vindex "&$message_exim_id$&"
12988 When a message is being received or delivered, this variable contains the
12989 unique message id that is generated and used by Exim to identify the message.
12990 An id is not created for a message until after its header has been successfully
12991 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12992 line; it is the local id that Exim assigns to the message, for example:
12993 &`1BXTIK-0001yO-VA`&.
12994
12995 .tvar &$message_headers$&
12996 This variable contains a concatenation of all the header lines when a message
12997 is being processed, except for lines added by routers or transports. The header
12998 lines are separated by newline characters. Their contents are decoded in the
12999 same way as a header line that is inserted by &%bheader%&.
13000
13001 .tvar &$message_headers_raw$&
13002 This variable is like &$message_headers$& except that no processing of the
13003 contents of header lines is done.
13004
13005 .vitem &$message_id$&
13006 This is an old name for &$message_exim_id$&. It is now deprecated.
13007
13008 .vitem &$message_linecount$&
13009 .vindex "&$message_linecount$&"
13010 This variable contains the total number of lines in the header and body of the
13011 message. Compare &$body_linecount$&, which is the count for the body only.
13012 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13013 number of lines received. Before delivery happens (that is, before filters,
13014 routers, and transports run) the count is increased to include the
13015 &'Received:'& header line that Exim standardly adds, and also any other header
13016 lines that are added by ACLs. The blank line that separates the message header
13017 from the body is not counted.
13018
13019 As with the special case of &$message_size$&, during the expansion of the
13020 appendfile transport's maildir_tag option in maildir format, the value of
13021 &$message_linecount$& is the precise size of the number of newlines in the
13022 file that has been written (minus one for the blank line between the
13023 header and the body).
13024
13025 Here is an example of the use of this variable in a DATA ACL:
13026 .code
13027 deny condition = \
13028       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13029      message   = Too many lines in message header
13030 .endd
13031 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13032 message has not yet been received.
13033
13034 This variable is not valid if the &%spool_wireformat%& option is used.
13035
13036 .vitem &$message_size$&
13037 .cindex "size" "of message"
13038 .cindex "message" "size"
13039 .vindex "&$message_size$&"
13040 When a message is being processed, this variable contains its size in bytes. In
13041 most cases, the size includes those headers that were received with the
13042 message, but not those (such as &'Envelope-to:'&) that are added to individual
13043 deliveries as they are written. However, there is one special case: during the
13044 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13045 doing a delivery in maildir format, the value of &$message_size$& is the
13046 precise size of the file that has been written. See also
13047 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13048
13049 .cindex "RCPT" "value of &$message_size$&"
13050 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13051 contains the size supplied on the MAIL command, or -1 if no size was given. The
13052 value may not, of course, be truthful.
13053
13054 .vitem &$mime_anomaly_level$& &&&
13055        &$mime_anomaly_text$& &&&
13056        &$mime_boundary$& &&&
13057        &$mime_charset$& &&&
13058        &$mime_content_description$& &&&
13059        &$mime_content_disposition$& &&&
13060        &$mime_content_id$& &&&
13061        &$mime_content_size$& &&&
13062        &$mime_content_transfer_encoding$& &&&
13063        &$mime_content_type$& &&&
13064        &$mime_decoded_filename$& &&&
13065        &$mime_filename$& &&&
13066        &$mime_is_coverletter$& &&&
13067        &$mime_is_multipart$& &&&
13068        &$mime_is_rfc822$& &&&
13069        &$mime_part_count$&
13070 A number of variables whose names start with &$mime$& are
13071 available when Exim is compiled with the content-scanning extension. For
13072 details, see section &<<SECTscanmimepart>>&.
13073
13074 .vitem "&$n0$& &-- &$n9$&"
13075 These variables are counters that can be incremented by means
13076 of the &%add%& command in filter files.
13077
13078 .tvar &$original_domain$&
13079 .vindex "&$domain$&"
13080 When a top-level address is being processed for delivery, this contains the
13081 same value as &$domain$&. However, if a &"child"& address (for example,
13082 generated by an alias, forward, or filter file) is being processed, this
13083 variable contains the domain of the original address (lower cased). This
13084 differs from &$parent_domain$& only when there is more than one level of
13085 aliasing or forwarding. When more than one address is being delivered in a
13086 single transport run, &$original_domain$& is not set.
13087
13088 If a new address is created by means of a &%deliver%& command in a system
13089 filter, it is set up with an artificial &"parent"& address. This has the local
13090 part &'system-filter'& and the default qualify domain.
13091
13092 .tvar &$original_local_part$&
13093 .vindex "&$local_part$&"
13094 When a top-level address is being processed for delivery, this contains the
13095 same value as &$local_part$&, unless a prefix or suffix was removed from the
13096 local part, because &$original_local_part$& always contains the full local
13097 part. When a &"child"& address (for example, generated by an alias, forward, or
13098 filter file) is being processed, this variable contains the full local part of
13099 the original address.
13100
13101 If the router that did the redirection processed the local part
13102 case-insensitively, the value in &$original_local_part$& is in lower case.
13103 This variable differs from &$parent_local_part$& only when there is more than
13104 one level of aliasing or forwarding. When more than one address is being
13105 delivered in a single transport run, &$original_local_part$& is not set.
13106
13107 If a new address is created by means of a &%deliver%& command in a system
13108 filter, it is set up with an artificial &"parent"& address. This has the local
13109 part &'system-filter'& and the default qualify domain.
13110
13111 .vitem &$originator_gid$&
13112 .cindex "gid (group id)" "of originating user"
13113 .cindex "sender" "gid"
13114 .vindex "&$caller_gid$&"
13115 .vindex "&$originator_gid$&"
13116 This variable contains the value of &$caller_gid$& that was set when the
13117 message was received. For messages received via the command line, this is the
13118 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13119 normally the gid of the Exim user.
13120
13121 .vitem &$originator_uid$&
13122 .cindex "uid (user id)" "of originating user"
13123 .cindex "sender" "uid"
13124 .vindex "&$caller_uid$&"
13125 .vindex "&$originator_uid$&"
13126 The value of &$caller_uid$& that was set when the message was received. For
13127 messages received via the command line, this is the uid of the sending user.
13128 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13129 user.
13130
13131 .tvar &$parent_domain$&
13132 This variable is similar to &$original_domain$& (see
13133 above), except that it refers to the immediately preceding parent address.
13134
13135 .tvar &$parent_local_part$&
13136 This variable is similar to &$original_local_part$&
13137 (see above), except that it refers to the immediately preceding parent address.
13138
13139 .vitem &$pid$&
13140 .cindex "pid (process id)" "of current process"
13141 .vindex "&$pid$&"
13142 This variable contains the current process id.
13143
13144 .vitem &$pipe_addresses$&
13145 .cindex "filter" "transport filter"
13146 .cindex "transport" "filter"
13147 .vindex "&$pipe_addresses$&"
13148 This is not an expansion variable, but is mentioned here because the string
13149 &`$pipe_addresses`& is handled specially in the command specification for the
13150 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13151 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13152 It cannot be used in general expansion strings, and provokes an &"unknown
13153 variable"& error if encountered.
13154 &*Note*&: This value permits data supplied by a potential attacker to
13155 be used in the command for a &(pipe)& transport.
13156 Such configurations should be carefully assessed for security vulnerbilities.
13157
13158 .vitem &$primary_hostname$&
13159 .vindex "&$primary_hostname$&"
13160 This variable contains the value set by &%primary_hostname%& in the
13161 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13162 a single-component name, Exim calls &[gethostbyname()]& (or
13163 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13164 qualified host name. See also &$smtp_active_hostname$&.
13165
13166
13167 .vitem &$proxy_external_address$& &&&
13168        &$proxy_external_port$& &&&
13169        &$proxy_local_address$& &&&
13170        &$proxy_local_port$& &&&
13171        &$proxy_session$&
13172 These variables are only available when built with Proxy Protocol
13173 or SOCKS5 support.
13174 For details see chapter &<<SECTproxyInbound>>&.
13175
13176 .vitem &$prdr_requested$&
13177 .cindex "PRDR" "variable for"
13178 This variable is set to &"yes"& if PRDR was requested by the client for the
13179 current message, otherwise &"no"&.
13180
13181 .vitem &$prvscheck_address$& &&&
13182        &$prvscheck_keynum$& &&&
13183        &$prvscheck_result$&
13184 These variables are used in conjunction with the &%prvscheck%& expansion item,
13185 which is described in sections &<<SECTexpansionitems>>& and
13186 &<<SECTverifyPRVS>>&.
13187
13188 .vitem &$qualify_domain$&
13189 .vindex "&$qualify_domain$&"
13190 The value set for the &%qualify_domain%& option in the configuration file.
13191
13192 .vitem &$qualify_recipient$&
13193 .vindex "&$qualify_recipient$&"
13194 The value set for the &%qualify_recipient%& option in the configuration file,
13195 or if not set, the value of &$qualify_domain$&.
13196
13197 .vitem &$queue_name$&
13198 .vindex &$queue_name$&
13199 .cindex "named queues" variable
13200 .cindex queues named
13201 The name of the spool queue in use; empty for the default queue.
13202
13203 .vitem &$queue_size$&
13204 .vindex "&$queue_size$&"
13205 .cindex "queue" "size of"
13206 .cindex "spool" "number of messages"
13207 This variable contains the number of messages queued.
13208 It is evaluated on demand, but no more often than once every minute.
13209 If there is no daemon notifier socket open, the value will be
13210 an empty string.
13211
13212 .vitem &$r_...$&
13213 .vindex &$r_...$&
13214 .cindex router variables
13215 Values can be placed in these variables by the &%set%& option of a router.
13216 They can be given any name that starts with &$r_$&.
13217 The values persist for the address being handled through subsequent routers
13218 and the eventual transport.
13219
13220 .vitem &$rcpt_count$&
13221 .vindex "&$rcpt_count$&"
13222 When a message is being received by SMTP, this variable contains the number of
13223 RCPT commands received for the current message. If this variable is used in a
13224 RCPT ACL, its value includes the current command.
13225
13226 .vitem &$rcpt_defer_count$&
13227 .vindex "&$rcpt_defer_count$&"
13228 .cindex "4&'xx'& responses" "count of"
13229 When a message is being received by SMTP, this variable contains the number of
13230 RCPT commands in the current message that have previously been rejected with a
13231 temporary (4&'xx'&) response.
13232
13233 .vitem &$rcpt_fail_count$&
13234 .vindex "&$rcpt_fail_count$&"
13235 When a message is being received by SMTP, this variable contains the number of
13236 RCPT commands in the current message that have previously been rejected with a
13237 permanent (5&'xx'&) response.
13238
13239 .vitem &$received_count$&
13240 .vindex "&$received_count$&"
13241 This variable contains the number of &'Received:'& header lines in the message,
13242 including the one added by Exim (so its value is always greater than zero). It
13243 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13244 delivering.
13245
13246 .tvar &$received_for$&
13247 If there is only a single recipient address in an incoming message, this
13248 variable contains that address when the &'Received:'& header line is being
13249 built. The value is copied after recipient rewriting has happened, but before
13250 the &[local_scan()]& function is run.
13251
13252 .vitem &$received_ip_address$& &&&
13253        &$received_port$&
13254 .vindex "&$received_ip_address$&"
13255 .vindex "&$received_port$&"
13256 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13257 variables are set to the address and port on the local IP interface.
13258 (The remote IP address and port are in
13259 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13260 the port value is -1 unless it has been set using the &%-oMi%& command line
13261 option.
13262
13263 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13264 could be used, for example, to make the filename for a TLS certificate depend
13265 on which interface and/or port is being used for the incoming connection. The
13266 values of &$received_ip_address$& and &$received_port$& are saved with any
13267 messages that are received, thus making these variables available at delivery
13268 time.
13269 For outbound connections see &$sending_ip_address$&.
13270
13271 .vitem &$received_protocol$&
13272 .vindex "&$received_protocol$&"
13273 When a message is being processed, this variable contains the name of the
13274 protocol by which it was received. Most of the names used by Exim are defined
13275 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13276 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13277 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13278 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13279 connection and the client was successfully authenticated.
13280
13281 Exim uses the protocol name &"smtps"& for the case when encryption is
13282 automatically set up on connection without the use of STARTTLS (see
13283 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13284 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13285 where the client initially uses EHLO, sets up an encrypted connection using
13286 STARTTLS, and then uses HELO afterwards.
13287
13288 The &%-oMr%& option provides a way of specifying a custom protocol name for
13289 messages that are injected locally by trusted callers. This is commonly used to
13290 identify messages that are being re-injected after some kind of scanning.
13291
13292 .vitem &$received_time$&
13293 .vindex "&$received_time$&"
13294 This variable contains the date and time when the current message was received,
13295 as a number of seconds since the start of the Unix epoch.
13296
13297 .vitem &$recipient_data$&
13298 .vindex "&$recipient_data$&"
13299 This variable is set after an indexing lookup success in an ACL &%recipients%&
13300 condition. It contains the data from the lookup, and the value remains set
13301 until the next &%recipients%& test. Thus, you can do things like this:
13302 .display
13303 &`require recipients  = cdb*@;/some/file`&
13304 &`deny    `&&'some further test involving'& &`$recipient_data`&
13305 .endd
13306 &*Warning*&: This variable is set only when a lookup is used as an indexing
13307 method in the address list, using the semicolon syntax as in the example above.
13308 The variable is not set for a lookup that is used as part of the string
13309 expansion that all such lists undergo before being interpreted.
13310
13311 .vitem &$recipient_verify_failure$&
13312 .vindex "&$recipient_verify_failure$&"
13313 In an ACL, when a recipient verification fails, this variable contains
13314 information about the failure. It is set to one of the following words:
13315
13316 .ilist
13317 &"qualify"&: The address was unqualified (no domain), and the message
13318 was neither local nor came from an exempted host.
13319
13320 .next
13321 &"route"&: Routing failed.
13322
13323 .next
13324 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13325 or before the MAIL command (that is, on initial connection, HELO, or
13326 MAIL).
13327
13328 .next
13329 &"recipient"&: The RCPT command in a callout was rejected.
13330 .next
13331
13332 &"postmaster"&: The postmaster check in a callout was rejected.
13333 .endlist
13334
13335 The main use of this variable is expected to be to distinguish between
13336 rejections of MAIL and rejections of RCPT.
13337
13338 .tvar &$recipients$&
13339 This variable contains a list of envelope recipients for a message. A comma and
13340 a space separate the addresses in the replacement text. However, the variable
13341 is not generally available, to prevent exposure of Bcc recipients in
13342 unprivileged users' filter files. You can use &$recipients$& only in these
13343 cases:
13344
13345 .olist
13346 In a system filter file.
13347 .next
13348 In the ACLs associated with the DATA command and with non-SMTP messages, that
13349 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13350 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13351 &%acl_not_smtp_mime%&.
13352 .next
13353 From within a &[local_scan()]& function.
13354 .endlist
13355
13356
13357 .vitem &$recipients_count$&
13358 .vindex "&$recipients_count$&"
13359 When a message is being processed, this variable contains the number of
13360 envelope recipients that came with the message. Duplicates are not excluded
13361 from the count. While a message is being received over SMTP, the number
13362 increases for each accepted recipient. It can be referenced in an ACL.
13363
13364
13365 .vitem &$regex_match_string$&
13366 .vindex "&$regex_match_string$&"
13367 This variable is set to contain the matching regular expression after a
13368 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13369
13370 .vitem "&$regex1$&, &$regex2$&, etc"
13371 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13372 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13373 these variables contain the
13374 captured substrings identified by the regular expression.
13375 If the subject string was tainted then so will any captured substring.
13376
13377
13378 .tvar &$reply_address$&
13379 When a message is being processed, this variable contains the contents of the
13380 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13381 contents of the &'From:'& header line. Apart from the removal of leading
13382 white space, the value is not processed in any way. In particular, no RFC 2047
13383 decoding or character code translation takes place.
13384
13385 .vitem &$return_path$&
13386 .vindex "&$return_path$&"
13387 When a message is being delivered, this variable contains the return path &--
13388 the sender field that will be sent as part of the envelope. It is not enclosed
13389 in <> characters. At the start of routing an address, &$return_path$& has the
13390 same value as &$sender_address$&, but if, for example, an incoming message to a
13391 mailing list has been expanded by a router which specifies a different address
13392 for bounce messages, &$return_path$& subsequently contains the new bounce
13393 address, whereas &$sender_address$& always contains the original sender address
13394 that was received with the message. In other words, &$sender_address$& contains
13395 the incoming envelope sender, and &$return_path$& contains the outgoing
13396 envelope sender.
13397
13398 .vitem &$return_size_limit$&
13399 .vindex "&$return_size_limit$&"
13400 This is an obsolete name for &$bounce_return_size_limit$&.
13401
13402 .vitem &$router_name$&
13403 .cindex "router" "name"
13404 .cindex "name" "of router"
13405 .vindex "&$router_name$&"
13406 During the running of a router this variable contains its name.
13407
13408 .vitem &$runrc$&
13409 .cindex "return code" "from &%run%& expansion"
13410 .vindex "&$runrc$&"
13411 This variable contains the return code from a command that is run by the
13412 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13413 assume the order in which option values are expanded, except for those
13414 preconditions whose order of testing is documented. Therefore, you cannot
13415 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13416 another.
13417
13418 .vitem &$self_hostname$&
13419 .oindex "&%self%&" "value of host name"
13420 .vindex "&$self_hostname$&"
13421 When an address is routed to a supposedly remote host that turns out to be the
13422 local host, what happens is controlled by the &%self%& generic router option.
13423 One of its values causes the address to be passed to another router. When this
13424 happens, &$self_hostname$& is set to the name of the local host that the
13425 original router encountered. In other circumstances its contents are null.
13426
13427 .tvar &$sender_address$&
13428 When a message is being processed, this variable contains the sender's address
13429 that was received in the message's envelope. The case of letters in the address
13430 is retained, in both the local part and the domain. For bounce messages, the
13431 value of this variable is the empty string. See also &$return_path$&.
13432
13433 .vitem &$sender_address_data$&
13434 .vindex "&$address_data$&"
13435 .vindex "&$sender_address_data$&"
13436 If &$address_data$& is set when the routers are called from an ACL to verify a
13437 sender address, the final value is preserved in &$sender_address_data$&, to
13438 distinguish it from data from a recipient address. The value does not persist
13439 after the end of the current ACL statement. If you want to preserve it for
13440 longer, you can save it in an ACL variable.
13441
13442 .tvar &$sender_address_domain$&
13443 The domain portion of &$sender_address$&.
13444
13445 .tvar &$sender_address_local_part$&
13446 The local part portion of &$sender_address$&.
13447
13448 .vitem &$sender_data$&
13449 .vindex "&$sender_data$&"
13450 This variable is set after a lookup success in an ACL &%senders%& condition or
13451 in a router &%senders%& option. It contains the data from the lookup, and the
13452 value remains set until the next &%senders%& test. Thus, you can do things like
13453 this:
13454 .display
13455 &`require senders      = cdb*@;/some/file`&
13456 &`deny    `&&'some further test involving'& &`$sender_data`&
13457 .endd
13458 &*Warning*&: This variable is set only when a lookup is used as an indexing
13459 method in the address list, using the semicolon syntax as in the example above.
13460 The variable is not set for a lookup that is used as part of the string
13461 expansion that all such lists undergo before being interpreted.
13462
13463 .vitem &$sender_fullhost$&
13464 .vindex "&$sender_fullhost$&"
13465 When a message is received from a remote host, this variable contains the host
13466 name and IP address in a single string. It ends with the IP address in square
13467 brackets, followed by a colon and a port number if the logging of ports is
13468 enabled. The format of the rest of the string depends on whether the host
13469 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13470 looking up its IP address. (Looking up the IP address can be forced by the
13471 &%host_lookup%& option, independent of verification.) A plain host name at the
13472 start of the string is a verified host name; if this is not present,
13473 verification either failed or was not requested. A host name in parentheses is
13474 the argument of a HELO or EHLO command. This is omitted if it is identical to
13475 the verified host name or to the host's IP address in square brackets.
13476
13477 .vitem &$sender_helo_dnssec$&
13478 .vindex "&$sender_helo_dnssec$&"
13479 This boolean variable is true if a successful HELO verification was
13480 .cindex "DNS" "DNSSEC"
13481 done using DNS information the resolver library stated was authenticated data.
13482
13483 .tvar &$sender_helo_name$&
13484 When a message is received from a remote host that has issued a HELO or EHLO
13485 command, the argument of that command is placed in this variable. It is also
13486 set if HELO or EHLO is used when a message is received using SMTP locally via
13487 the &%-bs%& or &%-bS%& options.
13488
13489 .vitem &$sender_host_address$&
13490 .vindex "&$sender_host_address$&"
13491 When a message is received from a remote host using SMTP,
13492 this variable contains that
13493 host's IP address. For locally non-SMTP submitted messages, it is empty.
13494
13495 .vitem &$sender_host_authenticated$&
13496 .vindex "&$sender_host_authenticated$&"
13497 This variable contains the name (not the public name) of the authenticator
13498 driver that successfully authenticated the client from which the message was
13499 received. It is empty if there was no successful authentication. See also
13500 &$authenticated_id$&.
13501
13502 .vitem &$sender_host_dnssec$&
13503 .vindex "&$sender_host_dnssec$&"
13504 If an attempt to populate &$sender_host_name$& has been made
13505 (by reference, &%hosts_lookup%& or
13506 otherwise) then this boolean will have been set true if, and only if, the
13507 resolver library states that both
13508 the reverse and forward DNS were authenticated data.  At all
13509 other times, this variable is false.
13510
13511 .cindex "DNS" "DNSSEC"
13512 It is likely that you will need to coerce DNSSEC support on in the resolver
13513 library, by setting:
13514 .code
13515 dns_dnssec_ok = 1
13516 .endd
13517
13518 In addition, on Linux with glibc 2.31 or newer the resolver library will
13519 default to stripping out a successful validation status.
13520 This will break a previously working Exim installation.
13521 Provided that you do trust the resolver (ie, is on localhost) you can tell
13522 glibc to pass through any successful validation with a new option in
13523 &_/etc/resolv.conf_&:
13524 .code
13525 options trust-ad
13526 .endd
13527
13528 Exim does not perform DNSSEC validation itself, instead leaving that to a
13529 validating resolver (e.g. unbound, or bind with suitable configuration).
13530
13531 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13532 mechanism in the list, then this variable will be false.
13533
13534 This requires that your system resolver library support EDNS0 (and that
13535 DNSSEC flags exist in the system headers).  If the resolver silently drops
13536 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13537 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13538
13539
13540 .tvar &$sender_host_name$&
13541 When a message is received from a remote host, this variable contains the
13542 host's name as obtained by looking up its IP address. For messages received by
13543 other means, this variable is empty.
13544
13545 .vindex "&$host_lookup_failed$&"
13546 If the host name has not previously been looked up, a reference to
13547 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13548 A looked up name is accepted only if it leads back to the original IP address
13549 via a forward lookup. If either the reverse or the forward lookup fails to find
13550 any data, or if the forward lookup does not yield the original IP address,
13551 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13552
13553 .vindex "&$host_lookup_deferred$&"
13554 However, if either of the lookups cannot be completed (for example, there is a
13555 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13556 &$host_lookup_failed$& remains set to &"0"&.
13557
13558 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13559 host name again if there is a subsequent reference to &$sender_host_name$&
13560 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13561 is set to &"1"&.
13562
13563 Exim does not automatically look up every calling host's name. If you want
13564 maximum efficiency, you should arrange your configuration so that it avoids
13565 these lookups altogether. The lookup happens only if one or more of the
13566 following are true:
13567
13568 .ilist
13569 A string containing &$sender_host_name$& is expanded.
13570 .next
13571 The calling host matches the list in &%host_lookup%&. In the default
13572 configuration, this option is set to *, so it must be changed if lookups are
13573 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13574 .next
13575 Exim needs the host name in order to test an item in a host list. The items
13576 that require this are described in sections &<<SECThoslispatnam>>& and
13577 &<<SECThoslispatnamsk>>&.
13578 .next
13579 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13580 In this case, the host name is required to compare with the name quoted in any
13581 EHLO or HELO commands that the client issues.
13582 .next
13583 The remote host issues a EHLO or HELO command that quotes one of the
13584 domains in &%helo_lookup_domains%&. The default value of this option is
13585 . ==== As this is a nested list, any displays it contains must be indented
13586 . ==== as otherwise they are too far to the left.
13587 .code
13588   helo_lookup_domains = @ : @[]
13589 .endd
13590 which causes a lookup if a remote host (incorrectly) gives the server's name or
13591 IP address in an EHLO or HELO command.
13592 .endlist
13593
13594
13595 .vitem &$sender_host_port$&
13596 .vindex "&$sender_host_port$&"
13597 When a message is received from a remote host, this variable contains the port
13598 number that was used on the remote host.
13599
13600 .vitem &$sender_ident$&
13601 .vindex "&$sender_ident$&"
13602 When a message is received from a remote host, this variable contains the
13603 identification received in response to an RFC 1413 request. When a message has
13604 been received locally, this variable contains the login name of the user that
13605 called Exim.
13606
13607 .vitem &$sender_rate_$&&'xxx'&
13608 A number of variables whose names begin &$sender_rate_$& are set as part of the
13609 &%ratelimit%& ACL condition. Details are given in section
13610 &<<SECTratelimiting>>&.
13611
13612 .vitem &$sender_rcvhost$&
13613 .cindex "DNS" "reverse lookup"
13614 .cindex "reverse DNS lookup"
13615 .vindex "&$sender_rcvhost$&"
13616 This is provided specifically for use in &'Received:'& headers. It starts with
13617 either the verified host name (as obtained from a reverse DNS lookup) or, if
13618 there is no verified host name, the IP address in square brackets. After that
13619 there may be text in parentheses. When the first item is a verified host name,
13620 the first thing in the parentheses is the IP address in square brackets,
13621 followed by a colon and a port number if port logging is enabled. When the
13622 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13623 the parentheses.
13624
13625 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13626 was used and its argument was not identical to the real host name or IP
13627 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13628 all three items are present in the parentheses, a newline and tab are inserted
13629 into the string, to improve the formatting of the &'Received:'& header.
13630
13631 .vitem &$sender_verify_failure$&
13632 .vindex "&$sender_verify_failure$&"
13633 In an ACL, when a sender verification fails, this variable contains information
13634 about the failure. The details are the same as for
13635 &$recipient_verify_failure$&.
13636
13637 .vitem &$sending_ip_address$&
13638 .vindex "&$sending_ip_address$&"
13639 This variable is set whenever an outgoing SMTP connection to another host has
13640 been set up. It contains the IP address of the local interface that is being
13641 used. This is useful if a host that has more than one IP address wants to take
13642 on different personalities depending on which one is being used. For incoming
13643 connections, see &$received_ip_address$&.
13644
13645 .vitem &$sending_port$&
13646 .vindex "&$sending_port$&"
13647 This variable is set whenever an outgoing SMTP connection to another host has
13648 been set up. It contains the local port that is being used. For incoming
13649 connections, see &$received_port$&.
13650
13651 .vitem &$smtp_active_hostname$&
13652 .vindex "&$smtp_active_hostname$&"
13653 During an incoming SMTP session, this variable contains the value of the active
13654 host name, as specified by the &%smtp_active_hostname%& option. The value of
13655 &$smtp_active_hostname$& is saved with any message that is received, so its
13656 value can be consulted during routing and delivery.
13657
13658 .tvar &$smtp_command$&
13659 During the processing of an incoming SMTP command, this variable contains the
13660 entire command. This makes it possible to distinguish between HELO and EHLO in
13661 the HELO ACL, and also to distinguish between commands such as these:
13662 .code
13663 MAIL FROM:<>
13664 MAIL FROM: <>
13665 .endd
13666 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13667 command, the address in &$smtp_command$& is the original address before any
13668 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13669 the address after SMTP-time rewriting.
13670
13671 .tvar &$smtp_command_argument$&
13672 .cindex "SMTP" "command, argument for"
13673 While an ACL is running to check an SMTP command, this variable contains the
13674 argument, that is, the text that follows the command name, with leading white
13675 space removed. Following the introduction of &$smtp_command$&, this variable is
13676 somewhat redundant, but is retained for backwards compatibility.
13677
13678 .vitem &$smtp_command_history$&
13679 .cindex SMTP "command history"
13680 .vindex "&$smtp_command_history$&"
13681 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13682 received, in time-order left to right.  Only a limited number of commands
13683 are remembered.
13684
13685 .vitem &$smtp_count_at_connection_start$&
13686 .vindex "&$smtp_count_at_connection_start$&"
13687 This variable is set greater than zero only in processes spawned by the Exim
13688 daemon for handling incoming SMTP connections. The name is deliberately long,
13689 in order to emphasize what the contents are. When the daemon accepts a new
13690 connection, it increments this variable. A copy of the variable is passed to
13691 the child process that handles the connection, but its value is fixed, and
13692 never changes. It is only an approximation of how many incoming connections
13693 there actually are, because many other connections may come and go while a
13694 single connection is being processed. When a child process terminates, the
13695 daemon decrements its copy of the variable.
13696
13697 .vitem "&$sn0$& &-- &$sn9$&"
13698 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13699 that were current at the end of the system filter file. This allows a system
13700 filter file to set values that can be tested in users' filter files. For
13701 example, a system filter could set a value indicating how likely it is that a
13702 message is junk mail.
13703
13704 .vitem &$spam_score$& &&&
13705        &$spam_score_int$& &&&
13706        &$spam_bar$& &&&
13707        &$spam_report$& &&&
13708        &$spam_action$&
13709 A number of variables whose names start with &$spam$& are available when Exim
13710 is compiled with the content-scanning extension. For details, see section
13711 &<<SECTscanspamass>>&.
13712
13713 .vitem &$spf_header_comment$& &&&
13714        &$spf_received$& &&&
13715        &$spf_result$& &&&
13716        &$spf_result_guessed$& &&&
13717        &$spf_smtp_comment$&
13718 These variables are only available if Exim is built with SPF support.
13719 For details see section &<<SECSPF>>&.
13720
13721 .vitem &$spool_directory$&
13722 .vindex "&$spool_directory$&"
13723 The name of Exim's spool directory.
13724
13725 .vitem &$spool_inodes$&
13726 .vindex "&$spool_inodes$&"
13727 The number of free inodes in the disk partition where Exim's spool files are
13728 being written. The value is recalculated whenever the variable is referenced.
13729 If the relevant file system does not have the concept of inodes, the value of
13730 is -1. See also the &%check_spool_inodes%& option.
13731
13732 .vitem &$spool_space$&
13733 .vindex "&$spool_space$&"
13734 The amount of free space (as a number of kilobytes) in the disk partition where
13735 Exim's spool files are being written. The value is recalculated whenever the
13736 variable is referenced. If the operating system does not have the ability to
13737 find the amount of free space (only true for experimental systems), the space
13738 value is -1. For example, to check in an ACL that there is at least 50
13739 megabytes free on the spool, you could write:
13740 .code
13741 condition = ${if > {$spool_space}{50000}}
13742 .endd
13743 See also the &%check_spool_space%& option.
13744
13745
13746 .vitem &$thisaddress$&
13747 .vindex "&$thisaddress$&"
13748 This variable is set only during the processing of the &%foranyaddress%&
13749 command in a filter file. Its use is explained in the description of that
13750 command, which can be found in the separate document entitled &'Exim's
13751 interfaces to mail filtering'&.
13752
13753 .vitem &$tls_in_bits$&
13754 .vindex "&$tls_in_bits$&"
13755 Contains an approximation of the TLS cipher's bit-strength
13756 on the inbound connection; the meaning of
13757 this depends upon the TLS implementation used.
13758 If TLS has not been negotiated, the value will be 0.
13759 The value of this is automatically fed into the Cyrus SASL authenticator
13760 when acting as a server, to specify the "external SSF" (a SASL term).
13761
13762 The deprecated &$tls_bits$& variable refers to the inbound side
13763 except when used in the context of an outbound SMTP delivery, when it refers to
13764 the outbound.
13765
13766 .vitem &$tls_out_bits$&
13767 .vindex "&$tls_out_bits$&"
13768 Contains an approximation of the TLS cipher's bit-strength
13769 on an outbound SMTP connection; the meaning of
13770 this depends upon the TLS implementation used.
13771 If TLS has not been negotiated, the value will be 0.
13772
13773 .vitem &$tls_in_ourcert$&
13774 .vindex "&$tls_in_ourcert$&"
13775 .cindex certificate variables
13776 This variable refers to the certificate presented to the peer of an
13777 inbound connection when the message was received.
13778 It is only useful as the argument of a
13779 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13780 or a &%def%& condition.
13781
13782 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13783 when a list of more than one
13784 file is used for &%tls_certificate%&, this variable is not reliable.
13785 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13786
13787 .vitem &$tls_in_peercert$&
13788 .vindex "&$tls_in_peercert$&"
13789 This variable refers to the certificate presented by the peer of an
13790 inbound connection when the message was received.
13791 It is only useful as the argument of a
13792 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13793 or a &%def%& condition.
13794 If certificate verification fails it may refer to a failing chain element
13795 which is not the leaf.
13796
13797 .vitem &$tls_out_ourcert$&
13798 .vindex "&$tls_out_ourcert$&"
13799 This variable refers to the certificate presented to the peer of an
13800 outbound connection.  It is only useful as the argument of a
13801 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13802 or a &%def%& condition.
13803
13804 .vitem &$tls_out_peercert$&
13805 .vindex "&$tls_out_peercert$&"
13806 This variable refers to the certificate presented by the peer of an
13807 outbound connection.  It is only useful as the argument of a
13808 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13809 or a &%def%& condition.
13810 If certificate verification fails it may refer to a failing chain element
13811 which is not the leaf.
13812
13813 .vitem &$tls_in_certificate_verified$&
13814 .vindex "&$tls_in_certificate_verified$&"
13815 This variable is set to &"1"& if a TLS certificate was verified when the
13816 message was received, and &"0"& otherwise.
13817
13818 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13819 except when used in the context of an outbound SMTP delivery, when it refers to
13820 the outbound.
13821
13822 .vitem &$tls_out_certificate_verified$&
13823 .vindex "&$tls_out_certificate_verified$&"
13824 This variable is set to &"1"& if a TLS certificate was verified when an
13825 outbound SMTP connection was made,
13826 and &"0"& otherwise.
13827
13828 .vitem &$tls_in_cipher$&
13829 .vindex "&$tls_in_cipher$&"
13830 .vindex "&$tls_cipher$&"
13831 When a message is received from a remote host over an encrypted SMTP
13832 connection, this variable is set to the cipher suite that was negotiated, for
13833 example DES-CBC3-SHA. In other circumstances, in particular, for message
13834 received over unencrypted connections, the variable is empty. Testing
13835 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13836 non-encrypted connections during ACL processing.
13837
13838 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13839 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13840 becomes the same as &$tls_out_cipher$&.
13841
13842 .vitem &$tls_in_cipher_std$&
13843 .vindex "&$tls_in_cipher_std$&"
13844 As above, but returning the RFC standard name for the cipher suite.
13845
13846 .vitem &$tls_out_cipher$&
13847 .vindex "&$tls_out_cipher$&"
13848 This variable is
13849 cleared before any outgoing SMTP connection is made,
13850 and then set to the outgoing cipher suite if one is negotiated. See chapter
13851 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13852 details of the &(smtp)& transport.
13853
13854 .vitem &$tls_out_cipher_std$&
13855 .vindex "&$tls_out_cipher_std$&"
13856 As above, but returning the RFC standard name for the cipher suite.
13857
13858 .vitem &$tls_out_dane$&
13859 .vindex &$tls_out_dane$&
13860 DANE active status.  See section &<<SECDANE>>&.
13861
13862 .vitem &$tls_in_ocsp$&
13863 .vindex "&$tls_in_ocsp$&"
13864 When a message is received from a remote client connection
13865 the result of any OCSP request from the client is encoded in this variable:
13866 .code
13867 0 OCSP proof was not requested (default value)
13868 1 No response to request
13869 2 Response not verified
13870 3 Verification failed
13871 4 Verification succeeded
13872 .endd
13873
13874 .vitem &$tls_out_ocsp$&
13875 .vindex "&$tls_out_ocsp$&"
13876 When a message is sent to a remote host connection
13877 the result of any OCSP request made is encoded in this variable.
13878 See &$tls_in_ocsp$& for values.
13879
13880 .vitem &$tls_in_peerdn$&
13881 .vindex "&$tls_in_peerdn$&"
13882 .vindex "&$tls_peerdn$&"
13883 .cindex certificate "extracting fields"
13884 When a message is received from a remote host over an encrypted SMTP
13885 connection, and Exim is configured to request a certificate from the client,
13886 the value of the Distinguished Name of the certificate is made available in the
13887 &$tls_in_peerdn$& during subsequent processing.
13888 If certificate verification fails it may refer to a failing chain element
13889 which is not the leaf.
13890
13891 The deprecated &$tls_peerdn$& variable refers to the inbound side
13892 except when used in the context of an outbound SMTP delivery, when it refers to
13893 the outbound.
13894
13895 .vitem &$tls_out_peerdn$&
13896 .vindex "&$tls_out_peerdn$&"
13897 When a message is being delivered to a remote host over an encrypted SMTP
13898 connection, and Exim is configured to request a certificate from the server,
13899 the value of the Distinguished Name of the certificate is made available in the
13900 &$tls_out_peerdn$& during subsequent processing.
13901 If certificate verification fails it may refer to a failing chain element
13902 which is not the leaf.
13903
13904
13905 .vitem &$tls_in_resumption$& &&&
13906        &$tls_out_resumption$&
13907 .vindex &$tls_in_resumption$&
13908 .vindex &$tls_out_resumption$&
13909 .cindex TLS resumption
13910 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13911
13912
13913 .tvar &$tls_in_sni$&
13914 .vindex "&$tls_sni$&"
13915 .cindex "TLS" "Server Name Indication"
13916 .cindex "TLS" SNI
13917 .cindex SNI "observability on server"
13918 When a TLS session is being established, if the client sends the Server
13919 Name Indication extension, the value will be placed in this variable.
13920 If the variable appears in &%tls_certificate%& then this option and
13921 some others, described in &<<SECTtlssni>>&,
13922 will be re-expanded early in the TLS session, to permit
13923 a different certificate to be presented (and optionally a different key to be
13924 used) to the client, based upon the value of the SNI extension.
13925
13926 The deprecated &$tls_sni$& variable refers to the inbound side
13927 except when used in the context of an outbound SMTP delivery, when it refers to
13928 the outbound.
13929
13930 .vitem &$tls_out_sni$&
13931 .vindex "&$tls_out_sni$&"
13932 .cindex "TLS" "Server Name Indication"
13933 .cindex "TLS" SNI
13934 .cindex SNI "observability in client"
13935 During outbound
13936 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13937 the transport.
13938
13939 .vitem &$tls_out_tlsa_usage$&
13940 .vindex &$tls_out_tlsa_usage$&
13941 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13942
13943 .vitem &$tls_in_ver$&
13944 .vindex "&$tls_in_ver$&"
13945 When a message is received from a remote host over an encrypted SMTP connection
13946 this variable is set to the protocol version, eg &'TLS1.2'&.
13947
13948 .vitem &$tls_out_ver$&
13949 .vindex "&$tls_out_ver$&"
13950 When a message is being delivered to a remote host over an encrypted SMTP connection
13951 this variable is set to the protocol version.
13952
13953
13954 .vitem &$tod_bsdinbox$&
13955 .vindex "&$tod_bsdinbox$&"
13956 The time of day and the date, in the format required for BSD-style mailbox
13957 files, for example: Thu Oct 17 17:14:09 1995.
13958
13959 .vitem &$tod_epoch$&
13960 .vindex "&$tod_epoch$&"
13961 The time and date as a number of seconds since the start of the Unix epoch.
13962
13963 .vitem &$tod_epoch_l$&
13964 .vindex "&$tod_epoch_l$&"
13965 The time and date as a number of microseconds since the start of the Unix epoch.
13966
13967 .vitem &$tod_full$&
13968 .vindex "&$tod_full$&"
13969 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13970 +0100. The timezone is always given as a numerical offset from UTC, with
13971 positive values used for timezones that are ahead (east) of UTC, and negative
13972 values for those that are behind (west).
13973
13974 .vitem &$tod_log$&
13975 .vindex "&$tod_log$&"
13976 The time and date in the format used for writing Exim's log files, for example:
13977 1995-10-12 15:32:29, but without a timezone.
13978
13979 .vitem &$tod_logfile$&
13980 .vindex "&$tod_logfile$&"
13981 This variable contains the date in the format yyyymmdd. This is the format that
13982 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13983 flag.
13984
13985 .vitem &$tod_zone$&
13986 .vindex "&$tod_zone$&"
13987 This variable contains the numerical value of the local timezone, for example:
13988 -0500.
13989
13990 .vitem &$tod_zulu$&
13991 .vindex "&$tod_zulu$&"
13992 This variable contains the UTC date and time in &"Zulu"& format, as specified
13993 by ISO 8601, for example: 20030221154023Z.
13994
13995 .vitem &$transport_name$&
13996 .cindex "transport" "name"
13997 .cindex "name" "of transport"
13998 .vindex "&$transport_name$&"
13999 During the running of a transport, this variable contains its name.
14000
14001 .vitem &$value$&
14002 .vindex "&$value$&"
14003 This variable contains the result of an expansion lookup, extraction operation,
14004 or external command, as described above. It is also used during a
14005 &*reduce*& expansion.
14006
14007 .vitem &$verify_mode$&
14008 .vindex "&$verify_mode$&"
14009 While a router or transport is being run in verify mode or for cutthrough delivery,
14010 contains "S" for sender-verification or "R" for recipient-verification.
14011 Otherwise, empty.
14012
14013 .vitem &$version_number$&
14014 .vindex "&$version_number$&"
14015 The version number of Exim. Same as &$exim_version$&, may be overridden
14016 by the &%exim_version%& main config option.
14017
14018 .vitem &$warn_message_delay$&
14019 .vindex "&$warn_message_delay$&"
14020 This variable is set only during the creation of a message warning about a
14021 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14022
14023 .vitem &$warn_message_recipients$&
14024 .vindex "&$warn_message_recipients$&"
14025 This variable is set only during the creation of a message warning about a
14026 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14027 .endlist
14028 .ecindex IIDstrexp
14029
14030
14031
14032 . ////////////////////////////////////////////////////////////////////////////
14033 . ////////////////////////////////////////////////////////////////////////////
14034
14035 .chapter "Embedded Perl" "CHAPperl"
14036 .scindex IIDperl "Perl" "calling from Exim"
14037 Exim can be built to include an embedded Perl interpreter. When this is done,
14038 Perl subroutines can be called as part of the string expansion process. To make
14039 use of the Perl support, you need version 5.004 or later of Perl installed on
14040 your system. To include the embedded interpreter in the Exim binary, include
14041 the line
14042 .code
14043 EXIM_PERL = perl.o
14044 .endd
14045 in your &_Local/Makefile_& and then build Exim in the normal way.
14046
14047
14048 .section "Setting up so Perl can be used" "SECID85"
14049 .oindex "&%perl_startup%&"
14050 Access to Perl subroutines is via a global configuration option called
14051 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14052 no &%perl_startup%& option in the Exim configuration file then no Perl
14053 interpreter is started and there is almost no overhead for Exim (since none of
14054 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14055 option then the associated value is taken to be Perl code which is executed in
14056 a newly created Perl interpreter.
14057
14058 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14059 need backslashes before any characters to escape special meanings. The option
14060 should usually be something like
14061 .code
14062 perl_startup = do '/etc/exim.pl'
14063 .endd
14064 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14065 use from Exim. Exim can be configured either to start up a Perl interpreter as
14066 soon as it is entered, or to wait until the first time it is needed. Starting
14067 the interpreter at the beginning ensures that it is done while Exim still has
14068 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14069 fact used in a particular run. Also, note that this does not mean that Exim is
14070 necessarily running as root when Perl is called at a later time. By default,
14071 the interpreter is started only when it is needed, but this can be changed in
14072 two ways:
14073
14074 .ilist
14075 .oindex "&%perl_at_start%&"
14076 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14077 a startup when Exim is entered.
14078 .next
14079 The command line option &%-ps%& also requests a startup when Exim is entered,
14080 overriding the setting of &%perl_at_start%&.
14081 .endlist
14082
14083 There is also a command line option &%-pd%& (for delay) which suppresses the
14084 initial startup, even if &%perl_at_start%& is set.
14085
14086 .ilist
14087 .oindex "&%perl_taintmode%&"
14088 .cindex "Perl" "taintmode"
14089 To provide more security executing Perl code via the embedded Perl
14090 interpreter, the &%perl_taintmode%& option can be set. This enables the
14091 taint mode of the Perl interpreter. You are encouraged to set this
14092 option to a true value. To avoid breaking existing installations, it
14093 defaults to false.
14094
14095 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14096
14097
14098 .section "Calling Perl subroutines" "SECID86"
14099 When the configuration file includes a &%perl_startup%& option you can make use
14100 of the string expansion item to call the Perl subroutines that are defined
14101 by the &%perl_startup%& code. The operator is used in any of the following
14102 forms:
14103 .code
14104 ${perl{foo}}
14105 ${perl{foo}{argument}}
14106 ${perl{foo}{argument1}{argument2} ... }
14107 .endd
14108 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14109 arguments may be passed. Passing more than this results in an expansion failure
14110 with an error message of the form
14111 .code
14112 Too many arguments passed to Perl subroutine "foo" (max is 8)
14113 .endd
14114 The return value of the Perl subroutine is evaluated in a scalar context before
14115 it is passed back to Exim to be inserted into the expanded string. If the
14116 return value is &'undef'&, the expansion is forced to fail in the same way as
14117 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14118 by obeying Perl's &%die%& function, the expansion fails with the error message
14119 that was passed to &%die%&.
14120
14121
14122 .section "Calling Exim functions from Perl" "SECID87"
14123 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14124 is available to call back into Exim's string expansion function. For example,
14125 the Perl code
14126 .code
14127 my $lp = Exim::expand_string('$local_part');
14128 .endd
14129 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14130 Note those are single quotes and not double quotes to protect against
14131 &$local_part$& being interpolated as a Perl variable.
14132
14133 If the string expansion is forced to fail by a &"fail"& item, the result of
14134 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14135 expansion string, the Perl call from the original expansion string fails with
14136 an appropriate error message, in the same way as if &%die%& were used.
14137
14138 .cindex "debugging" "from embedded Perl"
14139 .cindex "log" "writing from embedded Perl"
14140 Two other Exim functions are available for use from within Perl code.
14141 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14142 debugging is enabled. If you want a newline at the end, you must supply it.
14143 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14144 timestamp. In this case, you should not supply a terminating newline.
14145
14146
14147 .section "Use of standard output and error by Perl" "SECID88"
14148 .cindex "Perl" "standard output and error"
14149 You should not write to the standard error or output streams from within your
14150 Perl code, as it is not defined how these are set up. In versions of Exim
14151 before 4.50, it is possible for the standard output or error to refer to the
14152 SMTP connection during message reception via the daemon. Writing to this stream
14153 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14154 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14155 avoided, but the output is lost.
14156
14157 .cindex "Perl" "use of &%warn%&"
14158 The Perl &%warn%& statement writes to the standard error stream by default.
14159 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14160 you have no control. When Exim starts up the Perl interpreter, it arranges for
14161 output from the &%warn%& statement to be written to the Exim main log. You can
14162 change this by including appropriate Perl magic somewhere in your Perl code.
14163 For example, to discard &%warn%& output completely, you need this:
14164 .code
14165 $SIG{__WARN__} = sub { };
14166 .endd
14167 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14168 example, the code for the subroutine is empty, so it does nothing, but you can
14169 include any Perl code that you like. The text of the &%warn%& message is passed
14170 as the first subroutine argument.
14171 .ecindex IIDperl
14172
14173
14174 . ////////////////////////////////////////////////////////////////////////////
14175 . ////////////////////////////////////////////////////////////////////////////
14176
14177 .chapter "Starting the daemon and the use of network interfaces" &&&
14178          "CHAPinterfaces" &&&
14179          "Starting the daemon"
14180 .cindex "daemon" "starting"
14181 .cindex "interface" "listening"
14182 .cindex "network interface"
14183 .cindex "interface" "network"
14184 .cindex "IP address" "for listening"
14185 .cindex "daemon" "listening IP addresses"
14186 .cindex "TCP/IP" "setting listening interfaces"
14187 .cindex "TCP/IP" "setting listening ports"
14188 A host that is connected to a TCP/IP network may have one or more physical
14189 hardware network interfaces. Each of these interfaces may be configured as one
14190 or more &"logical"& interfaces, which are the entities that a program actually
14191 works with. Each of these logical interfaces is associated with an IP address.
14192 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14193 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14194 knowledge about the host's interfaces for use in three different circumstances:
14195
14196 .olist
14197 When a listening daemon is started, Exim needs to know which interfaces
14198 and ports to listen on.
14199 .next
14200 When Exim is routing an address, it needs to know which IP addresses
14201 are associated with local interfaces. This is required for the correct
14202 processing of MX lists by removing the local host and others with the
14203 same or higher priority values. Also, Exim needs to detect cases
14204 when an address is routed to an IP address that in fact belongs to the
14205 local host. Unless the &%self%& router option or the &%allow_localhost%&
14206 option of the smtp transport is set (as appropriate), this is treated
14207 as an error situation.
14208 .next
14209 When Exim connects to a remote host, it may need to know which interface to use
14210 for the outgoing connection.
14211 .endlist
14212
14213
14214 Exim's default behaviour is likely to be appropriate in the vast majority
14215 of cases. If your host has only one interface, and you want all its IP
14216 addresses to be treated in the same way, and you are using only the
14217 standard SMTP port, you should not need to take any special action. The
14218 rest of this chapter does not apply to you.
14219
14220 In a more complicated situation you may want to listen only on certain
14221 interfaces, or on different ports, and for this reason there are a number of
14222 options that can be used to influence Exim's behaviour. The rest of this
14223 chapter describes how they operate.
14224
14225 When a message is received over TCP/IP, the interface and port that were
14226 actually used are set in &$received_ip_address$& and &$received_port$&.
14227
14228
14229
14230 .section "Starting a listening daemon" "SECID89"
14231 When a listening daemon is started (by means of the &%-bd%& command line
14232 option), the interfaces and ports on which it listens are controlled by the
14233 following options:
14234
14235 .ilist
14236 &%daemon_smtp_ports%& contains a list of default ports
14237 or service names.
14238 (For backward compatibility, this option can also be specified in the singular.)
14239 .next
14240 &%local_interfaces%& contains list of interface IP addresses on which to
14241 listen. Each item may optionally also specify a port.
14242 .endlist
14243
14244 The default list separator in both cases is a colon, but this can be changed as
14245 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14246 it is usually best to change the separator to avoid having to double all the
14247 colons. For example:
14248 .code
14249 local_interfaces = <; 127.0.0.1 ; \
14250                       192.168.23.65 ; \
14251                       ::1 ; \
14252                       3ffe:ffff:836f::fe86:a061
14253 .endd
14254 There are two different formats for specifying a port along with an IP address
14255 in &%local_interfaces%&:
14256
14257 .olist
14258 The port is added onto the address with a dot separator. For example, to listen
14259 on port 1234 on two different IP addresses:
14260 .code
14261 local_interfaces = <; 192.168.23.65.1234 ; \
14262                       3ffe:ffff:836f::fe86:a061.1234
14263 .endd
14264 .next
14265 The IP address is enclosed in square brackets, and the port is added
14266 with a colon separator, for example:
14267 .code
14268 local_interfaces = <; [192.168.23.65]:1234 ; \
14269                       [3ffe:ffff:836f::fe86:a061]:1234
14270 .endd
14271 .endlist
14272
14273 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14274 default setting contains just one port:
14275 .code
14276 daemon_smtp_ports = smtp
14277 .endd
14278 If more than one port is listed, each interface that does not have its own port
14279 specified listens on all of them. Ports that are listed in
14280 &%daemon_smtp_ports%& can be identified either by name (defined in
14281 &_/etc/services_&) or by number. However, when ports are given with individual
14282 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14283
14284
14285
14286 .section "Special IP listening addresses" "SECID90"
14287 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14288 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14289 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14290 instead of setting up separate listening sockets for each interface. The
14291 default value of &%local_interfaces%& is
14292 .code
14293 local_interfaces = 0.0.0.0
14294 .endd
14295 when Exim is built without IPv6 support; otherwise it is:
14296 .code
14297 local_interfaces = <; ::0 ; 0.0.0.0
14298 .endd
14299 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14300
14301
14302
14303 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14304 The &%-oX%& command line option can be used to override the values of
14305 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14306 instance. Another way of doing this would be to use macros and the &%-D%&
14307 option. However, &%-oX%& can be used by any admin user, whereas modification of
14308 the runtime configuration by &%-D%& is allowed only when the caller is root or
14309 exim.
14310
14311 The value of &%-oX%& is a list of items. The default colon separator can be
14312 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14313 If there are any items that do not
14314 contain dots or colons (that is, are not IP addresses), the value of
14315 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14316 items that do contain dots or colons, the value of &%local_interfaces%& is
14317 replaced by those items. Thus, for example,
14318 .code
14319 -oX 1225
14320 .endd
14321 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14322 whereas
14323 .code
14324 -oX 192.168.34.5.1125
14325 .endd
14326 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14327 (However, since &%local_interfaces%& now contains no items without ports, the
14328 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14329
14330
14331
14332 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14333 .cindex "submissions protocol"
14334 .cindex "ssmtp protocol"
14335 .cindex "smtps protocol"
14336 .cindex "SMTP" "ssmtp protocol"
14337 .cindex "SMTP" "smtps protocol"
14338 Exim supports the use of TLS-on-connect, used by mail clients in the
14339 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14340 For some years, IETF Standards Track documents only blessed the
14341 STARTTLS-based Submission service (port 587) while common practice was to support
14342 the same feature set on port 465, but using TLS-on-connect.
14343 If your installation needs to provide service to mail clients
14344 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14345 the 465 TCP ports.
14346
14347 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14348 service names, connections to those ports must first establish TLS, before
14349 proceeding to the application layer use of the SMTP protocol.
14350
14351 The common use of this option is expected to be
14352 .code
14353 tls_on_connect_ports = 465
14354 .endd
14355 per RFC 8314.
14356 There is also a command line option &%-tls-on-connect%&, which forces all ports
14357 to behave in this way when a daemon is started.
14358
14359 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14360 daemon to listen on those ports. You must still specify them in
14361 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14362 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14363 connections via the daemon.)
14364
14365
14366
14367
14368 .section "IPv6 address scopes" "SECID92"
14369 .cindex "IPv6" "address scopes"
14370 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14371 can, in principle, have the same link-local IPv6 address on different
14372 interfaces. Thus, additional information is needed, over and above the IP
14373 address, to distinguish individual interfaces. A convention of using a
14374 percent sign followed by something (often the interface name) has been
14375 adopted in some cases, leading to addresses like this:
14376 .code
14377 fe80::202:b3ff:fe03:45c1%eth0
14378 .endd
14379 To accommodate this usage, a percent sign followed by an arbitrary string is
14380 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14381 to convert a textual IPv6 address for actual use. This function recognizes the
14382 percent convention in operating systems that support it, and it processes the
14383 address appropriately. Unfortunately, some older libraries have problems with
14384 &[getaddrinfo()]&. If
14385 .code
14386 IPV6_USE_INET_PTON=yes
14387 .endd
14388 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14389 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14390 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14391 function.) Of course, this means that the additional functionality of
14392 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14393
14394 .section "Disabling IPv6" "SECID93"
14395 .cindex "IPv6" "disabling"
14396 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14397 run on a host whose kernel does not support IPv6. The binary will fall back to
14398 using IPv4, but it may waste resources looking up AAAA records, and trying to
14399 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14400 .oindex "&%disable_ipv6%&"
14401 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14402 activities take place. AAAA records are never looked up, and any IPv6 addresses
14403 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14404 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14405 to handle IPv6 literal addresses.
14406
14407 On the other hand, when IPv6 is in use, there may be times when you want to
14408 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14409 option to globally suppress the lookup of AAAA records for specified domains,
14410 and you can use the &%ignore_target_hosts%& generic router option to ignore
14411 IPv6 addresses in an individual router.
14412
14413
14414
14415 .section "Examples of starting a listening daemon" "SECID94"
14416 The default case in an IPv6 environment is
14417 .code
14418 daemon_smtp_ports = smtp
14419 local_interfaces = <; ::0 ; 0.0.0.0
14420 .endd
14421 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14422 Either one or two sockets may be used, depending on the characteristics of
14423 the TCP/IP stack. (This is complicated and messy; for more information,
14424 read the comments in the &_daemon.c_& source file.)
14425
14426 To specify listening on ports 25 and 26 on all interfaces:
14427 .code
14428 daemon_smtp_ports = 25 : 26
14429 .endd
14430 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14431 .code
14432 local_interfaces = <; ::0.25     ; ::0.26 \
14433                       0.0.0.0.25 ; 0.0.0.0.26
14434 .endd
14435 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14436 IPv4 loopback address only:
14437 .code
14438 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14439 .endd
14440 To specify listening on the default port on specific interfaces only:
14441 .code
14442 local_interfaces = 10.0.0.67 : 192.168.34.67
14443 .endd
14444 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14445
14446
14447
14448 .section "Recognizing the local host" "SECTreclocipadd"
14449 The &%local_interfaces%& option is also used when Exim needs to determine
14450 whether or not an IP address refers to the local host. That is, the IP
14451 addresses of all the interfaces on which a daemon is listening are always
14452 treated as local.
14453
14454 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14455 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14456 available interfaces from the operating system, and extracts the relevant
14457 (that is, IPv4 or IPv6) addresses to use for checking.
14458
14459 Some systems set up large numbers of virtual interfaces in order to provide
14460 many virtual web servers. In this situation, you may want to listen for
14461 email on only a few of the available interfaces, but nevertheless treat all
14462 interfaces as local when routing. You can do this by setting
14463 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14464 &"all"& wildcard values. These addresses are recognized as local, but are not
14465 used for listening. Consider this example:
14466 .code
14467 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14468                       192.168.53.235 ; \
14469                       3ffe:2101:12:1:a00:20ff:fe86:a061
14470
14471 extra_local_interfaces = <; ::0 ; 0.0.0.0
14472 .endd
14473 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14474 address, but all available interface addresses are treated as local when
14475 Exim is routing.
14476
14477 In some environments the local host name may be in an MX list, but with an IP
14478 address that is not assigned to any local interface. In other cases it may be
14479 desirable to treat other host names as if they referred to the local host. Both
14480 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14481 This contains host names rather than IP addresses. When a host is referenced
14482 during routing, either via an MX record or directly, it is treated as the local
14483 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14484 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14485
14486
14487
14488 .section "Delivering to a remote host" "SECID95"
14489 Delivery to a remote host is handled by the smtp transport. By default, it
14490 allows the system's TCP/IP functions to choose which interface to use (if
14491 there is more than one) when connecting to a remote host. However, the
14492 &%interface%& option can be set to specify which interface is used. See the
14493 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14494 details.
14495
14496
14497
14498
14499 . ////////////////////////////////////////////////////////////////////////////
14500 . ////////////////////////////////////////////////////////////////////////////
14501
14502 .chapter "Main configuration" "CHAPmainconfig"
14503 .scindex IIDconfima "configuration file" "main section"
14504 .scindex IIDmaiconf "main configuration"
14505 The first part of the runtime configuration file contains three types of item:
14506
14507 .ilist
14508 Macro definitions: These lines start with an upper case letter. See section
14509 &<<SECTmacrodefs>>& for details of macro processing.
14510 .next
14511 Named list definitions: These lines start with one of the words &"domainlist"&,
14512 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14513 section &<<SECTnamedlists>>&.
14514 .next
14515 Main configuration settings: Each setting occupies one line of the file
14516 (with possible continuations). If any setting is preceded by the word
14517 &"hide"&, the &%-bP%& command line option displays its value to admin users
14518 only. See section &<<SECTcos>>& for a description of the syntax of these option
14519 settings.
14520 .endlist
14521
14522 This chapter specifies all the main configuration options, along with their
14523 types and default values. For ease of finding a particular option, they appear
14524 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14525 are now so many options, they are first listed briefly in functional groups, as
14526 an aid to finding the name of the option you are looking for. Some options are
14527 listed in more than one group.
14528
14529 .section "Miscellaneous" "SECID96"
14530 .table2
14531 .row &%add_environment%&             "environment variables"
14532 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14533 .row &%debug_store%&                 "do extra internal checks"
14534 .row &%disable_ipv6%&                "do no IPv6 processing"
14535 .row &%keep_environment%&            "environment variables"
14536 .row &%keep_malformed%&              "for broken files &-- should not happen"
14537 .row &%localhost_number%&            "for unique message ids in clusters"
14538 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14539 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14540 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14541 .row &%print_topbitchars%&           "top-bit characters are printing"
14542 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14543 .row &%timezone%&                    "force time zone"
14544 .endtable
14545
14546
14547 .section "Exim parameters" "SECID97"
14548 .table2
14549 .row &%exim_group%&                  "override compiled-in value"
14550 .row &%exim_path%&                   "override compiled-in value"
14551 .row &%exim_user%&                   "override compiled-in value"
14552 .row &%primary_hostname%&            "default from &[uname()]&"
14553 .row &%split_spool_directory%&       "use multiple directories"
14554 .row &%spool_directory%&             "override compiled-in value"
14555 .endtable
14556
14557
14558
14559 .section "Privilege controls" "SECID98"
14560 .table2
14561 .row &%admin_groups%&                "groups that are Exim admin users"
14562 .row &%commandline_checks_require_admin%& "require admin for various checks"
14563 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14564 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14565 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14566 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14567 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14568 .row &%never_users%&                 "do not run deliveries as these"
14569 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14570 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14571 .row &%trusted_groups%&              "groups that are trusted"
14572 .row &%trusted_users%&               "users that are trusted"
14573 .endtable
14574
14575
14576
14577 .section "Logging" "SECID99"
14578 .table2
14579 .row &%event_action%&                "custom logging"
14580 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14581 .row &%log_file_path%&               "override compiled-in value"
14582 .row &%log_selector%&                "set/unset optional logging"
14583 .row &%log_timezone%&                "add timezone to log lines"
14584 .row &%message_logs%&                "create per-message logs"
14585 .row &%preserve_message_logs%&       "after message completion"
14586 .row &%panic_coredump%&              "request coredump on fatal errors"
14587 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14588 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14589 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14590 .row &%syslog_facility%&             "set syslog &""facility""& field"
14591 .row &%syslog_pid%&                  "pid in syslog lines"
14592 .row &%syslog_processname%&          "set syslog &""ident""& field"
14593 .row &%syslog_timestamp%&            "timestamp syslog lines"
14594 .row &%write_rejectlog%&             "control use of message log"
14595 .endtable
14596
14597
14598
14599 .section "Frozen messages" "SECID100"
14600 .table2
14601 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14602 .row &%freeze_tell%&                 "send message when freezing"
14603 .row &%move_frozen_messages%&        "to another directory"
14604 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14605 .endtable
14606
14607
14608
14609 .section "Data lookups" "SECID101"
14610 .table2
14611 .row &%ibase_servers%&               "InterBase servers"
14612 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14613 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14614 .row &%ldap_cert_file%&              "client cert file for LDAP"
14615 .row &%ldap_cert_key%&               "client key file for LDAP"
14616 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14617 .row &%ldap_default_servers%&        "used if no server in query"
14618 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14619 .row &%ldap_start_tls%&              "require TLS within LDAP"
14620 .row &%ldap_version%&                "set protocol version"
14621 .row &%lookup_open_max%&             "lookup files held open"
14622 .row &%mysql_servers%&               "default MySQL servers"
14623 .row &%oracle_servers%&              "Oracle servers"
14624 .row &%pgsql_servers%&               "default PostgreSQL servers"
14625 .row &%sqlite_lock_timeout%&         "as it says"
14626 .endtable
14627
14628
14629
14630 .section "Message ids" "SECID102"
14631 .table2
14632 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14633 .row &%message_id_header_text%&      "ditto"
14634 .endtable
14635
14636
14637
14638 .section "Embedded Perl Startup" "SECID103"
14639 .table2
14640 .row &%perl_at_start%&               "always start the interpreter"
14641 .row &%perl_startup%&                "code to obey when starting Perl"
14642 .row &%perl_taintmode%&              "enable taint mode in Perl"
14643 .endtable
14644
14645
14646
14647 .section "Daemon" "SECID104"
14648 .table2
14649 .row &%daemon_smtp_ports%&           "default ports"
14650 .row &%daemon_startup_retries%&      "number of times to retry"
14651 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14652 .row &%extra_local_interfaces%&      "not necessarily listened on"
14653 .row &%local_interfaces%&            "on which to listen, with optional ports"
14654 .row &%notifier_socket%&             "override compiled-in value"
14655 .row &%pid_file_path%&               "override compiled-in value"
14656 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14657 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14658 .endtable
14659
14660
14661
14662 .section "Resource control" "SECID105"
14663 .table2
14664 .row &%check_log_inodes%&            "before accepting a message"
14665 .row &%check_log_space%&             "before accepting a message"
14666 .row &%check_spool_inodes%&          "before accepting a message"
14667 .row &%check_spool_space%&           "before accepting a message"
14668 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14669 .row &%queue_only_load%&             "queue incoming if load high"
14670 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14671 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14672 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14673 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14674 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14675 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14676 .row &%smtp_accept_max_per_connection%& "messages per connection"
14677 .row &%smtp_accept_max_per_host%&    "connections from one host"
14678 .row &%smtp_accept_queue%&           "queue mail if more connections"
14679 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14680                                            connection"
14681 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14682 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14683 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14684 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14685 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14686 .endtable
14687
14688
14689
14690 .section "Policy controls" "SECID106"
14691 .table2
14692 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14693 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14694 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14695 .row &%acl_smtp_auth%&               "ACL for AUTH"
14696 .row &%acl_smtp_connect%&            "ACL for connection"
14697 .row &%acl_smtp_data%&               "ACL for DATA"
14698 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14699 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14700 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14701 .row &%acl_smtp_expn%&               "ACL for EXPN"
14702 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14703 .row &%acl_smtp_mail%&               "ACL for MAIL"
14704 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14705 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14706 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14707 .row &%acl_smtp_predata%&            "ACL for start of data"
14708 .row &%acl_smtp_quit%&               "ACL for QUIT"
14709 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14710 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14711 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14712 .row &%av_scanner%&                  "specify virus scanner"
14713 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14714                                       words""&"
14715 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14716 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14717 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14718 .row &%header_maxsize%&              "total size of message header"
14719 .row &%header_line_maxsize%&         "individual header line limit"
14720 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14721 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14722 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14723 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14724 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14725 .row &%host_lookup%&                 "host name looked up for these hosts"
14726 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14727 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14728 .row &%host_reject_connection%&      "reject connection from these hosts"
14729 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14730 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14731 .row &%message_size_limit%&          "for all messages"
14732 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14733 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14734 .row &%spamd_address%&               "set interface to SpamAssassin"
14735 .row &%strict_acl_vars%&             "object to unset ACL variables"
14736 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14737 .endtable
14738
14739
14740
14741 .section "Callout cache" "SECID107"
14742 .table2
14743 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14744                                          item"
14745 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14746                                          item"
14747 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14748 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14749 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14750 .endtable
14751
14752
14753
14754 .section "TLS" "SECID108"
14755 .table2
14756 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14757 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14758 .row &%hosts_require_alpn%&          "mandatory ALPN"
14759 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14760 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14761 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14762 .row &%tls_alpn%&                    "acceptable protocol names"
14763 .row &%tls_certificate%&             "location of server certificate"
14764 .row &%tls_crl%&                     "certificate revocation list"
14765 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14766 .row &%tls_dhparam%&                 "DH parameters for server"
14767 .row &%tls_eccurve%&                 "EC curve selection for server"
14768 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14769 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14770 .row &%tls_privatekey%&              "location of server private key"
14771 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14772 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14773 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14774 .row &%tls_verify_certificates%&     "expected client certificates"
14775 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14776 .endtable
14777
14778
14779
14780 .section "Local user handling" "SECID109"
14781 .table2
14782 .row &%finduser_retries%&            "useful in NIS environments"
14783 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14784 .row &%gecos_pattern%&               "ditto"
14785 .row &%max_username_length%&         "for systems that truncate"
14786 .row &%unknown_login%&               "used when no login name found"
14787 .row &%unknown_username%&            "ditto"
14788 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14789 .row &%uucp_from_sender%&            "ditto"
14790 .endtable
14791
14792
14793
14794 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14795 .table2
14796 .row &%header_maxsize%&              "total size of message header"
14797 .row &%header_line_maxsize%&         "individual header line limit"
14798 .row &%message_size_limit%&          "applies to all messages"
14799 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14800 .row &%received_header_text%&        "expanded to make &'Received:'&"
14801 .row &%received_headers_max%&        "for mail loop detection"
14802 .row &%recipients_max%&              "limit per message"
14803 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14804 .endtable
14805
14806
14807
14808
14809 .section "Non-SMTP incoming messages" "SECID111"
14810 .table2
14811 .row &%receive_timeout%&             "for non-SMTP messages"
14812 .endtable
14813
14814
14815
14816
14817
14818 .section "Incoming SMTP messages" "SECID112"
14819 See also the &'Policy controls'& section above.
14820
14821 .table2
14822 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14823 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14824 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14825 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14826 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14827 .row &%dmarc_history_file%&          "DMARC results log"
14828 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14829 .row &%host_lookup%&                 "host name looked up for these hosts"
14830 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14831 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14832 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14833 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14834 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14835 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14836 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14837 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14838 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14839 .row &%smtp_accept_max_per_connection%& "messages per connection"
14840 .row &%smtp_accept_max_per_host%&    "connections from one host"
14841 .row &%smtp_accept_queue%&           "queue mail if more connections"
14842 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14843                                            connection"
14844 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14845 .row &%smtp_active_hostname%&        "host name to use in messages"
14846 .row &%smtp_banner%&                 "text for welcome banner"
14847 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14848 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14849 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14850 .row &%smtp_etrn_command%&           "what to run for ETRN"
14851 .row &%smtp_etrn_serialize%&         "only one at once"
14852 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14853 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14854 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14855 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14856 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14857 .row &%smtp_receive_timeout%&        "per command or data line"
14858 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14859 .row &%smtp_return_error_details%&   "give detail on rejections"
14860 .endtable
14861
14862
14863
14864 .section "SMTP extensions" "SECID113"
14865 .table2
14866 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14867 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14868 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14869 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14870 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14871 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14872 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14873 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14874 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14875 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14876 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14877 .endtable
14878
14879
14880
14881 .section "Processing messages" "SECID114"
14882 .table2
14883 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14884 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14885 .row &%allow_utf8_domains%&          "in addresses"
14886 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14887                                       words""&"
14888 .row &%delivery_date_remove%&        "from incoming messages"
14889 .row &%envelope_to_remove%&          "from incoming messages"
14890 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14891 .row &%headers_charset%&             "default for translations"
14892 .row &%qualify_domain%&              "default for senders"
14893 .row &%qualify_recipient%&           "default for recipients"
14894 .row &%return_path_remove%&          "from incoming messages"
14895 .row &%strip_excess_angle_brackets%& "in addresses"
14896 .row &%strip_trailing_dot%&          "at end of addresses"
14897 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14898 .endtable
14899
14900
14901
14902 .section "System filter" "SECID115"
14903 .table2
14904 .row &%system_filter%&               "locate system filter"
14905 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14906                                             directory"
14907 .row &%system_filter_file_transport%& "transport for delivery to a file"
14908 .row &%system_filter_group%&         "group for filter running"
14909 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14910 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14911 .row &%system_filter_user%&          "user for filter running"
14912 .endtable
14913
14914
14915
14916 .section "Routing and delivery" "SECID116"
14917 .table2
14918 .row &%disable_ipv6%&                "do no IPv6 processing"
14919 .row &%dns_again_means_nonexist%&    "for broken domains"
14920 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14921 .row &%dns_dnssec_ok%&               "parameter for resolver"
14922 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14923 .row &%dns_retrans%&                 "parameter for resolver"
14924 .row &%dns_retry%&                   "parameter for resolver"
14925 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14926 .row &%dns_use_edns0%&               "parameter for resolver"
14927 .row &%hold_domains%&                "hold delivery for these domains"
14928 .row &%local_interfaces%&            "for routing checks"
14929 .row &%queue_domains%&               "no immediate delivery for these"
14930 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14931 .row &%queue_only%&                  "no immediate delivery at all"
14932 .row &%queue_only_file%&             "no immediate delivery if file exists"
14933 .row &%queue_only_load%&             "no immediate delivery if load is high"
14934 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14935 .row &%queue_only_override%&         "allow command line to override"
14936 .row &%queue_run_in_order%&          "order of arrival"
14937 .row &%queue_run_max%&               "of simultaneous queue runners"
14938 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14939 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14940 .row &%remote_sort_domains%&         "order of remote deliveries"
14941 .row &%retry_data_expire%&           "timeout for retry data"
14942 .row &%retry_interval_max%&          "safety net for retry rules"
14943 .endtable
14944
14945
14946
14947 .section "Bounce and warning messages" "SECID117"
14948 .table2
14949 .row &%bounce_message_file%&         "content of bounce"
14950 .row &%bounce_message_text%&         "content of bounce"
14951 .row &%bounce_return_body%&          "include body if returning message"
14952 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14953 .row &%bounce_return_message%&       "include original message in bounce"
14954 .row &%bounce_return_size_limit%&    "limit on returned message"
14955 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14956 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14957 .row &%errors_copy%&                 "copy bounce messages"
14958 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14959 .row &%delay_warning%&               "time schedule"
14960 .row &%delay_warning_condition%&     "condition for warning messages"
14961 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14962 .row &%smtp_return_error_details%&   "give detail on rejections"
14963 .row &%warn_message_file%&           "content of warning message"
14964 .endtable
14965
14966
14967
14968 .section "Alphabetical list of main options" "SECTalomo"
14969 Those options that undergo string expansion before use are marked with
14970 &dagger;.
14971
14972 .option accept_8bitmime main boolean true
14973 .cindex "8BITMIME"
14974 .cindex "8-bit characters"
14975 .cindex "log" "selectors"
14976 .cindex "log" "8BITMIME"
14977 .cindex "ESMTP extensions" 8BITMIME
14978 This option causes Exim to send 8BITMIME in its response to an SMTP
14979 EHLO command, and to accept the BODY= parameter on MAIL commands.
14980 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14981 takes no steps to do anything special with messages received by this route.
14982
14983 Historically Exim kept this option off by default, but the maintainers
14984 feel that in today's Internet, this causes more problems than it solves.
14985 It now defaults to true.
14986 A more detailed analysis of the issues is provided by Dan Bernstein:
14987 .display
14988 &url(https://cr.yp.to/smtp/8bitmime.html)
14989 .endd
14990
14991 To log received 8BITMIME status use
14992 .code
14993 log_selector = +8bitmime
14994 .endd
14995
14996 .option acl_not_smtp main string&!! unset
14997 .cindex "&ACL;" "for non-SMTP messages"
14998 .cindex "non-SMTP messages" "ACLs for"
14999 This option defines the ACL that is run when a non-SMTP message has been
15000 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15001 further details.
15002
15003 .option acl_not_smtp_mime main string&!! unset
15004 This option defines the ACL that is run for individual MIME parts of non-SMTP
15005 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15006 SMTP messages.
15007
15008 .option acl_not_smtp_start main string&!! unset
15009 .cindex "&ACL;" "at start of non-SMTP message"
15010 .cindex "non-SMTP messages" "ACLs for"
15011 This option defines the ACL that is run before Exim starts reading a
15012 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15013
15014 .option acl_smtp_auth main string&!! unset
15015 .cindex "&ACL;" "setting up for SMTP commands"
15016 .cindex "AUTH" "ACL for"
15017 This option defines the ACL that is run when an SMTP AUTH command is
15018 received. See chapter &<<CHAPACL>>& for further details.
15019
15020 .option acl_smtp_connect main string&!! unset
15021 .cindex "&ACL;" "on SMTP connection"
15022 This option defines the ACL that is run when an SMTP connection is received.
15023 See chapter &<<CHAPACL>>& for further details.
15024
15025 .option acl_smtp_data main string&!! unset
15026 .cindex "DATA" "ACL for"
15027 This option defines the ACL that is run after an SMTP DATA command has been
15028 processed and the message itself has been received, but before the final
15029 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15030
15031 .option acl_smtp_data_prdr main string&!! accept
15032 .cindex "PRDR" "ACL for"
15033 .cindex "DATA" "PRDR ACL for"
15034 .cindex "&ACL;" "PRDR-related"
15035 .cindex "&ACL;" "per-user data processing"
15036 This option defines the ACL that,
15037 if the PRDR feature has been negotiated,
15038 is run for each recipient after an SMTP DATA command has been
15039 processed and the message itself has been received, but before the
15040 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15041
15042 .option acl_smtp_dkim main string&!! unset
15043 .cindex DKIM "ACL for"
15044 This option defines the ACL that is run for each DKIM signature
15045 (by default, or as specified in the dkim_verify_signers option)
15046 of a received message.
15047 See section &<<SECDKIMVFY>>& for further details.
15048
15049 .option acl_smtp_etrn main string&!! unset
15050 .cindex "ETRN" "ACL for"
15051 This option defines the ACL that is run when an SMTP ETRN command is
15052 received. See chapter &<<CHAPACL>>& for further details.
15053
15054 .option acl_smtp_expn main string&!! unset
15055 .cindex "EXPN" "ACL for"
15056 This option defines the ACL that is run when an SMTP EXPN command is
15057 received. See chapter &<<CHAPACL>>& for further details.
15058
15059 .option acl_smtp_helo main string&!! unset
15060 .cindex "EHLO" "ACL for"
15061 .cindex "HELO" "ACL for"
15062 This option defines the ACL that is run when an SMTP EHLO or HELO
15063 command is received. See chapter &<<CHAPACL>>& for further details.
15064
15065
15066 .option acl_smtp_mail main string&!! unset
15067 .cindex "MAIL" "ACL for"
15068 This option defines the ACL that is run when an SMTP MAIL command is
15069 received. See chapter &<<CHAPACL>>& for further details.
15070
15071 .option acl_smtp_mailauth main string&!! unset
15072 .cindex "AUTH" "on MAIL command"
15073 This option defines the ACL that is run when there is an AUTH parameter on
15074 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15075 &<<CHAPSMTPAUTH>>& for details of authentication.
15076
15077 .option acl_smtp_mime main string&!! unset
15078 .cindex "MIME content scanning" "ACL for"
15079 This option is available when Exim is built with the content-scanning
15080 extension. It defines the ACL that is run for each MIME part in a message. See
15081 section &<<SECTscanmimepart>>& for details.
15082
15083 .option acl_smtp_notquit main string&!! unset
15084 .cindex "not-QUIT, ACL for"
15085 This option defines the ACL that is run when an SMTP session
15086 ends without a QUIT command being received.
15087 See chapter &<<CHAPACL>>& for further details.
15088
15089 .option acl_smtp_predata main string&!! unset
15090 This option defines the ACL that is run when an SMTP DATA command is
15091 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15092 further details.
15093
15094 .option acl_smtp_quit main string&!! unset
15095 .cindex "QUIT, ACL for"
15096 This option defines the ACL that is run when an SMTP QUIT command is
15097 received. See chapter &<<CHAPACL>>& for further details.
15098
15099 .option acl_smtp_rcpt main string&!! unset
15100 .cindex "RCPT" "ACL for"
15101 This option defines the ACL that is run when an SMTP RCPT command is
15102 received. See chapter &<<CHAPACL>>& for further details.
15103
15104 .option acl_smtp_starttls main string&!! unset
15105 .cindex "STARTTLS, ACL for"
15106 This option defines the ACL that is run when an SMTP STARTTLS command is
15107 received. See chapter &<<CHAPACL>>& for further details.
15108
15109 .option acl_smtp_vrfy main string&!! unset
15110 .cindex "VRFY" "ACL for"
15111 This option defines the ACL that is run when an SMTP VRFY command is
15112 received. See chapter &<<CHAPACL>>& for further details.
15113
15114 .option add_environment main "string list" empty
15115 .cindex "environment" "set values"
15116 This option adds individual environment variables that the
15117 currently linked libraries and programs in child processes may use.
15118 Each list element should be of the form &"name=value"&.
15119
15120 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15121
15122 .option admin_groups main "string list&!!" unset
15123 .cindex "admin user"
15124 This option is expanded just once, at the start of Exim's processing. If the
15125 current group or any of the supplementary groups of an Exim caller is in this
15126 colon-separated list, the caller has admin privileges. If all your system
15127 programmers are in a specific group, for example, you can give them all Exim
15128 admin privileges by putting that group in &%admin_groups%&. However, this does
15129 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15130 To permit this, you have to add individuals to the Exim group.
15131
15132 .option allow_domain_literals main boolean false
15133 .cindex "domain literal"
15134 If this option is set, the RFC 2822 domain literal format is permitted in
15135 email addresses. The option is not set by default, because the domain literal
15136 format is not normally required these days, and few people know about it. It
15137 has, however, been exploited by mail abusers.
15138
15139 Unfortunately, it seems that some DNS black list maintainers are using this
15140 format to report black listing to postmasters. If you want to accept messages
15141 addressed to your hosts by IP address, you need to set
15142 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15143 domains (defined in the named domain list &%local_domains%& in the default
15144 configuration). This &"magic string"& matches the domain literal form of all
15145 the local host's IP addresses.
15146
15147 .option allow_mx_to_ip main boolean false
15148 .cindex "MX record" "pointing to IP address"
15149 It appears that more and more DNS zone administrators are breaking the rules
15150 and putting domain names that look like IP addresses on the right hand side of
15151 MX records. Exim follows the rules and rejects this, giving an error message
15152 that explains the misconfiguration. However, some other MTAs support this
15153 practice, so to avoid &"Why can't Exim do this?"& complaints,
15154 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15155 recommended, except when you have no other choice.
15156
15157 .option allow_utf8_domains main boolean false
15158 .cindex "domain" "UTF-8 characters in"
15159 .cindex "UTF-8" "in domain name"
15160 Lots of discussion is going on about internationalized domain names. One
15161 camp is strongly in favour of just using UTF-8 characters, and it seems
15162 that at least two other MTAs permit this.
15163 This option allows Exim users to experiment if they wish.
15164
15165 If it is set true, Exim's domain parsing function allows valid
15166 UTF-8 multicharacters to appear in domain name components, in addition to
15167 letters, digits, and hyphens.
15168
15169 If Exim is built with internationalization support
15170 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15171 this option can be left as default.
15172 Without that,
15173 if you want to look up such domain names in the DNS, you must also
15174 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15175 suitable setting is:
15176 .code
15177 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15178   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15179 .endd
15180 Alternatively, you can just disable this feature by setting
15181 .code
15182 dns_check_names_pattern =
15183 .endd
15184 That is, set the option to an empty string so that no check is done.
15185
15186
15187 .option auth_advertise_hosts main "host list&!!" *
15188 .cindex "authentication" "advertising"
15189 .cindex "AUTH" "advertising"
15190 .cindex "ESMTP extensions" AUTH
15191 If any server authentication mechanisms are configured, Exim advertises them in
15192 response to an EHLO command only if the calling host matches this list.
15193 Otherwise, Exim does not advertise AUTH.
15194 Exim does not accept AUTH commands from clients to which it has not
15195 advertised the availability of AUTH. The advertising of individual
15196 authentication mechanisms can be controlled by the use of the
15197 &%server_advertise_condition%& generic authenticator option on the individual
15198 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15199
15200 Certain mail clients (for example, Netscape) require the user to provide a name
15201 and password for authentication if AUTH is advertised, even though it may
15202 not be needed (the host may accept messages from hosts on its local LAN without
15203 authentication, for example). The &%auth_advertise_hosts%& option can be used
15204 to make these clients more friendly by excluding them from the set of hosts to
15205 which Exim advertises AUTH.
15206
15207 .cindex "AUTH" "advertising when encrypted"
15208 If you want to advertise the availability of AUTH only when the connection
15209 is encrypted using TLS, you can make use of the fact that the value of this
15210 option is expanded, with a setting like this:
15211 .code
15212 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15213 .endd
15214 .vindex "&$tls_in_cipher$&"
15215 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15216 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15217 expansion is *, which matches all hosts.
15218
15219
15220 .option auto_thaw main time 0s
15221 .cindex "thawing messages"
15222 .cindex "unfreezing messages"
15223 If this option is set to a time greater than zero, a queue runner will try a
15224 new delivery attempt on any frozen message, other than a bounce message, if
15225 this much time has passed since it was frozen. This may result in the message
15226 being re-frozen if nothing has changed since the last attempt. It is a way of
15227 saying &"keep on trying, even though there are big problems"&.
15228
15229 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15230 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15231 thought to be very useful any more, and its use should probably be avoided.
15232
15233
15234 .option av_scanner main string "see below"
15235 This option is available if Exim is built with the content-scanning extension.
15236 It specifies which anti-virus scanner to use. The default value is:
15237 .code
15238 sophie:/var/run/sophie
15239 .endd
15240 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15241 before use. See section &<<SECTscanvirus>>& for further details.
15242
15243
15244 .option bi_command main string unset
15245 .oindex "&%-bi%&"
15246 This option supplies the name of a command that is run when Exim is called with
15247 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15248 just the command name, it is not a complete command line. If an argument is
15249 required, it must come from the &%-oA%& command line option.
15250
15251
15252 .option bounce_message_file main string&!! unset
15253 .cindex "bounce message" "customizing"
15254 .cindex "customizing" "bounce message"
15255 This option defines a template file containing paragraphs of text to be used
15256 for constructing bounce messages.  Details of the file's contents are given in
15257 chapter &<<CHAPemsgcust>>&.
15258 .cindex bounce_message_file "tainted data"
15259 The option is expanded to give the file path, which must be
15260 absolute and untainted.
15261 See also &%warn_message_file%&.
15262
15263
15264 .option bounce_message_text main string unset
15265 When this option is set, its contents are included in the default bounce
15266 message immediately after &"This message was created automatically by mail
15267 delivery software."& It is not used if &%bounce_message_file%& is set.
15268
15269 .option bounce_return_body main boolean true
15270 .cindex "bounce message" "including body"
15271 This option controls whether the body of an incoming message is included in a
15272 bounce message when &%bounce_return_message%& is true. The default setting
15273 causes the entire message, both header and body, to be returned (subject to the
15274 value of &%bounce_return_size_limit%&). If this option is false, only the
15275 message header is included. In the case of a non-SMTP message containing an
15276 error that is detected during reception, only those header lines preceding the
15277 point at which the error was detected are returned.
15278 .cindex "bounce message" "including original"
15279
15280 .option bounce_return_linesize_limit main integer 998
15281 .cindex "size" "of bounce lines, limit"
15282 .cindex "bounce message" "line length limit"
15283 .cindex "limit" "bounce message line length"
15284 This option sets a limit in bytes on the line length of messages
15285 that are returned to senders due to delivery problems,
15286 when &%bounce_return_message%& is true.
15287 The default value corresponds to RFC limits.
15288 If the message being returned has lines longer than this value it is
15289 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15290
15291 The option also applies to bounces returned when an error is detected
15292 during reception of a message.
15293 In this case lines from the original are truncated.
15294
15295 The option does not apply to messages generated by an &(autoreply)& transport.
15296
15297
15298 .option bounce_return_message main boolean true
15299 If this option is set false, none of the original message is included in
15300 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15301 &%bounce_return_body%&.
15302
15303
15304 .option bounce_return_size_limit main integer 100K
15305 .cindex "size" "of bounce, limit"
15306 .cindex "bounce message" "size limit"
15307 .cindex "limit" "bounce message size"
15308 This option sets a limit in bytes on the size of messages that are returned to
15309 senders as part of bounce messages when &%bounce_return_message%& is true. The
15310 limit should be less than the value of the global &%message_size_limit%& and of
15311 any &%message_size_limit%& settings on transports, to allow for the bounce text
15312 that Exim generates. If this option is set to zero there is no limit.
15313
15314 When the body of any message that is to be included in a bounce message is
15315 greater than the limit, it is truncated, and a comment pointing this out is
15316 added at the top. The actual cutoff may be greater than the value given, owing
15317 to the use of buffering for transferring the message in chunks (typically 8K in
15318 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15319 messages.
15320
15321 .option bounce_sender_authentication main string unset
15322 .cindex "bounce message" "sender authentication"
15323 .cindex "authentication" "bounce message"
15324 .cindex "AUTH" "on bounce message"
15325 This option provides an authenticated sender address that is sent with any
15326 bounce messages generated by Exim that are sent over an authenticated SMTP
15327 connection. A typical setting might be:
15328 .code
15329 bounce_sender_authentication = mailer-daemon@my.domain.example
15330 .endd
15331 which would cause bounce messages to be sent using the SMTP command:
15332 .code
15333 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15334 .endd
15335 The value of &%bounce_sender_authentication%& must always be a complete email
15336 address.
15337
15338 .option callout_domain_negative_expire main time 3h
15339 .cindex "caching" "callout timeouts"
15340 .cindex "callout" "caching timeouts"
15341 This option specifies the expiry time for negative callout cache data for a
15342 domain. See section &<<SECTcallver>>& for details of callout verification, and
15343 section &<<SECTcallvercache>>& for details of the caching.
15344
15345
15346 .option callout_domain_positive_expire main time 7d
15347 This option specifies the expiry time for positive callout cache data for a
15348 domain. See section &<<SECTcallver>>& for details of callout verification, and
15349 section &<<SECTcallvercache>>& for details of the caching.
15350
15351
15352 .option callout_negative_expire main time 2h
15353 This option specifies the expiry time for negative callout cache data for an
15354 address. See section &<<SECTcallver>>& for details of callout verification, and
15355 section &<<SECTcallvercache>>& for details of the caching.
15356
15357
15358 .option callout_positive_expire main time 24h
15359 This option specifies the expiry time for positive callout cache data for an
15360 address. See section &<<SECTcallver>>& for details of callout verification, and
15361 section &<<SECTcallvercache>>& for details of the caching.
15362
15363
15364 .option callout_random_local_part main string&!! "see below"
15365 This option defines the &"random"& local part that can be used as part of
15366 callout verification. The default value is
15367 .code
15368 $primary_hostname-$tod_epoch-testing
15369 .endd
15370 See section &<<CALLaddparcall>>& for details of how this value is used.
15371
15372
15373 .option check_log_inodes main integer 100
15374 See &%check_spool_space%& below.
15375
15376
15377 .option check_log_space main integer 10M
15378 See &%check_spool_space%& below.
15379
15380 .oindex "&%check_rfc2047_length%&"
15381 .cindex "RFC 2047" "disabling length check"
15382 .option check_rfc2047_length main boolean true
15383 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15384 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15385 word; strings to be encoded that exceed this length are supposed to use
15386 multiple encoded words. By default, Exim does not recognize encoded words that
15387 exceed the maximum length. However, it seems that some software, in violation
15388 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15389 set false, Exim recognizes encoded words of any length.
15390
15391
15392 .option check_spool_inodes main integer 100
15393 See &%check_spool_space%& below.
15394
15395
15396 .option check_spool_space main integer 10M
15397 .cindex "checking disk space"
15398 .cindex "disk space, checking"
15399 .cindex "spool directory" "checking space"
15400 The four &%check_...%& options allow for checking of disk resources before a
15401 message is accepted.
15402
15403 .vindex "&$log_inodes$&"
15404 .vindex "&$log_space$&"
15405 .vindex "&$spool_inodes$&"
15406 .vindex "&$spool_space$&"
15407 When any of these options are nonzero, they apply to all incoming messages. If you
15408 want to apply different checks to different kinds of message, you can do so by
15409 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15410 &$spool_space$& in an ACL with appropriate additional conditions.
15411
15412
15413 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15414 either value is greater than zero, for example:
15415 .code
15416 check_spool_space = 100M
15417 check_spool_inodes = 100
15418 .endd
15419 The spool partition is the one that contains the directory defined by
15420 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15421 transit.
15422
15423 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15424 files are written if either is greater than zero. These should be set only if
15425 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15426
15427 If there is less space or fewer inodes than requested, Exim refuses to accept
15428 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15429 error response to the MAIL command. If ESMTP is in use and there was a
15430 SIZE parameter on the MAIL command, its value is added to the
15431 &%check_spool_space%& value, and the check is performed even if
15432 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15433
15434 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15435 number of kilobytes (though specified in bytes).
15436 If a non-multiple of 1024 is specified, it is rounded up.
15437
15438 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15439 failure a message is written to stderr and Exim exits with a non-zero code, as
15440 it obviously cannot send an error message of any kind.
15441
15442 There is a slight performance penalty for these checks.
15443 Versions of Exim preceding 4.88 had these disabled by default;
15444 high-rate installations confident they will never run out of resources
15445 may wish to deliberately disable them.
15446
15447 .option chunking_advertise_hosts main "host list&!!" *
15448 .cindex CHUNKING advertisement
15449 .cindex "RFC 3030" "CHUNKING"
15450 .cindex "ESMTP extensions" CHUNKING
15451 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15452 these hosts.
15453 Hosts may use the BDAT command as an alternate to DATA.
15454
15455 .option commandline_checks_require_admin main boolean &`false`&
15456 .cindex "restricting access to features"
15457 This option restricts various basic checking features to require an
15458 administrative user.
15459 This affects most of the &%-b*%& options, such as &%-be%&.
15460
15461 .option debug_store main boolean &`false`&
15462 .cindex debugging "memory corruption"
15463 .cindex memory debugging
15464 This option, when true, enables extra checking in Exim's internal memory
15465 management.  For use when a memory corruption issue is being investigated,
15466 it should normally be left as default.
15467
15468 .option daemon_smtp_ports main string &`smtp`&
15469 .cindex "port" "for daemon"
15470 .cindex "TCP/IP" "setting listening ports"
15471 This option specifies one or more default SMTP ports on which the Exim daemon
15472 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15473 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15474
15475 .option daemon_startup_retries main integer 9
15476 .cindex "daemon startup, retrying"
15477 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15478 the daemon at startup when it cannot immediately bind a listening socket
15479 (typically because the socket is already in use): &%daemon_startup_retries%&
15480 defines the number of retries after the first failure, and
15481 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15482
15483 .option daemon_startup_sleep main time 30s
15484 See &%daemon_startup_retries%&.
15485
15486 .option delay_warning main "time list" 24h
15487 .cindex "warning of delay"
15488 .cindex "delay warning, specifying"
15489 .cindex "queue" "delay warning"
15490 When a message is delayed, Exim sends a warning message to the sender at
15491 intervals specified by this option. The data is a colon-separated list of times
15492 after which to send warning messages. If the value of the option is an empty
15493 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15494 message has been in the queue for longer than the last time, the last interval
15495 between the times is used to compute subsequent warning times. For example,
15496 with
15497 .code
15498 delay_warning = 4h:8h:24h
15499 .endd
15500 the first message is sent after 4 hours, the second after 8 hours, and
15501 the third one after 24 hours. After that, messages are sent every 16 hours,
15502 because that is the interval between the last two times on the list. If you set
15503 just one time, it specifies the repeat interval. For example, with:
15504 .code
15505 delay_warning = 6h
15506 .endd
15507 messages are repeated every six hours. To stop warnings after a given time, set
15508 a very large time at the end of the list. For example:
15509 .code
15510 delay_warning = 2h:12h:99d
15511 .endd
15512 Note that the option is only evaluated at the time a delivery attempt fails,
15513 which depends on retry and queue-runner configuration.
15514 Typically retries will be configured more frequently than warning messages.
15515
15516 .option delay_warning_condition main string&!! "see below"
15517 .vindex "&$domain$&"
15518 The string is expanded at the time a warning message might be sent. If all the
15519 deferred addresses have the same domain, it is set in &$domain$& during the
15520 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15521 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15522 &"false"& (the comparison being done caselessly) then the warning message is
15523 not sent. The default is:
15524 .code
15525 delay_warning_condition = ${if or {\
15526   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15527   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15528   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15529   } {no}{yes}}
15530 .endd
15531 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15532 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15533 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15534 &"auto-replied"& in an &'Auto-Submitted:'& header.
15535
15536 .option deliver_drop_privilege main boolean false
15537 .cindex "unprivileged delivery"
15538 .cindex "delivery" "unprivileged"
15539 If this option is set true, Exim drops its root privilege at the start of a
15540 delivery process, and runs as the Exim user throughout. This severely restricts
15541 the kinds of local delivery that are possible, but is viable in certain types
15542 of configuration. There is a discussion about the use of root privilege in
15543 chapter &<<CHAPsecurity>>&.
15544
15545 .option deliver_queue_load_max main fixed-point unset
15546 .cindex "load average"
15547 .cindex "queue runner" "abandoning"
15548 When this option is set, a queue run is abandoned if the system load average
15549 becomes greater than the value of the option. The option has no effect on
15550 ancient operating systems on which Exim cannot determine the load average.
15551 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15552
15553
15554 .option delivery_date_remove main boolean true
15555 .cindex "&'Delivery-date:'& header line"
15556 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15557 message when it is delivered, in exactly the same way as &'Return-path:'& is
15558 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15559 should not be present in incoming messages, and this option causes them to be
15560 removed at the time the message is received, to avoid any problems that might
15561 occur when a delivered message is subsequently sent on to some other recipient.
15562
15563 .option disable_fsync main boolean false
15564 .cindex "&[fsync()]&, disabling"
15565 This option is available only if Exim was built with the compile-time option
15566 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15567 a runtime configuration generates an &"unknown option"& error. You should not
15568 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15569 really, really, really understand what you are doing. &'No pre-compiled
15570 distributions of Exim should ever make this option available.'&
15571
15572 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15573 updated files' data to be written to disc before continuing. Unexpected events
15574 such as crashes and power outages may cause data to be lost or scrambled.
15575 Here be Dragons. &*Beware.*&
15576
15577
15578 .option disable_ipv6 main boolean false
15579 .cindex "IPv6" "disabling"
15580 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15581 activities take place. AAAA records are never looked up, and any IPv6 addresses
15582 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15583 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15584 to handle IPv6 literal addresses.
15585
15586
15587 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15588 .cindex DKIM "selecting signature algorithms"
15589 This option gives a list of hash types which are acceptable in signatures,
15590 and an order of processing.
15591 Signatures with algorithms not in the list will be ignored.
15592
15593 Acceptable values include:
15594 .code
15595 sha1
15596 sha256
15597 sha512
15598 .endd
15599
15600 Note that the acceptance of sha1 violates RFC 8301.
15601
15602 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15603 This option gives a list of key types which are acceptable in signatures,
15604 and an order of processing.
15605 Signatures with algorithms not in the list will be ignored.
15606
15607
15608 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15609 This option gives a list of key sizes which are acceptable in signatures.
15610 The list is keyed by the algorithm type for the key; the values are in bits.
15611 Signatures with keys smaller than given by this option will fail verification.
15612
15613 The default enforces the RFC 8301 minimum key size for RSA signatures.
15614
15615 .option dkim_verify_minimal main boolean false
15616 If set to true, verification of signatures will terminate after the
15617 first success.
15618
15619 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15620 .cindex DKIM "controlling calls to the ACL"
15621 This option gives a list of DKIM domains for which the DKIM ACL is run.
15622 It is expanded after the message is received; by default it runs
15623 the ACL once for each signature in the message.
15624 See section &<<SECDKIMVFY>>&.
15625
15626
15627 .option dmarc_forensic_sender main string&!! unset
15628 .option dmarc_history_file main string unset
15629 .option dmarc_tld_file main string unset
15630 .cindex DMARC "main section options"
15631 These options control DMARC processing.
15632 See section &<<SECDMARC>>& for details.
15633
15634
15635 .option dns_again_means_nonexist main "domain list&!!" unset
15636 .cindex "DNS" "&""try again""& response; overriding"
15637 DNS lookups give a &"try again"& response for the DNS errors
15638 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15639 keep trying to deliver a message, or to give repeated temporary errors to
15640 incoming mail. Sometimes the effect is caused by a badly set up name server and
15641 may persist for a long time. If a domain which exhibits this problem matches
15642 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15643 This option should be used with care. You can make it apply to reverse lookups
15644 by a setting such as this:
15645 .code
15646 dns_again_means_nonexist = *.in-addr.arpa
15647 .endd
15648 This option applies to all DNS lookups that Exim does,
15649 .new
15650 except for TLSA lookups (where knowing about such failures
15651 is security-relevant).
15652 .wen
15653 It also applies when the
15654 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15655 since these are most likely to be caused by DNS lookup problems. The
15656 &(dnslookup)& router has some options of its own for controlling what happens
15657 when lookups for MX or SRV records give temporary errors. These more specific
15658 options are applied after this global option.
15659
15660 .option dns_check_names_pattern main string "see below"
15661 .cindex "DNS" "pre-check of name syntax"
15662 When this option is set to a non-empty string, it causes Exim to check domain
15663 names for characters that are not allowed in host names before handing them to
15664 the DNS resolver, because some resolvers give temporary errors for names that
15665 contain unusual characters. If a domain name contains any unwanted characters,
15666 a &"not found"& result is forced, and the resolver is not called. The check is
15667 done by matching the domain name against a regular expression, which is the
15668 value of this option. The default pattern is
15669 .code
15670 dns_check_names_pattern = \
15671   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15672 .endd
15673 which permits only letters, digits, slashes, and hyphens in components, but
15674 they must start and end with a letter or digit. Slashes are not, in fact,
15675 permitted in host names, but they are found in certain NS records (which can be
15676 accessed in Exim by using a &%dnsdb%& lookup). If you set
15677 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15678 empty string.
15679
15680 .option dns_csa_search_limit main integer 5
15681 This option controls the depth of parental searching for CSA SRV records in the
15682 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15683
15684 .option dns_csa_use_reverse main boolean true
15685 This option controls whether or not an IP address, given as a CSA domain, is
15686 reversed and looked up in the reverse DNS, as described in more detail in
15687 section &<<SECTverifyCSA>>&.
15688
15689 .option dns_cname_loops main integer 1
15690 .cindex DNS "CNAME following"
15691 This option controls the following of CNAME chains, needed if the resolver does
15692 not do it internally.
15693 As of 2018 most should, and the default can be left.
15694 If you have an ancient one, a value of 10 is likely needed.
15695
15696 The default value of one CNAME-follow is needed
15697 thanks to the observed return for an MX request,
15698 given no MX presence but a CNAME to an A, of the CNAME.
15699
15700
15701 .option dns_dnssec_ok main integer -1
15702 .cindex "DNS" "resolver options"
15703 .cindex "DNS" "DNSSEC"
15704 If this option is set to a non-negative number then Exim will initialise the
15705 DNS resolver library to either use or not use DNSSEC, overriding the system
15706 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15707
15708 If the resolver library does not support DNSSEC then this option has no effect.
15709
15710 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15711 will default to stripping out a successful validation status.
15712 This will break a previously working Exim installation.
15713 Provided that you do trust the resolver (ie, is on localhost) you can tell
15714 glibc to pass through any successful validation with a new option in
15715 &_/etc/resolv.conf_&:
15716 .code
15717 options trust-ad
15718 .endd
15719
15720
15721 .option dns_ipv4_lookup main "domain list&!!" unset
15722 .cindex "IPv6" "DNS lookup for AAAA records"
15723 .cindex "DNS" "IPv6 lookup for AAAA records"
15724 .cindex DNS "IPv6 disabling"
15725 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15726 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15727 (A records) when trying to find IP addresses for hosts, unless the host's
15728 domain matches this list.
15729
15730 This is a fudge to help with name servers that give big delays or otherwise do
15731 not work for the AAAA record type. In due course, when the world's name
15732 servers have all been upgraded, there should be no need for this option.
15733 Note that all lookups, including those done for verification, are affected;
15734 this will result in verify failure for IPv6 connections or ones using names
15735 only valid for IPv6 addresses.
15736
15737
15738 .option dns_retrans main time 0s
15739 .cindex "DNS" "resolver options"
15740 .cindex timeout "dns lookup"
15741 .cindex "DNS" timeout
15742 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15743 retransmission and retry parameters for DNS lookups. Values of zero (the
15744 defaults) leave the system default settings unchanged. The first value is the
15745 time between retries, and the second is the number of retries. It isn't
15746 totally clear exactly how these settings affect the total time a DNS lookup may
15747 take. I haven't found any documentation about timeouts on DNS lookups; these
15748 parameter values are available in the external resolver interface structure,
15749 but nowhere does it seem to describe how they are used or what you might want
15750 to set in them.
15751 See also the &%slow_lookup_log%& option.
15752
15753
15754 .option dns_retry main integer 0
15755 See &%dns_retrans%& above.
15756
15757
15758 .option dns_trust_aa main "domain list&!!" unset
15759 .cindex "DNS" "resolver options"
15760 .cindex "DNS" "DNSSEC"
15761 If this option is set then lookup results marked with the AA bit
15762 (Authoritative Answer) are trusted the same way as if they were
15763 DNSSEC-verified. The authority section's name of the answer must
15764 match with this expanded domain list.
15765
15766 Use this option only if you talk directly to a resolver that is
15767 authoritative for some zones and does not set the AD (Authentic Data)
15768 bit in the answer. Some DNS servers may have an configuration option to
15769 mark the answers from their own zones as verified (they set the AD bit).
15770 Others do not have this option. It is considered as poor practice using
15771 a resolver that is an authoritative server for some zones.
15772
15773 Use this option only if you really have to (e.g. if you want
15774 to use DANE for remote delivery to a server that is listed in the DNS
15775 zones that your resolver is authoritative for).
15776
15777 If the DNS answer packet has the AA bit set and contains resource record
15778 in the answer section, the name of the first NS record appearing in the
15779 authority section is compared against the list. If the answer packet is
15780 authoritative but the answer section is empty, the name of the first SOA
15781 record in the authoritative section is used instead.
15782
15783 .cindex "DNS" "resolver options"
15784 .option dns_use_edns0 main integer -1
15785 .cindex "DNS" "resolver options"
15786 .cindex "DNS" "EDNS0"
15787 .cindex "DNS" "OpenBSD
15788 If this option is set to a non-negative number then Exim will initialise the
15789 DNS resolver library to either use or not use EDNS0 extensions, overriding
15790 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15791 on.
15792
15793 If the resolver library does not support EDNS0 then this option has no effect.
15794
15795 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15796 means that DNSSEC will not work with Exim on that platform either, unless Exim
15797 is linked against an alternative DNS client library.
15798
15799
15800 .option drop_cr main boolean false
15801 This is an obsolete option that is now a no-op. It used to affect the way Exim
15802 handled CR and LF characters in incoming messages. What happens now is
15803 described in section &<<SECTlineendings>>&.
15804
15805 .option dsn_advertise_hosts main "host list&!!" unset
15806 .cindex "bounce messages" "success"
15807 .cindex "DSN" "success"
15808 .cindex "Delivery Status Notification" "success"
15809 .cindex "ESMTP extensions" DSN
15810 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15811 and accepted from, these hosts.
15812 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15813 and RET and ENVID options on MAIL FROM commands.
15814 A NOTIFY=SUCCESS option requests success-DSN messages.
15815 A NOTIFY= option with no argument requests that no delay or failure DSNs
15816 are sent.
15817 &*Note*&: Supplying success-DSN messages has been criticised
15818 on privacy grounds; it can leak details of internal forwarding.
15819
15820 .option dsn_from main "string&!!" "see below"
15821 .cindex "&'From:'& header line" "in bounces"
15822 .cindex "bounce messages" "&'From:'& line, specifying"
15823 This option can be used to vary the contents of &'From:'& header lines in
15824 bounces and other automatically generated messages (&"Delivery Status
15825 Notifications"& &-- hence the name of the option). The default setting is:
15826 .code
15827 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15828 .endd
15829 The value is expanded every time it is needed. If the expansion fails, a
15830 panic is logged, and the default value is used.
15831
15832 .option envelope_to_remove main boolean true
15833 .cindex "&'Envelope-to:'& header line"
15834 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15835 message when it is delivered, in exactly the same way as &'Return-path:'& is
15836 handled. &'Envelope-to:'& records the original recipient address from the
15837 message's envelope that caused the delivery to happen. Such headers should not
15838 be present in incoming messages, and this option causes them to be removed at
15839 the time the message is received, to avoid any problems that might occur when a
15840 delivered message is subsequently sent on to some other recipient.
15841
15842
15843 .option errors_copy main "string list&!!" unset
15844 .cindex "bounce message" "copy to other address"
15845 .cindex "copy of bounce message"
15846 Setting this option causes Exim to send bcc copies of bounce messages that it
15847 generates to other addresses. &*Note*&: This does not apply to bounce messages
15848 coming from elsewhere. The value of the option is a colon-separated list of
15849 items. Each item consists of a pattern, terminated by white space, followed by
15850 a comma-separated list of email addresses. If a pattern contains spaces, it
15851 must be enclosed in double quotes.
15852
15853 Each pattern is processed in the same way as a single item in an address list
15854 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15855 the bounce message, the message is copied to the addresses on the list. The
15856 items are scanned in order, and once a matching one is found, no further items
15857 are examined. For example:
15858 .code
15859 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15860               rqps@mydomain   hostmaster@mydomain.example,\
15861                               postmaster@mydomain.example
15862 .endd
15863 .vindex "&$domain$&"
15864 .vindex "&$local_part$&"
15865 The address list is expanded before use. The expansion variables &$local_part$&
15866 and &$domain$& are set from the original recipient of the error message, and if
15867 there was any wildcard matching in the pattern, the expansion
15868 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15869 variables &$0$&, &$1$&, etc. are set in the normal way.
15870
15871
15872 .option errors_reply_to main string unset
15873 .cindex "bounce message" "&'Reply-to:'& in"
15874 By default, Exim's bounce and delivery warning messages contain the header line
15875 .display
15876 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15877 .endd
15878 .oindex &%quota_warn_message%&
15879 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15880 A warning message that is generated by the &%quota_warn_message%& option in an
15881 &(appendfile)& transport may contain its own &'From:'& header line that
15882 overrides the default.
15883
15884 Experience shows that people reply to bounce messages. If the
15885 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15886 and warning messages. For example:
15887 .code
15888 errors_reply_to = postmaster@my.domain.example
15889 .endd
15890 The value of the option is not expanded. It must specify a valid RFC 2822
15891 address. However, if a warning message that is generated by the
15892 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15893 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15894 not used.
15895
15896
15897 .option event_action main string&!! unset
15898 .cindex events
15899 This option declares a string to be expanded for Exim's events mechanism.
15900 For details see chapter &<<CHAPevents>>&.
15901
15902
15903 .option exim_group main string "compile-time configured"
15904 .cindex "gid (group id)" "Exim's own"
15905 .cindex "Exim group"
15906 This option changes the gid under which Exim runs when it gives up root
15907 privilege. The default value is compiled into the binary. The value of this
15908 option is used only when &%exim_user%& is also set. Unless it consists entirely
15909 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15910 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15911 security issues.
15912
15913
15914 .option exim_path main string "see below"
15915 .cindex "Exim binary, path name"
15916 This option specifies the path name of the Exim binary, which is used when Exim
15917 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15918 the directory configured at compile time by the BIN_DIRECTORY setting. It
15919 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15920 other place.
15921 &*Warning*&: Do not use a macro to define the value of this option, because
15922 you will break those Exim utilities that scan the configuration file to find
15923 where the binary is. (They then use the &%-bP%& option to extract option
15924 settings such as the value of &%spool_directory%&.)
15925
15926
15927 .option exim_user main string "compile-time configured"
15928 .cindex "uid (user id)" "Exim's own"
15929 .cindex "Exim user"
15930 This option changes the uid under which Exim runs when it gives up root
15931 privilege. The default value is compiled into the binary. Ownership of the run
15932 time configuration file and the use of the &%-C%& and &%-D%& command line
15933 options is checked against the values in the binary, not what is set here.
15934
15935 Unless it consists entirely of digits, the string is looked up using
15936 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15937 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15938 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15939
15940
15941 .option exim_version main string "current version"
15942 .cindex "Exim version"
15943 .cindex customizing "version number"
15944 .cindex "version number of Exim" override
15945 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15946 various places.  Use with care; this may fool stupid security scanners.
15947
15948
15949 .option extra_local_interfaces main "string list" unset
15950 This option defines network interfaces that are to be considered local when
15951 routing, but which are not used for listening by the daemon. See section
15952 &<<SECTreclocipadd>>& for details.
15953
15954
15955 . Allow this long option name to split; give it unsplit as a fifth argument
15956 . for the automatic .oindex that is generated by .option.
15957
15958 .option "extract_addresses_remove_arguments" main boolean true &&&
15959          extract_addresses_remove_arguments
15960 .oindex "&%-t%&"
15961 .cindex "command line" "addresses with &%-t%&"
15962 .cindex "Sendmail compatibility" "&%-t%& option"
15963 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15964 are present on the command line when the &%-t%& option is used to build an
15965 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15966 line addresses are removed from the recipients list. This is also how Smail
15967 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15968 command line addresses are added to those obtained from the header lines. When
15969 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15970 argument headers. If it is set false, Exim adds rather than removes argument
15971 addresses.
15972
15973
15974 .option finduser_retries main integer 0
15975 .cindex "NIS, retrying user lookups"
15976 On systems running NIS or other schemes in which user and group information is
15977 distributed from a remote system, there can be times when &[getpwnam()]& and
15978 related functions fail, even when given valid data, because things time out.
15979 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15980 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15981 many extra times to find a user or a group, waiting for one second between
15982 retries.
15983
15984 .cindex "&_/etc/passwd_&" "multiple reading of"
15985 You should not set this option greater than zero if your user information is in
15986 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15987 search the file multiple times for non-existent users, and also cause delay.
15988
15989
15990
15991 .option freeze_tell main "string list, comma separated" unset
15992 .cindex "freezing messages" "sending a message when freezing"
15993 On encountering certain errors, or when configured to do so in a system filter,
15994 ACL, or special router, Exim freezes a message. This means that no further
15995 delivery attempts take place until an administrator thaws the message, or the
15996 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15997 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15998 warning message whenever it freezes something, unless the message it is
15999 freezing is a locally-generated bounce message. (Without this exception there
16000 is the possibility of looping.) The warning message is sent to the addresses
16001 supplied as the comma-separated value of this option. If several of the
16002 message's addresses cause freezing, only a single message is sent. If the
16003 freezing was automatic, the reason(s) for freezing can be found in the message
16004 log. If you configure freezing in a filter or ACL, you must arrange for any
16005 logging that you require.
16006
16007
16008 .option gecos_name main string&!! unset
16009 .cindex "HP-UX"
16010 .cindex "&""gecos""& field, parsing"
16011 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16012 password file to hold other information in addition to users' real names. Exim
16013 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16014 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16015 of the field are used unchanged, except that, if an ampersand is encountered,
16016 it is replaced by the user's login name with the first character forced to
16017 upper case, since this is a convention that is observed on many systems.
16018
16019 When these options are set, &%gecos_pattern%& is treated as a regular
16020 expression that is to be applied to the field (again with && replaced by the
16021 login name), and if it matches, &%gecos_name%& is expanded and used as the
16022 user's name.
16023
16024 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16025 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16026 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16027 name terminates at the first comma, the following can be used:
16028 .code
16029 gecos_pattern = ([^,]*)
16030 gecos_name = $1
16031 .endd
16032
16033 .option gecos_pattern main string unset
16034 See &%gecos_name%& above.
16035
16036
16037 .option gnutls_compat_mode main boolean unset
16038 This option controls whether GnuTLS is used in compatibility mode in an Exim
16039 server. This reduces security slightly, but improves interworking with older
16040 implementations of TLS.
16041
16042
16043 .option gnutls_allow_auto_pkcs11 main boolean unset
16044 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16045 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16046
16047 See
16048 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16049 for documentation.
16050
16051
16052
16053 .option headers_charset main string "see below"
16054 This option sets a default character set for translating from encoded MIME
16055 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16056 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16057 ultimate default is ISO-8859-1. For more details see the description of header
16058 insertions in section &<<SECTexpansionitems>>&.
16059
16060
16061
16062 .option header_maxsize main integer "see below"
16063 .cindex "header section" "maximum size of"
16064 .cindex "limit" "size of message header section"
16065 This option controls the overall maximum size of a message's header
16066 section. The default is the value of HEADER_MAXSIZE in
16067 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16068 sections are rejected.
16069
16070
16071 .option header_line_maxsize main integer 0
16072 .cindex "header lines" "maximum size of"
16073 .cindex "limit" "size of one header line"
16074 This option limits the length of any individual header line in a message, after
16075 all the continuations have been joined together. Messages with individual
16076 header lines that are longer than the limit are rejected. The default value of
16077 zero means &"no limit"&.
16078
16079
16080
16081
16082 .option helo_accept_junk_hosts main "host list&!!" unset
16083 .cindex "HELO" "accepting junk data"
16084 .cindex "EHLO" "accepting junk data"
16085 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16086 mail, and gives an error response for invalid data. Unfortunately, there are
16087 some SMTP clients that send syntactic junk. They can be accommodated by setting
16088 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16089 if you want to do semantic checking.
16090 See also &%helo_allow_chars%& for a way of extending the permitted character
16091 set.
16092
16093
16094 .option helo_allow_chars main string unset
16095 .cindex "HELO" "underscores in"
16096 .cindex "EHLO" "underscores in"
16097 .cindex "underscore in EHLO/HELO"
16098 This option can be set to a string of rogue characters that are permitted in
16099 all EHLO and HELO names in addition to the standard letters, digits,
16100 hyphens, and dots. If you really must allow underscores, you can set
16101 .code
16102 helo_allow_chars = _
16103 .endd
16104 Note that the value is one string, not a list.
16105
16106
16107 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16108 .cindex "HELO" "forcing reverse lookup"
16109 .cindex "EHLO" "forcing reverse lookup"
16110 If the domain given by a client in a HELO or EHLO command matches this
16111 list, a reverse lookup is done in order to establish the host's true name. The
16112 default forces a lookup if the client host gives the server's name or any of
16113 its IP addresses (in brackets), something that broken clients have been seen to
16114 do.
16115
16116
16117 .option helo_try_verify_hosts main "host list&!!" unset
16118 .cindex "HELO verifying" "optional"
16119 .cindex "EHLO" "verifying, optional"
16120 By default, Exim just checks the syntax of HELO and EHLO commands (see
16121 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16122 to do more extensive checking of the data supplied by these commands. The ACL
16123 condition &`verify = helo`& is provided to make this possible.
16124 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16125 to force the check to occur. From release 4.53 onwards, this is no longer
16126 necessary. If the check has not been done before &`verify = helo`& is
16127 encountered, it is done at that time. Consequently, this option is obsolete.
16128 Its specification is retained here for backwards compatibility.
16129
16130 When an EHLO or HELO command is received, if the calling host matches
16131 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16132 EHLO command either:
16133
16134 .ilist
16135 is an IP literal matching the calling address of the host, or
16136 .next
16137 .cindex "DNS" "reverse lookup"
16138 .cindex "reverse DNS lookup"
16139 matches the host name that Exim obtains by doing a reverse lookup of the
16140 calling host address, or
16141 .next
16142 when looked up in DNS yields the calling host address.
16143 .endlist
16144
16145 However, the EHLO or HELO command is not rejected if any of the checks
16146 fail. Processing continues, but the result of the check is remembered, and can
16147 be detected later in an ACL by the &`verify = helo`& condition.
16148
16149 If DNS was used for successful verification, the variable
16150 .cindex "DNS" "DNSSEC"
16151 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16152
16153 .option helo_verify_hosts main "host list&!!" unset
16154 .cindex "HELO verifying" "mandatory"
16155 .cindex "EHLO" "verifying, mandatory"
16156 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16157 backwards compatibility. For hosts that match this option, Exim checks the host
16158 name given in the HELO or EHLO in the same way as for
16159 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16160 rejected with a 550 error, and entries are written to the main and reject logs.
16161 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16162 error.
16163
16164 .option hold_domains main "domain list&!!" unset
16165 .cindex "domain" "delaying delivery"
16166 .cindex "delivery" "delaying certain domains"
16167 This option allows mail for particular domains to be held in the queue
16168 manually. The option is overridden if a message delivery is forced with the
16169 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16170 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16171 item in &%hold_domains%&, no routing or delivery for that address is done, and
16172 it is deferred every time the message is looked at.
16173
16174 This option is intended as a temporary operational measure for delaying the
16175 delivery of mail while some problem is being sorted out, or some new
16176 configuration tested. If you just want to delay the processing of some
16177 domains until a queue run occurs, you should use &%queue_domains%& or
16178 &%queue_smtp_domains%&, not &%hold_domains%&.
16179
16180 A setting of &%hold_domains%& does not override Exim's code for removing
16181 messages from the queue if they have been there longer than the longest retry
16182 time in any retry rule. If you want to hold messages for longer than the normal
16183 retry times, insert a dummy retry rule with a long retry time.
16184
16185
16186 .option host_lookup main "host list&!!" unset
16187 .cindex "host name" "lookup, forcing"
16188 Exim does not look up the name of a calling host from its IP address unless it
16189 is required to compare against some host list, or the host matches
16190 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16191 option (which normally contains IP addresses rather than host names). The
16192 default configuration file contains
16193 .code
16194 host_lookup = *
16195 .endd
16196 which causes a lookup to happen for all hosts. If the expense of these lookups
16197 is felt to be too great, the setting can be changed or removed.
16198
16199 After a successful reverse lookup, Exim does a forward lookup on the name it
16200 has obtained, to verify that it yields the IP address that it started with. If
16201 this check fails, Exim behaves as if the name lookup failed.
16202
16203 .vindex "&$host_lookup_failed$&"
16204 .vindex "&$sender_host_name$&"
16205 After any kind of failure, the host name (in &$sender_host_name$&) remains
16206 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16207 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16208 &`verify = reverse_host_lookup`& in ACLs.
16209
16210
16211 .option host_lookup_order main "string list" &`bydns:byaddr`&
16212 This option specifies the order of different lookup methods when Exim is trying
16213 to find a host name from an IP address. The default is to do a DNS lookup
16214 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16215 if that fails. You can change the order of these lookups, or omit one entirely,
16216 if you want.
16217
16218 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16219 multiple PTR records in the DNS and the IP address is not listed in
16220 &_/etc/hosts_&. Different operating systems give different results in this
16221 case. That is why the default tries a DNS lookup first.
16222
16223
16224
16225 .option host_reject_connection main "host list&!!" unset
16226 .cindex "host" "rejecting connections from"
16227 If this option is set, incoming SMTP calls from the hosts listed are rejected
16228 as soon as the connection is made.
16229 This option is obsolete, and retained only for backward compatibility, because
16230 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16231 connections immediately.
16232
16233 .new
16234 If the connection is on a TLS-on-connect port then the TCP connection is
16235 just dropped.  Otherwise, an SMTP error is sent first.
16236 .wen
16237
16238 The ability to give an immediate rejection (either by this option or using an
16239 ACL) is provided for use in unusual cases. Many hosts will just try again,
16240 sometimes without much delay. Normally, it is better to use an ACL to reject
16241 incoming messages at a later stage, such as after RCPT commands. See
16242 chapter &<<CHAPACL>>&.
16243
16244
16245 .option hosts_connection_nolog main "host list&!!" unset
16246 .cindex "host" "not logging connections from"
16247 This option defines a list of hosts for which connection logging does not
16248 happen, even though the &%smtp_connection%& log selector is set. For example,
16249 you might want not to log SMTP connections from local processes, or from
16250 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16251 the daemon; you should therefore strive to restrict its value to a short inline
16252 list of IP addresses and networks. To disable logging SMTP connections from
16253 local processes, you must create a host list with an empty item. For example:
16254 .code
16255 hosts_connection_nolog = :
16256 .endd
16257 .new
16258 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16259 lines, as may commonly be produced by a monitoring system.
16260 .wen
16261
16262
16263 .option hosts_require_alpn main "host list&!!" unset
16264 .cindex ALPN "require negotiation in server"
16265 .cindex TLS ALPN
16266 .cindex TLS "Application Layer Protocol Names"
16267 If the TLS library supports ALPN
16268 then a successful negotiation of ALPN will be required for any client
16269 matching the list, for TLS to be used.
16270 See also the &%tls_alpn%& option.
16271
16272 &*Note*&: prevention of fallback to in-clear connection is not
16273 managed by this option, and should be done separately.
16274
16275
16276 .option hosts_require_helo main "host list&!!" *
16277 .cindex "HELO/EHLO" requiring
16278 Exim will require an accepted HELO or EHLO command from a host matching
16279 this list, before accepting a MAIL command.
16280
16281
16282 .option hosts_proxy main "host list&!!" unset
16283 .cindex proxy "proxy protocol"
16284 This option enables use of Proxy Protocol proxies for incoming
16285 connections.  For details see section &<<SECTproxyInbound>>&.
16286
16287
16288 .option hosts_treat_as_local main "domain list&!!" unset
16289 .cindex "local host" "domains treated as"
16290 .cindex "host" "treated as local"
16291 If this option is set, any host names that match the domain list are treated as
16292 if they were the local host when Exim is scanning host lists obtained from MX
16293 records
16294 or other sources. Note that the value of this option is a domain list, not a
16295 host list, because it is always used to check host names, not IP addresses.
16296
16297 This option also applies when Exim is matching the special items
16298 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16299 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16300 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16301 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16302 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16303 interfaces and recognizing the local host.
16304
16305
16306 .option ibase_servers main "string list" unset
16307 .cindex "InterBase" "server list"
16308 This option provides a list of InterBase servers and associated connection data,
16309 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16310 The option is available only if Exim has been built with InterBase support.
16311
16312
16313
16314 .option ignore_bounce_errors_after main time 10w
16315 .cindex "bounce message" "discarding"
16316 .cindex "discarding bounce message"
16317 This option affects the processing of bounce messages that cannot be delivered,
16318 that is, those that suffer a permanent delivery failure. (Bounce messages that
16319 suffer temporary delivery failures are of course retried in the usual way.)
16320
16321 After a permanent delivery failure, bounce messages are frozen,
16322 because there is no sender to whom they can be returned. When a frozen bounce
16323 message has been in the queue for more than the given time, it is unfrozen at
16324 the next queue run, and a further delivery is attempted. If delivery fails
16325 again, the bounce message is discarded. This makes it possible to keep failed
16326 bounce messages around for a shorter time than the normal maximum retry time
16327 for frozen messages. For example,
16328 .code
16329 ignore_bounce_errors_after = 12h
16330 .endd
16331 retries failed bounce message deliveries after 12 hours, discarding any further
16332 failures. If the value of this option is set to a zero time period, bounce
16333 failures are discarded immediately. Setting a very long time (as in the default
16334 value) has the effect of disabling this option. For ways of automatically
16335 dealing with other kinds of frozen message, see &%auto_thaw%& and
16336 &%timeout_frozen_after%&.
16337
16338
16339 .option ignore_fromline_hosts main "host list&!!" unset
16340 .cindex "&""From""& line"
16341 .cindex "UUCP" "&""From""& line"
16342 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16343 the headers of a message. By default this is treated as the start of the
16344 message's body, which means that any following headers are not recognized as
16345 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16346 match those hosts that insist on sending it. If the sender is actually a local
16347 process rather than a remote host, and is using &%-bs%& to inject the messages,
16348 &%ignore_fromline_local%& must be set to achieve this effect.
16349
16350
16351 .option ignore_fromline_local main boolean false
16352 See &%ignore_fromline_hosts%& above.
16353
16354 .option keep_environment main "string list" unset
16355 .cindex "environment" "values from"
16356 This option contains a string list of environment variables to keep.
16357 You have to trust these variables or you have to be sure that
16358 these variables do not impose any security risk. Keep in mind that
16359 during the startup phase Exim is running with an effective UID 0 in most
16360 installations. As the default value is an empty list, the default
16361 environment for using libraries, running embedded Perl code, or running
16362 external binaries is empty, and does not not even contain PATH or HOME.
16363
16364 Actually the list is interpreted as a list of patterns
16365 (&<<SECTlistexpand>>&), except that it is not expanded first.
16366
16367 WARNING: Macro substitution is still done first, so having a macro
16368 FOO and having FOO_HOME in your &%keep_environment%& option may have
16369 unexpected results. You may work around this using a regular expression
16370 that does not match the macro name: ^[F]OO_HOME$.
16371
16372 Current versions of Exim issue a warning during startup if you do not mention
16373 &%keep_environment%& in your runtime configuration file and if your
16374 current environment is not empty. Future versions may not issue that warning
16375 anymore.
16376
16377 See the &%add_environment%& main config option for a way to set
16378 environment variables to a fixed value.  The environment for &(pipe)&
16379 transports is handled separately, see section &<<SECTpipeenv>>& for
16380 details.
16381
16382
16383 .option keep_malformed main time 4d
16384 This option specifies the length of time to keep messages whose spool files
16385 have been corrupted in some way. This should, of course, never happen. At the
16386 next attempt to deliver such a message, it gets removed. The incident is
16387 logged.
16388
16389
16390 .option ldap_ca_cert_dir main string unset
16391 .cindex "LDAP", "TLS CA certificate directory"
16392 .cindex certificate "directory for LDAP"
16393 This option indicates which directory contains CA certificates for verifying
16394 a TLS certificate presented by an LDAP server.
16395 While Exim does not provide a default value, your SSL library may.
16396 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16397 and constrained to be a directory.
16398
16399
16400 .option ldap_ca_cert_file main string unset
16401 .cindex "LDAP", "TLS CA certificate file"
16402 .cindex certificate "file for LDAP"
16403 This option indicates which file contains CA certificates for verifying
16404 a TLS certificate presented by an LDAP server.
16405 While Exim does not provide a default value, your SSL library may.
16406 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16407 and constrained to be a file.
16408
16409
16410 .option ldap_cert_file main string unset
16411 .cindex "LDAP" "TLS client certificate file"
16412 .cindex certificate "file for LDAP"
16413 This option indicates which file contains an TLS client certificate which
16414 Exim should present to the LDAP server during TLS negotiation.
16415 Should be used together with &%ldap_cert_key%&.
16416
16417
16418 .option ldap_cert_key main string unset
16419 .cindex "LDAP" "TLS client key file"
16420 .cindex certificate "key for LDAP"
16421 This option indicates which file contains the secret/private key to use
16422 to prove identity to the LDAP server during TLS negotiation.
16423 Should be used together with &%ldap_cert_file%&, which contains the
16424 identity to be proven.
16425
16426
16427 .option ldap_cipher_suite main string unset
16428 .cindex "LDAP" "TLS cipher suite"
16429 This controls the TLS cipher-suite negotiation during TLS negotiation with
16430 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16431 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16432
16433
16434 .option ldap_default_servers main "string list" unset
16435 .cindex "LDAP" "default servers"
16436 This option provides a list of LDAP servers which are tried in turn when an
16437 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16438 details of LDAP queries. This option is available only when Exim has been built
16439 with LDAP support.
16440
16441
16442 .option ldap_require_cert main string unset.
16443 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16444 This should be one of the values "hard", "demand", "allow", "try" or "never".
16445 A value other than one of these is interpreted as "never".
16446 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16447 Although Exim does not set a default, the LDAP library probably defaults
16448 to hard/demand.
16449
16450
16451 .option ldap_start_tls main boolean false
16452 .cindex "LDAP" "whether or not to negotiate TLS"
16453 If set, Exim will attempt to negotiate TLS with the LDAP server when
16454 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16455 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16456 of SSL-on-connect.
16457 In the event of failure to negotiate TLS, the action taken is controlled
16458 by &%ldap_require_cert%&.
16459 This option is ignored for &`ldapi`& connections.
16460
16461
16462 .option ldap_version main integer unset
16463 .cindex "LDAP" "protocol version, forcing"
16464 This option can be used to force Exim to set a specific protocol version for
16465 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16466 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16467 the LDAP headers; otherwise it is 2. This option is available only when Exim
16468 has been built with LDAP support.
16469
16470
16471
16472 .option local_from_check main boolean true
16473 .cindex "&'Sender:'& header line" "disabling addition of"
16474 .cindex "&'From:'& header line" "disabling checking of"
16475 When a message is submitted locally (that is, not over a TCP/IP connection) by
16476 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16477 checks that the &'From:'& header line matches the login of the calling user and
16478 the domain specified by &%qualify_domain%&.
16479
16480 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16481 locally submitted message is automatically qualified by Exim, unless the
16482 &%-bnq%& command line option is used.
16483
16484 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16485 on the local part. If the &'From:'& header line does not match, Exim adds a
16486 &'Sender:'& header with an address constructed from the calling user's login
16487 and the default qualify domain.
16488
16489 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16490 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16491 &'Sender:'& header lines supplied by untrusted users, you must also set
16492 &%local_sender_retain%& to be true.
16493
16494 .cindex "envelope from"
16495 .cindex "envelope sender"
16496 These options affect only the header lines in the message. The envelope sender
16497 is still forced to be the login id at the qualify domain unless
16498 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16499
16500 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16501 request similar header line checking. See section &<<SECTthesenhea>>&, which
16502 has more details about &'Sender:'& processing.
16503
16504
16505
16506
16507 .option local_from_prefix main string unset
16508 When Exim checks the &'From:'& header line of locally submitted messages for
16509 matching the login id (see &%local_from_check%& above), it can be configured to
16510 ignore certain prefixes and suffixes in the local part of the address. This is
16511 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16512 appropriate lists, in the same form as the &%local_part_prefix%& and
16513 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16514 example, if
16515 .code
16516 local_from_prefix = *-
16517 .endd
16518 is set, a &'From:'& line containing
16519 .code
16520 From: anything-user@your.domain.example
16521 .endd
16522 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16523 matches the actual sender address that is constructed from the login name and
16524 qualify domain.
16525
16526
16527 .option local_from_suffix main string unset
16528 See &%local_from_prefix%& above.
16529
16530
16531 .option local_interfaces main "string list" "see below"
16532 This option controls which network interfaces are used by the daemon for
16533 listening; they are also used to identify the local host when routing. Chapter
16534 &<<CHAPinterfaces>>& contains a full description of this option and the related
16535 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16536 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16537 &%local_interfaces%& is
16538 .code
16539 local_interfaces = 0.0.0.0
16540 .endd
16541 when Exim is built without IPv6 support; otherwise it is
16542 .code
16543 local_interfaces = <; ::0 ; 0.0.0.0
16544 .endd
16545
16546 .option local_scan_timeout main time 5m
16547 .cindex "timeout" "for &[local_scan()]& function"
16548 .cindex "&[local_scan()]& function" "timeout"
16549 This timeout applies to the &[local_scan()]& function (see chapter
16550 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16551 the incoming message is rejected with a temporary error if it is an SMTP
16552 message. For a non-SMTP message, the message is dropped and Exim ends with a
16553 non-zero code. The incident is logged on the main and reject logs.
16554
16555
16556
16557 .option local_sender_retain main boolean false
16558 .cindex "&'Sender:'& header line" "retaining from local submission"
16559 When a message is submitted locally (that is, not over a TCP/IP connection) by
16560 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16561 do not want this to happen, you must set &%local_sender_retain%&, and you must
16562 also set &%local_from_check%& to be false (Exim will complain if you do not).
16563 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16564 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16565
16566
16567
16568
16569 .option localhost_number main string&!! unset
16570 .cindex "host" "locally unique number for"
16571 .cindex "message ids" "with multiple hosts"
16572 .vindex "&$localhost_number$&"
16573 Exim's message ids are normally unique only within the local host. If
16574 uniqueness among a set of hosts is required, each host must set a different
16575 value for the &%localhost_number%& option. The string is expanded immediately
16576 after reading the configuration file (so that a number can be computed from the
16577 host name, for example) and the result of the expansion must be a number in the
16578 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16579 systems). This is available in subsequent string expansions via the variable
16580 &$localhost_number$&. When &%localhost_number is set%&, the final two
16581 characters of the message id, instead of just being a fractional part of the
16582 time, are computed from the time and the local host number as described in
16583 section &<<SECTmessiden>>&.
16584
16585
16586
16587 .option log_file_path main "string list&!!" "set at compile time"
16588 .cindex "log" "file path for"
16589 This option sets the path which is used to determine the names of Exim's log
16590 files, or indicates that logging is to be to syslog, or both. It is expanded
16591 when Exim is entered, so it can, for example, contain a reference to the host
16592 name. If no specific path is set for the log files at compile or runtime,
16593 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16594 they are written in a sub-directory called &_log_& in Exim's spool directory.
16595 A path must start with a slash.
16596 To send to syslog, use the word &"syslog"&.
16597 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16598 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16599 used. If this string is fixed at your installation (contains no expansion
16600 variables) it is recommended that you do not set this option in the
16601 configuration file, but instead supply the path using LOG_FILE_PATH in
16602 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16603 early on &-- in particular, failure to read the configuration file.
16604
16605
16606 .option log_selector main string unset
16607 .cindex "log" "selectors"
16608 This option can be used to reduce or increase the number of things that Exim
16609 writes to its log files. Its argument is made up of names preceded by plus or
16610 minus characters. For example:
16611 .code
16612 log_selector = +arguments -retry_defer
16613 .endd
16614 A list of possible names and what they control is given in the chapter on
16615 logging, in section &<<SECTlogselector>>&.
16616
16617
16618 .option log_timezone main boolean false
16619 .cindex "log" "timezone for entries"
16620 .vindex "&$tod_log$&"
16621 .vindex "&$tod_zone$&"
16622 By default, the timestamps on log lines are in local time without the
16623 timezone. This means that if your timezone changes twice a year, the timestamps
16624 in log lines are ambiguous for an hour when the clocks go back. One way of
16625 avoiding this problem is to set the timezone to UTC. An alternative is to set
16626 &%log_timezone%& true. This turns on the addition of the timezone offset to
16627 timestamps in log lines. Turning on this option can add quite a lot to the size
16628 of log files because each line is extended by 6 characters. Note that the
16629 &$tod_log$& variable contains the log timestamp without the zone, but there is
16630 another variable called &$tod_zone$& that contains just the timezone offset.
16631
16632
16633 .option lookup_open_max main integer 25
16634 .cindex "too many open files"
16635 .cindex "open files, too many"
16636 .cindex "file" "too many open"
16637 .cindex "lookup" "maximum open files"
16638 .cindex "limit" "open files for lookups"
16639 This option limits the number of simultaneously open files for single-key
16640 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16641 Exim normally keeps these files open during routing, because often the same
16642 file is required several times. If the limit is reached, Exim closes the least
16643 recently used file. Note that if you are using the &'ndbm'& library, it
16644 actually opens two files for each logical DBM database, though it still counts
16645 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16646 open files"& errors with NDBM, you need to reduce the value of
16647 &%lookup_open_max%&.
16648
16649
16650 .option max_username_length main integer 0
16651 .cindex "length of login name"
16652 .cindex "user name" "maximum length"
16653 .cindex "limit" "user name length"
16654 Some operating systems are broken in that they truncate long arguments to
16655 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16656 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16657 an argument that is longer behaves as if &[getpwnam()]& failed.
16658
16659
16660 .option message_body_newlines main bool false
16661 .cindex "message body" "newlines in variables"
16662 .cindex "newline" "in message body variables"
16663 .vindex "&$message_body$&"
16664 .vindex "&$message_body_end$&"
16665 By default, newlines in the message body are replaced by spaces when setting
16666 the &$message_body$& and &$message_body_end$& expansion variables. If this
16667 option is set true, this no longer happens.
16668
16669
16670 .option message_body_visible main integer 500
16671 .cindex "body of message" "visible size"
16672 .cindex "message body" "visible size"
16673 .vindex "&$message_body$&"
16674 .vindex "&$message_body_end$&"
16675 This option specifies how much of a message's body is to be included in the
16676 &$message_body$& and &$message_body_end$& expansion variables.
16677
16678
16679 .option message_id_header_domain main string&!! unset
16680 .cindex "&'Message-ID:'& header line"
16681 If this option is set, the string is expanded and used as the right hand side
16682 (domain) of the &'Message-ID:'& header that Exim creates if a
16683 locally-originated incoming message does not have one. &"Locally-originated"&
16684 means &"not received over TCP/IP."&
16685 Otherwise, the primary host name is used.
16686 Only letters, digits, dot and hyphen are accepted; any other characters are
16687 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16688 empty string, the option is ignored.
16689
16690
16691 .option message_id_header_text main string&!! unset
16692 If this variable is set, the string is expanded and used to augment the text of
16693 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16694 message does not have one. The text of this header is required by RFC 2822 to
16695 take the form of an address. By default, Exim uses its internal message id as
16696 the local part, and the primary host name as the domain. If this option is set,
16697 it is expanded, and provided the expansion is not forced to fail, and does not
16698 yield an empty string, the result is inserted into the header immediately
16699 before the @, separated from the internal message id by a dot. Any characters
16700 that are illegal in an address are automatically converted into hyphens. This
16701 means that variables such as &$tod_log$& can be used, because the spaces and
16702 colons will become hyphens.
16703
16704
16705 .option message_logs main boolean true
16706 .cindex "message logs" "disabling"
16707 .cindex "log" "message log; disabling"
16708 If this option is turned off, per-message log files are not created in the
16709 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16710 Exim, by reducing the number of files involved in handling a message from a
16711 minimum of four (header spool file, body spool file, delivery journal, and
16712 per-message log) to three. The other major I/O activity is Exim's main log,
16713 which is not affected by this option.
16714
16715
16716 .option message_size_limit main string&!! 50M
16717 .cindex "message" "size limit"
16718 .cindex "limit" "message size"
16719 .cindex "size" "of message, limit"
16720 This option limits the maximum size of message that Exim will process. The
16721 value is expanded for each incoming connection so, for example, it can be made
16722 to depend on the IP address of the remote host for messages arriving via
16723 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16724 optionally followed by K or M.
16725
16726 .cindex "SIZE" "ESMTP extension, advertising"
16727 .cindex "ESMTP extensions" SIZE
16728 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16729 service extension keyword.
16730
16731 &*Note*&: This limit cannot be made to depend on a message's sender or any
16732 other properties of an individual message, because it has to be advertised in
16733 the server's response to EHLO. String expansion failure causes a temporary
16734 error. A value of zero means no limit, but its use is not recommended. See also
16735 &%bounce_return_size_limit%&.
16736
16737 Incoming SMTP messages are failed with a 552 error if the limit is
16738 exceeded; locally-generated messages either get a stderr message or a delivery
16739 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16740 an oversized message is logged in both the main and the reject logs. See also
16741 the generic transport option &%message_size_limit%&, which limits the size of
16742 message that an individual transport can process.
16743
16744 If you use a virus-scanner and set this option to to a value larger than the
16745 maximum size that your virus-scanner is configured to support, you may get
16746 failures triggered by large mails.  The right size to configure for the
16747 virus-scanner depends upon what data is passed and the options in use but it's
16748 probably safest to just set it to a little larger than this value.  E.g., with a
16749 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16750 some problems may result.
16751
16752 A value of 0 will disable size limit checking; Exim will still advertise the
16753 SIZE extension in an EHLO response, but without a limit, so as to permit
16754 SMTP clients to still indicate the message size along with the MAIL verb.
16755
16756
16757 .option move_frozen_messages main boolean false
16758 .cindex "frozen messages" "moving"
16759 This option, which is available only if Exim has been built with the setting
16760 .code
16761 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16762 .endd
16763 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16764 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16765 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16766 standard utilities for handling such moved messages, and they do not show up in
16767 lists generated by &%-bp%& or by the Exim monitor.
16768
16769
16770 .option mua_wrapper main boolean false
16771 Setting this option true causes Exim to run in a very restrictive mode in which
16772 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16773 contains a full description of this facility.
16774
16775
16776
16777 .option mysql_servers main "string list" unset
16778 .cindex "MySQL" "server list"
16779 This option provides a list of MySQL servers and associated connection data, to
16780 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16781 option is available only if Exim has been built with MySQL support.
16782
16783
16784 .option never_users main "string list&!!" unset
16785 This option is expanded just once, at the start of Exim's processing. Local
16786 message deliveries are normally run in processes that are setuid to the
16787 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16788 It is usually desirable to prevent any deliveries from running as root, as a
16789 safety precaution.
16790
16791 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16792 list of users that must not be used for local deliveries. This list is fixed in
16793 the binary and cannot be overridden by the configuration file. By default, it
16794 contains just the single user name &"root"&. The &%never_users%& runtime option
16795 can be used to add more users to the fixed list.
16796
16797 If a message is to be delivered as one of the users on the fixed list or the
16798 &%never_users%& list, an error occurs, and delivery is deferred. A common
16799 example is
16800 .code
16801 never_users = root:daemon:bin
16802 .endd
16803 Including root is redundant if it is also on the fixed list, but it does no
16804 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16805 transport driver.
16806
16807
16808 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16809 This option gives the name for a unix-domain socket on which the daemon
16810 listens for work and information-requests.
16811 Only installations running multiple daemons sharing a spool directory
16812 should need to modify the default.
16813
16814 The option is expanded before use.
16815 If the platform supports Linux-style abstract socket names, the result
16816 is used with a nul byte prefixed.
16817 Otherwise,
16818 it should be a full path name and use a directory accessible
16819 to Exim.
16820
16821 If this option is set as empty,
16822 or the command line &%-oY%& option is used, or
16823 the command line uses a &%-oX%& option and does not use &%-oP%&,
16824 then a notifier socket is not created.
16825
16826
16827 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16828 .cindex "OpenSSL "compatibility options"
16829 This option allows an administrator to adjust the SSL options applied
16830 by OpenSSL to connections.  It is given as a space-separated list of items,
16831 each one to be +added or -subtracted from the current value.
16832
16833 This option is only available if Exim is built against OpenSSL.  The values
16834 available for this option vary according to the age of your OpenSSL install.
16835 The &"all"& value controls a subset of flags which are available, typically
16836 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16837 list the values known on your system and Exim should support all the
16838 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16839 names lose the leading &"SSL_OP_"& and are lower-cased.
16840
16841 Note that adjusting the options can have severe impact upon the security of
16842 SSL as used by Exim.  It is possible to disable safety checks and shoot
16843 yourself in the foot in various unpleasant ways.  This option should not be
16844 adjusted lightly.  An unrecognised item will be detected at startup, by
16845 invoking Exim with the &%-bV%& flag.
16846
16847 The option affects Exim operating both as a server and as a client.
16848
16849 Historical note: prior to release 4.80, Exim defaulted this value to
16850 "+dont_insert_empty_fragments", which may still be needed for compatibility
16851 with some clients, but which lowers security by increasing exposure to
16852 some now infamous attacks.
16853
16854 Examples:
16855 .code
16856 # Make both old MS and old Eudora happy:
16857 openssl_options = -all +microsoft_big_sslv3_buffer \
16858                        +dont_insert_empty_fragments
16859
16860 # Disable older protocol versions:
16861 openssl_options = +no_sslv2 +no_sslv3
16862 .endd
16863
16864 Possible options may include:
16865 .ilist
16866 &`all`&
16867 .next
16868 &`allow_unsafe_legacy_renegotiation`&
16869 .next
16870 &`cipher_server_preference`&
16871 .next
16872 &`dont_insert_empty_fragments`&
16873 .next
16874 &`ephemeral_rsa`&
16875 .next
16876 &`legacy_server_connect`&
16877 .next
16878 &`microsoft_big_sslv3_buffer`&
16879 .next
16880 &`microsoft_sess_id_bug`&
16881 .next
16882 &`msie_sslv2_rsa_padding`&
16883 .next
16884 &`netscape_challenge_bug`&
16885 .next
16886 &`netscape_reuse_cipher_change_bug`&
16887 .next
16888 &`no_compression`&
16889 .next
16890 &`no_session_resumption_on_renegotiation`&
16891 .next
16892 &`no_sslv2`&
16893 .next
16894 &`no_sslv3`&
16895 .next
16896 &`no_ticket`&
16897 .next
16898 &`no_tlsv1`&
16899 .next
16900 &`no_tlsv1_1`&
16901 .next
16902 &`no_tlsv1_2`&
16903 .next
16904 &`safari_ecdhe_ecdsa_bug`&
16905 .next
16906 &`single_dh_use`&
16907 .next
16908 &`single_ecdh_use`&
16909 .next
16910 &`ssleay_080_client_dh_bug`&
16911 .next
16912 &`sslref2_reuse_cert_type_bug`&
16913 .next
16914 &`tls_block_padding_bug`&
16915 .next
16916 &`tls_d5_bug`&
16917 .next
16918 &`tls_rollback_bug`&
16919 .endlist
16920
16921 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16922 all clients connecting using the MacOS SecureTransport TLS facility prior
16923 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16924 to negotiate TLS then this option value might help, provided that your OpenSSL
16925 release is new enough to contain this work-around.  This may be a situation
16926 where you have to upgrade OpenSSL to get buggy clients working.
16927
16928
16929 .option oracle_servers main "string list" unset
16930 .cindex "Oracle" "server list"
16931 This option provides a list of Oracle servers and associated connection data,
16932 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16933 The option is available only if Exim has been built with Oracle support.
16934
16935
16936 .new
16937 .option panic_coredump main boolean false
16938 This option is rarely needed but can help for some debugging investigations.
16939 If set, when an internal error is detected by Exim which is sufficient
16940 to terminate the process
16941 (all such are logged in the paniclog)
16942 then a coredump is requested.
16943
16944 Note that most systems require additional administrative configuration
16945 to permit write a core file for a setuid program, which is Exim's
16946 common installed configuration.
16947 .wen
16948
16949 .option percent_hack_domains main "domain list&!!" unset
16950 .cindex "&""percent hack""&"
16951 .cindex "source routing" "in email address"
16952 .cindex "address" "source-routed"
16953 The &"percent hack"& is the convention whereby a local part containing a
16954 percent sign is re-interpreted as a new email address, with the percent
16955 replaced by @. This is sometimes called &"source routing"&, though that term is
16956 also applied to RFC 2822 addresses that begin with an @ character. If this
16957 option is set, Exim implements the percent facility for those domains listed,
16958 but no others. This happens before an incoming SMTP address is tested against
16959 an ACL.
16960
16961 &*Warning*&: The &"percent hack"& has often been abused by people who are
16962 trying to get round relaying restrictions. For this reason, it is best avoided
16963 if at all possible. Unfortunately, a number of less security-conscious MTAs
16964 implement it unconditionally. If you are running Exim on a gateway host, and
16965 routing mail through to internal MTAs without processing the local parts, it is
16966 a good idea to reject recipient addresses with percent characters in their
16967 local parts. Exim's default configuration does this.
16968
16969
16970 .option perl_at_start main boolean false
16971 .cindex "Perl"
16972 This option is available only when Exim is built with an embedded Perl
16973 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16974
16975
16976 .option perl_startup main string unset
16977 .cindex "Perl"
16978 This option is available only when Exim is built with an embedded Perl
16979 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16980
16981 .option perl_taintmode main boolean false
16982 .cindex "Perl"
16983 This option enables the taint mode of the embedded Perl interpreter.
16984
16985
16986 .option pgsql_servers main "string list" unset
16987 .cindex "PostgreSQL lookup type" "server list"
16988 This option provides a list of PostgreSQL servers and associated connection
16989 data, to be used in conjunction with &(pgsql)& lookups (see section
16990 &<<SECID72>>&). The option is available only if Exim has been built with
16991 PostgreSQL support.
16992
16993
16994 .option pid_file_path main string&!! "set at compile time"
16995 .cindex "daemon" "pid file path"
16996 .cindex "pid file, path for"
16997 This option sets the name of the file to which the Exim daemon writes its
16998 process id. The string is expanded, so it can contain, for example, references
16999 to the host name:
17000 .code
17001 pid_file_path = /var/log/$primary_hostname/exim.pid
17002 .endd
17003 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17004 spool directory.
17005 The value set by the option can be overridden by the &%-oP%& command line
17006 option. A pid file is not written if a &"non-standard"& daemon is run by means
17007 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17008
17009
17010 .option pipelining_advertise_hosts main "host list&!!" *
17011 .cindex "PIPELINING" "suppressing advertising"
17012 .cindex "ESMTP extensions" PIPELINING
17013 This option can be used to suppress the advertisement of the SMTP
17014 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17015 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17016 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17017 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17018 that clients will use it; &"out of order"& commands that are &"expected"& do
17019 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17020
17021 .option pipelining_connect_advertise_hosts main "host list&!!" *
17022 .cindex "pipelining" "early connection"
17023 .cindex "pipelining" PIPECONNECT
17024 .cindex "ESMTP extensions" PIPECONNECT
17025 If Exim is built without the DISABLE_PIPE_CONNECT build option
17026 this option controls which hosts the facility is advertised to
17027 and from which pipeline early-connection (before MAIL) SMTP
17028 commands are acceptable.
17029 When used, the pipelining saves on roundtrip times.
17030
17031 See also the &%hosts_pipe_connect%& smtp transport option.
17032
17033 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17034 it permits the client to pipeline
17035 TCP connection and hello command (inclear phase),
17036 or TLS-establishment and hello command (encrypted phase),
17037 on later connections to the same host.
17038
17039
17040 .option prdr_enable main boolean false
17041 .cindex "PRDR" "enabling on server"
17042 .cindex "ESMTP extensions" PRDR
17043 This option can be used to enable the Per-Recipient Data Response extension
17044 to SMTP, defined by Eric Hall.
17045 If the option is set, PRDR is advertised by Exim when operating as a server.
17046 If the client requests PRDR, and more than one recipient, for a message
17047 an additional ACL is called for each recipient after the message content
17048 is received.  See section &<<SECTPRDRACL>>&.
17049
17050 .option preserve_message_logs main boolean false
17051 .cindex "message logs" "preserving"
17052 If this option is set, message log files are not deleted when messages are
17053 completed. Instead, they are moved to a sub-directory of the spool directory
17054 called &_msglog.OLD_&, where they remain available for statistical or debugging
17055 purposes. This is a dangerous option to set on systems with any appreciable
17056 volume of mail. Use with care!
17057
17058
17059 .option primary_hostname main string "see below"
17060 .cindex "name" "of local host"
17061 .cindex "host" "name of local"
17062 .cindex "local host" "name of"
17063 .vindex "&$primary_hostname$&"
17064 This specifies the name of the current host. It is used in the default EHLO or
17065 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17066 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17067 The value is also used by default in some SMTP response messages from an Exim
17068 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17069
17070 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17071 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17072 contains only one component, Exim passes it to &[gethostbyname()]& (or
17073 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17074 version. The variable &$primary_hostname$& contains the host name, whether set
17075 explicitly by this option, or defaulted.
17076
17077
17078 .option print_topbitchars main boolean false
17079 .cindex "printing characters"
17080 .cindex "8-bit characters"
17081 By default, Exim considers only those characters whose codes lie in the range
17082 32&--126 to be printing characters. In a number of circumstances (for example,
17083 when writing log entries) non-printing characters are converted into escape
17084 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17085 is set, code values of 128 and above are also considered to be printing
17086 characters.
17087
17088 This option also affects the header syntax checks performed by the
17089 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17090 the user's full name when constructing From: and Sender: addresses (as
17091 described in section &<<SECTconstr>>&). Setting this option can cause
17092 Exim to generate eight bit message headers that do not conform to the
17093 standards.
17094
17095
17096 .option process_log_path main string unset
17097 .cindex "process log path"
17098 .cindex "log" "process log"
17099 .cindex "&'exiwhat'&"
17100 This option sets the name of the file to which an Exim process writes its
17101 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17102 utility script. If this option is unset, the file called &_exim-process.info_&
17103 in Exim's spool directory is used. The ability to specify the name explicitly
17104 can be useful in environments where two different Exims are running, using
17105 different spool directories.
17106
17107
17108 .option prod_requires_admin main boolean true
17109 .cindex "restricting access to features"
17110 .oindex "&%-M%&"
17111 .oindex "&%-R%&"
17112 .oindex "&%-q%&"
17113 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17114 admin user unless &%prod_requires_admin%& is set false. See also
17115 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17116
17117
17118 .option proxy_protocol_timeout main time 3s
17119 .cindex proxy "proxy protocol"
17120 This option sets the timeout for proxy protocol negotiation.
17121 For details see section &<<SECTproxyInbound>>&.
17122
17123
17124 .option qualify_domain main string "see below"
17125 .cindex "domain" "for qualifying addresses"
17126 .cindex "address" "qualification"
17127 This option specifies the domain name that is added to any envelope sender
17128 addresses that do not have a domain qualification. It also applies to
17129 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17130 are accepted by default only for locally-generated messages. Qualification is
17131 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17132 locally-generated messages, unless the &%-bnq%& command line option is used.
17133
17134 Messages from external sources must always contain fully qualified addresses,
17135 unless the sending host matches &%sender_unqualified_hosts%& or
17136 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17137 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17138 necessary. Internally, Exim always works with fully qualified envelope
17139 addresses. If &%qualify_domain%& is not set, it defaults to the
17140 &%primary_hostname%& value.
17141
17142
17143 .option qualify_recipient main string "see below"
17144 This option allows you to specify a different domain for qualifying recipient
17145 addresses to the one that is used for senders. See &%qualify_domain%& above.
17146
17147
17148
17149 .option queue_domains main "domain list&!!" unset
17150 .cindex "domain" "specifying non-immediate delivery"
17151 .cindex "queueing incoming messages"
17152 .cindex "message" "queueing certain domains"
17153 This option lists domains for which immediate delivery is not required.
17154 A delivery process is started whenever a message is received, but only those
17155 domains that do not match are processed. All other deliveries wait until the
17156 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17157
17158
17159 .option queue_fast_ramp main boolean true
17160 .cindex "queue runner" "two phase"
17161 .cindex "queue" "double scanning"
17162 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17163 command line, may start parallel delivery processes during their first
17164 phase.  This will be done when a threshold number of messages have been
17165 routed for a single host.
17166
17167
17168 .option queue_list_requires_admin main boolean true
17169 .cindex "restricting access to features"
17170 .oindex "&%-bp%&"
17171 The &%-bp%& command-line option, which lists the messages that are on the
17172 queue, requires the caller to be an admin user unless
17173 &%queue_list_requires_admin%& is set false.
17174 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17175
17176
17177 .option queue_only main boolean false
17178 .cindex "queueing incoming messages"
17179 .cindex "message" "queueing unconditionally"
17180 If &%queue_only%& is set, a delivery process is not automatically started
17181 whenever a message is received. Instead, the message waits in the queue for the
17182 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17183 delivered immediately when certain conditions (such as heavy load) occur.
17184
17185 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17186 and &%-odi%& command line options override &%queue_only%& unless
17187 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17188 &%queue_only_load%&, and &%smtp_accept_queue%&.
17189
17190
17191 .option queue_only_file main string unset
17192 .cindex "queueing incoming messages"
17193 .cindex "message" "queueing by file existence"
17194 This option can be set to a colon-separated list of absolute path names, each
17195 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17196 it tests for the existence of each listed path using a call to &[stat()]&. For
17197 each path that exists, the corresponding queueing option is set.
17198 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17199 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17200 .code
17201 queue_only_file = smtp/some/file
17202 .endd
17203 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17204 &_/some/file_& exists.
17205
17206
17207 .option queue_only_load main fixed-point unset
17208 .cindex "load average"
17209 .cindex "queueing incoming messages"
17210 .cindex "message" "queueing by load"
17211 If the system load average is higher than this value, incoming messages from
17212 all sources are queued, and no automatic deliveries are started. If this
17213 happens during local or remote SMTP input, all subsequent messages received on
17214 the same SMTP connection are queued by default, whatever happens to the load in
17215 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17216 false.
17217
17218 Deliveries will subsequently be performed by queue runner processes. This
17219 option has no effect on ancient operating systems on which Exim cannot
17220 determine the load average. See also &%deliver_queue_load_max%& and
17221 &%smtp_load_reserve%&.
17222
17223
17224 .option queue_only_load_latch main boolean true
17225 .cindex "load average" "re-evaluating per message"
17226 When this option is true (the default), once one message has been queued
17227 because the load average is higher than the value set by &%queue_only_load%&,
17228 all subsequent messages received on the same SMTP connection are also queued.
17229 This is a deliberate choice; even though the load average may fall below the
17230 threshold, it doesn't seem right to deliver later messages on the same
17231 connection when not delivering earlier ones. However, there are special
17232 circumstances such as very long-lived connections from scanning appliances
17233 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17234 should be set false. This causes the value of the load average to be
17235 re-evaluated for each message.
17236
17237
17238 .option queue_only_override main boolean true
17239 .cindex "queueing incoming messages"
17240 When this option is true, the &%-od%&&'x'& command line options override the
17241 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17242 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17243 to override; they are accepted, but ignored.
17244
17245
17246 .option queue_run_in_order main boolean false
17247 .cindex "queue runner" "processing messages in order"
17248 If this option is set, queue runs happen in order of message arrival instead of
17249 in an arbitrary order. For this to happen, a complete list of the entire queue
17250 must be set up before the deliveries start. When the queue is all held in a
17251 single directory (the default), a single list is created for both the ordered
17252 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17253 single list is not created when &%queue_run_in_order%& is false. In this case,
17254 the sub-directories are processed one at a time (in a random order), and this
17255 avoids setting up one huge list for the whole queue. Thus, setting
17256 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17257 when the queue is large, because of the extra work in setting up the single,
17258 large list. In most situations, &%queue_run_in_order%& should not be set.
17259
17260
17261
17262 .option queue_run_max main integer&!! 5
17263 .cindex "queue runner" "maximum number of"
17264 This controls the maximum number of queue runner processes that an Exim daemon
17265 can run simultaneously. This does not mean that it starts them all at once,
17266 but rather that if the maximum number are still running when the time comes to
17267 start another one, it refrains from starting another one. This can happen with
17268 very large queues and/or very sluggish deliveries. This option does not,
17269 however, interlock with other processes, so additional queue runners can be
17270 started by other means, or by killing and restarting the daemon.
17271
17272 Setting this option to zero does not suppress queue runs; rather, it disables
17273 the limit, allowing any number of simultaneous queue runner processes to be
17274 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17275 the daemon's command line.
17276
17277 .cindex queues named
17278 .cindex "named queues" "resource limit"
17279 To set limits for different named queues use
17280 an expansion depending on the &$queue_name$& variable.
17281
17282 .option queue_smtp_domains main "domain list&!!" unset
17283 .cindex "queueing incoming messages"
17284 .cindex "message" "queueing remote deliveries"
17285 .cindex "first pass routing"
17286 When this option is set, a delivery process is started whenever a message is
17287 received, routing is performed, and local deliveries take place.
17288 However, if any SMTP deliveries are required for domains that match
17289 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17290 message waits in the queue for the next queue run. Since routing of the message
17291 has taken place, Exim knows to which remote hosts it must be delivered, and so
17292 when the queue run happens, multiple messages for the same host are delivered
17293 over a single SMTP connection. The &%-odqs%& command line option causes all
17294 SMTP deliveries to be queued in this way, and is equivalent to setting
17295 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17296 &%queue_domains%&.
17297
17298
17299 .option receive_timeout main time 0s
17300 .cindex "timeout" "for non-SMTP input"
17301 This option sets the timeout for accepting a non-SMTP message, that is, the
17302 maximum time that Exim waits when reading a message on the standard input. If
17303 the value is zero, it will wait forever. This setting is overridden by the
17304 &%-or%& command line option. The timeout for incoming SMTP messages is
17305 controlled by &%smtp_receive_timeout%&.
17306
17307 .option received_header_text main string&!! "see below"
17308 .cindex "customizing" "&'Received:'& header"
17309 .cindex "&'Received:'& header line" "customizing"
17310 This string defines the contents of the &'Received:'& message header that is
17311 added to each message, except for the timestamp, which is automatically added
17312 on at the end (preceded by a semicolon). The string is expanded each time it is
17313 used. If the expansion yields an empty string, no &'Received:'& header line is
17314 added to the message. Otherwise, the string should start with the text
17315 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17316 header lines.
17317 The default setting is:
17318
17319 .code
17320 received_header_text = Received: \
17321   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17322     {${if def:sender_ident \
17323       {from ${quote_local_part:$sender_ident} }}\
17324         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17325   by $primary_hostname \
17326   ${if def:received_protocol {with $received_protocol }}\
17327   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17328   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17329   (Exim $version_number)\n\t\
17330   ${if def:sender_address \
17331   {(envelope-from <$sender_address>)\n\t}}\
17332   id $message_exim_id\
17333   ${if def:received_for {\n\tfor $received_for}}
17334 .endd
17335
17336 The references to the TLS version and cipher are
17337 omitted when Exim is built without TLS
17338 support. The use of conditional expansions ensures that this works for both
17339 locally generated messages and messages received from remote hosts, giving
17340 header lines such as the following:
17341 .code
17342 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17343 by marley.carol.example with esmtp (Exim 4.00)
17344 (envelope-from <bob@carol.example>)
17345 id 16IOWa-00019l-00
17346 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17347 Received: by scrooge.carol.example with local (Exim 4.00)
17348 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17349 .endd
17350 Until the body of the message has been received, the timestamp is the time when
17351 the message started to be received. Once the body has arrived, and all policy
17352 checks have taken place, the timestamp is updated to the time at which the
17353 message was accepted.
17354
17355
17356 .option received_headers_max main integer 30
17357 .cindex "loop" "prevention"
17358 .cindex "mail loop prevention"
17359 .cindex "&'Received:'& header line" "counting"
17360 When a message is to be delivered, the number of &'Received:'& headers is
17361 counted, and if it is greater than this parameter, a mail loop is assumed to
17362 have occurred, the delivery is abandoned, and an error message is generated.
17363 This applies to both local and remote deliveries.
17364
17365
17366 .option recipient_unqualified_hosts main "host list&!!" unset
17367 .cindex "unqualified addresses"
17368 .cindex "host" "unqualified addresses from"
17369 This option lists those hosts from which Exim is prepared to accept unqualified
17370 recipient addresses in message envelopes. The addresses are made fully
17371 qualified by the addition of the &%qualify_recipient%& value. This option also
17372 affects message header lines. Exim does not reject unqualified recipient
17373 addresses in headers, but it qualifies them only if the message came from a
17374 host that matches &%recipient_unqualified_hosts%&,
17375 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17376 option was not set.
17377
17378
17379 .option recipients_max main integer 50000
17380 .cindex "limit" "number of recipients"
17381 .cindex "recipient" "maximum number"
17382 If this option is set greater than zero, it specifies the maximum number of
17383 original recipients for any message. Additional recipients that are generated
17384 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17385 all recipients over the limit; earlier recipients are delivered as normal.
17386 Non-SMTP messages with too many recipients are failed, and no deliveries are
17387 done.
17388
17389 .cindex "RCPT" "maximum number of incoming"
17390 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17391 RCPT commands in a single message.
17392
17393
17394 .option recipients_max_reject main boolean false
17395 If this option is set true, Exim rejects SMTP messages containing too many
17396 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17397 error to the eventual DATA command. Otherwise (the default) it gives a 452
17398 error to the surplus RCPT commands and accepts the message on behalf of the
17399 initial set of recipients. The remote server should then re-send the message
17400 for the remaining recipients at a later time.
17401
17402
17403 .option remote_max_parallel main integer 4
17404 .cindex "delivery" "parallelism for remote"
17405 This option controls parallel delivery of one message to a number of remote
17406 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17407 does all the remote deliveries for a message one by one. Otherwise, if a single
17408 message has to be delivered to more than one remote host, or if several copies
17409 have to be sent to the same remote host, up to &%remote_max_parallel%&
17410 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17411 deliveries are required, the maximum number of processes are started, and as
17412 each one finishes, another is begun. The order of starting processes is the
17413 same as if sequential delivery were being done, and can be controlled by the
17414 &%remote_sort_domains%& option. If parallel delivery takes place while running
17415 with debugging turned on, the debugging output from each delivery process is
17416 tagged with its process id.
17417
17418 This option controls only the maximum number of parallel deliveries for one
17419 message in one Exim delivery process. Because Exim has no central queue
17420 manager, there is no way of controlling the total number of simultaneous
17421 deliveries if the configuration allows a delivery attempt as soon as a message
17422 is received.
17423
17424 See also the &%max_parallel%& generic transport option,
17425 and the &%serialize_hosts%& smtp transport option.
17426
17427 .cindex "number of deliveries"
17428 .cindex "delivery" "maximum number of"
17429 If you want to control the total number of deliveries on the system, you
17430 need to set the &%queue_only%& option. This ensures that all incoming messages
17431 are added to the queue without starting a delivery process. Then set up an Exim
17432 daemon to start queue runner processes at appropriate intervals (probably
17433 fairly often, for example, every minute), and limit the total number of queue
17434 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17435 delivers only one message at a time, the maximum number of deliveries that can
17436 then take place at once is &%queue_run_max%& multiplied by
17437 &%remote_max_parallel%&.
17438
17439 If it is purely remote deliveries you want to control, use
17440 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17441 doing the SMTP routing before queueing, so that several messages for the same
17442 host will eventually get delivered down the same connection.
17443
17444
17445 .option remote_sort_domains main "domain list&!!" unset
17446 .cindex "sorting remote deliveries"
17447 .cindex "delivery" "sorting remote"
17448 When there are a number of remote deliveries for a message, they are sorted by
17449 domain into the order given by this list. For example,
17450 .code
17451 remote_sort_domains = *.cam.ac.uk:*.uk
17452 .endd
17453 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17454 then to those in the &%uk%& domain, then to any others.
17455
17456
17457 .option retry_data_expire main time 7d
17458 .cindex "hints database" "data expiry"
17459 This option sets a &"use before"& time on retry information in Exim's hints
17460 database. Any older retry data is ignored. This means that, for example, once a
17461 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17462 past failures.
17463
17464
17465 .option retry_interval_max main time 24h
17466 .cindex "retry" "limit on interval"
17467 .cindex "limit" "on retry interval"
17468 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17469 intervals between delivery attempts for messages that cannot be delivered
17470 straight away. This option sets an overall limit to the length of time between
17471 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17472 the default value.
17473
17474
17475 .option return_path_remove main boolean true
17476 .cindex "&'Return-path:'& header line" "removing"
17477 RFC 2821, section 4.4, states that an SMTP server must insert a
17478 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17479 The &'Return-path:'& header preserves the sender address as received in the
17480 MAIL command. This description implies that this header should not be present
17481 in an incoming message. If &%return_path_remove%& is true, any existing
17482 &'Return-path:'& headers are removed from messages at the time they are
17483 received. Exim's transports have options for adding &'Return-path:'& headers at
17484 the time of delivery. They are normally used only for final local deliveries.
17485
17486
17487 .option return_size_limit main integer 100K
17488 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17489
17490
17491 .option rfc1413_hosts main "host list&!!" @[]
17492 .cindex "RFC 1413"
17493 .cindex "host" "for RFC 1413 calls"
17494 RFC 1413 identification calls are made to any client host which matches
17495 an item in the list.
17496 The default value specifies just this host, being any local interface
17497 for the system.
17498
17499 .option rfc1413_query_timeout main time 0s
17500 .cindex "RFC 1413" "query timeout"
17501 .cindex "timeout" "for RFC 1413 call"
17502 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17503 no RFC 1413 calls are ever made.
17504
17505
17506 .option sender_unqualified_hosts main "host list&!!" unset
17507 .cindex "unqualified addresses"
17508 .cindex "host" "unqualified addresses from"
17509 This option lists those hosts from which Exim is prepared to accept unqualified
17510 sender addresses. The addresses are made fully qualified by the addition of
17511 &%qualify_domain%&. This option also affects message header lines. Exim does
17512 not reject unqualified addresses in headers that contain sender addresses, but
17513 it qualifies them only if the message came from a host that matches
17514 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17515 using TCP/IP), and the &%-bnq%& option was not set.
17516
17517
17518 .option slow_lookup_log main integer 0
17519 .cindex "logging" "slow lookups"
17520 .cindex "dns" "logging slow lookups"
17521 This option controls logging of slow lookups.
17522 If the value is nonzero it is taken as a number of milliseconds
17523 and lookups taking longer than this are logged.
17524 Currently this applies only to DNS lookups.
17525
17526
17527
17528 .option smtp_accept_keepalive main boolean true
17529 .cindex "keepalive" "on incoming connection"
17530 This option controls the setting of the SO_KEEPALIVE option on incoming
17531 TCP/IP socket connections. When set, it causes the kernel to probe idle
17532 connections periodically, by sending packets with &"old"& sequence numbers. The
17533 other end of the connection should send an acknowledgment if the connection is
17534 still okay or a reset if the connection has been aborted. The reason for doing
17535 this is that it has the beneficial effect of freeing up certain types of
17536 connection that can get stuck when the remote host is disconnected without
17537 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17538 hours to detect unreachable hosts.
17539
17540
17541
17542 .option smtp_accept_max main integer 20
17543 .cindex "limit" "incoming SMTP connections"
17544 .cindex "SMTP" "incoming connection count"
17545 .cindex "inetd"
17546 This option specifies the maximum number of simultaneous incoming SMTP calls
17547 that Exim will accept. It applies only to the listening daemon; there is no
17548 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17549 value is set to zero, no limit is applied. However, it is required to be
17550 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17551 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17552
17553 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17554 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17555 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17556 and &%smtp_load_reserve%& are then checked before accepting the connection.
17557
17558
17559 .option smtp_accept_max_nonmail main integer 10
17560 .cindex "limit" "non-mail SMTP commands"
17561 .cindex "SMTP" "limiting non-mail commands"
17562 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17563 the connection if there are too many. This option defines &"too many"&. The
17564 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17565 client looping sending EHLO, for example. The check is applied only if the
17566 client host matches &%smtp_accept_max_nonmail_hosts%&.
17567
17568 When a new message is expected, one occurrence of RSET is not counted. This
17569 allows a client to send one RSET between messages (this is not necessary,
17570 but some clients do it). Exim also allows one uncounted occurrence of HELO
17571 or EHLO, and one occurrence of STARTTLS between messages. After
17572 starting up a TLS session, another EHLO is expected, and so it too is not
17573 counted. The first occurrence of AUTH in a connection, or immediately
17574 following STARTTLS is not counted. Otherwise, all commands other than
17575 MAIL, RCPT, DATA, and QUIT are counted.
17576
17577
17578 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17579 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17580 check by setting this option. The default value makes it apply to all hosts. By
17581 changing the value, you can exclude any badly-behaved hosts that you have to
17582 live with.
17583
17584
17585 . Allow this long option name to split; give it unsplit as a fifth argument
17586 . for the automatic .oindex that is generated by .option.
17587 . We insert " &~&~" which is both pretty nasty visually and results in
17588 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17589 . zero-width-space, which would be nicer visually and results in (at least)
17590 . html that Firefox will split on when it's forced to reflow (rather than
17591 . inserting a horizontal scrollbar).  However, the text is still not
17592 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17593 . the option name to split.
17594
17595 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17596          smtp_accept_max_per_connection
17597 .cindex "SMTP" "limiting incoming message count"
17598 .cindex "limit" "messages per SMTP connection"
17599 The value of this option limits the number of MAIL commands that Exim is
17600 prepared to accept over a single SMTP connection, whether or not each command
17601 results in the transfer of a message. After the limit is reached, a 421
17602 response is given to subsequent MAIL commands. This limit is a safety
17603 precaution against a client that goes mad (incidents of this type have been
17604 seen).
17605 The option is expanded after the HELO or EHLO is received
17606 and may depend on values available at that time.
17607 An empty or zero value after expansion removes the limit.
17608
17609
17610 .option smtp_accept_max_per_host main string&!! unset
17611 .cindex "limit" "SMTP connections from one host"
17612 .cindex "host" "limiting SMTP connections from"
17613 This option restricts the number of simultaneous IP connections from a single
17614 host (strictly, from a single IP address) to the Exim daemon. The option is
17615 expanded, to enable different limits to be applied to different hosts by
17616 reference to &$sender_host_address$&. Once the limit is reached, additional
17617 connection attempts from the same host are rejected with error code 421. This
17618 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17619 of zero imposes no limit. If this option is set greater than zero, it is
17620 required that &%smtp_accept_max%& be non-zero.
17621
17622 &*Warning*&: When setting this option you should not use any expansion
17623 constructions that take an appreciable amount of time. The expansion and test
17624 happen in the main daemon loop, in order to reject additional connections
17625 without forking additional processes (otherwise a denial-of-service attack
17626 could cause a vast number or processes to be created). While the daemon is
17627 doing this processing, it cannot accept any other incoming connections.
17628
17629
17630
17631 .option smtp_accept_queue main integer 0
17632 .cindex "SMTP" "incoming connection count"
17633 .cindex "queueing incoming messages"
17634 .cindex "message" "queueing by SMTP connection count"
17635 If the number of simultaneous incoming SMTP connections being handled via the
17636 listening daemon exceeds this value, messages received by SMTP are just placed
17637 in the queue; no delivery processes are started automatically. The count is
17638 fixed at the start of an SMTP connection. It cannot be updated in the
17639 subprocess that receives messages, and so the queueing or not queueing applies
17640 to all messages received in the same connection.
17641
17642 A value of zero implies no limit, and clearly any non-zero value is useful only
17643 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17644 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17645 various &%-od%&&'x'& command line options.
17646
17647
17648 . See the comment on smtp_accept_max_per_connection
17649
17650 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17651          smtp_accept_queue_per_connection
17652 .cindex "queueing incoming messages"
17653 .cindex "message" "queueing by message count"
17654 This option limits the number of delivery processes that Exim starts
17655 automatically when receiving messages via SMTP, whether via the daemon or by
17656 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17657 and the number of messages received in a single SMTP session exceeds this
17658 number, subsequent messages are placed in the queue, but no delivery processes
17659 are started. This helps to limit the number of Exim processes when a server
17660 restarts after downtime and there is a lot of mail waiting for it on other
17661 systems. On large systems, the default should probably be increased, and on
17662 dial-in client systems it should probably be set to zero (that is, disabled).
17663
17664
17665 .option smtp_accept_reserve main integer 0
17666 .cindex "SMTP" "incoming call count"
17667 .cindex "host" "reserved"
17668 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17669 number of SMTP connections that are reserved for connections from the hosts
17670 that are specified in &%smtp_reserve_hosts%&. The value set in
17671 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17672 restricted to this number of connections; the option specifies a minimum number
17673 of connection slots for them, not a maximum. It is a guarantee that this group
17674 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17675 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17676 individual host.
17677
17678 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17679 set to 5, once there are 45 active connections (from any hosts), new
17680 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17681 provided the other criteria for acceptance are met.
17682
17683
17684 .option smtp_active_hostname main string&!! unset
17685 .cindex "host" "name in SMTP responses"
17686 .cindex "SMTP" "host name in responses"
17687 .vindex "&$primary_hostname$&"
17688 This option is provided for multi-homed servers that want to masquerade as
17689 several different hosts. At the start of an incoming SMTP connection, its value
17690 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17691 responses. For example, it is used as domain name in the response to an
17692 incoming HELO or EHLO command.
17693
17694 .vindex "&$smtp_active_hostname$&"
17695 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17696 is saved with any messages that are received. It is therefore available for use
17697 in routers and transports when the message is later delivered.
17698
17699 If this option is unset, or if its expansion is forced to fail, or if the
17700 expansion results in an empty string, the value of &$primary_hostname$& is
17701 used. Other expansion failures cause a message to be written to the main and
17702 panic logs, and the SMTP command receives a temporary error. Typically, the
17703 value of &%smtp_active_hostname%& depends on the incoming interface address.
17704 For example:
17705 .code
17706 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17707   {cox.mydomain}{box.mydomain}}
17708 .endd
17709
17710 Although &$smtp_active_hostname$& is primarily concerned with incoming
17711 messages, it is also used as the default for HELO commands in callout
17712 verification if there is no remote transport from which to obtain a
17713 &%helo_data%& value.
17714
17715 .option smtp_backlog_monitor main integer 0
17716 .cindex "connection backlog" monitoring
17717 If this option is set to greater than zero, and the backlog of available
17718 TCP connections on a socket listening for SMTP is larger than it, a line
17719 is logged giving the value and the socket address and port.
17720 The value is retrived jsut before an accept call.
17721 This facility is only available on Linux.
17722
17723 .option smtp_banner main string&!! "see below"
17724 .cindex "SMTP" "welcome banner"
17725 .cindex "banner for SMTP"
17726 .cindex "welcome banner for SMTP"
17727 .cindex "customizing" "SMTP banner"
17728 If a connect ACL does not supply a message,
17729 this string (which is expanded every time it is used) is output as the initial
17730 positive response to an SMTP connection. The default setting is:
17731 .code
17732 smtp_banner = $smtp_active_hostname ESMTP Exim \
17733   $version_number $tod_full
17734 .endd
17735 .new
17736 Failure to expand the string causes a panic error;
17737 a forced fail just closes the connection.
17738 .wen
17739 If you want to create a
17740 multiline response to the initial SMTP connection, use &"\n"& in the string at
17741 appropriate points, but not at the end. Note that the 220 code is not included
17742 in this string. Exim adds it automatically (several times in the case of a
17743 multiline response).
17744
17745
17746 .option smtp_check_spool_space main boolean true
17747 .cindex "checking disk space"
17748 .cindex "disk space, checking"
17749 .cindex "spool directory" "checking space"
17750 When this option is set, if an incoming SMTP session encounters the SIZE
17751 option on a MAIL command, it checks that there is enough space in the
17752 spool directory's partition to accept a message of that size, while still
17753 leaving free the amount specified by &%check_spool_space%& (even if that value
17754 is zero). If there isn't enough space, a temporary error code is returned.
17755
17756
17757 .option smtp_connect_backlog main integer 20
17758 .cindex "connection backlog" "set maximum"
17759 .cindex "SMTP" "connection backlog"
17760 .cindex "backlog of connections"
17761 This option specifies a maximum number of waiting SMTP connections. Exim passes
17762 this value to the TCP/IP system when it sets up its listener. Once this number
17763 of connections are waiting for the daemon's attention, subsequent connection
17764 attempts are refused at the TCP/IP level. At least, that is what the manuals
17765 say; in some circumstances such connection attempts have been observed to time
17766 out instead. For large systems it is probably a good idea to increase the
17767 value (to 50, say). It also gives some protection against denial-of-service
17768 attacks by SYN flooding.
17769
17770
17771 .option smtp_enforce_sync main boolean true
17772 .cindex "SMTP" "synchronization checking"
17773 .cindex "synchronization checking in SMTP"
17774 The SMTP protocol specification requires the client to wait for a response from
17775 the server at certain points in the dialogue. Without PIPELINING these
17776 synchronization points are after every command; with PIPELINING they are
17777 fewer, but they still exist.
17778
17779 Some spamming sites send out a complete set of SMTP commands without waiting
17780 for any response. Exim protects against this by rejecting a message if the
17781 client has sent further input when it should not have. The error response &"554
17782 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17783 for this error cannot be perfect because of transmission delays (unexpected
17784 input may be on its way but not yet received when Exim checks). However, it
17785 does detect many instances.
17786
17787 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17788 If you want to disable the check selectively (for example, only for certain
17789 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17790 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17791
17792
17793
17794 .option smtp_etrn_command main string&!! unset
17795 .cindex "ETRN" "command to be run"
17796 .cindex "ESMTP extensions" ETRN
17797 .vindex "&$domain$&"
17798 If this option is set, the given command is run whenever an SMTP ETRN
17799 command is received from a host that is permitted to issue such commands (see
17800 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17801 are independently expanded. The expansion variable &$domain$& is set to the
17802 argument of the ETRN command, and no syntax checking is done on it. For
17803 example:
17804 .code
17805 smtp_etrn_command = /etc/etrn_command $domain \
17806                     $sender_host_address
17807 .endd
17808 If the option is not set, the argument for the ETRN command must
17809 be a &'#'& followed by an address string.
17810 In this case an &'exim -R <string>'& command is used;
17811 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17812
17813 A new process is created to run the command, but Exim does not wait for it to
17814 complete. Consequently, its status cannot be checked. If the command cannot be
17815 run, a line is written to the panic log, but the ETRN caller still receives
17816 a 250 success response. Exim is normally running under its own uid when
17817 receiving SMTP, so it is not possible for it to change the uid before running
17818 the command.
17819
17820
17821 .option smtp_etrn_serialize main boolean true
17822 .cindex "ETRN" "serializing"
17823 When this option is set, it prevents the simultaneous execution of more than
17824 one identical command as a result of ETRN in an SMTP connection. See
17825 section &<<SECTETRN>>& for details.
17826
17827
17828 .option smtp_load_reserve main fixed-point unset
17829 .cindex "load average"
17830 If the system load average ever gets higher than this, incoming SMTP calls are
17831 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17832 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17833 the load is over the limit. The option has no effect on ancient operating
17834 systems on which Exim cannot determine the load average. See also
17835 &%deliver_queue_load_max%& and &%queue_only_load%&.
17836
17837
17838
17839 .option smtp_max_synprot_errors main integer 3
17840 .cindex "SMTP" "limiting syntax and protocol errors"
17841 .cindex "limit" "SMTP syntax and protocol errors"
17842 Exim rejects SMTP commands that contain syntax or protocol errors. In
17843 particular, a syntactically invalid email address, as in this command:
17844 .code
17845 RCPT TO:<abc xyz@a.b.c>
17846 .endd
17847 causes immediate rejection of the command, before any other tests are done.
17848 (The ACL cannot be run if there is no valid address to set up for it.) An
17849 example of a protocol error is receiving RCPT before MAIL. If there are
17850 too many syntax or protocol errors in one SMTP session, the connection is
17851 dropped. The limit is set by this option.
17852
17853 .cindex "PIPELINING" "expected errors"
17854 When the PIPELINING extension to SMTP is in use, some protocol errors are
17855 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17856 Exim assumes that PIPELINING will be used if it advertises it (see
17857 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17858 not count towards the limit.
17859
17860
17861
17862 .option smtp_max_unknown_commands main integer 3
17863 .cindex "SMTP" "limiting unknown commands"
17864 .cindex "limit" "unknown SMTP commands"
17865 If there are too many unrecognized commands in an incoming SMTP session, an
17866 Exim server drops the connection. This is a defence against some kinds of abuse
17867 that subvert web
17868 clients
17869 into making connections to SMTP ports; in these circumstances, a number of
17870 non-SMTP command lines are sent first.
17871
17872
17873
17874 .option smtp_ratelimit_hosts main "host list&!!" unset
17875 .cindex "SMTP" "rate limiting"
17876 .cindex "limit" "rate of message arrival"
17877 .cindex "RCPT" "rate limiting"
17878 Some sites find it helpful to be able to limit the rate at which certain hosts
17879 can send them messages, and the rate at which an individual message can specify
17880 recipients.
17881
17882 Exim has two rate-limiting facilities. This section describes the older
17883 facility, which can limit rates within a single connection. The newer
17884 &%ratelimit%& ACL condition can limit rates across all connections. See section
17885 &<<SECTratelimiting>>& for details of the newer facility.
17886
17887 When a host matches &%smtp_ratelimit_hosts%&, the values of
17888 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17889 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17890 respectively. Each option, if set, must contain a set of four comma-separated
17891 values:
17892
17893 .ilist
17894 A threshold, before which there is no rate limiting.
17895 .next
17896 An initial time delay. Unlike other times in Exim, numbers with decimal
17897 fractional parts are allowed here.
17898 .next
17899 A factor by which to increase the delay each time.
17900 .next
17901 A maximum value for the delay. This should normally be less than 5 minutes,
17902 because after that time, the client is liable to timeout the SMTP command.
17903 .endlist
17904
17905 For example, these settings have been used successfully at the site which
17906 first suggested this feature, for controlling mail from their customers:
17907 .code
17908 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17909 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17910 .endd
17911 The first setting specifies delays that are applied to MAIL commands after
17912 two have been received over a single connection. The initial delay is 0.5
17913 seconds, increasing by a factor of 1.05 each time. The second setting applies
17914 delays to RCPT commands when more than four occur in a single message.
17915
17916
17917 .option smtp_ratelimit_mail main string unset
17918 See &%smtp_ratelimit_hosts%& above.
17919
17920
17921 .option smtp_ratelimit_rcpt main string unset
17922 See &%smtp_ratelimit_hosts%& above.
17923
17924
17925 .option smtp_receive_timeout main time&!! 5m
17926 .cindex "timeout" "for SMTP input"
17927 .cindex "SMTP" "input timeout"
17928 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17929 input, including batch SMTP. If a line of input (either an SMTP command or a
17930 data line) is not received within this time, the SMTP connection is dropped and
17931 the message is abandoned.
17932 A line is written to the log containing one of the following messages:
17933 .code
17934 SMTP command timeout on connection from...
17935 SMTP data timeout on connection from...
17936 .endd
17937 The former means that Exim was expecting to read an SMTP command; the latter
17938 means that it was in the DATA phase, reading the contents of a message.
17939
17940 If the first character of the option is a &"$"& the option is
17941 expanded before use and may depend on
17942 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17943
17944
17945 .oindex "&%-os%&"
17946 The value set by this option can be overridden by the
17947 &%-os%& command-line option. A setting of zero time disables the timeout, but
17948 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17949 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17950 timeout is controlled by &%receive_timeout%& and &%-or%&.
17951
17952
17953 .option smtp_reserve_hosts main "host list&!!" unset
17954 This option defines hosts for which SMTP connections are reserved; see
17955 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17956
17957
17958 .option smtp_return_error_details main boolean false
17959 .cindex "SMTP" "details policy failures"
17960 .cindex "policy control" "rejection, returning details"
17961 In the default state, Exim uses bland messages such as
17962 &"Administrative prohibition"& when it rejects SMTP commands for policy
17963 reasons. Many sysadmins like this because it gives away little information
17964 to spammers. However, some other sysadmins who are applying strict checking
17965 policies want to give out much fuller information about failures. Setting
17966 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17967 example, instead of &"Administrative prohibition"&, it might give:
17968 .code
17969 550-Rejected after DATA: '>' missing at end of address:
17970 550 failing address in "From" header is: <user@dom.ain
17971 .endd
17972
17973
17974 .option smtputf8_advertise_hosts main "host list&!!" *
17975 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17976 .cindex "ESMTP extensions" SMTPUTF8
17977 When Exim is built with support for internationalised mail names,
17978 the availability thereof is advertised in
17979 response to EHLO only to those client hosts that match this option. See
17980 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17981
17982
17983 .option spamd_address main string "127.0.0.1 783"
17984 This option is available when Exim is compiled with the content-scanning
17985 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17986 See section &<<SECTscanspamass>>& for more details.
17987
17988
17989
17990 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17991 This option is available when Exim is compiled with SPF support.
17992 See section &<<SECSPF>>& for more details.
17993
17994 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17995 This option is available when Exim is compiled with SPF support.  It
17996 allows the customisation of the SMTP comment that the SPF library
17997 generates.  You are strongly encouraged to link to your own explanative
17998 site. The template must not contain spaces. If you need spaces in the
17999 output, use the proper placeholder. If libspf2 can not parse the
18000 template, it uses a built-in default broken link. The following placeholders
18001 (along with Exim variables (but see below)) are allowed in the template:
18002 .ilist
18003 &*%_*&: A space.
18004 .next
18005 &*%{L}*&: Envelope sender's local part.
18006 .next
18007 &*%{S}*&: Envelope sender.
18008 .next
18009 &*%{O}*&: Envelope sender's domain.
18010 .next
18011 &*%{D}*&: Current(?) domain.
18012 .next
18013 &*%{I}*&: SMTP client Ip.
18014 .next
18015 &*%{C}*&: SMTP client pretty IP.
18016 .next
18017 &*%{T}*&: Epoch time (UTC).
18018 .next
18019 &*%{P}*&: SMTP client domain name.
18020 .next
18021 &*%{V}*&: IP version.
18022 .next
18023 &*%{H}*&: EHLO/HELO domain.
18024 .next
18025 &*%{R}*&: Receiving domain.
18026 .endlist
18027 The capitalized placeholders do proper URL encoding, if you use them
18028 lowercased, no encoding takes place.  This list was compiled from the
18029 libspf2 sources.
18030
18031 A note on using Exim variables: As
18032 currently the SPF library is initialized before the SMTP EHLO phase,
18033 the variables useful for expansion are quite limited.
18034
18035
18036 .option split_spool_directory main boolean false
18037 .cindex "multiple spool directories"
18038 .cindex "spool directory" "split"
18039 .cindex "directories, multiple"
18040 If this option is set, it causes Exim to split its input directory into 62
18041 subdirectories, each with a single alphanumeric character as its name. The
18042 sixth character of the message id is used to allocate messages to
18043 subdirectories; this is the least significant base-62 digit of the time of
18044 arrival of the message.
18045
18046 Splitting up the spool in this way may provide better performance on systems
18047 where there are long mail queues, by reducing the number of files in any one
18048 directory. The msglog directory is also split up in a similar way to the input
18049 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18050 are still placed in the single directory &_msglog.OLD_&.
18051
18052 It is not necessary to take any special action for existing messages when
18053 changing &%split_spool_directory%&. Exim notices messages that are in the
18054 &"wrong"& place, and continues to process them. If the option is turned off
18055 after a period of being on, the subdirectories will eventually empty and be
18056 automatically deleted.
18057
18058 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18059 changes. Instead of creating a list of all messages in the queue, and then
18060 trying to deliver each one, in turn, it constructs a list of those in one
18061 sub-directory and tries to deliver them, before moving on to the next
18062 sub-directory. The sub-directories are processed in a random order. This
18063 spreads out the scanning of the input directories, and uses less memory. It is
18064 particularly beneficial when there are lots of messages in the queue. However,
18065 if &%queue_run_in_order%& is set, none of this new processing happens. The
18066 entire queue has to be scanned and sorted before any deliveries can start.
18067
18068
18069 .option spool_directory main string&!! "set at compile time"
18070 .cindex "spool directory" "path to"
18071 This defines the directory in which Exim keeps its spool, that is, the messages
18072 it is waiting to deliver. The default value is taken from the compile-time
18073 configuration setting, if there is one. If not, this option must be set. The
18074 string is expanded, so it can contain, for example, a reference to
18075 &$primary_hostname$&.
18076
18077 If the spool directory name is fixed on your installation, it is recommended
18078 that you set it at build time rather than from this option, particularly if the
18079 log files are being written to the spool directory (see &%log_file_path%&).
18080 Otherwise log files cannot be used for errors that are detected early on, such
18081 as failures in the configuration file.
18082
18083 By using this option to override the compiled-in path, it is possible to run
18084 tests of Exim without using the standard spool.
18085
18086 .option spool_wireformat main boolean false
18087 .cindex "spool directory" "file formats"
18088 If this option is set, Exim may for some messages use an alternative format
18089 for data-files in the spool which matches the wire format.
18090 Doing this permits more efficient message reception and transmission.
18091 Currently it is only done for messages received using the ESMTP CHUNKING
18092 option.
18093
18094 The following variables will not have useful values:
18095 .code
18096 $max_received_linelength
18097 $body_linecount
18098 $body_zerocount
18099 .endd
18100
18101 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18102 and any external programs which are passed a reference to a message data file
18103 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18104 will need to be aware of the different formats potentially available.
18105
18106 Using any of the ACL conditions noted will negate the reception benefit
18107 (as a Unix-mbox-format file is constructed for them).
18108 The transmission benefit is maintained.
18109
18110 .option sqlite_lock_timeout main time 5s
18111 .cindex "sqlite lookup type" "lock timeout"
18112 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18113 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18114
18115 .option strict_acl_vars main boolean false
18116 .cindex "&ACL;" "variables, handling unset"
18117 This option controls what happens if a syntactically valid but undefined ACL
18118 variable is referenced. If it is false (the default), an empty string
18119 is substituted; if it is true, an error is generated. See section
18120 &<<SECTaclvariables>>& for details of ACL variables.
18121
18122 .option strip_excess_angle_brackets main boolean false
18123 .cindex "angle brackets, excess"
18124 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18125 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18126 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18127 passed on to another MTA, the excess angle brackets are not passed on. If this
18128 option is not set, multiple pairs of angle brackets cause a syntax error.
18129
18130
18131 .option strip_trailing_dot main boolean false
18132 .cindex "trailing dot on domain"
18133 .cindex "dot" "trailing on domain"
18134 If this option is set, a trailing dot at the end of a domain in an address is
18135 ignored. If this is in the envelope and the message is passed on to another
18136 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18137 domain causes a syntax error.
18138 However, addresses in header lines are checked only when an ACL requests header
18139 syntax checking.
18140
18141
18142 .option syslog_duplication main boolean true
18143 .cindex "syslog" "duplicate log lines; suppressing"
18144 When Exim is logging to syslog, it writes the log lines for its three
18145 separate logs at different syslog priorities so that they can in principle
18146 be separated on the logging hosts. Some installations do not require this
18147 separation, and in those cases, the duplication of certain log lines is a
18148 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18149 particular log line is written to syslog. For lines that normally go to
18150 both the main log and the reject log, the reject log version (possibly
18151 containing message header lines) is written, at LOG_NOTICE priority.
18152 Lines that normally go to both the main and the panic log are written at
18153 the LOG_ALERT priority.
18154
18155
18156 .option syslog_facility main string unset
18157 .cindex "syslog" "facility; setting"
18158 This option sets the syslog &"facility"& name, used when Exim is logging to
18159 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18160 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18161 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18162 details of Exim's logging.
18163
18164
18165 .option syslog_pid main boolean true
18166 .cindex "syslog" "pid"
18167 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18168 omitted when these lines are sent to syslog. (Syslog normally prefixes
18169 the log lines with the PID of the logging process automatically.) You need
18170 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18171 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18172
18173
18174
18175 .option syslog_processname main string &`exim`&
18176 .cindex "syslog" "process name; setting"
18177 This option sets the syslog &"ident"& name, used when Exim is logging to
18178 syslog. The value must be no longer than 32 characters. See chapter
18179 &<<CHAPlog>>& for details of Exim's logging.
18180
18181
18182
18183 .option syslog_timestamp main boolean true
18184 .cindex "syslog" "timestamps"
18185 .cindex timestamps syslog
18186 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18187 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18188 details of Exim's logging.
18189
18190
18191 .option system_filter main string&!! unset
18192 .cindex "filter" "system filter"
18193 .cindex "system filter" "specifying"
18194 .cindex "Sieve filter" "not available for system filter"
18195 This option specifies an Exim filter file that is applied to all messages at
18196 the start of each delivery attempt, before any routing is done. System filters
18197 must be Exim filters; they cannot be Sieve filters. If the system filter
18198 generates any deliveries to files or pipes, or any new mail messages, the
18199 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18200 which transports are to be used. Details of this facility are given in chapter
18201 &<<CHAPsystemfilter>>&.
18202 A forced expansion failure results in no filter operation.
18203
18204
18205 .option system_filter_directory_transport main string&!! unset
18206 .vindex "&$address_file$&"
18207 This sets the name of the transport driver that is to be used when the
18208 &%save%& command in a system message filter specifies a path ending in &"/"&,
18209 implying delivery of each message into a separate file in some directory.
18210 During the delivery, the variable &$address_file$& contains the path name.
18211
18212
18213 .option system_filter_file_transport main string&!! unset
18214 .cindex "file" "transport for system filter"
18215 This sets the name of the transport driver that is to be used when the &%save%&
18216 command in a system message filter specifies a path not ending in &"/"&. During
18217 the delivery, the variable &$address_file$& contains the path name.
18218
18219 .option system_filter_group main string unset
18220 .cindex "gid (group id)" "system filter"
18221 This option is used only when &%system_filter_user%& is also set. It sets the
18222 gid under which the system filter is run, overriding any gid that is associated
18223 with the user. The value may be numerical or symbolic.
18224
18225 .option system_filter_pipe_transport main string&!! unset
18226 .cindex "&(pipe)& transport" "for system filter"
18227 .vindex "&$address_pipe$&"
18228 This specifies the transport driver that is to be used when a &%pipe%& command
18229 is used in a system filter. During the delivery, the variable &$address_pipe$&
18230 contains the pipe command.
18231
18232
18233 .option system_filter_reply_transport main string&!! unset
18234 .cindex "&(autoreply)& transport" "for system filter"
18235 This specifies the transport driver that is to be used when a &%mail%& command
18236 is used in a system filter.
18237
18238
18239 .option system_filter_user main string unset
18240 .cindex "uid (user id)" "system filter"
18241 If this option is set to root, the system filter is run in the main Exim
18242 delivery process, as root.  Otherwise, the system filter runs in a separate
18243 process, as the given user, defaulting to the Exim run-time user.
18244 Unless the string consists entirely of digits, it
18245 is looked up in the password data. Failure to find the named user causes a
18246 configuration error. The gid is either taken from the password data, or
18247 specified by &%system_filter_group%&. When the uid is specified numerically,
18248 &%system_filter_group%& is required to be set.
18249
18250 If the system filter generates any pipe, file, or reply deliveries, the uid
18251 under which the filter is run is used when transporting them, unless a
18252 transport option overrides.
18253
18254
18255 .option tcp_nodelay main boolean true
18256 .cindex "daemon" "TCP_NODELAY on sockets"
18257 .cindex "Nagle algorithm"
18258 .cindex "TCP_NODELAY on listening sockets"
18259 If this option is set false, it stops the Exim daemon setting the
18260 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18261 turns off the &"Nagle algorithm"&, which is a way of improving network
18262 performance in interactive (character-by-character) situations. Turning it off
18263 should improve Exim's performance a bit, so that is what happens by default.
18264 However, it appears that some broken clients cannot cope, and time out. Hence
18265 this option. It affects only those sockets that are set up for listening by the
18266 daemon. Sockets created by the smtp transport for delivering mail always set
18267 TCP_NODELAY.
18268
18269
18270 .option timeout_frozen_after main time 0s
18271 .cindex "frozen messages" "timing out"
18272 .cindex "timeout" "frozen messages"
18273 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18274 message of any kind that has been in the queue for longer than the given time
18275 is automatically cancelled at the next queue run. If the frozen message is a
18276 bounce message, it is just discarded; otherwise, a bounce is sent to the
18277 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18278 If you want to timeout frozen bounce messages earlier than other kinds of
18279 frozen message, see &%ignore_bounce_errors_after%&.
18280
18281 &*Note:*& the default value of zero means no timeouts; with this setting,
18282 frozen messages remain in the queue forever (except for any frozen bounce
18283 messages that are released by &%ignore_bounce_errors_after%&).
18284
18285
18286 .option timezone main string unset
18287 .cindex "timezone, setting"
18288 .cindex "environment" "values from"
18289 The value of &%timezone%& is used to set the environment variable TZ while
18290 running Exim (if it is different on entry). This ensures that all timestamps
18291 created by Exim are in the required timezone. If you want all your timestamps
18292 to be in UTC (aka GMT) you should set
18293 .code
18294 timezone = UTC
18295 .endd
18296 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18297 or, if that is not set, from the value of the TZ environment variable when Exim
18298 is built. If &%timezone%& is set to the empty string, either at build or run
18299 time, any existing TZ variable is removed from the environment when Exim
18300 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18301 unfortunately not all, operating systems.
18302
18303
18304 .option tls_advertise_hosts main "host list&!!" *
18305 .cindex "TLS" "advertising"
18306 .cindex "encryption" "on SMTP connection"
18307 .cindex "SMTP" "encrypted connection"
18308 .cindex "ESMTP extensions" STARTTLS
18309 When Exim is built with support for TLS encrypted connections, the availability
18310 of the STARTTLS command to set up an encrypted session is advertised in
18311 response to EHLO only to those client hosts that match this option. See
18312 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18313 Note that the default value requires that a certificate be supplied
18314 using the &%tls_certificate%& option.  If TLS support for incoming connections
18315 is not required the &%tls_advertise_hosts%& option should be set empty.
18316
18317
18318 .option tls_alpn main "string list&!!" "smtp : esmtp"
18319 .cindex TLS "Application Layer Protocol Names"
18320 .cindex TLS ALPN
18321 .cindex ALPN "set acceptable names for server"
18322 If this option is set,
18323 the TLS library supports ALPN,
18324 and the client offers either more than
18325 ALPN name or a name which does not match the list,
18326 the TLS connection is declined.
18327
18328
18329 .option tls_certificate main "string list&!!" unset
18330 .cindex "TLS" "server certificate; location of"
18331 .cindex "certificate" "server, location of"
18332 The value of this option is expanded, and must then be a list of absolute paths to
18333 files which contain the server's certificates (in PEM format).
18334 Commonly only one file is needed.
18335 The server's private key is also
18336 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18337 &<<CHAPTLS>>& for further details.
18338
18339 &*Note*&: The certificates defined by this option are used only when Exim is
18340 receiving incoming messages as a server. If you want to supply certificates for
18341 use when sending messages as a client, you must set the &%tls_certificate%&
18342 option in the relevant &(smtp)& transport.
18343
18344 &*Note*&: If you use filenames based on IP addresses, change the list
18345 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18346
18347 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18348 when a list of more than one
18349 file is used, the &$tls_in_ourcert$& variable is unreliable.
18350 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18351
18352 .cindex SNI "selecting server certificate based on"
18353 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18354 if the OpenSSL build supports TLS extensions and the TLS client sends the
18355 Server Name Indication extension, then this option and others documented in
18356 &<<SECTtlssni>>& will be re-expanded.
18357
18358 If this option is unset or empty a self-signed certificate will be
18359 used.
18360 Under Linux this is generated at daemon startup; on other platforms it will be
18361 generated fresh for every connection.
18362
18363 .option tls_crl main string&!! unset
18364 .cindex "TLS" "server certificate revocation list"
18365 .cindex "certificate" "revocation list for server"
18366 This option specifies a certificate revocation list. The expanded value must
18367 be the name of a file that contains CRLs in PEM format.
18368
18369 Under OpenSSL the option can specify a directory with CRL files.
18370
18371 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18372 for each signing element of the certificate chain (i.e. all but the leaf).
18373 For the file variant this can be multiple PEM blocks in the one file.
18374
18375 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18376
18377
18378 .option tls_dh_max_bits main integer 2236
18379 .cindex "TLS" "D-H bit count"
18380 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18381 the chosen TLS library.  That value might prove to be too high for
18382 interoperability.  This option provides a maximum clamp on the value
18383 suggested, trading off security for interoperability.
18384
18385 The value must be at least 1024.
18386
18387 The value 2236 was chosen because, at time of adding the option, it was the
18388 hard-coded maximum value supported by the NSS cryptographic library, as used
18389 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18390
18391 If you prefer more security and are willing to break some clients, raise this
18392 number.
18393
18394 Note that the value passed to GnuTLS for *generating* a new prime may be a
18395 little less than this figure, because GnuTLS is inexact and may produce a
18396 larger prime than requested.
18397
18398
18399 .option tls_dhparam main string&!! unset
18400 .cindex "TLS" "D-H parameters for server"
18401 The value of this option is expanded and indicates the source of DH parameters
18402 to be used by Exim.
18403
18404 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18405 local DH parameters*&, which has been supported across all versions of Exim.  The
18406 other specific constants available are a fallback so that even when
18407 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18408
18409 If &%tls_dhparam%& is a filename starting with a &`/`&,
18410 then it names a file from which DH
18411 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18412 PKCS#3 representation of the DH prime.  If the file does not exist, for
18413 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18414 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18415 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18416 and treated as though the &%tls_dhparam%& were set to "none".
18417
18418 If this option expands to the string "none", then no DH parameters will be
18419 loaded by Exim.
18420
18421 If this option expands to the string "historic" and Exim is using GnuTLS, then
18422 Exim will attempt to load a file from inside the spool directory.  If the file
18423 does not exist, Exim will attempt to create it.
18424 See section &<<SECTgnutlsparam>>& for further details.
18425
18426 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18427 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18428
18429 In older versions of Exim the default was the 2048 bit prime described in section
18430 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18431 in IKE is assigned number 23.
18432
18433 Otherwise, the option must expand to the name used by Exim for any of a number
18434 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18435 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18436 the number used by IKE, or "default" which corresponds to
18437 &`exim.dev.20160529.3`&.
18438
18439 The available standard primes are:
18440 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18441 &`ike1`&, &`ike2`&, &`ike5`&,
18442 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18443 &`ike22`&, &`ike23`& and &`ike24`&.
18444
18445 The available additional primes are:
18446 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18447
18448 Some of these will be too small to be accepted by clients.
18449 Some may be too large to be accepted by clients.
18450 The open cryptographic community has suspicions about the integrity of some
18451 of the later IKE values, which led into RFC7919 providing new fixed constants
18452 (the "ffdhe" identifiers).
18453
18454 At this point, all of the "ike" values should be considered obsolete;
18455 they are still in Exim to avoid breaking unusual configurations, but are
18456 candidates for removal the next time we have backwards-incompatible changes.
18457 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18458 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18459 SHOULD NOT.
18460 Because of this, Exim regards them as deprecated; if either of the first pair
18461 are used, warnings will be logged in the paniclog, and if any are used then
18462 warnings will be logged in the mainlog.
18463 All four will be removed in a future Exim release.
18464
18465 The TLS protocol does not negotiate an acceptable size for this; clients tend
18466 to hard-drop connections if what is offered by the server is unacceptable,
18467 whether too large or too small, and there's no provision for the client to
18468 tell the server what these constraints are.  Thus, as a server operator, you
18469 need to make an educated guess as to what is most likely to work for your
18470 userbase.
18471
18472 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18473 is most likely to maximise interoperability.  The upper bound comes from
18474 applications using the Mozilla Network Security Services (NSS) library, which
18475 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18476 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18477 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18478 acceptable bound from 1024 to 2048.
18479
18480
18481 .option tls_eccurve main string list&!! &`auto`&
18482 .cindex TLS "EC cryptography"
18483 This option selects EC curves for use by Exim when used with OpenSSL.
18484 It has no effect when Exim is used with GnuTLS
18485 (the equivalent can be done using a priority string for the
18486 &%tls_require_ciphers%& option).
18487
18488 After expansion it must contain
18489 .new
18490 one or (only for OpenSSL versiona 1.1.1 onwards) more
18491 .wen
18492 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18493 Consult your OpenSSL manual for valid curve names.
18494
18495 For OpenSSL versions before (and not including) 1.0.2, the string
18496 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18497 &`auto`& tells the library to choose.
18498
18499 .new
18500 If the option expands to an empty string, the effect is undefined.
18501 .wen
18502
18503
18504 .option tls_ocsp_file main string&!! unset
18505 .cindex TLS "certificate status"
18506 .cindex TLS "OCSP proof file"
18507 This option
18508 must if set expand to the absolute path to a file which contains a current
18509 status proof for the server's certificate, as obtained from the
18510 Certificate Authority.
18511
18512 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18513 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18514
18515 For OpenSSL 1.1.0 or later, and
18516 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18517 of files, to match a list given for the &%tls_certificate%& option.
18518 The ordering of the two lists must match.
18519 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18520
18521 The file(s) should be in DER format,
18522 except for GnuTLS 3.6.3 or later
18523 or for OpenSSL,
18524 when an optional filetype prefix can be used.
18525 The prefix must be one of "DER" or "PEM", followed by
18526 a single space.  If one is used it sets the format for subsequent
18527 files in the list; the initial format is DER.
18528 If multiple proofs are wanted, for multiple chain elements
18529 (this only works under TLS1.3)
18530 they must be coded as a combined OCSP response.
18531
18532 Although GnuTLS will accept PEM files with multiple separate
18533 PEM blobs (ie. separate OCSP responses), it sends them in the
18534 TLS Certificate record interleaved with the certificates of the chain;
18535 although a GnuTLS client is happy with that, an OpenSSL client is not.
18536
18537 .option tls_on_connect_ports main "string list" unset
18538 .cindex SSMTP
18539 .cindex SMTPS
18540 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18541 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18542 set up without waiting for the client to issue a STARTTLS command. For
18543 further details, see section &<<SECTsupobssmt>>&.
18544
18545
18546
18547 .option tls_privatekey main "string list&!!" unset
18548 .cindex "TLS" "server private key; location of"
18549 The value of this option is expanded, and must then be a list of absolute paths to
18550 files which contains the server's private keys.
18551 If this option is unset, or if
18552 the expansion is forced to fail, or the result is an empty string, the private
18553 key is assumed to be in the same file as the server's certificates. See chapter
18554 &<<CHAPTLS>>& for further details.
18555
18556 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18557
18558
18559 .option tls_remember_esmtp main boolean false
18560 .cindex "TLS" "esmtp state; remembering"
18561 .cindex "TLS" "broken clients"
18562 If this option is set true, Exim violates the RFCs by remembering that it is in
18563 &"esmtp"& state after successfully negotiating a TLS session. This provides
18564 support for broken clients that fail to send a new EHLO after starting a
18565 TLS session.
18566
18567
18568 .option tls_require_ciphers main string&!! unset
18569 .cindex "TLS" "requiring specific ciphers"
18570 .cindex "cipher" "requiring specific"
18571 This option controls which ciphers can be used for incoming TLS connections.
18572 The &(smtp)& transport has an option of the same name for controlling outgoing
18573 connections. This option is expanded for each connection, so can be varied for
18574 different clients if required. The value of this option must be a list of
18575 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18576 in somewhat different ways. If GnuTLS is being used, the client controls the
18577 preference order of the available ciphers. Details are given in sections
18578 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18579
18580
18581 .option tls_resumption_hosts main "host list&!!" unset
18582 .cindex TLS resumption
18583 This option controls which connections to offer the TLS resumption feature.
18584 See &<<SECTresumption>>& for details.
18585
18586
18587 .option tls_try_verify_hosts main "host list&!!" unset
18588 .cindex "TLS" "client certificate verification"
18589 .cindex "certificate" "verification of client"
18590 See &%tls_verify_hosts%& below.
18591
18592
18593 .option tls_verify_certificates main string&!! system
18594 .cindex "TLS" "client certificate verification"
18595 .cindex "certificate" "verification of client"
18596 The value of this option is expanded, and must then be either the
18597 word "system"
18598 or the absolute path to
18599 a file or directory containing permitted certificates for clients that
18600 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18601
18602 The "system" value for the option will use a
18603 system default location compiled into the SSL library.
18604 This is not available for GnuTLS versions preceding 3.0.20,
18605 and will be taken as empty; an explicit location
18606 must be specified.
18607
18608 The use of a directory for the option value is not available for GnuTLS versions
18609 preceding 3.3.6 and a single file must be used.
18610
18611 With OpenSSL the certificates specified
18612 explicitly
18613 either by file or directory
18614 are added to those given by the system default location.
18615
18616 These certificates should be for the certificate authorities trusted, rather
18617 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18618 the value is a file then the certificates are sent by Exim as a server to
18619 connecting clients, defining the list of accepted certificate authorities.
18620 Thus the values defined should be considered public data.  To avoid this,
18621 use the explicit directory version. (If your peer is Exim up to 4.85,
18622 using GnuTLS, you may need to send the CAs (thus using the file
18623 variant). Otherwise the peer doesn't send its certificate.)
18624
18625 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18626
18627 A forced expansion failure or setting to an empty string is equivalent to
18628 being unset.
18629
18630
18631 .option tls_verify_hosts main "host list&!!" unset
18632 .cindex "TLS" "client certificate verification"
18633 .cindex "certificate" "verification of client"
18634 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18635 certificates from clients. The expected certificates are defined by
18636 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18637 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18638 &%tls_verify_certificates%& is not set.
18639
18640 Any client that matches &%tls_verify_hosts%& is constrained by
18641 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18642 present one of the listed certificates. If it does not, the connection is
18643 aborted.
18644 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18645 the host to use TLS. It can still send SMTP commands through unencrypted
18646 connections. Forcing a client to use TLS has to be done separately using an
18647 ACL to reject inappropriate commands when the connection is not encrypted.
18648
18649 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18650 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18651 certificate and checks it against &%tls_verify_certificates%&, but does not
18652 abort the connection if there is no certificate or if it does not match. This
18653 state can be detected in an ACL, which makes it possible to implement policies
18654 such as &"accept for relay only if a verified certificate has been received,
18655 but accept for local delivery if encrypted, even without a verified
18656 certificate"&.
18657
18658 Client hosts that match neither of these lists are not asked to present
18659 certificates.
18660
18661
18662 .option trusted_groups main "string list&!!" unset
18663 .cindex "trusted groups"
18664 .cindex "groups" "trusted"
18665 This option is expanded just once, at the start of Exim's processing. If this
18666 option is set, any process that is running in one of the listed groups, or
18667 which has one of them as a supplementary group, is trusted. The groups can be
18668 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18669 details of what trusted callers are permitted to do. If neither
18670 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18671 are trusted.
18672
18673 .option trusted_users main "string list&!!" unset
18674 .cindex "trusted users"
18675 .cindex "user" "trusted"
18676 This option is expanded just once, at the start of Exim's processing. If this
18677 option is set, any process that is running as one of the listed users is
18678 trusted. The users can be specified numerically or by name. See section
18679 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18680 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18681 Exim user are trusted.
18682
18683 .option unknown_login main string&!! unset
18684 .cindex "uid (user id)" "unknown caller"
18685 .vindex "&$caller_uid$&"
18686 This is a specialized feature for use in unusual configurations. By default, if
18687 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18688 gives up. The &%unknown_login%& option can be used to set a login name to be
18689 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18690 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18691 is used for the user's real name (gecos field), unless this has been set by the
18692 &%-F%& option.
18693
18694 .option unknown_username main string unset
18695 See &%unknown_login%&.
18696
18697 .option untrusted_set_sender main "address list&!!" unset
18698 .cindex "trusted users"
18699 .cindex "sender" "setting by untrusted user"
18700 .cindex "untrusted user setting sender"
18701 .cindex "user" "untrusted setting sender"
18702 .cindex "envelope from"
18703 .cindex "envelope sender"
18704 When an untrusted user submits a message to Exim using the standard input, Exim
18705 normally creates an envelope sender address from the user's login and the
18706 default qualification domain. Data from the &%-f%& option (for setting envelope
18707 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18708 is used) is ignored.
18709
18710 However, untrusted users are permitted to set an empty envelope sender address,
18711 to declare that a message should never generate any bounces. For example:
18712 .code
18713 exim -f '<>' user@domain.example
18714 .endd
18715 .vindex "&$sender_ident$&"
18716 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18717 other envelope sender addresses in a controlled way. When it is set, untrusted
18718 users are allowed to set envelope sender addresses that match any of the
18719 patterns in the list. Like all address lists, the string is expanded. The
18720 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18721 users to setting senders that start with their login ids
18722 followed by a hyphen
18723 by a setting like this:
18724 .code
18725 untrusted_set_sender = ^$sender_ident-
18726 .endd
18727 If you want to allow untrusted users to set envelope sender addresses without
18728 restriction, you can use
18729 .code
18730 untrusted_set_sender = *
18731 .endd
18732 The &%untrusted_set_sender%& option applies to all forms of local input, but
18733 only to the setting of the envelope sender. It does not permit untrusted users
18734 to use the other options which trusted user can use to override message
18735 parameters. Furthermore, it does not stop Exim from removing an existing
18736 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18737 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18738 overriding these actions. The handling of the &'Sender:'& header is also
18739 described in section &<<SECTthesenhea>>&.
18740
18741 The log line for a message's arrival shows the envelope sender following
18742 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18743 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18744 envelope sender address, the user's login is shown in parentheses after the
18745 sender address.
18746
18747
18748 .option uucp_from_pattern main string "see below"
18749 .cindex "&""From""& line"
18750 .cindex "UUCP" "&""From""& line"
18751 Some applications that pass messages to an MTA via a command line interface use
18752 an initial line starting with &"From&~"& to pass the envelope sender. In
18753 particular, this is used by UUCP software. Exim recognizes such a line by means
18754 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18755 matches, the sender address is constructed by expanding the contents of
18756 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18757 default pattern recognizes lines in the following two forms:
18758 .code
18759 From ph10 Fri Jan  5 12:35 GMT 1996
18760 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18761 .endd
18762 The pattern can be seen by running
18763 .code
18764 exim -bP uucp_from_pattern
18765 .endd
18766 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18767 year in the second case. The first word after &"From&~"& is matched in the
18768 regular expression by a parenthesized subpattern. The default value for
18769 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18770 (&"ph10"& in the example above) as the message's sender. See also
18771 &%ignore_fromline_hosts%&.
18772
18773
18774 .option uucp_from_sender main string&!! &`$1`&
18775 See &%uucp_from_pattern%& above.
18776
18777
18778 .option warn_message_file main string&!! unset
18779 .cindex "warning of delay" "customizing the message"
18780 .cindex "customizing" "warning message"
18781 This option defines a template file containing paragraphs of text to be used
18782 for constructing the warning message which is sent by Exim when a message has
18783 been in the queue for a specified amount of time, as specified by
18784 &%delay_warning%&. Details of the file's contents are given in chapter
18785 &<<CHAPemsgcust>>&.
18786 .cindex warn_message_file "tainted data"
18787 The option is expanded to give the file path, which must be
18788 absolute and untainted.
18789 See also &%bounce_message_file%&.
18790
18791
18792 .option write_rejectlog main boolean true
18793 .cindex "reject log" "disabling"
18794 If this option is set false, Exim no longer writes anything to the reject log.
18795 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18796 .ecindex IIDconfima
18797 .ecindex IIDmaiconf
18798
18799
18800
18801
18802 . ////////////////////////////////////////////////////////////////////////////
18803 . ////////////////////////////////////////////////////////////////////////////
18804
18805 .chapter "Generic options for routers" "CHAProutergeneric"
18806 .scindex IIDgenoprou1 "options" "generic; for routers"
18807 .scindex IIDgenoprou2 "generic options" "router"
18808 This chapter describes the generic options that apply to all routers.
18809 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18810
18811 For a general description of how a router operates, see sections
18812 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18813 which the preconditions are tested. The order of expansion of the options that
18814 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18815 &%headers_remove%&, &%transport%&.
18816
18817 The name of a router is limited to be &drivernamemax; ASCII characters long;
18818 prior to Exim 4.95 names would be silently truncated at this length, but now
18819 it is enforced.
18820
18821
18822 .option address_data routers string&!! unset
18823 .cindex "router" "data attached to address"
18824 The string is expanded just before the router is run, that is, after all the
18825 precondition tests have succeeded. If the expansion is forced to fail, the
18826 router declines, the value of &%address_data%& remains unchanged, and the
18827 &%more%& option controls what happens next. Other expansion failures cause
18828 delivery of the address to be deferred.
18829
18830 .vindex "&$address_data$&"
18831 When the expansion succeeds, the value is retained with the address, and can be
18832 accessed using the variable &$address_data$& in the current router, subsequent
18833 routers, and the eventual transport.
18834
18835 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18836 that runs a user's filter file, the contents of &$address_data$& are accessible
18837 in the filter. This is not normally a problem, because such data is usually
18838 either not confidential or it &"belongs"& to the current user, but if you do
18839 put confidential data into &$address_data$& you need to remember this point.
18840
18841 Even if the router declines or passes, the value of &$address_data$& remains
18842 with the address, though it can be changed by another &%address_data%& setting
18843 on a subsequent router. If a router generates child addresses, the value of
18844 &$address_data$& propagates to them. This also applies to the special kind of
18845 &"child"& that is generated by a router with the &%unseen%& option.
18846
18847 The idea of &%address_data%& is that you can use it to look up a lot of data
18848 for the address once, and then pick out parts of the data later. For example,
18849 you could use a single LDAP lookup to return a string of the form
18850 .code
18851 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18852 .endd
18853 In the transport you could pick out the mailbox by a setting such as
18854 .code
18855 file = ${extract{mailbox}{$address_data}}
18856 .endd
18857 This makes the configuration file less messy, and also reduces the number of
18858 lookups (though Exim does cache lookups).
18859
18860 See also the &%set%& option below.
18861
18862 .vindex "&$sender_address_data$&"
18863 .vindex "&$address_data$&"
18864 The &%address_data%& facility is also useful as a means of passing information
18865 from one router to another, and from a router to a transport. In addition, if
18866 &$address_data$& is set by a router when verifying a recipient address from an
18867 ACL, it remains available for use in the rest of the ACL statement. After
18868 verifying a sender, the value is transferred to &$sender_address_data$&.
18869
18870
18871
18872 .option address_test routers&!? boolean true
18873 .oindex "&%-bt%&"
18874 .cindex "router" "skipping when address testing"
18875 If this option is set false, the router is skipped when routing is being tested
18876 by means of the &%-bt%& command line option. This can be a convenience when
18877 your first router sends messages to an external scanner, because it saves you
18878 having to set the &"already scanned"& indicator when testing real address
18879 routing.
18880
18881
18882
18883 .option cannot_route_message routers string&!! unset
18884 .cindex "router" "customizing &""cannot route""& message"
18885 .cindex "customizing" "&""cannot route""& message"
18886 This option specifies a text message that is used when an address cannot be
18887 routed because Exim has run out of routers. The default message is
18888 &"Unrouteable address"&. This option is useful only on routers that have
18889 &%more%& set false, or on the very last router in a configuration, because the
18890 value that is used is taken from the last router that is considered. This
18891 includes a router that is skipped because its preconditions are not met, as
18892 well as a router that declines. For example, using the default configuration,
18893 you could put:
18894 .code
18895 cannot_route_message = Remote domain not found in DNS
18896 .endd
18897 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18898 and
18899 .code
18900 cannot_route_message = Unknown local user
18901 .endd
18902 on the final router that checks for local users. If string expansion fails for
18903 this option, the default message is used. Unless the expansion failure was
18904 explicitly forced, a message about the failure is written to the main and panic
18905 logs, in addition to the normal message about the routing failure.
18906
18907
18908 .option caseful_local_part routers boolean false
18909 .cindex "case of local parts"
18910 .cindex "router" "case of local parts"
18911 By default, routers handle the local parts of addresses in a case-insensitive
18912 manner, though the actual case is preserved for transmission with the message.
18913 If you want the case of letters to be significant in a router, you must set
18914 this option true. For individual router options that contain address or local
18915 part lists (for example, &%local_parts%&), case-sensitive matching can be
18916 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18917 more details.
18918
18919 .vindex "&$local_part$&"
18920 .vindex "&$original_local_part$&"
18921 .vindex "&$parent_local_part$&"
18922 The value of the &$local_part$& variable is forced to lower case while a
18923 router is running unless &%caseful_local_part%& is set. When a router assigns
18924 an address to a transport, the value of &$local_part$& when the transport runs
18925 is the same as it was in the router. Similarly, when a router generates child
18926 addresses by aliasing or forwarding, the values of &$original_local_part$&
18927 and &$parent_local_part$& are those that were used by the redirecting router.
18928
18929 This option applies to the processing of an address by a router. When a
18930 recipient address is being processed in an ACL, there is a separate &%control%&
18931 modifier that can be used to specify case-sensitive processing within the ACL
18932 (see section &<<SECTcontrols>>&).
18933
18934
18935
18936 .option check_local_user routers&!? boolean false
18937 .cindex "local user, checking in router"
18938 .cindex "router" "checking for local user"
18939 .cindex "&_/etc/passwd_&"
18940 .vindex "&$home$&"
18941 When this option is true, Exim checks that the local part of the recipient
18942 address (with affixes removed if relevant) is the name of an account on the
18943 local system. The check is done by calling the &[getpwnam()]& function rather
18944 than trying to read &_/etc/passwd_& directly. This means that other methods of
18945 holding password data (such as NIS) are supported. If the local part is a local
18946 user,
18947 .cindex "tainted data" "de-tainting"
18948 .cindex "de-tainting" "using router check_local_user option"
18949 &$local_part_data$& is set to an untainted version of the local part and
18950 &$home$& is set from the password data. The latter can be tested in other
18951 preconditions that are evaluated after this one (the order of evaluation is
18952 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18953 overridden by &%router_home_directory%&. If the local part is not a local user,
18954 the router is skipped.
18955
18956 If you want to check that the local part is either the name of a local user
18957 or matches something else, you cannot combine &%check_local_user%& with a
18958 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18959 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18960 setting to achieve this. For example:
18961 .code
18962 local_parts = passwd;$local_part : lsearch;/etc/other/users
18963 .endd
18964 Note, however, that the side effects of &%check_local_user%& (such as setting
18965 up a home directory) do not occur when a &(passwd)& lookup is used in a
18966 &%local_parts%& (or any other) precondition.
18967
18968
18969
18970 .option condition routers&!? string&!! unset
18971 .cindex "router" "customized precondition"
18972 This option specifies a general precondition test that has to succeed for the
18973 router to be called. The &%condition%& option is the last precondition to be
18974 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18975 result is a forced failure, or an empty string, or one of the strings &"0"& or
18976 &"no"& or &"false"& (checked without regard to the case of the letters), the
18977 router is skipped, and the address is offered to the next one.
18978
18979 If the result is any other value, the router is run (as this is the last
18980 precondition to be evaluated, all the other preconditions must be true).
18981
18982 This option is unusual in that multiple &%condition%& options may be present.
18983 All &%condition%& options must succeed.
18984
18985 The &%condition%& option provides a means of applying custom conditions to the
18986 running of routers. Note that in the case of a simple conditional expansion,
18987 the default expansion values are exactly what is wanted. For example:
18988 .code
18989 condition = ${if >{$message_age}{600}}
18990 .endd
18991 Because of the default behaviour of the string expansion, this is equivalent to
18992 .code
18993 condition = ${if >{$message_age}{600}{true}{}}
18994 .endd
18995
18996 A multiple condition example, which succeeds:
18997 .code
18998 condition = ${if >{$message_age}{600}}
18999 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19000 condition = foobar
19001 .endd
19002
19003 If the expansion fails (other than forced failure) delivery is deferred. Some
19004 of the other precondition options are common special cases that could in fact
19005 be specified using &%condition%&.
19006
19007 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19008 are far older, and use one set of semantics.  ACLs are newer and when
19009 they were created, the ACL &%condition%& process was given far stricter
19010 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19011 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19012 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19013 Router rules processing behavior.
19014
19015 This is best illustrated in an example:
19016 .code
19017 # If used in an ACL condition will fail with a syntax error, but
19018 # in a router condition any extra characters are treated as a string
19019
19020 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19021 true {yes} {no}}
19022
19023 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19024  {yes} {no}}
19025 .endd
19026 In each example above, the &%if%& statement actually ends after
19027 &"{google.com}}"&.  Since no true or false braces were defined, the
19028 default &%if%& behavior is to return a boolean true or a null answer
19029 (which evaluates to false). The rest of the line is then treated as a
19030 string. So the first example resulted in the boolean answer &"true"&
19031 with the string &" {yes} {no}}"& appended to it. The second example
19032 resulted in the null output (indicating false) with the string
19033 &" {yes} {no}}"& appended to it.
19034
19035 In fact you can put excess forward braces in too.  In the router
19036 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19037 mean something, like after a &"$"& or when required as part of a
19038 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19039 string characters.
19040
19041 Thus, in a Router, the above expansion strings will both always evaluate
19042 true, as the result of expansion is a non-empty string which doesn't
19043 match an explicit false value.  This can be tricky to debug.  By
19044 contrast, in an ACL either of those strings will always result in an
19045 expansion error because the result doesn't look sufficiently boolean.
19046
19047
19048 .option debug_print routers string&!! unset
19049 .cindex "testing" "variables in drivers"
19050 If this option is set and debugging is enabled (see the &%-d%& command line
19051 option) or in address-testing mode (see the &%-bt%& command line option),
19052 the string is expanded and included in the debugging output.
19053 If expansion of the string fails, the error message is written to the debugging
19054 output, and Exim carries on processing.
19055 This option is provided to help with checking out the values of variables and
19056 so on when debugging router configurations. For example, if a &%condition%&
19057 option appears not to be working, &%debug_print%& can be used to output the
19058 variables it references. The output happens after checks for &%domains%&,
19059 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19060 are tested. A newline is added to the text if it does not end with one.
19061 The variable &$router_name$& contains the name of the router.
19062
19063
19064
19065 .option disable_logging routers boolean false
19066 If this option is set true, nothing is logged for any routing errors
19067 or for any deliveries caused by this router. You should not set this option
19068 unless you really, really know what you are doing. See also the generic
19069 transport option of the same name.
19070
19071 .option dnssec_request_domains routers "domain list&!!" *
19072 .cindex "MX record" "security"
19073 .cindex "DNSSEC" "MX lookup"
19074 .cindex "security" "MX lookup"
19075 .cindex "DNS" "DNSSEC"
19076 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19077 the DNSSEC request bit set.
19078 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19079
19080 .option dnssec_require_domains routers "domain list&!!" unset
19081 .cindex "MX record" "security"
19082 .cindex "DNSSEC" "MX lookup"
19083 .cindex "security" "MX lookup"
19084 .cindex "DNS" "DNSSEC"
19085 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19086 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19087 (AD bit) set will be ignored and logged as a host-lookup failure.
19088 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19089
19090
19091 .option domains routers&!? "domain list&!!" unset
19092 .cindex "router" "restricting to specific domains"
19093 .vindex "&$domain_data$&"
19094 If this option is set, the router is skipped unless the current domain matches
19095 the list. If the match is achieved by means of a file lookup, the data that the
19096 lookup returned for the domain is placed in &$domain_data$& for use in string
19097 expansions of the driver's private options and in the transport.
19098 See section &<<SECTrouprecon>>& for
19099 a list of the order in which preconditions are evaluated.
19100
19101
19102
19103 .option driver routers string unset
19104 This option must always be set. It specifies which of the available routers is
19105 to be used.
19106
19107
19108 .option dsn_lasthop routers boolean false
19109 .cindex "DSN" "success"
19110 .cindex "Delivery Status Notification" "success"
19111 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19112 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19113 instead send a success DSN as if the next hop does not support DSN.
19114 Not effective on redirect routers.
19115
19116
19117
19118 .option errors_to routers string&!! unset
19119 .cindex "envelope from"
19120 .cindex "envelope sender"
19121 .cindex "router" "changing address for errors"
19122 If a router successfully handles an address, it may assign the address to a
19123 transport for delivery or it may generate child addresses. In both cases, if
19124 there is a delivery problem during later processing, the resulting bounce
19125 message is sent to the address that results from expanding this string,
19126 provided that the address verifies successfully. The &%errors_to%& option is
19127 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19128
19129 The &%errors_to%& setting associated with an address can be overridden if it
19130 subsequently passes through other routers that have their own &%errors_to%&
19131 settings, or if the message is delivered by a transport with a &%return_path%&
19132 setting.
19133
19134 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19135 the expansion fails to verify, the errors address associated with the incoming
19136 address is used. At top level, this is the envelope sender. A non-forced
19137 expansion failure causes delivery to be deferred.
19138
19139 If an address for which &%errors_to%& has been set ends up being delivered over
19140 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19141 any bounces that are generated by other MTAs on the delivery route are also
19142 sent there. You can set &%errors_to%& to the empty string by either of these
19143 settings:
19144 .code
19145 errors_to =
19146 errors_to = ""
19147 .endd
19148 An expansion item that yields an empty string has the same effect. If you do
19149 this, a locally detected delivery error for addresses processed by this router
19150 no longer gives rise to a bounce message; the error is discarded. If the
19151 address is delivered to a remote host, the return path is set to &`<>`&, unless
19152 overridden by the &%return_path%& option on the transport.
19153
19154 .vindex "&$address_data$&"
19155 If for some reason you want to discard local errors, but use a non-empty
19156 MAIL command for remote delivery, you can preserve the original return
19157 path in &$address_data$& in the router, and reinstate it in the transport by
19158 setting &%return_path%&.
19159
19160 The most common use of &%errors_to%& is to direct mailing list bounces to the
19161 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19162 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19163
19164
19165
19166 .option expn routers&!? boolean true
19167 .cindex "address" "testing"
19168 .cindex "testing" "addresses"
19169 .cindex "EXPN" "router skipping"
19170 .cindex "router" "skipping for EXPN"
19171 If this option is turned off, the router is skipped when testing an address
19172 as a result of processing an SMTP EXPN command. You might, for example,
19173 want to turn it off on a router for users' &_.forward_& files, while leaving it
19174 on for the system alias file.
19175 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19176 are evaluated.
19177
19178 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19179 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19180 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19181
19182
19183
19184 .option fail_verify routers boolean false
19185 .cindex "router" "forcing verification failure"
19186 Setting this option has the effect of setting both &%fail_verify_sender%& and
19187 &%fail_verify_recipient%& to the same value.
19188
19189
19190
19191 .option fail_verify_recipient routers boolean false
19192 If this option is true and an address is accepted by this router when
19193 verifying a recipient, verification fails.
19194
19195
19196
19197 .option fail_verify_sender routers boolean false
19198 If this option is true and an address is accepted by this router when
19199 verifying a sender, verification fails.
19200
19201
19202
19203 .option fallback_hosts routers "string list" unset
19204 .cindex "router" "fallback hosts"
19205 .cindex "fallback" "hosts specified on router"
19206 String expansion is not applied to this option. The argument must be a
19207 colon-separated list of host names or IP addresses. The list separator can be
19208 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19209 each name or address. In fact, the format of each item is exactly the same as
19210 defined for the list of hosts in a &(manualroute)& router (see section
19211 &<<SECTformatonehostitem>>&).
19212
19213 If a router queues an address for a remote transport, this host list is
19214 associated with the address, and used instead of the transport's fallback host
19215 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19216 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19217 transport for further details.
19218
19219
19220 .option group routers string&!! "see below"
19221 .cindex "gid (group id)" "local delivery"
19222 .cindex "local transports" "uid and gid"
19223 .cindex "transport" "local"
19224 .cindex "router" "setting group"
19225 When a router queues an address for a transport, and the transport does not
19226 specify a group, the group given here is used when running the delivery
19227 process.
19228 The group may be specified numerically or by name. If expansion fails, the
19229 error is logged and delivery is deferred.
19230 The default is unset, unless &%check_local_user%& is set, when the default
19231 is taken from the password information. See also &%initgroups%& and &%user%&
19232 and the discussion in chapter &<<CHAPenvironment>>&.
19233
19234
19235
19236 .option headers_add routers list&!! unset
19237 .cindex "header lines" "adding"
19238 .cindex "router" "adding header lines"
19239 This option specifies a list of text headers,
19240 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19241 that is associated with any addresses that are accepted by the router.
19242 Each item is separately expanded, at routing time.  However, this
19243 option has no effect when an address is just being verified. The way in which
19244 the text is used to add header lines at transport time is described in section
19245 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19246 message is in the process of being transported. This means that references to
19247 header lines in string expansions in the transport's configuration do not
19248 &"see"& the added header lines.
19249
19250 The &%headers_add%& option is expanded after &%errors_to%&, but before
19251 &%headers_remove%& and &%transport%&. If an item is empty, or if
19252 an item expansion is forced to fail, the item has no effect. Other expansion
19253 failures are treated as configuration errors.
19254
19255 Unlike most options, &%headers_add%& can be specified multiple times
19256 for a router; all listed headers are added.
19257
19258 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19259 router that has the &%one_time%& option set.
19260
19261 .cindex "duplicate addresses"
19262 .oindex "&%unseen%&"
19263 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19264 additions are deleted when the address is passed on to subsequent routers.
19265 For a &%redirect%& router, if a generated address is the same as the incoming
19266 address, this can lead to duplicate addresses with different header
19267 modifications. Exim does not do duplicate deliveries (except, in certain
19268 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19269 which of the duplicates is discarded, so this ambiguous situation should be
19270 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19271
19272
19273
19274 .option headers_remove routers list&!! unset
19275 .cindex "header lines" "removing"
19276 .cindex "router" "removing header lines"
19277 This option specifies a list of text headers,
19278 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19279 that is associated with any addresses that are accepted by the router.
19280 However, the option has no effect when an address is just being verified.
19281 Each list item is separately expanded, at transport time.
19282 If an item ends in *, it will match any header with the given prefix.
19283 The way in which
19284 the text is used to remove header lines at transport time is described in
19285 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19286 the message is in the process of being transported. This means that references
19287 to header lines in string expansions in the transport's configuration still
19288 &"see"& the original header lines.
19289
19290 The &%headers_remove%& option is handled after &%errors_to%& and
19291 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19292 the item has no effect. Other expansion failures are treated as configuration
19293 errors.
19294
19295 Unlike most options, &%headers_remove%& can be specified multiple times
19296 for a router; all listed headers are removed.
19297
19298 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19299 router that has the &%one_time%& option set.
19300
19301 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19302 removal requests are deleted when the address is passed on to subsequent
19303 routers, and this can lead to problems with duplicates -- see the similar
19304 warning for &%headers_add%& above.
19305
19306 &*Warning 3*&: Because of the separate expansion of the list items,
19307 items that contain a list separator must have it doubled.
19308 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19309
19310
19311
19312 .option ignore_target_hosts routers "host list&!!" unset
19313 .cindex "IP address" "discarding"
19314 .cindex "router" "discarding IP addresses"
19315 Although this option is a host list, it should normally contain IP address
19316 entries rather than names. If any host that is looked up by the router has an
19317 IP address that matches an item in this list, Exim behaves as if that IP
19318 address did not exist. This option allows you to cope with rogue DNS entries
19319 like
19320 .code
19321 remote.domain.example.  A  127.0.0.1
19322 .endd
19323 by setting
19324 .code
19325 ignore_target_hosts = 127.0.0.1
19326 .endd
19327 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19328 discarded in this way, the router declines. In a conventional configuration, an
19329 attempt to mail to such a domain would normally provoke the &"unrouteable
19330 domain"& error, and an attempt to verify an address in the domain would fail.
19331 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19332 router declines if presented with one of the listed addresses.
19333
19334 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19335 means of the first or the second of the following settings, respectively:
19336 .code
19337 ignore_target_hosts = 0.0.0.0/0
19338 ignore_target_hosts = <; 0::0/0
19339 .endd
19340 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19341 in the second line matches all IPv6 addresses.
19342
19343 This option may also be useful for ignoring link-local and site-local IPv6
19344 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19345 is expanded before use as a list, it is possible to make it dependent on the
19346 domain that is being routed.
19347
19348 .vindex "&$host_address$&"
19349 During its expansion, &$host_address$& is set to the IP address that is being
19350 checked.
19351
19352 .option initgroups routers boolean false
19353 .cindex "additional groups"
19354 .cindex "groups" "additional"
19355 .cindex "local transports" "uid and gid"
19356 .cindex "transport" "local"
19357 If the router queues an address for a transport, and this option is true, and
19358 the uid supplied by the router is not overridden by the transport, the
19359 &[initgroups()]& function is called when running the transport to ensure that
19360 any additional groups associated with the uid are set up. See also &%group%&
19361 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19362
19363
19364
19365 .option local_part_prefix routers&!? "string list" unset
19366 .cindex affix "router precondition"
19367 .cindex "router" "prefix for local part"
19368 .cindex "prefix" "for local part, used in router"
19369 If this option is set, the router is skipped unless the local part starts with
19370 one of the given strings, or &%local_part_prefix_optional%& is true. See
19371 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19372 evaluated.
19373
19374 The list is scanned from left to right, and the first prefix that matches is
19375 used. A limited form of wildcard is available; if the prefix begins with an
19376 asterisk, it matches the longest possible sequence of arbitrary characters at
19377 the start of the local part. An asterisk should therefore always be followed by
19378 some character that does not occur in normal local parts.
19379 .cindex "multiple mailboxes"
19380 .cindex "mailbox" "multiple"
19381 Wildcarding can be used to set up multiple user mailboxes, as described in
19382 section &<<SECTmulbox>>&.
19383
19384 .vindex "&$local_part$&"
19385 .vindex "&$local_part_prefix$&"
19386 During the testing of the &%local_parts%& option, and while the router is
19387 running, the prefix is removed from the local part, and is available in the
19388 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19389 the router accepts the address, this remains true during subsequent delivery by
19390 a transport. In particular, the local part that is transmitted in the RCPT
19391 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19392 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19393 the relevant transport.
19394
19395 .vindex &$local_part_prefix_v$&
19396 If wildcarding (above) was used then the part of the prefix matching the
19397 wildcard is available in &$local_part_prefix_v$&.
19398
19399 When an address is being verified, &%local_part_prefix%& affects only the
19400 behaviour of the router. If the callout feature of verification is in use, this
19401 means that the full address, including the prefix, will be used during the
19402 callout.
19403
19404 The prefix facility is commonly used to handle local parts of the form
19405 &%owner-something%&. Another common use is to support local parts of the form
19406 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19407 to tell a user their forwarding is broken &-- by placing a router like this one
19408 immediately before the router that handles &_.forward_& files:
19409 .code
19410 real_localuser:
19411   driver = accept
19412   local_part_prefix = real-
19413   check_local_user
19414   transport = local_delivery
19415 .endd
19416 For security, it would probably be a good idea to restrict the use of this
19417 router to locally-generated messages, using a condition such as this:
19418 .code
19419   condition = ${if match {$sender_host_address}\
19420                          {\N^(|127\.0\.0\.1)$\N}}
19421 .endd
19422
19423 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19424 both conditions must be met if not optional. Care must be taken if wildcards
19425 are used in both a prefix and a suffix on the same router. Different
19426 separator characters must be used to avoid ambiguity.
19427
19428
19429 .option local_part_prefix_optional routers boolean false
19430 See &%local_part_prefix%& above.
19431
19432
19433
19434 .option local_part_suffix routers&!? "string list" unset
19435 .cindex "router" "suffix for local part"
19436 .cindex "suffix for local part" "used in router"
19437 This option operates in the same way as &%local_part_prefix%&, except that the
19438 local part must end (rather than start) with the given string, the
19439 &%local_part_suffix_optional%& option determines whether the suffix is
19440 mandatory, and the wildcard * character, if present, must be the last
19441 character of the suffix. This option facility is commonly used to handle local
19442 parts of the form &%something-request%& and multiple user mailboxes of the form
19443 &%username-foo%&.
19444
19445
19446 .option local_part_suffix_optional routers boolean false
19447 See &%local_part_suffix%& above.
19448
19449
19450
19451 .option local_parts routers&!? "local part list&!!" unset
19452 .cindex "router" "restricting to specific local parts"
19453 .cindex "local part" "checking in router"
19454 The router is run only if the local part of the address matches the list.
19455 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19456 are evaluated, and
19457 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19458 string is expanded, it is possible to make it depend on the domain, for
19459 example:
19460 .code
19461 local_parts = dbm;/usr/local/specials/$domain_data
19462 .endd
19463 .vindex "&$local_part_data$&"
19464 If the match is achieved by a lookup, the data that the lookup returned
19465 for the local part is placed in the variable &$local_part_data$& for use in
19466 expansions of the router's private options or in the transport.
19467 You might use this option, for
19468 example, if you have a large number of local virtual domains, and you want to
19469 send all postmaster mail to the same place without having to set up an alias in
19470 each virtual domain:
19471 .code
19472 postmaster:
19473   driver = redirect
19474   local_parts = postmaster
19475   data = postmaster@real.domain.example
19476 .endd
19477
19478
19479 .option log_as_local routers boolean "see below"
19480 .cindex "log" "delivery line"
19481 .cindex "delivery" "log line format"
19482 Exim has two logging styles for delivery, the idea being to make local
19483 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19484 recipient address is given just as the local part, without a domain. The use of
19485 this style is controlled by this option. It defaults to true for the &(accept)&
19486 router, and false for all the others. This option applies only when a
19487 router assigns an address to a transport. It has no effect on routers that
19488 redirect addresses.
19489
19490
19491
19492 .option more routers boolean&!! true
19493 The result of string expansion for this option must be a valid boolean value,
19494 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19495 result causes an error, and delivery is deferred. If the expansion is forced to
19496 fail, the default value for the option (true) is used. Other failures cause
19497 delivery to be deferred.
19498
19499 If this option is set false, and the router declines to handle the address, no
19500 further routers are tried, routing fails, and the address is bounced.
19501 .oindex "&%self%&"
19502 However, if the router explicitly passes an address to the following router by
19503 means of the setting
19504 .code
19505 self = pass
19506 .endd
19507 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19508 does not affect the behaviour if one of the precondition tests fails. In that
19509 case, the address is always passed to the next router.
19510
19511 Note that &%address_data%& is not considered to be a precondition. If its
19512 expansion is forced to fail, the router declines, and the value of &%more%&
19513 controls what happens next.
19514
19515
19516 .option pass_on_timeout routers boolean false
19517 .cindex "timeout" "of router"
19518 .cindex "router" "timeout"
19519 If a router times out during a host lookup, it normally causes deferral of the
19520 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19521 router, overriding &%no_more%&. This may be helpful for systems that are
19522 intermittently connected to the Internet, or those that want to pass to a smart
19523 host any messages that cannot immediately be delivered.
19524
19525 There are occasional other temporary errors that can occur while doing DNS
19526 lookups. They are treated in the same way as a timeout, and this option
19527 applies to all of them.
19528
19529
19530
19531 .option pass_router routers string unset
19532 .cindex "router" "go to after &""pass""&"
19533 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19534 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19535 routing to continue, and overriding a false setting of &%more%&. When one of
19536 these routers returns &"pass"&, the address is normally handed on to the next
19537 router in sequence. This can be changed by setting &%pass_router%& to the name
19538 of another router. However (unlike &%redirect_router%&) the named router must
19539 be below the current router, to avoid loops. Note that this option applies only
19540 to the special case of &"pass"&. It does not apply when a router returns
19541 &"decline"& because it cannot handle an address.
19542
19543
19544
19545 .option redirect_router routers string unset
19546 .cindex "router" "start at after redirection"
19547 Sometimes an administrator knows that it is pointless to reprocess addresses
19548 generated from alias or forward files with the same router again. For
19549 example, if an alias file translates real names into login ids there is no
19550 point searching the alias file a second time, especially if it is a large file.
19551
19552 The &%redirect_router%& option can be set to the name of any router instance.
19553 It causes the routing of any generated addresses to start at the named router
19554 instead of at the first router. This option has no effect if the router in
19555 which it is set does not generate new addresses.
19556
19557
19558
19559 .option require_files routers&!? "string list&!!" unset
19560 .cindex "file" "requiring for router"
19561 .cindex "router" "requiring file existence"
19562 This option provides a general mechanism for predicating the running of a
19563 router on the existence or non-existence of certain files or directories.
19564 Before running a router, as one of its precondition tests, Exim works its way
19565 through the &%require_files%& list, expanding each item separately.
19566
19567 Because the list is split before expansion, any colons in expansion items must
19568 be doubled, or the facility for using a different list separator must be used
19569 (&<<SECTlistsepchange>>&).
19570 If any expansion is forced to fail, the item is ignored. Other expansion
19571 failures cause routing of the address to be deferred.
19572
19573 If any expanded string is empty, it is ignored. Otherwise, except as described
19574 below, each string must be a fully qualified file path, optionally preceded by
19575 &"!"&. The paths are passed to the &[stat()]& function to test for the
19576 existence of the files or directories. The router is skipped if any paths not
19577 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19578
19579 .cindex "NFS"
19580 If &[stat()]& cannot determine whether a file exists or not, delivery of
19581 the message is deferred. This can happen when NFS-mounted filesystems are
19582 unavailable.
19583
19584 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19585 options, so you cannot use it to check for the existence of a file in which to
19586 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19587 full list of the order in which preconditions are evaluated.) However, as
19588 these options are all expanded, you can use the &%exists%& expansion condition
19589 to make such tests. The &%require_files%& option is intended for checking files
19590 that the router may be going to use internally, or which are needed by a
19591 transport (e.g., &_.procmailrc_&).
19592
19593 During delivery, the &[stat()]& function is run as root, but there is a
19594 facility for some checking of the accessibility of a file by another user.
19595 This is not a proper permissions check, but just a &"rough"& check that
19596 operates as follows:
19597
19598 If an item in a &%require_files%& list does not contain any forward slash
19599 characters, it is taken to be the user (and optional group, separated by a
19600 comma) to be checked for subsequent files in the list. If no group is specified
19601 but the user is specified symbolically, the gid associated with the uid is
19602 used. For example:
19603 .code
19604 require_files = mail:/some/file
19605 require_files = $local_part_data:$home/.procmailrc
19606 .endd
19607 If a user or group name in a &%require_files%& list does not exist, the
19608 &%require_files%& condition fails.
19609
19610 Exim performs the check by scanning along the components of the file path, and
19611 checking the access for the given uid and gid. It checks for &"x"& access on
19612 directories, and &"r"& access on the final file. Note that this means that file
19613 access control lists, if the operating system has them, are ignored.
19614
19615 &*Warning 1*&: When the router is being run to verify addresses for an
19616 incoming SMTP message, Exim is not running as root, but under its own uid. This
19617 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19618 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19619 user is not permitted to read one of the directories on the file's path.
19620
19621 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19622 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19623 without root access. In this case, if a check for access by a particular user
19624 is requested, Exim creates a subprocess that runs as that user, and tries the
19625 check again in that process.
19626
19627 The default action for handling an unresolved EACCES is to consider it to
19628 be caused by a configuration error, and routing is deferred because the
19629 existence or non-existence of the file cannot be determined. However, in some
19630 circumstances it may be desirable to treat this condition as if the file did
19631 not exist. If the filename (or the exclamation mark that precedes the filename
19632 for non-existence) is preceded by a plus sign, the EACCES error is treated
19633 as if the file did not exist. For example:
19634 .code
19635 require_files = +/some/file
19636 .endd
19637 If the router is not an essential part of verification (for example, it
19638 handles users' &_.forward_& files), another solution is to set the &%verify%&
19639 option false so that the router is skipped when verifying.
19640
19641
19642
19643 .option retry_use_local_part routers boolean "see below"
19644 .cindex "hints database" "retry keys"
19645 .cindex "local part" "in retry keys"
19646 When a delivery suffers a temporary routing failure, a retry record is created
19647 in Exim's hints database. For addresses whose routing depends only on the
19648 domain, the key for the retry record should not involve the local part, but for
19649 other addresses, both the domain and the local part should be included.
19650 Usually, remote routing is of the former kind, and local routing is of the
19651 latter kind.
19652
19653 This option controls whether the local part is used to form the key for retry
19654 hints for addresses that suffer temporary errors while being handled by this
19655 router. The default value is true for any router that has any of
19656 &%check_local_user%&,
19657 &%local_parts%&,
19658 &%condition%&,
19659 &%local_part_prefix%&,
19660 &%local_part_suffix%&,
19661 &%senders%& or
19662 &%require_files%&
19663 set, and false otherwise. Note that this option does not apply to hints keys
19664 for transport delays; they are controlled by a generic transport option of the
19665 same name.
19666
19667 Failing to set this option when it is needed
19668 (because a remote router handles only some of the local-parts for a domain)
19669 can result in incorrect error messages being generated.
19670
19671 The setting of &%retry_use_local_part%& applies only to the router on which it
19672 appears. If the router generates child addresses, they are routed
19673 independently; this setting does not become attached to them.
19674
19675
19676
19677 .option router_home_directory routers string&!! unset
19678 .cindex "router" "home directory for"
19679 .cindex "home directory" "for router"
19680 .vindex "&$home$&"
19681 This option sets a home directory for use while the router is running. (Compare
19682 &%transport_home_directory%&, which sets a home directory for later
19683 transporting.) In particular, if used on a &(redirect)& router, this option
19684 sets a value for &$home$& while a filter is running. The value is expanded;
19685 forced expansion failure causes the option to be ignored &-- other failures
19686 cause the router to defer.
19687
19688 Expansion of &%router_home_directory%& happens immediately after the
19689 &%check_local_user%& test (if configured), before any further expansions take
19690 place.
19691 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19692 are evaluated.)
19693 While the router is running, &%router_home_directory%& overrides the value of
19694 &$home$& that came from &%check_local_user%&.
19695
19696 When a router accepts an address and assigns it to a local transport (including
19697 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19698 delivery), the home directory setting for the transport is taken from the first
19699 of these values that is set:
19700
19701 .ilist
19702 The &%home_directory%& option on the transport;
19703 .next
19704 The &%transport_home_directory%& option on the router;
19705 .next
19706 The password data if &%check_local_user%& is set on the router;
19707 .next
19708 The &%router_home_directory%& option on the router.
19709 .endlist
19710
19711 In other words, &%router_home_directory%& overrides the password data for the
19712 router, but not for the transport.
19713
19714
19715
19716 .option self routers string freeze
19717 .cindex "MX record" "pointing to local host"
19718 .cindex "local host" "MX pointing to"
19719 This option applies to those routers that use a recipient address to find a
19720 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19721 and &(manualroute)& routers.
19722 Certain configurations of the &(queryprogram)& router can also specify a list
19723 of remote hosts.
19724 Usually such routers are configured to send the message to a remote host via an
19725 &(smtp)& transport. The &%self%& option specifies what happens when the first
19726 host on the list turns out to be the local host.
19727 The way in which Exim checks for the local host is described in section
19728 &<<SECTreclocipadd>>&.
19729
19730 Normally this situation indicates either an error in Exim's configuration (for
19731 example, the router should be configured not to process this domain), or an
19732 error in the DNS (for example, the MX should not point to this host). For this
19733 reason, the default action is to log the incident, defer the address, and
19734 freeze the message. The following alternatives are provided for use in special
19735 cases:
19736
19737 .vlist
19738 .vitem &%defer%&
19739 Delivery of the message is tried again later, but the message is not frozen.
19740
19741 .vitem "&%reroute%&: <&'domain'&>"
19742 The domain is changed to the given domain, and the address is passed back to
19743 be reprocessed by the routers. No rewriting of headers takes place. This
19744 behaviour is essentially a redirection.
19745
19746 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19747 The domain is changed to the given domain, and the address is passed back to be
19748 reprocessed by the routers. Any headers that contain the original domain are
19749 rewritten.
19750
19751 .vitem &%pass%&
19752 .oindex "&%more%&"
19753 .vindex "&$self_hostname$&"
19754 The router passes the address to the next router, or to the router named in the
19755 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19756 subsequent routing and delivery, the variable &$self_hostname$& contains the
19757 name of the local host that the router encountered. This can be used to
19758 distinguish between different cases for hosts with multiple names. The
19759 combination
19760 .code
19761 self = pass
19762 no_more
19763 .endd
19764 ensures that only those addresses that routed to the local host are passed on.
19765 Without &%no_more%&, addresses that were declined for other reasons would also
19766 be passed to the next router.
19767
19768 .vitem &%fail%&
19769 Delivery fails and an error report is generated.
19770
19771 .vitem &%send%&
19772 .cindex "local host" "sending to"
19773 The anomaly is ignored and the address is queued for the transport. This
19774 setting should be used with extreme caution. For an &(smtp)& transport, it
19775 makes sense only in cases where the program that is listening on the SMTP port
19776 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19777 different configuration file that handles the domain in another way.
19778 .endlist
19779
19780
19781
19782 .option senders routers&!? "address list&!!" unset
19783 .cindex "router" "checking senders"
19784 If this option is set, the router is skipped unless the message's sender
19785 address matches something on the list.
19786 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19787 are evaluated.
19788
19789 There are issues concerning verification when the running of routers is
19790 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19791 setting, it sets the sender to the null string. When using the &%-bt%& option
19792 to check a configuration file, it is necessary also to use the &%-f%& option to
19793 set an appropriate sender. For incoming mail, the sender is unset when
19794 verifying the sender, but is available when verifying any recipients. If the
19795 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19796 matters.
19797
19798
19799 .option set routers "string list" unset
19800 .cindex router variables
19801 This option may be used multiple times on a router;
19802 because of this the list aspect is mostly irrelevant.
19803 The list separator is a semicolon but can be changed in the
19804 usual way.
19805
19806 Each list-element given must be of the form &"name = value"&
19807 and the names used must start with the string &"r_"&.
19808 Values containing a list-separator should have them doubled.
19809 When a router runs, the strings are evaluated in order,
19810 to create variables which are added to the set associated with
19811 the address.
19812 This is done immediately after all the preconditions, before the
19813 evaluation of the &%address_data%& option.
19814 The variable is set with the expansion of the value.
19815 The variables can be used by the router options
19816 (not including any preconditions)
19817 and by the transport.
19818 Later definitions of a given named variable will override former ones.
19819 Variable use is via the usual &$r_...$& syntax.
19820
19821 This is similar to the &%address_data%& option, except that
19822 many independent variables can be used, with choice of naming.
19823
19824
19825 .option translate_ip_address routers string&!! unset
19826 .cindex "IP address" "translating"
19827 .cindex "packet radio"
19828 .cindex "router" "IP address translation"
19829 There exist some rare networking situations (for example, packet radio) where
19830 it is helpful to be able to translate IP addresses generated by normal routing
19831 mechanisms into other IP addresses, thus performing a kind of manual IP
19832 routing. This should be done only if the normal IP routing of the TCP/IP stack
19833 is inadequate or broken. Because this is an extremely uncommon requirement, the
19834 code to support this option is not included in the Exim binary unless
19835 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19836
19837 .vindex "&$host_address$&"
19838 The &%translate_ip_address%& string is expanded for every IP address generated
19839 by the router, with the generated address set in &$host_address$&. If the
19840 expansion is forced to fail, no action is taken.
19841 For any other expansion error, delivery of the message is deferred.
19842 If the result of the expansion is an IP address, that replaces the original
19843 address; otherwise the result is assumed to be a host name &-- this is looked
19844 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19845 produce one or more replacement IP addresses. For example, to subvert all IP
19846 addresses in some specific networks, this could be added to a router:
19847 .code
19848 translate_ip_address = \
19849   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19850     {$value}fail}}
19851 .endd
19852 The file would contain lines like
19853 .code
19854 10.2.3.128/26    some.host
19855 10.8.4.34/26     10.44.8.15
19856 .endd
19857 You should not make use of this facility unless you really understand what you
19858 are doing.
19859
19860
19861
19862 .option transport routers string&!! unset
19863 This option specifies the transport to be used when a router accepts an address
19864 and sets it up for delivery. A transport is never needed if a router is used
19865 only for verification. The value of the option is expanded at routing time,
19866 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19867 and result must be the name of one of the configured transports. If it is not,
19868 delivery is deferred.
19869
19870 The &%transport%& option is not used by the &(redirect)& router, but it does
19871 have some private options that set up transports for pipe and file deliveries
19872 (see chapter &<<CHAPredirect>>&).
19873
19874
19875
19876 .option transport_current_directory routers string&!! unset
19877 .cindex "current directory for local transport"
19878 This option associates a current directory with any address that is routed
19879 to a local transport. This can happen either because a transport is
19880 explicitly configured for the router, or because it generates a delivery to a
19881 file or a pipe. During the delivery process (that is, at transport time), this
19882 option string is expanded and is set as the current directory, unless
19883 overridden by a setting on the transport.
19884 If the expansion fails for any reason, including forced failure, an error is
19885 logged, and delivery is deferred.
19886 See chapter &<<CHAPenvironment>>& for details of the local delivery
19887 environment.
19888
19889
19890
19891
19892 .option transport_home_directory routers string&!! "see below"
19893 .cindex "home directory" "for local transport"
19894 This option associates a home directory with any address that is routed to a
19895 local transport. This can happen either because a transport is explicitly
19896 configured for the router, or because it generates a delivery to a file or a
19897 pipe. During the delivery process (that is, at transport time), the option
19898 string is expanded and is set as the home directory, unless overridden by a
19899 setting of &%home_directory%& on the transport.
19900 If the expansion fails for any reason, including forced failure, an error is
19901 logged, and delivery is deferred.
19902
19903 If the transport does not specify a home directory, and
19904 &%transport_home_directory%& is not set for the router, the home directory for
19905 the transport is taken from the password data if &%check_local_user%& is set for
19906 the router. Otherwise it is taken from &%router_home_directory%& if that option
19907 is set; if not, no home directory is set for the transport.
19908
19909 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19910 environment.
19911
19912
19913
19914
19915 .option unseen routers boolean&!! false
19916 .cindex "router" "carrying on after success"
19917 The result of string expansion for this option must be a valid boolean value,
19918 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19919 result causes an error, and delivery is deferred. If the expansion is forced to
19920 fail, the default value for the option (false) is used. Other failures cause
19921 delivery to be deferred.
19922
19923 When this option is set true, routing does not cease if the router accepts the
19924 address. Instead, a copy of the incoming address is passed to the next router,
19925 overriding a false setting of &%more%&. There is little point in setting
19926 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19927 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19928 sometimes true and sometimes false).
19929
19930 .cindex "copy of message (&%unseen%& option)"
19931 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19932 qualifier in filter files. It can be used to cause copies of messages to be
19933 delivered to some other destination, while also carrying out a normal delivery.
19934 In effect, the current address is made into a &"parent"& that has two children
19935 &-- one that is delivered as specified by this router, and a clone that goes on
19936 to be routed further. For this reason, &%unseen%& may not be combined with the
19937 &%one_time%& option in a &(redirect)& router.
19938
19939 &*Warning*&: Header lines added to the address (or specified for removal) by
19940 this router or by previous routers affect the &"unseen"& copy of the message
19941 only. The clone that continues to be processed by further routers starts with
19942 no added headers and none specified for removal. For a &%redirect%& router, if
19943 a generated address is the same as the incoming address, this can lead to
19944 duplicate addresses with different header modifications. Exim does not do
19945 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19946 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19947 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19948 &%redirect%& router may be of help.
19949
19950 Unlike the handling of header modifications, any data that was set by the
19951 &%address_data%& option in the current or previous routers &'is'& passed on to
19952 subsequent routers.
19953
19954
19955 .option user routers string&!! "see below"
19956 .cindex "uid (user id)" "local delivery"
19957 .cindex "local transports" "uid and gid"
19958 .cindex "transport" "local"
19959 .cindex "router" "user for filter processing"
19960 .cindex "filter" "user for processing"
19961 When a router queues an address for a transport, and the transport does not
19962 specify a user, the user given here is used when running the delivery process.
19963 The user may be specified numerically or by name. If expansion fails, the
19964 error is logged and delivery is deferred.
19965 This user is also used by the &(redirect)& router when running a filter file.
19966 The default is unset, except when &%check_local_user%& is set. In this case,
19967 the default is taken from the password information. If the user is specified as
19968 a name, and &%group%& is not set, the group associated with the user is used.
19969 See also &%initgroups%& and &%group%& and the discussion in chapter
19970 &<<CHAPenvironment>>&.
19971
19972
19973
19974 .option verify routers&!? boolean true
19975 Setting this option has the effect of setting &%verify_sender%& and
19976 &%verify_recipient%& to the same value.
19977
19978
19979 .option verify_only routers&!? boolean false
19980 .cindex "EXPN" "with &%verify_only%&"
19981 .oindex "&%-bv%&"
19982 .cindex "router" "used only when verifying"
19983 If this option is set, the router is used only when verifying an address,
19984 delivering in cutthrough mode or
19985 testing with the &%-bv%& option, not when actually doing a delivery, testing
19986 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19987 restricted to verifying only senders or recipients by means of
19988 &%verify_sender%& and &%verify_recipient%&.
19989
19990 &*Warning*&: When the router is being run to verify addresses for an incoming
19991 SMTP message, Exim is not running as root, but under its own uid. If the router
19992 accesses any files, you need to make sure that they are accessible to the Exim
19993 user or group.
19994
19995
19996 .option verify_recipient routers&!? boolean true
19997 If this option is false, the router is skipped when verifying recipient
19998 addresses,
19999 delivering in cutthrough mode
20000 or testing recipient verification using &%-bv%&.
20001 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20002 are evaluated.
20003 See also the &$verify_mode$& variable.
20004
20005
20006 .option verify_sender routers&!? boolean true
20007 If this option is false, the router is skipped when verifying sender addresses
20008 or testing sender verification using &%-bvs%&.
20009 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20010 are evaluated.
20011 See also the &$verify_mode$& variable.
20012 .ecindex IIDgenoprou1
20013 .ecindex IIDgenoprou2
20014
20015
20016
20017
20018
20019
20020 . ////////////////////////////////////////////////////////////////////////////
20021 . ////////////////////////////////////////////////////////////////////////////
20022
20023 .chapter "The accept router" "CHID4"
20024 .cindex "&(accept)& router"
20025 .cindex "routers" "&(accept)&"
20026 The &(accept)& router has no private options of its own. Unless it is being
20027 used purely for verification (see &%verify_only%&) a transport is required to
20028 be defined by the generic &%transport%& option. If the preconditions that are
20029 specified by generic options are met, the router accepts the address and queues
20030 it for the given transport. The most common use of this router is for setting
20031 up deliveries to local mailboxes. For example:
20032 .code
20033 localusers:
20034   driver = accept
20035   domains = mydomain.example
20036   check_local_user
20037   transport = local_delivery
20038 .endd
20039 The &%domains%& condition in this example checks the domain of the address, and
20040 &%check_local_user%& checks that the local part is the login of a local user.
20041 When both preconditions are met, the &(accept)& router runs, and queues the
20042 address for the &(local_delivery)& transport.
20043
20044
20045
20046
20047
20048
20049 . ////////////////////////////////////////////////////////////////////////////
20050 . ////////////////////////////////////////////////////////////////////////////
20051
20052 .chapter "The dnslookup router" "CHAPdnslookup"
20053 .scindex IIDdnsrou1 "&(dnslookup)& router"
20054 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20055 The &(dnslookup)& router looks up the hosts that handle mail for the
20056 recipient's domain in the DNS. A transport must always be set for this router,
20057 unless &%verify_only%& is set.
20058
20059 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20060 SRV records. If none are found, or if SRV support is not configured,
20061 MX records are looked up. If no MX records exist, address records are sought.
20062 However, &%mx_domains%& can be set to disable the direct use of address
20063 records.
20064
20065 MX records of equal priority are sorted by Exim into a random order. Exim then
20066 looks for address records for the host names obtained from MX or SRV records.
20067 When a host has more than one IP address, they are sorted into a random order,
20068 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20069 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20070 generic option, the router declines.
20071
20072 Unless they have the highest priority (lowest MX value), MX records that point
20073 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20074 are discarded, together with any other MX records of equal or lower priority.
20075
20076 .cindex "MX record" "pointing to local host"
20077 .cindex "local host" "MX pointing to"
20078 .oindex "&%self%&" "in &(dnslookup)& router"
20079 If the host pointed to by the highest priority MX record, or looked up as an
20080 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20081 happens is controlled by the generic &%self%& option.
20082
20083
20084 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20085 There have been problems with DNS servers when SRV records are looked up.
20086 Some misbehaving servers return a DNS error or timeout when a non-existent
20087 SRV record is sought. Similar problems have in the past been reported for
20088 MX records. The global &%dns_again_means_nonexist%& option can help with this
20089 problem, but it is heavy-handed because it is a global option.
20090
20091 For this reason, there are two options, &%srv_fail_domains%& and
20092 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20093 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20094 an attempt to look up an SRV or MX record causes one of these results, and the
20095 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20096 such record"&. In the case of an SRV lookup, this means that the router
20097 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20098 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20099 case routing fails.
20100
20101
20102 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20103 .cindex "&(dnslookup)& router" "declines"
20104 There are a few cases where a &(dnslookup)& router will decline to accept
20105 an address; if such a router is expected to handle "all remaining non-local
20106 domains", then it is important to set &%no_more%&.
20107
20108 The router will defer rather than decline if the domain
20109 is found in the &%fail_defer_domains%& router option.
20110
20111 Reasons for a &(dnslookup)& router to decline currently include:
20112 .ilist
20113 The domain does not exist in DNS
20114 .next
20115 The domain exists but the MX record's host part is just "."; this is a common
20116 convention (borrowed from SRV) used to indicate that there is no such service
20117 for this domain and to not fall back to trying A/AAAA records.
20118 .next
20119 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20120 .next
20121 MX record points to a non-existent host.
20122 .next
20123 MX record points to an IP address and the main section option
20124 &%allow_mx_to_ip%& is not set.
20125 .next
20126 MX records exist and point to valid hosts, but all hosts resolve only to
20127 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20128 .next
20129 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20130 &%dns_check_names_pattern%& for handling one variant of this)
20131 .next
20132 &%check_secondary_mx%& is set on this router but the local host can
20133 not be found in the MX records (see below)
20134 .endlist
20135
20136
20137
20138
20139 .section "Private options for dnslookup" "SECID118"
20140 .cindex "options" "&(dnslookup)& router"
20141 The private options for the &(dnslookup)& router are as follows:
20142
20143 .option check_secondary_mx dnslookup boolean false
20144 .cindex "MX record" "checking for secondary"
20145 If this option is set, the router declines unless the local host is found in
20146 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20147 process domains for which the local host is a secondary mail exchanger
20148 differently to other domains. The way in which Exim decides whether a host is
20149 the local host is described in section &<<SECTreclocipadd>>&.
20150
20151
20152 .option check_srv dnslookup string&!! unset
20153 .cindex "SRV record" "enabling use of"
20154 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20155 addition to MX and address records. The support is disabled by default. To
20156 enable SRV support, set the &%check_srv%& option to the name of the service
20157 required. For example,
20158 .code
20159 check_srv = smtp
20160 .endd
20161 looks for SRV records that refer to the normal smtp service. The option is
20162 expanded, so the service name can vary from message to message or address
20163 to address. This might be helpful if SRV records are being used for a
20164 submission service. If the expansion is forced to fail, the &%check_srv%&
20165 option is ignored, and the router proceeds to look for MX records in the
20166 normal way.
20167
20168 When the expansion succeeds, the router searches first for SRV records for
20169 the given service (it assumes TCP protocol). A single SRV record with a
20170 host name that consists of just a single dot indicates &"no such service for
20171 this domain"&; if this is encountered, the router declines. If other kinds of
20172 SRV record are found, they are used to construct a host list for delivery
20173 according to the rules of RFC 2782. MX records are not sought in this case.
20174
20175 When no SRV records are found, MX records (and address records) are sought in
20176 the traditional way. In other words, SRV records take precedence over MX
20177 records, just as MX records take precedence over address records. Note that
20178 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20179 defined it. It is apparently believed that MX records are sufficient for email
20180 and that SRV records should not be used for this purpose. However, SRV records
20181 have an additional &"weight"& feature which some people might find useful when
20182 trying to split an SMTP load between hosts of different power.
20183
20184 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20185 when there is a DNS lookup error.
20186
20187
20188
20189
20190 .option fail_defer_domains dnslookup "domain list&!!" unset
20191 .cindex "MX record" "not found"
20192 DNS lookups for domains matching &%fail_defer_domains%&
20193 which find no matching record will cause the router to defer
20194 rather than the default behaviour of decline.
20195 This maybe be useful for queueing messages for a newly created
20196 domain while the DNS configuration is not ready.
20197 However, it will result in any message with mistyped domains
20198 also being queued.
20199
20200
20201 .option ipv4_only "string&!!" unset
20202 .cindex IPv6 disabling
20203 .cindex DNS "IPv6 disabling"
20204 The string is expanded, and if the result is anything but a forced failure,
20205 or an empty string, or one of the strings “0” or “no” or “false”
20206 (checked without regard to the case of the letters),
20207 only A records are used.
20208
20209 .option ipv4_prefer "string&!!" unset
20210 .cindex IPv4 preference
20211 .cindex DNS "IPv4 preference"
20212 The string is expanded, and if the result is anything but a forced failure,
20213 or an empty string, or one of the strings “0” or “no” or “false”
20214 (checked without regard to the case of the letters),
20215 A records are sorted before AAAA records (inverting the default).
20216
20217 .option mx_domains dnslookup "domain list&!!" unset
20218 .cindex "MX record" "required to exist"
20219 .cindex "SRV record" "required to exist"
20220 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20221 record in order to be recognized. (The name of this option could be improved.)
20222 For example, if all the mail hosts in &'fict.example'& are known to have MX
20223 records, except for those in &'discworld.fict.example'&, you could use this
20224 setting:
20225 .code
20226 mx_domains = ! *.discworld.fict.example : *.fict.example
20227 .endd
20228 This specifies that messages addressed to a domain that matches the list but
20229 has no MX record should be bounced immediately instead of being routed using
20230 the address record.
20231
20232
20233 .option mx_fail_domains dnslookup "domain list&!!" unset
20234 If the DNS lookup for MX records for one of the domains in this list causes a
20235 DNS lookup error, Exim behaves as if no MX records were found. See section
20236 &<<SECTprowitdnsloo>>& for more discussion.
20237
20238
20239
20240
20241 .option qualify_single dnslookup boolean true
20242 .cindex "DNS" "resolver options"
20243 .cindex "DNS" "qualifying single-component names"
20244 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20245 lookups. Typically, but not standardly, this causes the resolver to qualify
20246 single-component names with the default domain. For example, on a machine
20247 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20248 &'thesaurus.ref.example'& inside the resolver. For details of what your
20249 resolver actually does, consult your man pages for &'resolver'& and
20250 &'resolv.conf'&.
20251
20252
20253
20254 .option rewrite_headers dnslookup boolean true
20255 .cindex "rewriting" "header lines"
20256 .cindex "header lines" "rewriting"
20257 If the domain name in the address that is being processed is not fully
20258 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20259 an address is specified as &'dormouse@teaparty'&, the domain might be
20260 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20261 occur as a result of setting the &%widen_domains%& option. If
20262 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20263 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20264 header lines of the message are rewritten with the full domain name.
20265
20266 This option should be turned off only when it is known that no message is
20267 ever going to be sent outside an environment where the abbreviation makes
20268 sense.
20269
20270 When an MX record is looked up in the DNS and matches a wildcard record, name
20271 servers normally return a record containing the name that has been looked up,
20272 making it impossible to detect whether a wildcard was present or not. However,
20273 some name servers have recently been seen to return the wildcard entry. If the
20274 name returned by a DNS lookup begins with an asterisk, it is not used for
20275 header rewriting.
20276
20277
20278 .option same_domain_copy_routing dnslookup boolean false
20279 .cindex "address" "copying routing"
20280 Addresses with the same domain are normally routed by the &(dnslookup)& router
20281 to the same list of hosts. However, this cannot be presumed, because the router
20282 options and preconditions may refer to the local part of the address. By
20283 default, therefore, Exim routes each address in a message independently. DNS
20284 servers run caches, so repeated DNS lookups are not normally expensive, and in
20285 any case, personal messages rarely have more than a few recipients.
20286
20287 If you are running mailing lists with large numbers of subscribers at the same
20288 domain, and you are using a &(dnslookup)& router which is independent of the
20289 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20290 lookups for identical domains in one message. In this case, when &(dnslookup)&
20291 routes an address to a remote transport, any other unrouted addresses in the
20292 message that have the same domain are automatically given the same routing
20293 without processing them independently,
20294 provided the following conditions are met:
20295
20296 .ilist
20297 No router that processed the address specified &%headers_add%& or
20298 &%headers_remove%&.
20299 .next
20300 The router did not change the address in any way, for example, by &"widening"&
20301 the domain.
20302 .endlist
20303
20304
20305
20306
20307 .option search_parents dnslookup boolean false
20308 .cindex "DNS" "resolver options"
20309 When this option is true, the resolver option RES_DNSRCH is set for DNS
20310 lookups. This is different from the &%qualify_single%& option in that it
20311 applies to domains containing dots. Typically, but not standardly, it causes
20312 the resolver to search for the name in the current domain and in parent
20313 domains. For example, on a machine in the &'fict.example'& domain, if looking
20314 up &'teaparty.wonderland'& failed, the resolver would try
20315 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20316 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20317
20318 Setting this option true can cause problems in domains that have a wildcard MX
20319 record, because any domain that does not have its own MX record matches the
20320 local wildcard.
20321
20322
20323
20324 .option srv_fail_domains dnslookup "domain list&!!" unset
20325 If the DNS lookup for SRV records for one of the domains in this list causes a
20326 DNS lookup error, Exim behaves as if no SRV records were found. See section
20327 &<<SECTprowitdnsloo>>& for more discussion.
20328
20329
20330
20331
20332 .option widen_domains dnslookup "string list" unset
20333 .cindex "domain" "partial; widening"
20334 If a DNS lookup fails and this option is set, each of its strings in turn is
20335 added onto the end of the domain, and the lookup is tried again. For example,
20336 if
20337 .code
20338 widen_domains = fict.example:ref.example
20339 .endd
20340 is set and a lookup of &'klingon.dictionary'& fails,
20341 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20342 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20343 and &%search_parents%& options can cause some widening to be undertaken inside
20344 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20345 when verifying, unless &%rewrite_headers%& is false (not the default).
20346
20347
20348 .section "Effect of qualify_single and search_parents" "SECID119"
20349 When a domain from an envelope recipient is changed by the resolver as a result
20350 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20351 corresponding address in the message's header lines unless &%rewrite_headers%&
20352 is set false. Exim then re-routes the address, using the full domain.
20353
20354 These two options affect only the DNS lookup that takes place inside the router
20355 for the domain of the address that is being routed. They do not affect lookups
20356 such as that implied by
20357 .code
20358 domains = @mx_any
20359 .endd
20360 that may happen while processing a router precondition before the router is
20361 entered. No widening ever takes place for these lookups.
20362 .ecindex IIDdnsrou1
20363 .ecindex IIDdnsrou2
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373 . ////////////////////////////////////////////////////////////////////////////
20374 . ////////////////////////////////////////////////////////////////////////////
20375
20376 .chapter "The ipliteral router" "CHID5"
20377 .cindex "&(ipliteral)& router"
20378 .cindex "domain literal" "routing"
20379 .cindex "routers" "&(ipliteral)&"
20380 This router has no private options. Unless it is being used purely for
20381 verification (see &%verify_only%&) a transport is required to be defined by the
20382 generic &%transport%& option. The router accepts the address if its domain part
20383 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20384 router handles the address
20385 .code
20386 root@[192.168.1.1]
20387 .endd
20388 by setting up delivery to the host with that IP address. IPv4 domain literals
20389 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20390 are similar, but the address is preceded by &`ipv6:`&. For example:
20391 .code
20392 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20393 .endd
20394 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20395 grounds that sooner or later somebody will try it.
20396
20397 .oindex "&%self%&" "in &(ipliteral)& router"
20398 If the IP address matches something in &%ignore_target_hosts%&, the router
20399 declines. If an IP literal turns out to refer to the local host, the generic
20400 &%self%& option determines what happens.
20401
20402 The RFCs require support for domain literals; however, their use is
20403 controversial in today's Internet. If you want to use this router, you must
20404 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20405 Exim will not recognize the domain literal syntax in addresses.
20406
20407
20408
20409 . ////////////////////////////////////////////////////////////////////////////
20410 . ////////////////////////////////////////////////////////////////////////////
20411
20412 .chapter "The iplookup router" "CHID6"
20413 .cindex "&(iplookup)& router"
20414 .cindex "routers" "&(iplookup)&"
20415 The &(iplookup)& router was written to fulfil a specific requirement in
20416 Cambridge University (which in fact no longer exists). For this reason, it is
20417 not included in the binary of Exim by default. If you want to include it, you
20418 must set
20419 .code
20420 ROUTER_IPLOOKUP=yes
20421 .endd
20422 in your &_Local/Makefile_& configuration file.
20423
20424 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20425 connection to one or more specific hosts. The host can then return the same or
20426 a different address &-- in effect rewriting the recipient address in the
20427 message's envelope. The new address is then passed on to subsequent routers. If
20428 this process fails, the address can be passed on to other routers, or delivery
20429 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20430 must not be specified for it.
20431
20432 .cindex "options" "&(iplookup)& router"
20433 .option hosts iplookup string unset
20434 This option must be supplied. Its value is a colon-separated list of host
20435 names. The hosts are looked up using &[gethostbyname()]&
20436 (or &[getipnodebyname()]& when available)
20437 and are tried in order until one responds to the query. If none respond, what
20438 happens is controlled by &%optional%&.
20439
20440
20441 .option optional iplookup boolean false
20442 If &%optional%& is true, if no response is obtained from any host, the address
20443 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20444 delivery to the address is deferred.
20445
20446
20447 .option port iplookup integer 0
20448 .cindex "port" "&(iplookup)& router"
20449 This option must be supplied. It specifies the port number for the TCP or UDP
20450 call.
20451
20452
20453 .option protocol iplookup string udp
20454 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20455 protocols is to be used.
20456
20457
20458 .option query iplookup string&!! "see below"
20459 This defines the content of the query that is sent to the remote hosts. The
20460 default value is:
20461 .code
20462 $local_part@$domain $local_part@$domain
20463 .endd
20464 The repetition serves as a way of checking that a response is to the correct
20465 query in the default case (see &%response_pattern%& below).
20466
20467
20468 .option reroute iplookup string&!! unset
20469 If this option is not set, the rerouted address is precisely the byte string
20470 returned by the remote host, up to the first white space, if any. If set, the
20471 string is expanded to form the rerouted address. It can include parts matched
20472 in the response by &%response_pattern%& by means of numeric variables such as
20473 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20474 whether or not a pattern is in use. In all cases, the rerouted address must end
20475 up in the form &'local_part@domain'&.
20476
20477
20478 .option response_pattern iplookup string unset
20479 This option can be set to a regular expression that is applied to the string
20480 returned from the remote host. If the pattern does not match the response, the
20481 router declines. If &%response_pattern%& is not set, no checking of the
20482 response is done, unless the query was defaulted, in which case there is a
20483 check that the text returned after the first white space is the original
20484 address. This checks that the answer that has been received is in response to
20485 the correct question. For example, if the response is just a new domain, the
20486 following could be used:
20487 .code
20488 response_pattern = ^([^@]+)$
20489 reroute = $local_part@$1
20490 .endd
20491
20492 .option timeout iplookup time 5s
20493 This specifies the amount of time to wait for a response from the remote
20494 machine. The same timeout is used for the &[connect()]& function for a TCP
20495 call. It does not apply to UDP.
20496
20497
20498
20499
20500 . ////////////////////////////////////////////////////////////////////////////
20501 . ////////////////////////////////////////////////////////////////////////////
20502
20503 .chapter "The manualroute router" "CHID7"
20504 .scindex IIDmanrou1 "&(manualroute)& router"
20505 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20506 .cindex "domain" "manually routing"
20507 The &(manualroute)& router is so-called because it provides a way of manually
20508 routing an address according to its domain. It is mainly used when you want to
20509 route addresses to remote hosts according to your own rules, bypassing the
20510 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20511 route to local transports, a facility that may be useful if you want to save
20512 messages for dial-in hosts in local files.
20513
20514 The &(manualroute)& router compares a list of domain patterns with the domain
20515 it is trying to route. If there is no match, the router declines. Each pattern
20516 has associated with it a list of hosts and some other optional data, which may
20517 include a transport. The combination of a pattern and its data is called a
20518 &"routing rule"&. For patterns that do not have an associated transport, the
20519 generic &%transport%& option must specify a transport, unless the router is
20520 being used purely for verification (see &%verify_only%&).
20521
20522 .vindex "&$host$&"
20523 In the case of verification, matching the domain pattern is sufficient for the
20524 router to accept the address. When actually routing an address for delivery,
20525 an address that matches a domain pattern is queued for the associated
20526 transport. If the transport is not a local one, a host list must be associated
20527 with the pattern; IP addresses are looked up for the hosts, and these are
20528 passed to the transport along with the mail address. For local transports, a
20529 host list is optional. If it is present, it is passed in &$host$& as a single
20530 text string.
20531
20532 The list of routing rules can be provided as an inline string in
20533 &%route_list%&, or the data can be obtained by looking up the domain in a file
20534 or database by setting &%route_data%&. Only one of these settings may appear in
20535 any one instance of &(manualroute)&. The format of routing rules is described
20536 below, following the list of private options.
20537
20538
20539 .section "Private options for manualroute" "SECTprioptman"
20540
20541 .cindex "options" "&(manualroute)& router"
20542 The private options for the &(manualroute)& router are as follows:
20543
20544 .option host_all_ignored manualroute string defer
20545 See &%host_find_failed%&.
20546
20547 .option host_find_failed manualroute string freeze
20548 This option controls what happens when &(manualroute)& tries to find an IP
20549 address for a host, and the host does not exist. The option can be set to one
20550 of the following values:
20551 .code
20552 decline
20553 defer
20554 fail
20555 freeze
20556 ignore
20557 pass
20558 .endd
20559 The default (&"freeze"&) assumes that this state is a serious configuration
20560 error. The difference between &"pass"& and &"decline"& is that the former
20561 forces the address to be passed to the next router (or the router defined by
20562 &%pass_router%&),
20563 .oindex "&%more%&"
20564 overriding &%no_more%&, whereas the latter passes the address to the next
20565 router only if &%more%& is true.
20566
20567 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20568 cannot be found. If all the hosts in the list are ignored, the behaviour is
20569 controlled by the &%host_all_ignored%& option. This takes the same values
20570 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20571
20572 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20573 state; if a host lookup gets a temporary error, delivery is deferred unless the
20574 generic &%pass_on_timeout%& option is set.
20575
20576
20577 .option hosts_randomize manualroute boolean false
20578 .cindex "randomized host list"
20579 .cindex "host" "list of; randomized"
20580 If this option is set, the order of the items in a host list in a routing rule
20581 is randomized each time the list is used, unless an option in the routing rule
20582 overrides (see below). Randomizing the order of a host list can be used to do
20583 crude load sharing. However, if more than one mail address is routed by the
20584 same router to the same host list, the host lists are considered to be the same
20585 (even though they may be randomized into different orders) for the purpose of
20586 deciding whether to batch the deliveries into a single SMTP transaction.
20587
20588 When &%hosts_randomize%& is true, a host list may be split
20589 into groups whose order is separately randomized. This makes it possible to
20590 set up MX-like behaviour. The boundaries between groups are indicated by an
20591 item that is just &`+`& in the host list. For example:
20592 .code
20593 route_list = * host1:host2:host3:+:host4:host5
20594 .endd
20595 The order of the first three hosts and the order of the last two hosts is
20596 randomized for each use, but the first three always end up before the last two.
20597 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20598 randomized host list is passed to an &(smtp)& transport that also has
20599 &%hosts_randomize set%&, the list is not re-randomized.
20600
20601
20602 .option route_data manualroute string&!! unset
20603 If this option is set, it must expand to yield the data part of a routing rule.
20604 Typically, the expansion string includes a lookup based on the domain. For
20605 example:
20606 .code
20607 route_data = ${lookup{$domain}dbm{/etc/routes}}
20608 .endd
20609 If the expansion is forced to fail, or the result is an empty string, the
20610 router declines. Other kinds of expansion failure cause delivery to be
20611 deferred.
20612
20613
20614 .option route_list manualroute "string list" unset
20615 This string is a list of routing rules, in the form defined below. Note that,
20616 unlike most string lists, the items are separated by semicolons. This is so
20617 that they may contain colon-separated host lists.
20618
20619
20620 .option same_domain_copy_routing manualroute boolean false
20621 .cindex "address" "copying routing"
20622 Addresses with the same domain are normally routed by the &(manualroute)&
20623 router to the same list of hosts. However, this cannot be presumed, because the
20624 router options and preconditions may refer to the local part of the address. By
20625 default, therefore, Exim routes each address in a message independently. DNS
20626 servers run caches, so repeated DNS lookups are not normally expensive, and in
20627 any case, personal messages rarely have more than a few recipients.
20628
20629 If you are running mailing lists with large numbers of subscribers at the same
20630 domain, and you are using a &(manualroute)& router which is independent of the
20631 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20632 lookups for identical domains in one message. In this case, when
20633 &(manualroute)& routes an address to a remote transport, any other unrouted
20634 addresses in the message that have the same domain are automatically given the
20635 same routing without processing them independently. However, this is only done
20636 if &%headers_add%& and &%headers_remove%& are unset.
20637
20638
20639
20640
20641 .section "Routing rules in route_list" "SECID120"
20642 The value of &%route_list%& is a string consisting of a sequence of routing
20643 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20644 entered as two semicolons. Alternatively, the list separator can be changed as
20645 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20646 Empty rules are ignored. The format of each rule is
20647 .display
20648 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20649 .endd
20650 The following example contains two rules, each with a simple domain pattern and
20651 no options:
20652 .code
20653 route_list = \
20654   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20655   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20656 .endd
20657 The three parts of a rule are separated by white space. The pattern and the
20658 list of hosts can be enclosed in quotes if necessary, and if they are, the
20659 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20660 single domain pattern, which is the only mandatory item in the rule. The
20661 pattern is in the same format as one item in a domain list (see section
20662 &<<SECTdomainlist>>&),
20663 except that it may not be the name of an interpolated file.
20664 That is, it may be wildcarded, or a regular expression, or a file or database
20665 lookup (with semicolons doubled, because of the use of semicolon as a separator
20666 in a &%route_list%&).
20667
20668 The rules in &%route_list%& are searched in order until one of the patterns
20669 matches the domain that is being routed. The list of hosts and then options are
20670 then used as described below. If there is no match, the router declines. When
20671 &%route_list%& is set, &%route_data%& must not be set.
20672
20673
20674
20675 .section "Routing rules in route_data" "SECID121"
20676 The use of &%route_list%& is convenient when there are only a small number of
20677 routing rules. For larger numbers, it is easier to use a file or database to
20678 hold the routing information, and use the &%route_data%& option instead.
20679 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20680 Most commonly, &%route_data%& is set as a string that contains an
20681 expansion lookup. For example, suppose we place two routing rules in a file
20682 like this:
20683 .code
20684 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20685 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20686 .endd
20687 This data can be accessed by setting
20688 .code
20689 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20690 .endd
20691 Failure of the lookup results in an empty string, causing the router to
20692 decline. However, you do not have to use a lookup in &%route_data%&. The only
20693 requirement is that the result of expanding the string is a list of hosts,
20694 possibly followed by options, separated by white space. The list of hosts must
20695 be enclosed in quotes if it contains white space.
20696
20697
20698
20699
20700 .section "Format of the list of hosts" "SECID122"
20701 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20702 always separately expanded before use. If the expansion fails, the router
20703 declines. The result of the expansion must be a colon-separated list of names
20704 and/or IP addresses, optionally also including ports.
20705 If the list is written with spaces, it must be protected with quotes.
20706 The format of each item
20707 in the list is described in the next section. The list separator can be changed
20708 as described in section &<<SECTlistsepchange>>&.
20709
20710 If the list of hosts was obtained from a &%route_list%& item, the following
20711 variables are set during its expansion:
20712
20713 .ilist
20714 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20715 If the domain was matched against a regular expression, the numeric variables
20716 &$1$&, &$2$&, etc. may be set. For example:
20717 .code
20718 route_list = ^domain(\d+)   host-$1.text.example
20719 .endd
20720 .next
20721 &$0$& is always set to the entire domain.
20722 .next
20723 &$1$& is also set when partial matching is done in a file lookup.
20724
20725 .next
20726 .vindex "&$value$&"
20727 If the pattern that matched the domain was a lookup item, the data that was
20728 looked up is available in the expansion variable &$value$&. For example:
20729 .code
20730 route_list = lsearch;;/some/file.routes  $value
20731 .endd
20732 .endlist
20733
20734 Note the doubling of the semicolon in the pattern that is necessary because
20735 semicolon is the default route list separator.
20736
20737
20738
20739 .section "Format of one host item" "SECTformatonehostitem"
20740 Each item in the list of hosts can be either a host name or an IP address,
20741 optionally with an attached port number, or it can be a single "+"
20742 (see &%hosts_randomize%&).
20743 When no port is given, an IP address
20744 is not enclosed in brackets. When a port is specified, it overrides the port
20745 specification on the transport. The port is separated from the name or address
20746 by a colon. This leads to some complications:
20747
20748 .ilist
20749 Because colon is the default separator for the list of hosts, either
20750 the colon that specifies a port must be doubled, or the list separator must
20751 be changed. The following two examples have the same effect:
20752 .code
20753 route_list = * "host1.tld::1225 : host2.tld::1226"
20754 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20755 .endd
20756 .next
20757 When IPv6 addresses are involved, it gets worse, because they contain
20758 colons of their own. To make this case easier, it is permitted to
20759 enclose an IP address (either v4 or v6) in square brackets if a port
20760 number follows. For example:
20761 .code
20762 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20763 .endd
20764 .endlist
20765
20766 .section "How the list of hosts is used" "SECThostshowused"
20767 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20768 the hosts is tried, in the order specified, when carrying out the SMTP
20769 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20770 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20771 transport.
20772
20773 Hosts may be listed by name or by IP address. An unadorned name in the list of
20774 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20775 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20776 records in the DNS. For example:
20777 .code
20778 route_list = *  x.y.z:p.q.r/MX:e.f.g
20779 .endd
20780 If this feature is used with a port specifier, the port must come last. For
20781 example:
20782 .code
20783 route_list = *  dom1.tld/mx::1225
20784 .endd
20785 If the &%hosts_randomize%& option is set, the order of the items in the list is
20786 randomized before any lookups are done. Exim then scans the list; for any name
20787 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20788 be an interface on the local host and the item is not the first in the list,
20789 Exim discards it and any subsequent items. If it is the first item, what
20790 happens is controlled by the
20791 .oindex "&%self%&" "in &(manualroute)& router"
20792 &%self%& option of the router.
20793
20794 A name on the list that is followed by &`/MX`& is replaced with the list of
20795 hosts obtained by looking up MX records for the name. This is always a DNS
20796 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20797 below) are not relevant here. The order of these hosts is determined by the
20798 preference values in the MX records, according to the usual rules. Because
20799 randomizing happens before the MX lookup, it does not affect the order that is
20800 defined by MX preferences.
20801
20802 If the local host is present in the sublist obtained from MX records, but is
20803 not the most preferred host in that list, it and any equally or less
20804 preferred hosts are removed before the sublist is inserted into the main list.
20805
20806 If the local host is the most preferred host in the MX list, what happens
20807 depends on where in the original list of hosts the &`/MX`& item appears. If it
20808 is not the first item (that is, there are previous hosts in the main list),
20809 Exim discards this name and any subsequent items in the main list.
20810
20811 If the MX item is first in the list of hosts, and the local host is the
20812 most preferred host, what happens is controlled by the &%self%& option of the
20813 router.
20814
20815 DNS failures when lookup up the MX records are treated in the same way as DNS
20816 failures when looking up IP addresses: &%pass_on_timeout%& and
20817 &%host_find_failed%& are used when relevant.
20818
20819 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20820 whether obtained from an MX lookup or not.
20821
20822
20823
20824 .section "How the options are used" "SECThowoptused"
20825 The options are a sequence of words, space-separated.
20826 One of the words can be the name of a transport; this overrides the
20827 &%transport%& option on the router for this particular routing rule only. The
20828 other words (if present) control randomization of the list of hosts on a
20829 per-rule basis, and how the IP addresses of the hosts are to be found when
20830 routing to a remote transport. These options are as follows:
20831
20832 .ilist
20833 &%randomize%&: randomize the order of the hosts in this list, overriding the
20834 setting of &%hosts_randomize%& for this routing rule only.
20835 .next
20836 &%no_randomize%&: do not randomize the order of the hosts in this list,
20837 overriding the setting of &%hosts_randomize%& for this routing rule only.
20838 .next
20839 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20840 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20841 also look in &_/etc/hosts_& or other sources of information.
20842 .next
20843 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20844 no address records are found. If there is a temporary DNS error (such as a
20845 timeout), delivery is deferred.
20846 .next
20847 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20848 .next
20849 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20850 .endlist
20851
20852 For example:
20853 .code
20854 route_list = domain1  host1:host2:host3  randomize bydns;\
20855              domain2  host4:host5
20856 .endd
20857 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20858 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20859 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20860 or &[gethostbyname()]&, and the result of the lookup is the result of that
20861 call.
20862
20863 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20864 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20865 instead of TRY_AGAIN. That is why the default action is to try a DNS
20866 lookup first. Only if that gives a definite &"no such host"& is the local
20867 function called.
20868
20869 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20870 inadvertent constraint that a transport name as an option had to be the last
20871 option specified.
20872
20873
20874
20875 If no IP address for a host can be found, what happens is controlled by the
20876 &%host_find_failed%& option.
20877
20878 .vindex "&$host$&"
20879 When an address is routed to a local transport, IP addresses are not looked up.
20880 The host list is passed to the transport in the &$host$& variable.
20881
20882
20883
20884 .section "Manualroute examples" "SECID123"
20885 In some of the examples that follow, the presence of the &%remote_smtp%&
20886 transport, as defined in the default configuration file, is assumed:
20887
20888 .ilist
20889 .cindex "smart host" "example router"
20890 The &(manualroute)& router can be used to forward all external mail to a
20891 &'smart host'&. If you have set up, in the main part of the configuration, a
20892 named domain list that contains your local domains, for example:
20893 .code
20894 domainlist local_domains = my.domain.example
20895 .endd
20896 You can arrange for all other domains to be routed to a smart host by making
20897 your first router something like this:
20898 .code
20899 smart_route:
20900   driver = manualroute
20901   domains = !+local_domains
20902   transport = remote_smtp
20903   route_list = * smarthost.ref.example
20904 .endd
20905 This causes all non-local addresses to be sent to the single host
20906 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20907 they are tried in order
20908 (but you can use &%hosts_randomize%& to vary the order each time).
20909 Another way of configuring the same thing is this:
20910 .code
20911 smart_route:
20912   driver = manualroute
20913   transport = remote_smtp
20914   route_list = !+local_domains  smarthost.ref.example
20915 .endd
20916 There is no difference in behaviour between these two routers as they stand.
20917 However, they behave differently if &%no_more%& is added to them. In the first
20918 example, the router is skipped if the domain does not match the &%domains%&
20919 precondition; the following router is always tried. If the router runs, it
20920 always matches the domain and so can never decline. Therefore, &%no_more%&
20921 would have no effect. In the second case, the router is never skipped; it
20922 always runs. However, if it doesn't match the domain, it declines. In this case
20923 &%no_more%& would prevent subsequent routers from running.
20924
20925 .next
20926 .cindex "mail hub example"
20927 A &'mail hub'& is a host which receives mail for a number of domains via MX
20928 records in the DNS and delivers it via its own private routing mechanism. Often
20929 the final destinations are behind a firewall, with the mail hub being the one
20930 machine that can connect to machines both inside and outside the firewall. The
20931 &(manualroute)& router is usually used on a mail hub to route incoming messages
20932 to the correct hosts. For a small number of domains, the routing can be inline,
20933 using the &%route_list%& option, but for a larger number a file or database
20934 lookup is easier to manage.
20935
20936 If the domain names are in fact the names of the machines to which the mail is
20937 to be sent by the mail hub, the configuration can be quite simple. For
20938 example:
20939 .code
20940 hub_route:
20941   driver = manualroute
20942   transport = remote_smtp
20943   route_list = *.rhodes.tvs.example  $domain
20944 .endd
20945 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20946 whose names are the same as the mail domains. A similar approach can be taken
20947 if the host name can be obtained from the domain name by a string manipulation
20948 that the expansion facilities can handle. Otherwise, a lookup based on the
20949 domain can be used to find the host:
20950 .code
20951 through_firewall:
20952   driver = manualroute
20953   transport = remote_smtp
20954   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20955 .endd
20956 The result of the lookup must be the name or IP address of the host (or
20957 hosts) to which the address is to be routed. If the lookup fails, the route
20958 data is empty, causing the router to decline. The address then passes to the
20959 next router.
20960
20961 .next
20962 .cindex "batched SMTP output example"
20963 .cindex "SMTP" "batched outgoing; example"
20964 You can use &(manualroute)& to deliver messages to pipes or files in batched
20965 SMTP format for onward transportation by some other means. This is one way of
20966 storing mail for a dial-up host when it is not connected. The route list entry
20967 can be as simple as a single domain name in a configuration like this:
20968 .code
20969 save_in_file:
20970   driver = manualroute
20971   transport = batchsmtp_appendfile
20972   route_list = saved.domain.example
20973 .endd
20974 though often a pattern is used to pick up more than one domain. If there are
20975 several domains or groups of domains with different transport requirements,
20976 different transports can be listed in the routing information:
20977 .code
20978 save_in_file:
20979   driver = manualroute
20980   route_list = \
20981     *.saved.domain1.example  $domain  batch_appendfile; \
20982     *.saved.domain2.example  \
20983       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20984       batch_pipe
20985 .endd
20986 .vindex "&$domain$&"
20987 .vindex "&$host$&"
20988 The first of these just passes the domain in the &$host$& variable, which
20989 doesn't achieve much (since it is also in &$domain$&), but the second does a
20990 file lookup to find a value to pass, causing the router to decline to handle
20991 the address if the lookup fails.
20992
20993 .next
20994 .cindex "UUCP" "example of router for"
20995 Routing mail directly to UUCP software is a specific case of the use of
20996 &(manualroute)& in a gateway to another mail environment. This is an example of
20997 one way it can be done:
20998 .code
20999 # Transport
21000 uucp:
21001   driver = pipe
21002   user = nobody
21003   command = /usr/local/bin/uux -r - \
21004     ${substr_-5:$host}!rmail ${local_part}
21005   return_fail_output = true
21006
21007 # Router
21008 uucphost:
21009   transport = uucp
21010   driver = manualroute
21011   route_data = \
21012     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21013 .endd
21014 The file &_/usr/local/exim/uucphosts_& contains entries like
21015 .code
21016 darksite.ethereal.example:           darksite.UUCP
21017 .endd
21018 It can be set up more simply without adding and removing &".UUCP"& but this way
21019 makes clear the distinction between the domain name
21020 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21021 .endlist
21022 .ecindex IIDmanrou1
21023 .ecindex IIDmanrou2
21024
21025
21026
21027
21028
21029
21030
21031
21032 . ////////////////////////////////////////////////////////////////////////////
21033 . ////////////////////////////////////////////////////////////////////////////
21034
21035 .chapter "The queryprogram router" "CHAPdriverlast"
21036 .scindex IIDquerou1 "&(queryprogram)& router"
21037 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21038 .cindex "routing" "by external program"
21039 The &(queryprogram)& router routes an address by running an external command
21040 and acting on its output. This is an expensive way to route, and is intended
21041 mainly for use in lightly-loaded systems, or for performing experiments.
21042 However, if it is possible to use the precondition options (&%domains%&,
21043 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21044 be used in special cases, even on a busy host. There are the following private
21045 options:
21046 .cindex "options" "&(queryprogram)& router"
21047
21048 .option command queryprogram string&!! unset
21049 This option must be set. It specifies the command that is to be run. The
21050 command is split up into a command name and arguments, and then each is
21051 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21052 &<<CHAPpipetransport>>&).
21053
21054
21055 .option command_group queryprogram string unset
21056 .cindex "gid (group id)" "in &(queryprogram)& router"
21057 This option specifies a gid to be set when running the command while routing an
21058 address for deliver. It must be set if &%command_user%& specifies a numerical
21059 uid. If it begins with a digit, it is interpreted as the numerical value of the
21060 gid. Otherwise it is looked up using &[getgrnam()]&.
21061
21062
21063 .option command_user queryprogram string unset
21064 .cindex "uid (user id)" "for &(queryprogram)&"
21065 This option must be set. It specifies the uid which is set when running the
21066 command while routing an address for delivery. If the value begins with a digit,
21067 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21068 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21069 not set, a value for the gid also.
21070
21071 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21072 root, which it does during a normal delivery in a conventional configuration.
21073 However, when an address is being verified during message reception, Exim is
21074 usually running as the Exim user, not as root. If the &(queryprogram)& router
21075 is called from a non-root process, Exim cannot change uid or gid before running
21076 the command. In this circumstance the command runs under the current uid and
21077 gid.
21078
21079
21080 .option current_directory queryprogram string /
21081 This option specifies an absolute path which is made the current directory
21082 before running the command.
21083
21084
21085 .option timeout queryprogram time 1h
21086 If the command does not complete within the timeout period, its process group
21087 is killed and the message is frozen. A value of zero time specifies no
21088 timeout.
21089
21090
21091 The standard output of the command is connected to a pipe, which is read when
21092 the command terminates. It should consist of a single line of output,
21093 containing up to five fields, separated by white space. The maximum length of
21094 the line is 1023 characters. Longer lines are silently truncated. The first
21095 field is one of the following words (case-insensitive):
21096
21097 .ilist
21098 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21099 below).
21100 .next
21101 &'Decline'&: the router declines; pass the address to the next router, unless
21102 &%no_more%& is set.
21103 .next
21104 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21105 subsequent text on the line is an error message. If the router is run as part
21106 of address verification during an incoming SMTP message, the message is
21107 included in the SMTP response.
21108 .next
21109 &'Defer'&: routing could not be completed at this time; try again later. Any
21110 subsequent text on the line is an error message which is logged. It is not
21111 included in any SMTP response.
21112 .next
21113 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21114 .next
21115 &'Pass'&: pass the address to the next router (or the router specified by
21116 &%pass_router%&), overriding &%no_more%&.
21117 .next
21118 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21119 new addresses, which are routed independently, starting with the first router,
21120 or the router specified by &%redirect_router%&, if set.
21121 .endlist
21122
21123 When the first word is &'accept'&, the remainder of the line consists of a
21124 number of keyed data values, as follows (split into two lines here, to fit on
21125 the page):
21126 .code
21127 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21128 LOOKUP=byname|bydns DATA=<text>
21129 .endd
21130 The data items can be given in any order, and all are optional. If no transport
21131 is included, the transport specified by the generic &%transport%& option is
21132 used. The list of hosts and the lookup type are needed only if the transport is
21133 an &(smtp)& transport that does not itself supply a list of hosts.
21134
21135 The format of the list of hosts is the same as for the &(manualroute)& router.
21136 As well as host names and IP addresses with optional port numbers, as described
21137 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21138 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21139 (see section &<<SECThostshowused>>&).
21140
21141 If the lookup type is not specified, Exim behaves as follows when trying to
21142 find an IP address for each host: First, a DNS lookup is done. If this yields
21143 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21144 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21145 result of the lookup is the result of that call.
21146
21147 .vindex "&$address_data$&"
21148 If the DATA field is set, its value is placed in the &$address_data$&
21149 variable. For example, this return line
21150 .code
21151 accept hosts=x1.y.example:x2.y.example data="rule1"
21152 .endd
21153 routes the address to the default transport, passing a list of two hosts. When
21154 the transport runs, the string &"rule1"& is in &$address_data$&.
21155 .ecindex IIDquerou1
21156 .ecindex IIDquerou2
21157
21158
21159
21160
21161 . ////////////////////////////////////////////////////////////////////////////
21162 . ////////////////////////////////////////////////////////////////////////////
21163
21164 .chapter "The redirect router" "CHAPredirect"
21165 .scindex IIDredrou1 "&(redirect)& router"
21166 .scindex IIDredrou2 "routers" "&(redirect)&"
21167 .cindex "alias file" "in a &(redirect)& router"
21168 .cindex "address redirection" "&(redirect)& router"
21169 The &(redirect)& router handles several kinds of address redirection. Its most
21170 common uses are for resolving local part aliases from a central alias file
21171 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21172 files, but it has many other potential uses. The incoming address can be
21173 redirected in several different ways:
21174
21175 .ilist
21176 It can be replaced by one or more new addresses which are themselves routed
21177 independently.
21178 .next
21179 It can be routed to be delivered to a given file or directory.
21180 .next
21181 It can be routed to be delivered to a specified pipe command.
21182 .next
21183 It can cause an automatic reply to be generated.
21184 .next
21185 It can be forced to fail, optionally with a custom error message.
21186 .next
21187 It can be temporarily deferred, optionally with a custom message.
21188 .next
21189 It can be discarded.
21190 .endlist
21191
21192 The generic &%transport%& option must not be set for &(redirect)& routers.
21193 However, there are some private options which define transports for delivery to
21194 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21195 &%pipe_transport%& and &%reply_transport%& descriptions below.
21196
21197 If success DSNs have been requested
21198 .cindex "DSN" "success"
21199 .cindex "Delivery Status Notification" "success"
21200 redirection triggers one and the DSN options are not passed any further.
21201
21202
21203
21204 .section "Redirection data" "SECID124"
21205 The router operates by interpreting a text string which it obtains either by
21206 expanding the contents of the &%data%& option, or by reading the entire
21207 contents of a file whose name is given in the &%file%& option. These two
21208 options are mutually exclusive. The first is commonly used for handling system
21209 aliases, in a configuration like this:
21210 .code
21211 system_aliases:
21212   driver = redirect
21213   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21214 .endd
21215 If the lookup fails, the expanded string in this example is empty. When the
21216 expansion of &%data%& results in an empty string, the router declines. A forced
21217 expansion failure also causes the router to decline; other expansion failures
21218 cause delivery to be deferred.
21219
21220 A configuration using &%file%& is commonly used for handling users'
21221 &_.forward_& files, like this:
21222 .code
21223 userforward:
21224   driver = redirect
21225   check_local_user
21226   file = $home/.forward
21227   no_verify
21228 .endd
21229 If the file does not exist, or causes no action to be taken (for example, it is
21230 empty or consists only of comments), the router declines. &*Warning*&: This
21231 is not the case when the file contains syntactically valid items that happen to
21232 yield empty addresses, for example, items containing only RFC 2822 address
21233 comments.
21234
21235 .cindex "tainted data" "in filenames"
21236 .cindex redirect "tainted data"
21237 Tainted data may not be used for a filename.
21238
21239 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21240 directly for redirection,
21241 as they are provided by a potential attacker.
21242 In the examples above, &$local_part$& is used for looking up data held locally
21243 on the system, and not used directly (the second example derives &$home$& via
21244 the passsword file or database, using &$local_part$&).
21245
21246
21247
21248 .section "Forward files and address verification" "SECID125"
21249 .cindex "address redirection" "while verifying"
21250 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21251 &_.forward_& files, as in the example above. There are two reasons for this:
21252
21253 .ilist
21254 When Exim is receiving an incoming SMTP message from a remote host, it is
21255 running under the Exim uid, not as root. Exim is unable to change uid to read
21256 the file as the user, and it may not be able to read it as the Exim user. So in
21257 practice the router may not be able to operate.
21258 .next
21259 However, even when the router can operate, the existence of a &_.forward_& file
21260 is unimportant when verifying an address. What should be checked is whether the
21261 local part is a valid user name or not. Cutting out the redirection processing
21262 saves some resources.
21263 .endlist
21264
21265
21266
21267
21268
21269
21270 .section "Interpreting redirection data" "SECID126"
21271 .cindex "Sieve filter" "specifying in redirection data"
21272 .cindex "filter" "specifying in redirection data"
21273 The contents of the data string, whether obtained from &%data%& or &%file%&,
21274 can be interpreted in two different ways:
21275
21276 .ilist
21277 If the &%allow_filter%& option is set true, and the data begins with the text
21278 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21279 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21280 respectively. Details of the syntax and semantics of filter files are described
21281 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21282 document is intended for use by end users.
21283 .next
21284 Otherwise, the data must be a comma-separated list of redirection items, as
21285 described in the next section.
21286 .endlist
21287
21288 When a message is redirected to a file (a &"mail folder"&), the filename given
21289 in a non-filter redirection list must always be an absolute path. A filter may
21290 generate a relative path &-- how this is handled depends on the transport's
21291 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21292 for the &(appendfile)& transport.
21293
21294
21295
21296 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21297 .cindex "address redirection" "non-filter list items"
21298 When the redirection data is not an Exim or Sieve filter, for example, if it
21299 comes from a conventional alias or forward file, it consists of a list of
21300 addresses, filenames, pipe commands, or certain special items (see section
21301 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21302 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21303 depending on their default values. The items in the list are separated by
21304 commas or newlines.
21305 If a comma is required in an item, the entire item must be enclosed in double
21306 quotes.
21307
21308 Lines starting with a # character are comments, and are ignored, and # may
21309 also appear following a comma, in which case everything between the # and the
21310 next newline character is ignored.
21311
21312 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21313 double quotes are retained because some forms of mail address require their use
21314 (but never to enclose the entire address). In the following description,
21315 &"item"& refers to what remains after any surrounding double quotes have been
21316 removed.
21317
21318 .vindex "&$local_part$&"
21319 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21320 and the expansion contains a reference to &$local_part$&, you should make use
21321 of the &%quote_local_part%& expansion operator, in case the local part contains
21322 special characters. For example, to redirect all mail for the domain
21323 &'obsolete.example'&, retaining the existing local part, you could use this
21324 setting:
21325 .code
21326 data = ${quote_local_part:$local_part}@newdomain.example
21327 .endd
21328
21329
21330 .section "Redirecting to a local mailbox" "SECTredlocmai"
21331 .cindex "routing" "loops in"
21332 .cindex "loop" "while routing, avoidance of"
21333 .cindex "address redirection" "to local mailbox"
21334 A redirection item may safely be the same as the address currently under
21335 consideration. This does not cause a routing loop, because a router is
21336 automatically skipped if any ancestor of the address that is being processed
21337 is the same as the current address and was processed by the current router.
21338 Such an address is therefore passed to the following routers, so it is handled
21339 as if there were no redirection. When making this loop-avoidance test, the
21340 complete local part, including any prefix or suffix, is used.
21341
21342 .cindex "address redirection" "local part without domain"
21343 Specifying the same local part without a domain is a common usage in personal
21344 filter files when the user wants to have messages delivered to the local
21345 mailbox and also forwarded elsewhere. For example, the user whose login is
21346 &'cleo'& might have a &_.forward_& file containing this:
21347 .code
21348 cleo, cleopatra@egypt.example
21349 .endd
21350 .cindex "backslash in alias file"
21351 .cindex "alias file" "backslash in"
21352 For compatibility with other MTAs, such unqualified local parts may be
21353 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21354 it does make a difference if more than one domain is being handled
21355 synonymously.
21356
21357 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21358 2822 address that does not include a domain, the item is qualified using the
21359 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21360 addresses are qualified using the value in &%qualify_recipient%&, but you can
21361 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21362
21363 Care must be taken if there are alias names for local users.
21364 Consider an MTA handling a single local domain where the system alias file
21365 contains:
21366 .code
21367 Sam.Reman: spqr
21368 .endd
21369 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21370 messages in the local mailbox, and also forward copies elsewhere. He creates
21371 this forward file:
21372 .code
21373 Sam.Reman, spqr@reme.elsewhere.example
21374 .endd
21375 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21376 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21377 second time round, because it has previously routed it,
21378 and the following routers presumably cannot handle the alias. The forward file
21379 should really contain
21380 .code
21381 spqr, spqr@reme.elsewhere.example
21382 .endd
21383 but because this is such a common error, the &%check_ancestor%& option (see
21384 below) exists to provide a way to get round it. This is normally set on a
21385 &(redirect)& router that is handling users' &_.forward_& files.
21386
21387
21388
21389 .section "Special items in redirection lists" "SECTspecitredli"
21390 In addition to addresses, the following types of item may appear in redirection
21391 lists (that is, in non-filter redirection data):
21392
21393 .ilist
21394 .cindex "pipe" "in redirection list"
21395 .cindex "address redirection" "to pipe"
21396 An item is treated as a pipe command if it begins with &"|"& and does not parse
21397 as a valid RFC 2822 address that includes a domain. A transport for running the
21398 command must be specified by the &%pipe_transport%& option.
21399 Normally, either the router or the transport specifies a user and a group under
21400 which to run the delivery. The default is to use the Exim user and group.
21401
21402 Single or double quotes can be used for enclosing the individual arguments of
21403 the pipe command; no interpretation of escapes is done for single quotes. If
21404 the command contains a comma character, it is necessary to put the whole item
21405 in double quotes, for example:
21406 .code
21407 "|/some/command ready,steady,go"
21408 .endd
21409 since items in redirection lists are terminated by commas. Do not, however,
21410 quote just the command. An item such as
21411 .code
21412 |"/some/command ready,steady,go"
21413 .endd
21414 is interpreted as a pipe with a rather strange command name, and no arguments.
21415
21416 Note that the above example assumes that the text comes from a lookup source
21417 of some sort, so that the quotes are part of the data.  If composing a
21418 redirect router with a &%data%& option directly specifying this command, the
21419 quotes will be used by the configuration parser to define the extent of one
21420 string, but will not be passed down into the redirect router itself.  There
21421 are two main approaches to get around this: escape quotes to be part of the
21422 data itself, or avoid using this mechanism and instead create a custom
21423 transport with the &%command%& option set and reference that transport from
21424 an &%accept%& router.
21425
21426 .next
21427 .cindex "file" "in redirection list"
21428 .cindex "address redirection" "to file"
21429 An item is interpreted as a path name if it begins with &"/"& and does not
21430 parse as a valid RFC 2822 address that includes a domain. For example,
21431 .code
21432 /home/world/minbari
21433 .endd
21434 is treated as a filename, but
21435 .code
21436 /s=molari/o=babylon/@x400gate.way
21437 .endd
21438 is treated as an address. For a filename, a transport must be specified using
21439 the &%file_transport%& option. However, if the generated path name ends with a
21440 forward slash character, it is interpreted as a directory name rather than a
21441 filename, and &%directory_transport%& is used instead.
21442
21443 Normally, either the router or the transport specifies a user and a group under
21444 which to run the delivery. The default is to use the Exim user and group.
21445
21446 .cindex "&_/dev/null_&"
21447 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21448 bypassed at a high level, and the log entry shows &"**bypassed**"&
21449 instead of a transport name. In this case the user and group are not used.
21450
21451 .next
21452 .cindex "included address list"
21453 .cindex "address redirection" "included external list"
21454 If an item is of the form
21455 .code
21456 :include:<path name>
21457 .endd
21458 a list of further items is taken from the given file and included at that
21459 point. &*Note*&: Such a file can not be a filter file; it is just an
21460 out-of-line addition to the list. The items in the included list are separated
21461 by commas or newlines and are not subject to expansion. If this is the first
21462 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21463 the alias name. This example is incorrect:
21464 .code
21465 list1    :include:/opt/lists/list1
21466 .endd
21467 It must be given as
21468 .code
21469 list1:   :include:/opt/lists/list1
21470 .endd
21471 .cindex "tainted data" "in filenames"
21472 .cindex redirect "tainted data"
21473 Tainted data may not be used for a filename.
21474 .next
21475 .cindex "address redirection" "to black hole"
21476 .cindex "delivery" "discard"
21477 .cindex "delivery" "blackhole"
21478 .cindex "black hole"
21479 .cindex "abandoning mail"
21480 Sometimes you want to throw away mail to a particular local part.  Making the
21481 &%data%& option expand to an empty string does not work, because that causes
21482 the router to decline. Instead, the alias item
21483 .code
21484 :blackhole:
21485 .endd
21486 can be used. It does what its name implies. No delivery is
21487 done, and no error message is generated. This has the same effect as specifying
21488 &_/dev/null_& as a destination, but it can be independently disabled.
21489
21490 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21491 delivery is done for the original local part, even if other redirection items
21492 are present. If you are generating a multi-item list (for example, by reading a
21493 database) and need the ability to provide a no-op item, you must use
21494 &_/dev/null_&.
21495
21496 .next
21497 .cindex "delivery" "forcing failure"
21498 .cindex "delivery" "forcing deferral"
21499 .cindex "failing delivery" "forcing"
21500 .cindex "deferred delivery, forcing"
21501 .cindex "customizing" "failure message"
21502 An attempt to deliver a particular address can be deferred or forced to fail by
21503 redirection items of the form
21504 .code
21505 :defer:
21506 :fail:
21507 .endd
21508 respectively. When a redirection list contains such an item, it applies
21509 to the entire redirection; any other items in the list are ignored. Any
21510 text following &':fail:'& or &':defer:'& is placed in the error text
21511 associated with the failure. For example, an alias file might contain:
21512 .code
21513 X.Employee:  :fail: Gone away, no forwarding address
21514 .endd
21515 In the case of an address that is being verified from an ACL or as the subject
21516 of a
21517 .cindex "VRFY" "error text, display of"
21518 VRFY command, the text is included in the SMTP error response by
21519 default.
21520 .cindex "EXPN" "error text, display of"
21521 The text is not included in the response to an EXPN command. In non-SMTP cases
21522 the text is included in the error message that Exim generates.
21523
21524 .cindex "SMTP" "error codes"
21525 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21526 &':fail:'&. However, if the message starts with three digits followed by a
21527 space, optionally followed by an extended code of the form &'n.n.n'&, also
21528 followed by a space, and the very first digit is the same as the default error
21529 code, the code from the message is used instead. If the very first digit is
21530 incorrect, a panic error is logged, and the default code is used. You can
21531 suppress the use of the supplied code in a redirect router by setting the
21532 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21533 ignored.
21534
21535 .vindex "&$acl_verify_message$&"
21536 In an ACL, an explicitly provided message overrides the default, but the
21537 default message is available in the variable &$acl_verify_message$& and can
21538 therefore be included in a custom message if this is desired.
21539
21540 Normally the error text is the rest of the redirection list &-- a comma does
21541 not terminate it &-- but a newline does act as a terminator. Newlines are not
21542 normally present in alias expansions. In &(lsearch)& lookups they are removed
21543 as part of the continuation process, but they may exist in other kinds of
21544 lookup and in &':include:'& files.
21545
21546 During routing for message delivery (as opposed to verification), a redirection
21547 containing &':fail:'& causes an immediate failure of the incoming address,
21548 whereas &':defer:'& causes the message to remain in the queue so that a
21549 subsequent delivery attempt can happen at a later time. If an address is
21550 deferred for too long, it will ultimately fail, because the normal retry
21551 rules still apply.
21552
21553 .next
21554 .cindex "alias file" "exception to default"
21555 Sometimes it is useful to use a single-key search type with a default (see
21556 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21557 for exceptions to the default. These can be handled by aliasing them to
21558 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21559 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21560 results in an empty redirection list has the same effect.
21561 .endlist
21562
21563
21564 .section "Duplicate addresses" "SECTdupaddr"
21565 .cindex "duplicate addresses"
21566 .cindex "address duplicate, discarding"
21567 .cindex "pipe" "duplicated"
21568 Exim removes duplicate addresses from the list to which it is delivering, so as
21569 to deliver just one copy to each address. This does not apply to deliveries
21570 routed to pipes by different immediate parent addresses, but an indirect
21571 aliasing scheme of the type
21572 .code
21573 pipe:       |/some/command $local_part
21574 localpart1: pipe
21575 localpart2: pipe
21576 .endd
21577 does not work with a message that is addressed to both local parts, because
21578 when the second is aliased to the intermediate local part &"pipe"& it gets
21579 discarded as being the same as a previously handled address. However, a scheme
21580 such as
21581 .code
21582 localpart1: |/some/command $local_part
21583 localpart2: |/some/command $local_part
21584 .endd
21585 does result in two different pipe deliveries, because the immediate parents of
21586 the pipes are distinct.
21587
21588
21589
21590 .section "Repeated redirection expansion" "SECID128"
21591 .cindex "repeated redirection expansion"
21592 .cindex "address redirection" "repeated for each delivery attempt"
21593 When a message cannot be delivered to all of its recipients immediately,
21594 leading to two or more delivery attempts, redirection expansion is carried out
21595 afresh each time for those addresses whose children were not all previously
21596 delivered. If redirection is being used as a mailing list, this can lead to new
21597 members of the list receiving copies of old messages. The &%one_time%& option
21598 can be used to avoid this.
21599
21600
21601 .section "Errors in redirection lists" "SECID129"
21602 .cindex "address redirection" "errors"
21603 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21604 error is skipped, and an entry is written to the main log. This may be useful
21605 for mailing lists that are automatically managed. Otherwise, if an error is
21606 detected while generating the list of new addresses, the original address is
21607 deferred. See also &%syntax_errors_to%&.
21608
21609
21610
21611 .section "Private options for the redirect router" "SECID130"
21612
21613 .cindex "options" "&(redirect)& router"
21614 The private options for the &(redirect)& router are as follows:
21615
21616
21617 .option allow_defer redirect boolean false
21618 Setting this option allows the use of &':defer:'& in non-filter redirection
21619 data, or the &%defer%& command in an Exim filter file.
21620
21621
21622 .option allow_fail redirect boolean false
21623 .cindex "failing delivery" "from filter"
21624 If this option is true, the &':fail:'& item can be used in a redirection list,
21625 and the &%fail%& command may be used in an Exim filter file.
21626
21627
21628 .option allow_filter redirect boolean false
21629 .cindex "filter" "enabling use of"
21630 .cindex "Sieve filter" "enabling use of"
21631 Setting this option allows Exim to interpret redirection data that starts with
21632 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21633 are some features of Exim filter files that some administrators may wish to
21634 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21635
21636 It is also possible to lock out Exim filters or Sieve filters while allowing
21637 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21638
21639
21640 The filter is run using the uid and gid set by the generic &%user%& and
21641 &%group%& options. These take their defaults from the password data if
21642 &%check_local_user%& is set, so in the normal case of users' personal filter
21643 files, the filter is run as the relevant user. When &%allow_filter%& is set
21644 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21645
21646
21647
21648 .option allow_freeze redirect boolean false
21649 .cindex "freezing messages" "allowing in filter"
21650 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21651 This command is more normally encountered in system filters, and is disabled by
21652 default for redirection filters because it isn't something you usually want to
21653 let ordinary users do.
21654
21655
21656
21657 .option check_ancestor redirect boolean false
21658 This option is concerned with handling generated addresses that are the same
21659 as some address in the list of redirection ancestors of the current address.
21660 Although it is turned off by default in the code, it is set in the default
21661 configuration file for handling users' &_.forward_& files. It is recommended
21662 for this use of the &(redirect)& router.
21663
21664 When &%check_ancestor%& is set, if a generated address (including the domain)
21665 is the same as any ancestor of the current address, it is replaced by a copy of
21666 the current address. This helps in the case where local part A is aliased to B,
21667 and B has a &_.forward_& file pointing back to A. For example, within a single
21668 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21669 &_&~jb/.forward_& contains:
21670 .code
21671 \Joe.Bloggs, <other item(s)>
21672 .endd
21673 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21674 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21675 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21676 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21677 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21678 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21679 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21680 original address. See also the &%repeat_use%& option below.
21681
21682
21683 .option check_group redirect boolean "see below"
21684 When the &%file%& option is used, the group owner of the file is checked only
21685 when this option is set. The permitted groups are those listed in the
21686 &%owngroups%& option, together with the user's default group if
21687 &%check_local_user%& is set. If the file has the wrong group, routing is
21688 deferred. The default setting for this option is true if &%check_local_user%&
21689 is set and the &%modemask%& option permits the group write bit, or if the
21690 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21691
21692
21693
21694 .option check_owner redirect boolean "see below"
21695 When the &%file%& option is used, the owner of the file is checked only when
21696 this option is set. If &%check_local_user%& is set, the local user is
21697 permitted; otherwise the owner must be one of those listed in the &%owners%&
21698 option. The default value for this option is true if &%check_local_user%& or
21699 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21700
21701
21702 .option data redirect string&!! unset
21703 This option is mutually exclusive with &%file%&. One or other of them must be
21704 set, but not both. The contents of &%data%& are expanded, and then used as the
21705 list of forwarding items, or as a set of filtering instructions. If the
21706 expansion is forced to fail, or the result is an empty string or a string that
21707 has no effect (consists entirely of comments), the router declines.
21708
21709 When filtering instructions are used, the string must begin with &"#Exim
21710 filter"&, and all comments in the string, including this initial one, must be
21711 terminated with newline characters. For example:
21712 .code
21713 data = #Exim filter\n\
21714        if $h_to: contains Exim then save $home/mail/exim endif
21715 .endd
21716 If you are reading the data from a database where newlines cannot be included,
21717 you can use the &${sg}$& expansion item to turn the escape string of your
21718 choice into a newline.
21719
21720
21721 .option directory_transport redirect string&!! unset
21722 A &(redirect)& router sets up a direct delivery to a directory when a path name
21723 ending with a slash is specified as a new &"address"&. The transport used is
21724 specified by this option, which, after expansion, must be the name of a
21725 configured transport. This should normally be an &(appendfile)& transport.
21726
21727
21728 .option file redirect string&!! unset
21729 This option specifies the name of a file that contains the redirection data. It
21730 is mutually exclusive with the &%data%& option. The string is expanded before
21731 use; if the expansion is forced to fail, the router declines. Other expansion
21732 failures cause delivery to be deferred. The result of a successful expansion
21733 must be an absolute path. The entire file is read and used as the redirection
21734 data. If the data is an empty string or a string that has no effect (consists
21735 entirely of comments), the router declines.
21736
21737 .cindex "NFS" "checking for file existence"
21738 If the attempt to open the file fails with a &"does not exist"& error, Exim
21739 runs a check on the containing directory,
21740 unless &%ignore_enotdir%& is true (see below).
21741 If the directory does not appear to exist, delivery is deferred. This can
21742 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21743 is a mount problem. If the containing directory does exist, but the file does
21744 not, the router declines.
21745
21746
21747 .option file_transport redirect string&!! unset
21748 .vindex "&$address_file$&"
21749 A &(redirect)& router sets up a direct delivery to a file when a path name not
21750 ending in a slash is specified as a new &"address"&. The transport used is
21751 specified by this option, which, after expansion, must be the name of a
21752 configured transport. This should normally be an &(appendfile)& transport. When
21753 it is running, the filename is in &$address_file$&.
21754
21755
21756 .option filter_prepend_home redirect boolean true
21757 When this option is true, if a &(save)& command in an Exim filter specifies a
21758 relative path, and &$home$& is defined, it is automatically prepended to the
21759 relative path. If this option is set false, this action does not happen. The
21760 relative path is then passed to the transport unmodified.
21761
21762
21763 .option forbid_blackhole redirect boolean false
21764 .cindex "restricting access to features"
21765 .cindex "filter" "locking out certain features"
21766 If this option is true, the &':blackhole:'& item may not appear in a
21767 redirection list.
21768
21769
21770 .option forbid_exim_filter redirect boolean false
21771 .cindex "restricting access to features"
21772 .cindex "filter" "locking out certain features"
21773 If this option is set true, only Sieve filters are permitted when
21774 &%allow_filter%& is true.
21775
21776
21777
21778
21779 .option forbid_file redirect boolean false
21780 .cindex "restricting access to features"
21781 .cindex "delivery" "to file; forbidding"
21782 .cindex "filter" "locking out certain features"
21783 .cindex "Sieve filter" "forbidding delivery to a file"
21784 .cindex "Sieve filter" "&""keep""& facility; disabling"
21785 If this option is true, this router may not generate a new address that
21786 specifies delivery to a local file or directory, either from a filter or from a
21787 conventional forward file. This option is forced to be true if &%one_time%& is
21788 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21789 locks out the Sieve's &"keep"& facility.
21790
21791
21792 .option forbid_filter_dlfunc redirect boolean false
21793 .cindex "restricting access to features"
21794 .cindex "filter" "locking out certain features"
21795 If this option is true, string expansions in Exim filters are not allowed to
21796 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21797 functions.
21798
21799 .option forbid_filter_existstest redirect boolean false
21800 .cindex "restricting access to features"
21801 .cindex "filter" "locking out certain features"
21802 .cindex "expansion" "statting a file"
21803 If this option is true, string expansions in Exim filters are not allowed to
21804 make use of the &%exists%& condition or the &%stat%& expansion item.
21805
21806 .option forbid_filter_logwrite redirect boolean false
21807 .cindex "restricting access to features"
21808 .cindex "filter" "locking out certain features"
21809 If this option is true, use of the logging facility in Exim filters is not
21810 permitted. Logging is in any case available only if the filter is being run
21811 under some unprivileged uid (which is normally the case for ordinary users'
21812 &_.forward_& files).
21813
21814
21815 .option forbid_filter_lookup redirect boolean false
21816 .cindex "restricting access to features"
21817 .cindex "filter" "locking out certain features"
21818 If this option is true, string expansions in Exim filter files are not allowed
21819 to make use of &%lookup%& items.
21820
21821
21822 .option forbid_filter_perl redirect boolean false
21823 .cindex "restricting access to features"
21824 .cindex "filter" "locking out certain features"
21825 This option has an effect only if Exim is built with embedded Perl support. If
21826 it is true, string expansions in Exim filter files are not allowed to make use
21827 of the embedded Perl support.
21828
21829
21830 .option forbid_filter_readfile redirect boolean false
21831 .cindex "restricting access to features"
21832 .cindex "filter" "locking out certain features"
21833 If this option is true, string expansions in Exim filter files are not allowed
21834 to make use of &%readfile%& items.
21835
21836
21837 .option forbid_filter_readsocket redirect boolean false
21838 .cindex "restricting access to features"
21839 .cindex "filter" "locking out certain features"
21840 If this option is true, string expansions in Exim filter files are not allowed
21841 to make use of &%readsocket%& items.
21842
21843
21844 .option forbid_filter_reply redirect boolean false
21845 .cindex "restricting access to features"
21846 .cindex "filter" "locking out certain features"
21847 If this option is true, this router may not generate an automatic reply
21848 message. Automatic replies can be generated only from Exim or Sieve filter
21849 files, not from traditional forward files. This option is forced to be true if
21850 &%one_time%& is set.
21851
21852
21853 .option forbid_filter_run redirect boolean false
21854 .cindex "restricting access to features"
21855 .cindex "filter" "locking out certain features"
21856 If this option is true, string expansions in Exim filter files are not allowed
21857 to make use of &%run%& items.
21858
21859
21860 .option forbid_include redirect boolean false
21861 .cindex "restricting access to features"
21862 .cindex "filter" "locking out certain features"
21863 If this option is true, items of the form
21864 .code
21865 :include:<path name>
21866 .endd
21867 are not permitted in non-filter redirection lists.
21868
21869
21870 .option forbid_pipe redirect boolean false
21871 .cindex "restricting access to features"
21872 .cindex "filter" "locking out certain features"
21873 .cindex "delivery" "to pipe; forbidding"
21874 If this option is true, this router may not generate a new address which
21875 specifies delivery to a pipe, either from an Exim filter or from a conventional
21876 forward file. This option is forced to be true if &%one_time%& is set.
21877
21878
21879 .option forbid_sieve_filter redirect boolean false
21880 .cindex "restricting access to features"
21881 .cindex "filter" "locking out certain features"
21882 If this option is set true, only Exim filters are permitted when
21883 &%allow_filter%& is true.
21884
21885
21886 .cindex "SMTP" "error codes"
21887 .option forbid_smtp_code redirect boolean false
21888 If this option is set true, any SMTP error codes that are present at the start
21889 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21890 the default codes (451 and 550, respectively) are always used.
21891
21892
21893
21894
21895 .option hide_child_in_errmsg redirect boolean false
21896 .cindex "bounce message" "redirection details; suppressing"
21897 If this option is true, it prevents Exim from quoting a child address if it
21898 generates a bounce or delay message for it. Instead it says &"an address
21899 generated from <&'the top level address'&>"&. Of course, this applies only to
21900 bounces generated locally. If a message is forwarded to another host, &'its'&
21901 bounce may well quote the generated address.
21902
21903
21904 .option ignore_eacces redirect boolean false
21905 .cindex "EACCES"
21906 If this option is set and an attempt to open a redirection file yields the
21907 EACCES error (permission denied), the &(redirect)& router behaves as if the
21908 file did not exist.
21909
21910
21911 .option ignore_enotdir redirect boolean false
21912 .cindex "ENOTDIR"
21913 If this option is set and an attempt to open a redirection file yields the
21914 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21915 router behaves as if the file did not exist.
21916
21917 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21918 router that has the &%file%& option set discovers that the file does not exist
21919 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21920 against unmounted NFS directories. If the parent can not be statted, delivery
21921 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21922 is set, because that option tells Exim to ignore &"something on the path is not
21923 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21924 that some operating systems give ENOENT where others give ENOTDIR.
21925
21926
21927
21928 .option include_directory redirect string unset
21929 If this option is set, the path names of any &':include:'& items in a
21930 redirection list must start with this directory.
21931
21932
21933 .option modemask redirect "octal integer" 022
21934 This specifies mode bits which must not be set for a file specified by the
21935 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21936
21937
21938 .option one_time redirect boolean false
21939 .cindex "one-time aliasing/forwarding expansion"
21940 .cindex "alias file" "one-time expansion"
21941 .cindex "forward file" "one-time expansion"
21942 .cindex "mailing lists" "one-time expansion"
21943 .cindex "address redirection" "one-time expansion"
21944 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21945 files each time it tries to deliver a message causes a problem when one or more
21946 of the generated addresses fails be delivered at the first attempt. The problem
21947 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21948 but of what happens when the redirection list changes during the time that the
21949 message is on Exim's queue. This is particularly true in the case of mailing
21950 lists, where new subscribers might receive copies of messages that were posted
21951 before they subscribed.
21952
21953 If &%one_time%& is set and any addresses generated by the router fail to
21954 deliver at the first attempt, the failing addresses are added to the message as
21955 &"top level"& addresses, and the parent address that generated them is marked
21956 &"delivered"&. Thus, redirection does not happen again at the next delivery
21957 attempt.
21958
21959 &*Warning 1*&: Any header line addition or removal that is specified by this
21960 router would be lost if delivery did not succeed at the first attempt. For this
21961 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21962 permitted when &%one_time%& is set.
21963
21964 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21965 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21966 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21967
21968 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21969 &%one_time%&.
21970
21971 The original top-level address is remembered with each of the generated
21972 addresses, and is output in any log messages. However, any intermediate parent
21973 addresses are not recorded. This makes a difference to the log only if
21974 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21975 typically be used for mailing lists, where there is normally just one level of
21976 expansion.
21977
21978
21979 .option owners redirect "string list" unset
21980 .cindex "ownership" "alias file"
21981 .cindex "ownership" "forward file"
21982 .cindex "alias file" "ownership"
21983 .cindex "forward file" "ownership"
21984 This specifies a list of permitted owners for the file specified by &%file%&.
21985 This list is in addition to the local user when &%check_local_user%& is set.
21986 See &%check_owner%& above.
21987
21988
21989 .option owngroups redirect "string list" unset
21990 This specifies a list of permitted groups for the file specified by &%file%&.
21991 The list is in addition to the local user's primary group when
21992 &%check_local_user%& is set. See &%check_group%& above.
21993
21994
21995 .option pipe_transport redirect string&!! unset
21996 .vindex "&$address_pipe$&"
21997 A &(redirect)& router sets up a direct delivery to a pipe when a string
21998 starting with a vertical bar character is specified as a new &"address"&. The
21999 transport used is specified by this option, which, after expansion, must be the
22000 name of a configured transport. This should normally be a &(pipe)& transport.
22001 When the transport is run, the pipe command is in &$address_pipe$&.
22002
22003
22004 .option qualify_domain redirect string&!! unset
22005 .vindex "&$qualify_recipient$&"
22006 If this option is set, and an unqualified address (one without a domain) is
22007 generated, and that address would normally be qualified by the global setting
22008 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22009 expanding this string. If the expansion fails, the router declines. If you want
22010 to revert to the default, you can have the expansion generate
22011 &$qualify_recipient$&.
22012
22013 This option applies to all unqualified addresses generated by Exim filters,
22014 but for traditional &_.forward_& files, it applies only to addresses that are
22015 not preceded by a backslash. Sieve filters cannot generate unqualified
22016 addresses.
22017
22018 .option qualify_preserve_domain redirect boolean false
22019 .cindex "domain" "in redirection; preserving"
22020 .cindex "preserving domain in redirection"
22021 .cindex "address redirection" "domain; preserving"
22022 If this option is set, the router's local &%qualify_domain%& option must not be
22023 set (a configuration error occurs if it is). If an unqualified address (one
22024 without a domain) is generated, it is qualified with the domain of the parent
22025 address (the immediately preceding ancestor) instead of the global
22026 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22027 this applies whether or not the address is preceded by a backslash.
22028
22029
22030 .option repeat_use redirect boolean true
22031 If this option is set false, the router is skipped for a child address that has
22032 any ancestor that was routed by this router. This test happens before any of
22033 the other preconditions are tested. Exim's default anti-looping rules skip
22034 only when the ancestor is the same as the current address. See also
22035 &%check_ancestor%& above and the generic &%redirect_router%& option.
22036
22037
22038 .option reply_transport redirect string&!! unset
22039 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22040 &%vacation%& command is used in a filter file. The transport used is specified
22041 by this option, which, after expansion, must be the name of a configured
22042 transport. This should normally be an &(autoreply)& transport. Other transports
22043 are unlikely to do anything sensible or useful.
22044
22045
22046 .option rewrite redirect boolean true
22047 .cindex "address redirection" "disabling rewriting"
22048 If this option is set false, addresses generated by the router are not
22049 subject to address rewriting. Otherwise, they are treated like new addresses
22050 and are rewritten according to the global rewriting rules.
22051
22052
22053 .option sieve_subaddress redirect string&!! unset
22054 The value of this option is passed to a Sieve filter to specify the
22055 :subaddress part of an address.
22056
22057 .option sieve_useraddress redirect string&!! unset
22058 The value of this option is passed to a Sieve filter to specify the :user part
22059 of an address. However, if it is unset, the entire original local part
22060 (including any prefix or suffix) is used for :user.
22061
22062
22063 .option sieve_vacation_directory redirect string&!! unset
22064 .cindex "Sieve filter" "vacation directory"
22065 To enable the &"vacation"& extension for Sieve filters, you must set
22066 &%sieve_vacation_directory%& to the directory where vacation databases are held
22067 (do not put anything else in that directory), and ensure that the
22068 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22069 needs their own directory; Exim will create it if necessary.
22070
22071
22072
22073 .option skip_syntax_errors redirect boolean false
22074 .cindex "forward file" "broken"
22075 .cindex "address redirection" "broken files"
22076 .cindex "alias file" "broken"
22077 .cindex "broken alias or forward files"
22078 .cindex "ignoring faulty addresses"
22079 .cindex "skipping faulty addresses"
22080 .cindex "error" "skipping bad syntax"
22081 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22082 non-filter redirection data are skipped, and each failing address is logged. If
22083 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22084 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22085 are expanded and placed at the head of the error message generated by
22086 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22087 be the same address as the generic &%errors_to%& option. The
22088 &%skip_syntax_errors%& option is often used when handling mailing lists.
22089
22090 If all the addresses in a redirection list are skipped because of syntax
22091 errors, the router declines to handle the original address, and it is passed to
22092 the following routers.
22093
22094 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22095 error in the filter causes filtering to be abandoned without any action being
22096 taken. The incident is logged, and the router declines to handle the address,
22097 so it is passed to the following routers.
22098
22099 .cindex "Sieve filter" "syntax errors in"
22100 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22101 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22102 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22103
22104 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22105 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22106 option, used with an address that does not get redirected, can be used to
22107 notify users of these errors, by means of a router like this:
22108 .code
22109 userforward:
22110   driver = redirect
22111   allow_filter
22112   check_local_user
22113   file = $home/.forward
22114   file_transport = address_file
22115   pipe_transport = address_pipe
22116   reply_transport = address_reply
22117   no_verify
22118   skip_syntax_errors
22119   syntax_errors_to = real-$local_part@$domain
22120   syntax_errors_text = \
22121    This is an automatically generated message. An error has\n\
22122    been found in your .forward file. Details of the error are\n\
22123    reported below. While this error persists, you will receive\n\
22124    a copy of this message for every message that is addressed\n\
22125    to you. If your .forward file is a filter file, or if it is\n\
22126    a non-filter file containing no valid forwarding addresses,\n\
22127    a copy of each incoming message will be put in your normal\n\
22128    mailbox. If a non-filter file contains at least one valid\n\
22129    forwarding address, forwarding to the valid addresses will\n\
22130    happen, and those will be the only deliveries that occur.
22131 .endd
22132 You also need a router to ensure that local addresses that are prefixed by
22133 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22134 put this immediately before the &(userforward)& router:
22135 .code
22136 real_localuser:
22137   driver = accept
22138   check_local_user
22139   local_part_prefix = real-
22140   transport = local_delivery
22141 .endd
22142 For security, it would probably be a good idea to restrict the use of this
22143 router to locally-generated messages, using a condition such as this:
22144 .code
22145   condition = ${if match {$sender_host_address}\
22146                          {\N^(|127\.0\.0\.1)$\N}}
22147 .endd
22148
22149
22150 .option syntax_errors_text redirect string&!! unset
22151 See &%skip_syntax_errors%& above.
22152
22153
22154 .option syntax_errors_to redirect string unset
22155 See &%skip_syntax_errors%& above.
22156 .ecindex IIDredrou1
22157 .ecindex IIDredrou2
22158
22159
22160
22161
22162
22163
22164 . ////////////////////////////////////////////////////////////////////////////
22165 . ////////////////////////////////////////////////////////////////////////////
22166
22167 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22168          "Environment for local transports"
22169 .scindex IIDenvlotra1 "local transports" "environment for"
22170 .scindex IIDenvlotra2 "environment" "local transports"
22171 .scindex IIDenvlotra3 "transport" "local; environment for"
22172 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22173 transport can be thought of as similar to a pipe.) Exim always runs transports
22174 in subprocesses, under specified uids and gids. Typical deliveries to local
22175 mailboxes run under the uid and gid of the local user.
22176
22177 Exim also sets a specific current directory while running the transport; for
22178 some transports a home directory setting is also relevant. The &(pipe)&
22179 transport is the only one that sets up environment variables; see section
22180 &<<SECTpipeenv>>& for details.
22181
22182 The values used for the uid, gid, and the directories may come from several
22183 different places. In many cases, the router that handles the address associates
22184 settings with that address as a result of its &%check_local_user%&, &%group%&,
22185 or &%user%& options. However, values may also be given in the transport's own
22186 configuration, and these override anything that comes from the router.
22187
22188
22189
22190 .section "Concurrent deliveries" "SECID131"
22191 .cindex "concurrent deliveries"
22192 .cindex "simultaneous deliveries"
22193 If two different messages for the same local recipient arrive more or less
22194 simultaneously, the two delivery processes are likely to run concurrently. When
22195 the &(appendfile)& transport is used to write to a file, Exim applies locking
22196 rules to stop concurrent processes from writing to the same file at the same
22197 time.
22198
22199 However, when you use a &(pipe)& transport, it is up to you to arrange any
22200 locking that is needed. Here is a silly example:
22201 .code
22202 my_transport:
22203   driver = pipe
22204   command = /bin/sh -c 'cat >>/some/file'
22205 .endd
22206 This is supposed to write the message at the end of the file. However, if two
22207 messages arrive at the same time, the file will be scrambled. You can use the
22208 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22209 file using the same algorithm that Exim itself uses.
22210
22211
22212
22213
22214 .section "Uids and gids" "SECTenvuidgid"
22215 .cindex "local transports" "uid and gid"
22216 .cindex "transport" "local; uid and gid"
22217 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22218 overrides any group that the router set in the address, even if &%user%& is not
22219 set for the transport. This makes it possible, for example, to run local mail
22220 delivery under the uid of the recipient (set by the router), but in a special
22221 group (set by the transport). For example:
22222 .code
22223 # Routers ...
22224 # User/group are set by check_local_user in this router
22225 local_users:
22226   driver = accept
22227   check_local_user
22228   transport = group_delivery
22229
22230 # Transports ...
22231 # This transport overrides the group
22232 group_delivery:
22233   driver = appendfile
22234   file = /var/spool/mail/$local_part_data
22235   group = mail
22236 .endd
22237 If &%user%& is set for a transport, its value overrides what is set in the
22238 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22239 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22240 set.
22241
22242 .oindex "&%initgroups%&"
22243 When the uid is taken from the transport's configuration, the &[initgroups()]&
22244 function is called for the groups associated with that uid if the
22245 &%initgroups%& option is set for the transport. When the uid is not specified
22246 by the transport, but is associated with the address by a router, the option
22247 for calling &[initgroups()]& is taken from the router configuration.
22248
22249 .cindex "&(pipe)& transport" "uid for"
22250 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22251 is set and &%user%& is not set, the uid of the process that called Exim to
22252 receive the message is used, and if &%group%& is not set, the corresponding
22253 original gid is also used.
22254
22255 This is the detailed preference order for obtaining a gid; the first of the
22256 following that is set is used:
22257
22258 .ilist
22259 A &%group%& setting of the transport;
22260 .next
22261 A &%group%& setting of the router;
22262 .next
22263 A gid associated with a user setting of the router, either as a result of
22264 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22265 .next
22266 The group associated with a non-numeric &%user%& setting of the transport;
22267 .next
22268 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22269 the uid is the creator's uid;
22270 .next
22271 The Exim gid if the Exim uid is being used as a default.
22272 .endlist
22273
22274 If, for example, the user is specified numerically on the router and there are
22275 no group settings, no gid is available. In this situation, an error occurs.
22276 This is different for the uid, for which there always is an ultimate default.
22277 The first of the following that is set is used:
22278
22279 .ilist
22280 A &%user%& setting of the transport;
22281 .next
22282 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22283 .next
22284 A &%user%& setting of the router;
22285 .next
22286 A &%check_local_user%& setting of the router;
22287 .next
22288 The Exim uid.
22289 .endlist
22290
22291 Of course, an error will still occur if the uid that is chosen is on the
22292 &%never_users%& list.
22293
22294
22295
22296
22297
22298 .section "Current and home directories" "SECID132"
22299 .cindex "current directory for local transport"
22300 .cindex "home directory" "for local transport"
22301 .cindex "transport" "local; home directory for"
22302 .cindex "transport" "local; current directory for"
22303 Routers may set current and home directories for local transports by means of
22304 the &%transport_current_directory%& and &%transport_home_directory%& options.
22305 However, if the transport's &%current_directory%& or &%home_directory%& options
22306 are set, they override the router's values. In detail, the home directory
22307 for a local transport is taken from the first of these values that is set:
22308
22309 .ilist
22310 The &%home_directory%& option on the transport;
22311 .next
22312 The &%transport_home_directory%& option on the router;
22313 .next
22314 The password data if &%check_local_user%& is set on the router;
22315 .next
22316 The &%router_home_directory%& option on the router.
22317 .endlist
22318
22319 The current directory is taken from the first of these values that is set:
22320
22321 .ilist
22322 The &%current_directory%& option on the transport;
22323 .next
22324 The &%transport_current_directory%& option on the router.
22325 .endlist
22326
22327
22328 If neither the router nor the transport sets a current directory, Exim uses the
22329 value of the home directory, if it is set. Otherwise it sets the current
22330 directory to &_/_& before running a local transport.
22331
22332
22333
22334 .section "Expansion variables derived from the address" "SECID133"
22335 .vindex "&$domain$&"
22336 .vindex "&$local_part$&"
22337 .vindex "&$original_domain$&"
22338 Normally a local delivery is handling a single address, and in that case the
22339 variables such as &$domain$& and &$local_part$& are set during local
22340 deliveries. However, in some circumstances more than one address may be handled
22341 at once (for example, while writing batch SMTP for onward transmission by some
22342 other means). In this case, the variables associated with the local part are
22343 never set, &$domain$& is set only if all the addresses have the same domain,
22344 and &$original_domain$& is never set.
22345 .ecindex IIDenvlotra1
22346 .ecindex IIDenvlotra2
22347 .ecindex IIDenvlotra3
22348
22349
22350
22351
22352
22353
22354
22355 . ////////////////////////////////////////////////////////////////////////////
22356 . ////////////////////////////////////////////////////////////////////////////
22357
22358 .chapter "Generic options for transports" "CHAPtransportgeneric"
22359 .scindex IIDgenoptra1 "generic options" "transport"
22360 .scindex IIDgenoptra2 "options" "generic; for transports"
22361 .scindex IIDgenoptra3 "transport" "generic options for"
22362 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22363 prior to Exim 4.95 names would be silently truncated at this length, but now
22364 it is enforced.
22365
22366 The following generic options apply to all transports:
22367
22368
22369 .option body_only transports boolean false
22370 .cindex "transport" "body only"
22371 .cindex "message" "transporting body only"
22372 .cindex "body of message" "transporting"
22373 If this option is set, the message's headers are not transported. It is
22374 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22375 or &(pipe)& transports, the settings of &%message_prefix%& and
22376 &%message_suffix%& should be checked, because this option does not
22377 automatically suppress them.
22378
22379
22380 .option current_directory transports string&!! unset
22381 .cindex "transport" "current directory for"
22382 This specifies the current directory that is to be set while running the
22383 transport, overriding any value that may have been set by the router.
22384 If the expansion fails for any reason, including forced failure, an error is
22385 logged, and delivery is deferred.
22386
22387
22388 .option disable_logging transports boolean false
22389 If this option is set true, nothing is logged for any
22390 deliveries by the transport or for any
22391 transport errors. You should not set this option unless you really, really know
22392 what you are doing.
22393
22394
22395 .option debug_print transports string&!! unset
22396 .cindex "testing" "variables in drivers"
22397 If this option is set and debugging is enabled (see the &%-d%& command line
22398 option), the string is expanded and included in the debugging output when the
22399 transport is run.
22400 If expansion of the string fails, the error message is written to the debugging
22401 output, and Exim carries on processing.
22402 This facility is provided to help with checking out the values of variables and
22403 so on when debugging driver configurations. For example, if a &%headers_add%&
22404 option is not working properly, &%debug_print%& could be used to output the
22405 variables it references. A newline is added to the text if it does not end with
22406 one.
22407 The variables &$transport_name$& and &$router_name$& contain the name of the
22408 transport and the router that called it.
22409
22410 .option delivery_date_add transports boolean false
22411 .cindex "&'Delivery-date:'& header line"
22412 If this option is true, a &'Delivery-date:'& header is added to the message.
22413 This gives the actual time the delivery was made. As this is not a standard
22414 header, Exim has a configuration option (&%delivery_date_remove%&) which
22415 requests its removal from incoming messages, so that delivered messages can
22416 safely be resent to other recipients.
22417
22418
22419 .option driver transports string unset
22420 This specifies which of the available transport drivers is to be used.
22421 There is no default, and this option must be set for every transport.
22422
22423
22424 .option envelope_to_add transports boolean false
22425 .cindex "&'Envelope-to:'& header line"
22426 If this option is true, an &'Envelope-to:'& header is added to the message.
22427 This gives the original address(es) in the incoming envelope that caused this
22428 delivery to happen. More than one address may be present if the transport is
22429 configured to handle several addresses at once, or if more than one original
22430 address was redirected to the same final address. As this is not a standard
22431 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22432 its removal from incoming messages, so that delivered messages can safely be
22433 resent to other recipients.
22434
22435 &*Note:*& If used on a transport handling multiple recipients
22436 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22437 transport if &%batch_max%& is greater than 1)
22438 then information about Bcc recipients will be leaked.
22439 Doing so is generally not advised.
22440
22441
22442 .option event_action transports string&!! unset
22443 .cindex events
22444 This option declares a string to be expanded for Exim's events mechanism.
22445 For details see chapter &<<CHAPevents>>&.
22446
22447
22448 .option group transports string&!! "Exim group"
22449 .cindex "transport" "group; specifying"
22450 This option specifies a gid for running the transport process, overriding any
22451 value that the router supplies, and also overriding any value associated with
22452 &%user%& (see below).
22453
22454
22455 .option headers_add transports list&!! unset
22456 .cindex "header lines" "adding in transport"
22457 .cindex "transport" "header lines; adding"
22458 This option specifies a list of text headers,
22459 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22460 which are (separately) expanded and added to the header
22461 portion of a message as it is transported, as described in section
22462 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22463 routers. If the result of the expansion is an empty string, or if the expansion
22464 is forced to fail, no action is taken. Other expansion failures are treated as
22465 errors and cause the delivery to be deferred.
22466
22467 Unlike most options, &%headers_add%& can be specified multiple times
22468 for a transport; all listed headers are added.
22469
22470
22471 .option headers_only transports boolean false
22472 .cindex "transport" "header lines only"
22473 .cindex "message" "transporting headers only"
22474 .cindex "header lines" "transporting"
22475 If this option is set, the message's body is not transported. It is mutually
22476 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22477 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22478 checked, since this option does not automatically suppress them.
22479
22480
22481 .option headers_remove transports list&!! unset
22482 .cindex "header lines" "removing"
22483 .cindex "transport" "header lines; removing"
22484 This option specifies a list of text headers,
22485 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22486 to be removed from the message.
22487 However, the option has no effect when an address is just being verified.
22488 Each list item is separately expanded.
22489 If the result of the expansion is an empty string, or if the expansion
22490 is forced to fail, no action is taken. Other expansion failures are treated as
22491 errors and cause the delivery to be deferred.
22492 If an item ends in *, it will match any header with the given prefix.
22493
22494 Matching headers are omitted from the message as it is transported, as described
22495 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22496 routers.
22497
22498 Unlike most options, &%headers_remove%& can be specified multiple times
22499 for a transport; all listed headers are removed.
22500
22501 &*Warning*&: Because of the separate expansion of the list items,
22502 items that contain a list separator must have it doubled.
22503 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22504
22505
22506
22507 .option headers_rewrite transports string unset
22508 .cindex "transport" "header lines; rewriting"
22509 .cindex "rewriting" "at transport time"
22510 This option allows addresses in header lines to be rewritten at transport time,
22511 that is, as the message is being copied to its destination. The contents of the
22512 option are a colon-separated list of rewriting rules. Each rule is in exactly
22513 the same form as one of the general rewriting rules that are applied when a
22514 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22515 example,
22516 .code
22517 headers_rewrite = a@b c@d f : \
22518                   x@y w@z
22519 .endd
22520 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22521 &'w@z'& in all address-bearing header lines. The rules are applied to the
22522 header lines just before they are written out at transport time, so they affect
22523 only those copies of the message that pass through the transport. However, only
22524 the message's original header lines, and any that were added by a system
22525 filter, are rewritten. If a router or transport adds header lines, they are not
22526 affected by this option. These rewriting rules are &'not'& applied to the
22527 envelope. You can change the return path using &%return_path%&, but you cannot
22528 change envelope recipients at this time.
22529
22530
22531 .option home_directory transports string&!! unset
22532 .cindex "transport" "home directory for"
22533 .vindex "&$home$&"
22534 This option specifies a home directory setting for a local transport,
22535 overriding any value that may be set by the router. The home directory is
22536 placed in &$home$& while expanding the transport's private options. It is also
22537 used as the current directory if no current directory is set by the
22538 &%current_directory%& option on the transport or the
22539 &%transport_current_directory%& option on the router. If the expansion fails
22540 for any reason, including forced failure, an error is logged, and delivery is
22541 deferred.
22542
22543
22544 .option initgroups transports boolean false
22545 .cindex "additional groups"
22546 .cindex "groups" "additional"
22547 .cindex "transport" "group; additional"
22548 If this option is true and the uid for the delivery process is provided by the
22549 transport, the &[initgroups()]& function is called when running the transport
22550 to ensure that any additional groups associated with the uid are set up.
22551
22552
22553 .option max_parallel transports integer&!! unset
22554 .cindex limit "transport parallelism"
22555 .cindex transport "parallel processes"
22556 .cindex transport "concurrency limit"
22557 .cindex "delivery" "parallelism for transport"
22558 If this option is set and expands to an integer greater than zero
22559 it limits the number of concurrent runs of the transport.
22560 The control does not apply to shadow transports.
22561
22562 .cindex "hints database" "transport concurrency control"
22563 Exim implements this control by means of a hints database in which a record is
22564 incremented whenever a transport process is being created. The record
22565 is decremented and possibly removed when the process terminates.
22566 Obviously there is scope for
22567 records to get left lying around if there is a system or program crash. To
22568 guard against this, Exim ignores any records that are more than six hours old.
22569
22570 If you use this option, you should also arrange to delete the
22571 relevant hints database whenever your system reboots. The names of the files
22572 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22573 may be one or two files, depending on the type of DBM in use. The same files
22574 are used for ETRN and smtp transport serialization.
22575
22576
22577 .option message_size_limit transports string&!! 0
22578 .cindex "limit" "message size per transport"
22579 .cindex "size" "of message, limit"
22580 .cindex "transport" "message size; limiting"
22581 This option controls the size of messages passed through the transport. It is
22582 expanded before use; the result of the expansion must be a sequence of decimal
22583 digits, optionally followed by K or M. If the expansion fails for any reason,
22584 including forced failure, or if the result is not of the required form,
22585 delivery is deferred. If the value is greater than zero and the size of a
22586 message exceeds this limit, the address is failed. If there is any chance that
22587 the resulting bounce message could be routed to the same transport, you should
22588 ensure that &%return_size_limit%& is less than the transport's
22589 &%message_size_limit%&, as otherwise the bounce message will fail to get
22590 delivered.
22591
22592
22593
22594 .option rcpt_include_affixes transports boolean false
22595 .cindex "prefix" "for local part, including in envelope"
22596 .cindex "suffix for local part" "including in envelope"
22597 .cindex "local part" "prefix"
22598 .cindex "local part" "suffix"
22599 When this option is false (the default), and an address that has had any
22600 affixes (prefixes or suffixes) removed from the local part is delivered by any
22601 form of SMTP or LMTP, the affixes are not included. For example, if a router
22602 that contains
22603 .code
22604 local_part_prefix = *-
22605 .endd
22606 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22607 is delivered with
22608 .code
22609 RCPT TO:<xyz@some.domain>
22610 .endd
22611 This is also the case when an ACL-time callout is being used to verify a
22612 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22613 whole local part is included in the RCPT command. This option applies to BSMTP
22614 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22615 &(lmtp)& and &(smtp)& transports.
22616
22617
22618 .option retry_use_local_part transports boolean "see below"
22619 .cindex "hints database" "retry keys"
22620 When a delivery suffers a temporary failure, a retry record is created
22621 in Exim's hints database. For remote deliveries, the key for the retry record
22622 is based on the name and/or IP address of the failing remote host. For local
22623 deliveries, the key is normally the entire address, including both the local
22624 part and the domain. This is suitable for most common cases of local delivery
22625 temporary failure &-- for example, exceeding a mailbox quota should delay only
22626 deliveries to that mailbox, not to the whole domain.
22627
22628 However, in some special cases you may want to treat a temporary local delivery
22629 as a failure associated with the domain, and not with a particular local part.
22630 (For example, if you are storing all mail for some domain in files.) You can do
22631 this by setting &%retry_use_local_part%& false.
22632
22633 For all the local transports, its default value is true. For remote transports,
22634 the default value is false for tidiness, but changing the value has no effect
22635 on a remote transport in the current implementation.
22636
22637
22638 .option return_path transports string&!! unset
22639 .cindex "envelope sender"
22640 .cindex "envelope from"
22641 .cindex "transport" "return path; changing"
22642 .cindex "return path" "changing in transport"
22643 If this option is set, the string is expanded at transport time and replaces
22644 the existing return path (envelope sender) value in the copy of the message
22645 that is being delivered. An empty return path is permitted. This feature is
22646 designed for remote deliveries, where the value of this option is used in the
22647 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22648 only effect is to change the address that is placed in the &'Return-path:'&
22649 header line, if one is added to the message (see the next option).
22650
22651 &*Note:*& A changed return path is not logged unless you add
22652 &%return_path_on_delivery%& to the log selector.
22653
22654 .vindex "&$return_path$&"
22655 The expansion can refer to the existing value via &$return_path$&. This is
22656 either the message's envelope sender, or an address set by the
22657 &%errors_to%& option on a router. If the expansion is forced to fail, no
22658 replacement occurs; if it fails for another reason, delivery is deferred. This
22659 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22660 section &<<SECTverp>>&.
22661
22662 &*Note*&: If a delivery error is detected locally, including the case when a
22663 remote server rejects a message at SMTP time, the bounce message is not sent to
22664 the value of this option. It is sent to the previously set errors address.
22665 This defaults to the incoming sender address, but can be changed by setting
22666 &%errors_to%& in a router.
22667
22668
22669
22670 .option return_path_add transports boolean false
22671 .chindex Return-path:
22672 If this option is true, a &'Return-path:'& header is added to the message.
22673 Although the return path is normally available in the prefix line of BSD
22674 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22675 have easy access to it.
22676
22677 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22678 the delivery SMTP server makes the final delivery"&. This implies that this
22679 header should not be present in incoming messages. Exim has a configuration
22680 option, &%return_path_remove%&, which requests removal of this header from
22681 incoming messages, so that delivered messages can safely be resent to other
22682 recipients.
22683
22684
22685 .option shadow_condition transports string&!! unset
22686 See &%shadow_transport%& below.
22687
22688
22689 .option shadow_transport transports string unset
22690 .cindex "shadow transport"
22691 .cindex "transport" "shadow"
22692 A local transport may set the &%shadow_transport%& option to the name of
22693 another local transport. Shadow remote transports are not supported.
22694
22695 Whenever a delivery to the main transport succeeds, and either
22696 &%shadow_condition%& is unset, or its expansion does not result in the empty
22697 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22698 passed to the shadow transport, with the same delivery address or addresses. If
22699 expansion fails, no action is taken except that non-forced expansion failures
22700 cause a log line to be written.
22701
22702 The result of the shadow transport is discarded and does not affect the
22703 subsequent processing of the message. Only a single level of shadowing is
22704 provided; the &%shadow_transport%& option is ignored on any transport when it
22705 is running as a shadow. Options concerned with output from pipes are also
22706 ignored. The log line for the successful delivery has an item added on the end,
22707 of the form
22708 .code
22709 ST=<shadow transport name>
22710 .endd
22711 If the shadow transport did not succeed, the error message is put in
22712 parentheses afterwards. Shadow transports can be used for a number of different
22713 purposes, including keeping more detailed log information than Exim normally
22714 provides, and implementing automatic acknowledgment policies based on message
22715 headers that some sites insist on.
22716
22717
22718 .option transport_filter transports string&!! unset
22719 .cindex "transport" "filter"
22720 .cindex "filter" "transport filter"
22721 This option sets up a filtering (in the Unix shell sense) process for messages
22722 at transport time. It should not be confused with mail filtering as set up by
22723 individual users or via a system filter.
22724 If unset, or expanding to an empty string, no filtering is done.
22725
22726 When the message is about to be written out, the command specified by
22727 &%transport_filter%& is started up in a separate, parallel process, and
22728 the entire message, including the header lines, is passed to it on its standard
22729 input (this in fact is done from a third process, to avoid deadlock). The
22730 command must be specified as an absolute path.
22731
22732 The lines of the message that are written to the transport filter are
22733 terminated by newline (&"\n"&). The message is passed to the filter before any
22734 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22735 lines beginning with a dot, and also before any processing implied by the
22736 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22737 &(pipe)& transports.
22738
22739 The standard error for the filter process is set to the same destination as its
22740 standard output; this is read and written to the message's ultimate
22741 destination. The process that writes the message to the filter, the
22742 filter itself, and the original process that reads the result and delivers it
22743 are all run in parallel, like a shell pipeline.
22744
22745 The filter can perform any transformations it likes, but of course should take
22746 care not to break RFC 2822 syntax. Exim does not check the result, except to
22747 test for a final newline when SMTP is in use. All messages transmitted over
22748 SMTP must end with a newline, so Exim supplies one if it is missing.
22749
22750 .cindex "content scanning" "per user"
22751 A transport filter can be used to provide content-scanning on a per-user basis
22752 at delivery time if the only required effect of the scan is to modify the
22753 message. For example, a content scan could insert a new header line containing
22754 a spam score. This could be interpreted by a filter in the user's MUA. It is
22755 not possible to discard a message at this stage.
22756
22757 .cindex "SIZE" "ESMTP extension"
22758 A problem might arise if the filter increases the size of a message that is
22759 being sent down an SMTP connection. If the receiving SMTP server has indicated
22760 support for the SIZE parameter, Exim will have sent the size of the message
22761 at the start of the SMTP session. If what is actually sent is substantially
22762 more, the server might reject the message. This can be worked round by setting
22763 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22764 additions to the message, or to disable the use of SIZE altogether.
22765
22766 .vindex "&$pipe_addresses$&"
22767 The value of the &%transport_filter%& option is the command string for starting
22768 the filter, which is run directly from Exim, not under a shell. The string is
22769 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22770 Exim breaks it up into arguments and then expands each argument separately (see
22771 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22772 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22773 of arguments, one for each address that applies to this delivery. (This isn't
22774 an ideal name for this feature here, but as it was already implemented for the
22775 &(pipe)& transport, it seemed sensible not to change it.)
22776
22777 .vindex "&$host$&"
22778 .vindex "&$host_address$&"
22779 The expansion variables &$host$& and &$host_address$& are available when the
22780 transport is a remote one. They contain the name and IP address of the host to
22781 which the message is being sent. For example:
22782 . used to have $sender_address in this cmdline, but it's tainted
22783 .code
22784 transport_filter = /some/directory/transport-filter.pl \
22785   $host $host_address $pipe_addresses
22786 .endd
22787
22788 Two problems arise if you want to use more complicated expansion items to
22789 generate transport filter commands, both of which due to the fact that the
22790 command is split up &'before'& expansion.
22791 .ilist
22792 If an expansion item contains white space, you must quote it, so that it is all
22793 part of the same command item. If the entire option setting is one such
22794 expansion item, you have to take care what kind of quoting you use. For
22795 example:
22796 .code
22797 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22798 .endd
22799 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22800 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22801 stripped by Exim when it read the option's value. When the value is used, if
22802 the single quotes were missing, the line would be split into two items,
22803 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22804 Exim tried to expand the first one.
22805 .next
22806 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22807 expansion cannot generate multiple arguments, or a command name followed by
22808 arguments. Consider this example:
22809 .code
22810 transport_filter = ${lookup{$host}lsearch{/a/file}\
22811                     {$value}{/bin/cat}}
22812 .endd
22813 The result of the lookup is interpreted as the name of the command, even
22814 if it contains white space. The simplest way round this is to use a shell:
22815 .code
22816 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22817                                {$value}{/bin/cat}}
22818 .endd
22819 .endlist
22820
22821 The filter process is run under the same uid and gid as the normal delivery.
22822 For remote deliveries this is the Exim uid/gid by default. The command should
22823 normally yield a zero return code. Transport filters are not supposed to fail.
22824 A non-zero code is taken to mean that the transport filter encountered some
22825 serious problem. Delivery of the message is deferred; the message remains on
22826 the queue and is tried again later. It is not possible to cause a message to be
22827 bounced from a transport filter.
22828
22829 If a transport filter is set on an autoreply transport, the original message is
22830 passed through the filter as it is being copied into the newly generated
22831 message, which happens if the &%return_message%& option is set.
22832
22833
22834 .option transport_filter_timeout transports time 5m
22835 .cindex "transport" "filter, timeout"
22836 When Exim is reading the output of a transport filter, it applies a timeout
22837 that can be set by this option. Exceeding the timeout is normally treated as a
22838 temporary delivery failure. However, if a transport filter is used with a
22839 &(pipe)& transport, a timeout in the transport filter is treated in the same
22840 way as a timeout in the pipe command itself. By default, a timeout is a hard
22841 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22842 becomes a temporary error.
22843
22844
22845 .option user transports string&!! "Exim user"
22846 .cindex "uid (user id)" "local delivery"
22847 .cindex "transport" "user, specifying"
22848 This option specifies the user under whose uid the delivery process is to be
22849 run, overriding any uid that may have been set by the router. If the user is
22850 given as a name, the uid is looked up from the password data, and the
22851 associated group is taken as the value of the gid to be used if the &%group%&
22852 option is not set.
22853
22854 For deliveries that use local transports, a user and group are normally
22855 specified explicitly or implicitly (for example, as a result of
22856 &%check_local_user%&) by the router or transport.
22857
22858 .cindex "hints database" "access by remote transport"
22859 For remote transports, you should leave this option unset unless you really are
22860 sure you know what you are doing. When a remote transport is running, it needs
22861 to be able to access Exim's hints databases, because each host may have its own
22862 retry data.
22863 .ecindex IIDgenoptra1
22864 .ecindex IIDgenoptra2
22865 .ecindex IIDgenoptra3
22866
22867
22868
22869
22870
22871
22872 . ////////////////////////////////////////////////////////////////////////////
22873 . ////////////////////////////////////////////////////////////////////////////
22874
22875 .chapter "Address batching in local transports" "CHAPbatching" &&&
22876          "Address batching"
22877 .cindex "transport" "local; address batching in"
22878 The only remote transport (&(smtp)&) is normally configured to handle more than
22879 one address at a time, so that when several addresses are routed to the same
22880 remote host, just one copy of the message is sent. Local transports, however,
22881 normally handle one address at a time. That is, a separate instance of the
22882 transport is run for each address that is routed to the transport. A separate
22883 copy of the message is delivered each time.
22884
22885 .cindex "batched local delivery"
22886 .oindex "&%batch_max%&"
22887 .oindex "&%batch_id%&"
22888 In special cases, it may be desirable to handle several addresses at once in a
22889 local transport, for example:
22890
22891 .ilist
22892 In an &(appendfile)& transport, when storing messages in files for later
22893 delivery by some other means, a single copy of the message with multiple
22894 recipients saves space.
22895 .next
22896 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22897 a single copy saves time, and is the normal way LMTP is expected to work.
22898 .next
22899 In a &(pipe)& transport, when passing the message
22900 to a scanner program or
22901 to some other delivery mechanism such as UUCP, multiple recipients may be
22902 acceptable.
22903 .endlist
22904
22905 These three local transports all have the same options for controlling multiple
22906 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22907 repeating the information for each transport, these options are described here.
22908
22909 The &%batch_max%& option specifies the maximum number of addresses that can be
22910 delivered together in a single run of the transport. Its default value is one
22911 (no batching). When more than one address is routed to a transport that has a
22912 &%batch_max%& value greater than one, the addresses are delivered in a batch
22913 (that is, in a single run of the transport with multiple recipients), subject
22914 to certain conditions:
22915
22916 .ilist
22917 .vindex "&$local_part$&"
22918 If any of the transport's options contain a reference to &$local_part$&, no
22919 batching is possible.
22920 .next
22921 .vindex "&$domain$&"
22922 If any of the transport's options contain a reference to &$domain$&, only
22923 addresses with the same domain are batched.
22924 .next
22925 .cindex "customizing" "batching condition"
22926 If &%batch_id%& is set, it is expanded for each address, and only those
22927 addresses with the same expanded value are batched. This allows you to specify
22928 customized batching conditions. Failure of the expansion for any reason,
22929 including forced failure, disables batching, but it does not stop the delivery
22930 from taking place.
22931 .next
22932 Batched addresses must also have the same errors address (where to send
22933 delivery errors), the same header additions and removals, the same user and
22934 group for the transport, and if a host list is present, the first host must
22935 be the same.
22936 .endlist
22937
22938 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22939 both when the file or pipe command is specified in the transport, and when it
22940 is specified by a &(redirect)& router, but all the batched addresses must of
22941 course be routed to the same file or pipe command. These two transports have an
22942 option called &%use_bsmtp%&, which causes them to deliver the message in
22943 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22944 &%check_string%& and &%escape_string%& options are forced to the values
22945 .code
22946 check_string = "."
22947 escape_string = ".."
22948 .endd
22949 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22950 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22951 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22952
22953 .cindex "&'Envelope-to:'& header line"
22954 If the generic &%envelope_to_add%& option is set for a batching transport, the
22955 &'Envelope-to:'& header that is added to the message contains all the addresses
22956 that are being processed together. If you are using a batching &(appendfile)&
22957 transport without &%use_bsmtp%&, the only way to preserve the recipient
22958 addresses is to set the &%envelope_to_add%& option.
22959
22960 .cindex "&(pipe)& transport" "with multiple addresses"
22961 .vindex "&$pipe_addresses$&"
22962 If you are using a &(pipe)& transport without BSMTP, and setting the
22963 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22964 the command. This is not a true variable; it is a bit of magic that causes each
22965 of the recipient addresses to be inserted into the command as a separate
22966 argument. This provides a way of accessing all the addresses that are being
22967 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22968 are specified by a &(redirect)& router.
22969
22970
22971
22972
22973 . ////////////////////////////////////////////////////////////////////////////
22974 . ////////////////////////////////////////////////////////////////////////////
22975
22976 .chapter "The appendfile transport" "CHAPappendfile"
22977 .scindex IIDapptra1 "&(appendfile)& transport"
22978 .scindex IIDapptra2 "transports" "&(appendfile)&"
22979 .cindex "directory creation"
22980 .cindex "creating directories"
22981 The &(appendfile)& transport delivers a message by appending it to an existing
22982 file, or by creating an entirely new file in a specified directory. Single
22983 files to which messages are appended can be in the traditional Unix mailbox
22984 format, or optionally in the MBX format supported by the Pine MUA and
22985 University of Washington IMAP daemon, &'inter alia'&. When each message is
22986 being delivered as a separate file, &"maildir"& format can optionally be used
22987 to give added protection against failures that happen part-way through the
22988 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22989 supported. For all file formats, Exim attempts to create as many levels of
22990 directory as necessary, provided that &%create_directory%& is set.
22991
22992 The code for the optional formats is not included in the Exim binary by
22993 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22994 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22995 included.
22996
22997 .cindex "quota" "system"
22998 Exim recognizes system quota errors, and generates an appropriate message. Exim
22999 also supports its own quota control within the transport, for use when the
23000 system facility is unavailable or cannot be used for some reason.
23001
23002 If there is an error while appending to a file (for example, quota exceeded or
23003 partition filled), Exim attempts to reset the file's length and last
23004 modification time back to what they were before. If there is an error while
23005 creating an entirely new file, the new file is removed.
23006
23007 Before appending to a file, a number of security checks are made, and the
23008 file is locked. A detailed description is given below, after the list of
23009 private options.
23010
23011 The &(appendfile)& transport is most commonly used for local deliveries to
23012 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23013 putting messages into files for remote delivery by some means other than Exim.
23014 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23015 option).
23016
23017
23018
23019 .section "The file and directory options" "SECTfildiropt"
23020 The &%file%& option specifies a single file, to which the message is appended;
23021 the &%directory%& option specifies a directory, in which a new file containing
23022 the message is created. Only one of these two options can be set, and for
23023 normal deliveries to mailboxes, one of them &'must'& be set.
23024
23025 .vindex "&$address_file$&"
23026 .vindex "&$local_part$&"
23027 However, &(appendfile)& is also used for delivering messages to files or
23028 directories whose names (or parts of names) are obtained from alias,
23029 forwarding, or filtering operations (for example, a &%save%& command in a
23030 user's Exim filter). When such a transport is running, &$local_part$& contains
23031 the local part that was aliased or forwarded, and &$address_file$& contains the
23032 name (or partial name) of the file or directory generated by the redirection
23033 operation. There are two cases:
23034
23035 .ilist
23036 If neither &%file%& nor &%directory%& is set, the redirection operation
23037 must specify an absolute path (one that begins with &`/`&). This is the most
23038 common case when users with local accounts use filtering to sort mail into
23039 different folders. See for example, the &(address_file)& transport in the
23040 default configuration. If the path ends with a slash, it is assumed to be the
23041 name of a directory. A delivery to a directory can also be forced by setting
23042 &%maildir_format%& or &%mailstore_format%&.
23043 .next
23044 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23045 used to determine the file or directory name for the delivery. Normally, the
23046 contents of &$address_file$& are used in some way in the string expansion.
23047 .endlist
23048 If the &%create_file%& option is set to a path which
23049 matches (see the option definition below for details)
23050 a file or directory name
23051 for the delivery, that name becomes de-tainted.
23052
23053 .cindex "tainted data" "in filenames"
23054 .cindex appendfile "tainted data"
23055 Tainted data may not be used for a file or directory name.
23056 This means that, for instance, &$local_part$& cannot be used directly
23057 as a component of a path.  It can however be used as the key for a lookup
23058 which returns a path (or component).
23059
23060
23061 .cindex "Sieve filter" "configuring &(appendfile)&"
23062 .cindex "Sieve filter" "relative mailbox path handling"
23063 As an example of the second case, consider an environment where users do not
23064 have home directories. They may be permitted to use Exim filter commands of the
23065 form:
23066 .code
23067 save folder23
23068 .endd
23069 or Sieve filter commands of the form:
23070 .code
23071 require "fileinto";
23072 fileinto "folder23";
23073 .endd
23074 In this situation, the expansion of &%file%& or &%directory%& in the transport
23075 must transform the relative path into an appropriate absolute filename. In the
23076 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23077 is used as a result of a &"keep"& action in the filter. This example shows one
23078 way of handling this requirement:
23079 .code
23080 file = ${if eq{$address_file}{inbox} \
23081             {/var/mail/$local_part_data} \
23082             {${if eq{${substr_0_1:$address_file}}{/} \
23083                   {$address_file} \
23084                   {$home/mail/$address_file} \
23085             }} \
23086        }
23087 .endd
23088 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23089 location, absolute paths are used without change, and other folders are in the
23090 &_mail_& directory within the home directory.
23091
23092 &*Note 1*&: While processing an Exim filter, a relative path such as
23093 &_folder23_& is turned into an absolute path if a home directory is known to
23094 the router. In particular, this is the case if &%check_local_user%& is set. If
23095 you want to prevent this happening at routing time, you can set
23096 &%router_home_directory%& empty. This forces the router to pass the relative
23097 path to the transport.
23098
23099 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23100 the &%file%& or &%directory%& option is still used if it is set.
23101
23102
23103
23104
23105 .section "Private options for appendfile" "SECID134"
23106 .cindex "options" "&(appendfile)& transport"
23107
23108
23109
23110 .option allow_fifo appendfile boolean false
23111 .cindex "fifo (named pipe)"
23112 .cindex "named pipe (fifo)"
23113 .cindex "pipe" "named (fifo)"
23114 Setting this option permits delivery to named pipes (FIFOs) as well as to
23115 regular files. If no process is reading the named pipe at delivery time, the
23116 delivery is deferred.
23117
23118
23119 .option allow_symlink appendfile boolean false
23120 .cindex "symbolic link" "to mailbox"
23121 .cindex "mailbox" "symbolic link"
23122 By default, &(appendfile)& will not deliver if the path name for the file is
23123 that of a symbolic link. Setting this option relaxes that constraint, but there
23124 are security issues involved in the use of symbolic links. Be sure you know
23125 what you are doing if you set this. Details of exactly what this option affects
23126 are included in the discussion which follows this list of options.
23127
23128
23129 .option batch_id appendfile string&!! unset
23130 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23131 However, batching is automatically disabled for &(appendfile)& deliveries that
23132 happen as a result of forwarding or aliasing or other redirection directly to a
23133 file.
23134
23135
23136 .option batch_max appendfile integer 1
23137 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23138
23139
23140 .option check_group appendfile boolean false
23141 When this option is set, the group owner of the file defined by the &%file%&
23142 option is checked to see that it is the same as the group under which the
23143 delivery process is running. The default setting is false because the default
23144 file mode is 0600, which means that the group is irrelevant.
23145
23146
23147 .option check_owner appendfile boolean true
23148 When this option is set, the owner of the file defined by the &%file%& option
23149 is checked to ensure that it is the same as the user under which the delivery
23150 process is running.
23151
23152
23153 .option check_string appendfile string "see below"
23154 .cindex "&""From""& line"
23155 As &(appendfile)& writes the message, the start of each line is tested for
23156 matching &%check_string%&, and if it does, the initial matching characters are
23157 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23158 a literal string, not a regular expression, and the case of any letters it
23159 contains is significant.
23160
23161 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23162 are forced to &"."& and &".."& respectively, and any settings in the
23163 configuration are ignored. Otherwise, they default to &"From&~"& and
23164 &">From&~"& when the &%file%& option is set, and unset when any of the
23165 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23166
23167 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23168 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23169 &"From&~"& indicates the start of a new message. All four options need changing
23170 if another format is used. For example, to deliver to mailboxes in MMDF format:
23171 .cindex "MMDF format mailbox"
23172 .cindex "mailbox" "MMDF format"
23173 .code
23174 check_string = "\1\1\1\1\n"
23175 escape_string = "\1\1\1\1 \n"
23176 message_prefix = "\1\1\1\1\n"
23177 message_suffix = "\1\1\1\1\n"
23178 .endd
23179 .option create_directory appendfile boolean true
23180 .cindex "directory creation"
23181 When this option is true, Exim attempts to create any missing superior
23182 directories for the file that it is about to write. A created directory's mode
23183 is given by the &%directory_mode%& option.
23184
23185 The group ownership of a newly created directory is highly dependent on the
23186 operating system (and possibly the file system) that is being used. For
23187 example, in Solaris, if the parent directory has the setgid bit set, its group
23188 is propagated to the child; if not, the currently set group is used. However,
23189 in FreeBSD, the parent's group is always used.
23190
23191
23192
23193 .option create_file appendfile string anywhere
23194 This option constrains the location of files and directories that are created
23195 by this transport. It applies to files defined by the &%file%& option and
23196 directories defined by the &%directory%& option. In the case of maildir
23197 delivery, it applies to the top level directory, not the maildir directories
23198 beneath.
23199
23200 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23201 &"belowhome"&, or to an absolute path.
23202
23203 In the second and third cases, a home directory must have been
23204 set for the transport, and the file or directory being created must
23205 reside within it.
23206 The "belowhome" checking additionally checks for attempts to use "../"
23207 to evade the testing.
23208 This option is not useful when an explicit filename is
23209 given for normal mailbox deliveries. It is intended for the case when filenames
23210 are generated from users' &_.forward_& files. These are usually handled
23211 by an &(appendfile)& transport called &%address_file%&. See also
23212 &%file_must_exist%&.
23213
23214 In the fourth case,
23215 the value given for this option must be an absolute path for an
23216 existing directory.
23217 The value is used for checking instead of a home directory;
23218 checking is done in "belowhome" mode.
23219
23220 .cindex "tainted data" "de-tainting"
23221 .cindex "de-tainting" "using appendfile create_file option"
23222 If "belowhome" checking is used, the file or directory path
23223 becomes de-tainted.
23224
23225
23226 .option directory appendfile string&!! unset
23227 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23228 or &%directory%& must be set, unless the delivery is the direct result of a
23229 redirection (see section &<<SECTfildiropt>>&).
23230
23231 When &%directory%& is set, the string is expanded, and the message is delivered
23232 into a new file or files in or below the given directory, instead of being
23233 appended to a single mailbox file. A number of different formats are provided
23234 (see &%maildir_format%& and &%mailstore_format%&), and see section
23235 &<<SECTopdir>>& for further details of this form of delivery.
23236
23237 The result of expansion must not be tainted, unless the &%create_file%& option
23238 specifies a path.
23239
23240
23241 .option directory_file appendfile string&!! "see below"
23242 .cindex "base62"
23243 .vindex "&$inode$&"
23244 When &%directory%& is set, but neither &%maildir_format%& nor
23245 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23246 whose name is obtained by expanding this string. The default value is:
23247 .code
23248 q${base62:$tod_epoch}-$inode
23249 .endd
23250 This generates a unique name from the current time, in base 62 form, and the
23251 inode of the file. The variable &$inode$& is available only when expanding this
23252 option.
23253
23254
23255 .option directory_mode appendfile "octal integer" 0700
23256 If &(appendfile)& creates any directories as a result of the
23257 &%create_directory%& option, their mode is specified by this option.
23258
23259
23260 .option escape_string appendfile string "see description"
23261 See &%check_string%& above.
23262
23263
23264 .option file appendfile string&!! unset
23265 This option is mutually exclusive with the &%directory%& option, but one of
23266 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23267 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23268 specifies a single file, to which the message is appended. One or more of
23269 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23270 &%file%&.
23271
23272 The result of expansion must not be tainted, unless the &%create_file%& option
23273 specifies a path.
23274
23275 .cindex "NFS" "lock file"
23276 .cindex "locking files"
23277 .cindex "lock files"
23278 If you are using more than one host to deliver over NFS into the same
23279 mailboxes, you should always use lock files.
23280
23281 The string value is expanded for each delivery, and must yield an absolute
23282 path. The most common settings of this option are variations on one of these
23283 examples:
23284 .code
23285 file = /var/spool/mail/$local_part_data
23286 file = /home/$local_part_data/inbox
23287 file = $home/inbox
23288 .endd
23289 .cindex "&""sticky""& bit"
23290 In the first example, all deliveries are done into the same directory. If Exim
23291 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23292 create a file in the directory, so the &"sticky"& bit must be turned on for
23293 deliveries to be possible, or alternatively the &%group%& option can be used to
23294 run the delivery under a group id which has write access to the directory.
23295
23296
23297
23298 .option file_format appendfile string unset
23299 .cindex "file" "mailbox; checking existing format"
23300 This option requests the transport to check the format of an existing file
23301 before adding to it. The check consists of matching a specific string at the
23302 start of the file. The value of the option consists of an even number of
23303 colon-separated strings. The first of each pair is the test string, and the
23304 second is the name of a transport. If the transport associated with a matched
23305 string is not the current transport, control is passed over to the other
23306 transport. For example, suppose the standard &(local_delivery)& transport has
23307 this added to it:
23308 .code
23309 file_format = "From       : local_delivery :\
23310                \1\1\1\1\n : local_mmdf_delivery"
23311 .endd
23312 Mailboxes that begin with &"From"& are still handled by this transport, but if
23313 a mailbox begins with four binary ones followed by a newline, control is passed
23314 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23315 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23316 is assumed to match the current transport. If the start of a mailbox doesn't
23317 match any string, or if the transport named for a given string is not defined,
23318 delivery is deferred.
23319
23320
23321 .option file_must_exist appendfile boolean false
23322 If this option is true, the file specified by the &%file%& option must exist.
23323 A temporary error occurs if it does not, causing delivery to be deferred.
23324 If this option is false, the file is created if it does not exist.
23325
23326
23327 .option lock_fcntl_timeout appendfile time 0s
23328 .cindex "timeout" "mailbox locking"
23329 .cindex "mailbox" "locking, blocking and non-blocking"
23330 .cindex "locking files"
23331 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23332 when locking an open mailbox file. If the call fails, the delivery process
23333 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23334 Non-blocking calls are used so that the file is not kept open during the wait
23335 for the lock; the reason for this is to make it as safe as possible for
23336 deliveries over NFS in the case when processes might be accessing an NFS
23337 mailbox without using a lock file. This should not be done, but
23338 misunderstandings and hence misconfigurations are not unknown.
23339
23340 On a busy system, however, the performance of a non-blocking lock approach is
23341 not as good as using a blocking lock with a timeout. In this case, the waiting
23342 is done inside the system call, and Exim's delivery process acquires the lock
23343 and can proceed as soon as the previous lock holder releases it.
23344
23345 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23346 timeout, are used. There may still be some retrying: the maximum number of
23347 retries is
23348 .code
23349 (lock_retries * lock_interval) / lock_fcntl_timeout
23350 .endd
23351 rounded up to the next whole number. In other words, the total time during
23352 which &(appendfile)& is trying to get a lock is roughly the same, unless
23353 &%lock_fcntl_timeout%& is set very large.
23354
23355 You should consider setting this option if you are getting a lot of delayed
23356 local deliveries because of errors of the form
23357 .code
23358 failed to lock mailbox /some/file (fcntl)
23359 .endd
23360
23361 .option lock_flock_timeout appendfile time 0s
23362 This timeout applies to file locking when using &[flock()]& (see
23363 &%use_flock%&); the timeout operates in a similar manner to
23364 &%lock_fcntl_timeout%&.
23365
23366
23367 .option lock_interval appendfile time 3s
23368 This specifies the time to wait between attempts to lock the file. See below
23369 for details of locking.
23370
23371
23372 .option lock_retries appendfile integer 10
23373 This specifies the maximum number of attempts to lock the file. A value of zero
23374 is treated as 1. See below for details of locking.
23375
23376
23377 .option lockfile_mode appendfile "octal integer" 0600
23378 This specifies the mode of the created lock file, when a lock file is being
23379 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23380
23381
23382 .option lockfile_timeout appendfile time 30m
23383 .cindex "timeout" "mailbox locking"
23384 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23385 exists and is older than this value, it is assumed to have been left behind by
23386 accident, and Exim attempts to remove it.
23387
23388
23389 .option mailbox_filecount appendfile string&!! unset
23390 .cindex "mailbox" "specifying size of"
23391 .cindex "size" "of mailbox"
23392 If this option is set, it is expanded, and the result is taken as the current
23393 number of files in the mailbox. It must be a decimal number, optionally
23394 followed by K or M. This provides a way of obtaining this information from an
23395 external source that maintains the data.
23396
23397
23398 .option mailbox_size appendfile string&!! unset
23399 .cindex "mailbox" "specifying size of"
23400 .cindex "size" "of mailbox"
23401 If this option is set, it is expanded, and the result is taken as the current
23402 size the mailbox. It must be a decimal number, optionally followed by K or M.
23403 This provides a way of obtaining this information from an external source that
23404 maintains the data. This is likely to be helpful for maildir deliveries where
23405 it is computationally expensive to compute the size of a mailbox.
23406
23407
23408
23409 .option maildir_format appendfile boolean false
23410 .cindex "maildir format" "specifying"
23411 If this option is set with the &%directory%& option, the delivery is into a new
23412 file, in the &"maildir"& format that is used by other mail software. When the
23413 transport is activated directly from a &(redirect)& router (for example, the
23414 &(address_file)& transport in the default configuration), setting
23415 &%maildir_format%& causes the path received from the router to be treated as a
23416 directory, whether or not it ends with &`/`&. This option is available only if
23417 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23418 &<<SECTmaildirdelivery>>& below for further details.
23419
23420
23421 .option maildir_quota_directory_regex appendfile string "See below"
23422 .cindex "maildir format" "quota; directories included in"
23423 .cindex "quota" "maildir; directories included in"
23424 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23425 a regular expression for specifying directories, relative to the quota
23426 directory (see &%quota_directory%&), that should be included in the quota
23427 calculation. The default value is:
23428 .code
23429 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23430 .endd
23431 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23432 (directories whose names begin with a dot). If you want to exclude the
23433 &_Trash_&
23434 folder from the count (as some sites do), you need to change this setting to
23435 .code
23436 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23437 .endd
23438 This uses a negative lookahead in the regular expression to exclude the
23439 directory whose name is &_.Trash_&. When a directory is excluded from quota
23440 calculations, quota processing is bypassed for any messages that are delivered
23441 directly into that directory.
23442
23443
23444 .option maildir_retries appendfile integer 10
23445 This option specifies the number of times to retry when writing a file in
23446 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23447
23448
23449 .option maildir_tag appendfile string&!! unset
23450 This option applies only to deliveries in maildir format, and is described in
23451 section &<<SECTmaildirdelivery>>& below.
23452
23453
23454 .option maildir_use_size_file appendfile&!! boolean false
23455 .cindex "maildir format" "&_maildirsize_& file"
23456 The result of string expansion for this option must be a valid boolean value.
23457 If it is true, it enables support for &_maildirsize_& files. Exim
23458 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23459 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23460 value is zero. See &%maildir_quota_directory_regex%& above and section
23461 &<<SECTmaildirdelivery>>& below for further details.
23462
23463 .option maildirfolder_create_regex appendfile string unset
23464 .cindex "maildir format" "&_maildirfolder_& file"
23465 .cindex "&_maildirfolder_&, creating"
23466 The value of this option is a regular expression. If it is unset, it has no
23467 effect. Otherwise, before a maildir delivery takes place, the pattern is
23468 matched against the name of the maildir directory, that is, the directory
23469 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23470 delivery. If there is a match, Exim checks for the existence of a file called
23471 &_maildirfolder_& in the directory, and creates it if it does not exist.
23472 See section &<<SECTmaildirdelivery>>& for more details.
23473
23474
23475 .option mailstore_format appendfile boolean false
23476 .cindex "mailstore format" "specifying"
23477 If this option is set with the &%directory%& option, the delivery is into two
23478 new files in  &"mailstore"& format. The option is available only if
23479 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23480 below for further details.
23481
23482
23483 .option mailstore_prefix appendfile string&!! unset
23484 This option applies only to deliveries in mailstore format, and is described in
23485 section &<<SECTopdir>>& below.
23486
23487
23488 .option mailstore_suffix appendfile string&!! unset
23489 This option applies only to deliveries in mailstore format, and is described in
23490 section &<<SECTopdir>>& below.
23491
23492
23493 .option mbx_format appendfile boolean false
23494 .cindex "locking files"
23495 .cindex "file" "locking"
23496 .cindex "file" "MBX format"
23497 .cindex "MBX format, specifying"
23498 This option is available only if Exim has been compiled with SUPPORT_MBX
23499 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23500 the message is appended to the mailbox file in MBX format instead of
23501 traditional Unix format. This format is supported by Pine4 and its associated
23502 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23503
23504 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23505 automatically changed by the use of &%mbx_format%&. They should normally be set
23506 empty when using MBX format, so this option almost always appears in this
23507 combination:
23508 .code
23509 mbx_format = true
23510 message_prefix =
23511 message_suffix =
23512 .endd
23513 If none of the locking options are mentioned in the configuration,
23514 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23515 is possible to specify the other kinds of locking with &%mbx_format%&, but
23516 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23517 interworks with &'c-client'&, providing for shared access to the mailbox. It
23518 should not be used if any program that does not use this form of locking is
23519 going to access the mailbox, nor should it be used if the mailbox file is NFS
23520 mounted, because it works only when the mailbox is accessed from a single host.
23521
23522 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23523 the standard version of &'c-client'&, because as long as it has a mailbox open
23524 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23525 append messages to it.
23526
23527
23528 .option message_prefix appendfile string&!! "see below"
23529 .cindex "&""From""& line"
23530 The string specified here is expanded and output at the start of every message.
23531 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23532 in which case it is:
23533 .code
23534 message_prefix = "From ${if def:return_path{$return_path}\
23535   {MAILER-DAEMON}} $tod_bsdinbox\n"
23536 .endd
23537 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23538 &`\n`& to &`\r\n`& in &%message_prefix%&.
23539
23540 .option message_suffix appendfile string&!! "see below"
23541 The string specified here is expanded and output at the end of every message.
23542 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23543 in which case it is a single newline character. The suffix can be suppressed by
23544 setting
23545 .code
23546 message_suffix =
23547 .endd
23548 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23549 &`\n`& to &`\r\n`& in &%message_suffix%&.
23550
23551 .option mode appendfile "octal integer" 0600
23552 If the output file is created, it is given this mode. If it already exists and
23553 has wider permissions, they are reduced to this mode. If it has narrower
23554 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23555 if the delivery is the result of a &%save%& command in a filter file specifying
23556 a particular mode, the mode of the output file is always forced to take that
23557 value, and this option is ignored.
23558
23559
23560 .option mode_fail_narrower appendfile boolean true
23561 This option applies in the case when an existing mailbox file has a narrower
23562 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23563 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23564 continues with the delivery attempt, using the existing mode of the file.
23565
23566
23567 .option notify_comsat appendfile boolean false
23568 If this option is true, the &'comsat'& daemon is notified after every
23569 successful delivery to a user mailbox. This is the daemon that notifies logged
23570 on users about incoming mail.
23571
23572
23573 .option quota appendfile string&!! unset
23574 .cindex "quota" "imposed by Exim"
23575 This option imposes a limit on the size of the file to which Exim is appending,
23576 or to the total space used in the directory tree when the &%directory%& option
23577 is set. In the latter case, computation of the space used is expensive, because
23578 all the files in the directory (and any sub-directories) have to be
23579 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23580 &%maildir_use_size_file%& for ways to avoid this in environments where users
23581 have no shell access to their mailboxes).
23582
23583 As there is no interlock against two simultaneous deliveries into a
23584 multi-file mailbox, it is possible for the quota to be overrun in this case.
23585 For single-file mailboxes, of course, an interlock is a necessity.
23586
23587 A file's size is taken as its &'used'& value. Because of blocking effects, this
23588 may be a lot less than the actual amount of disk space allocated to the file.
23589 If the sizes of a number of files are being added up, the rounding effect can
23590 become quite noticeable, especially on systems that have large block sizes.
23591 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23592 the obvious value which users understand most easily.
23593
23594 The value of the option is expanded, and must then be a numerical value
23595 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23596 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23597 and further option modifiers. If Exim is running on a system with
23598 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23599 be handled.
23600
23601 The option modifier &%no_check%& can be used to force delivery even if the over
23602 quota condition is met. The quota gets updated as usual.
23603
23604 &*Note*&: A value of zero is interpreted as &"no quota"&.
23605
23606 The expansion happens while Exim is running as root, before it changes uid for
23607 the delivery. This means that files that are inaccessible to the end user can
23608 be used to hold quota values that are looked up in the expansion. When delivery
23609 fails because this quota is exceeded, the handling of the error is as for
23610 system quota failures.
23611
23612 By default, Exim's quota checking mimics system quotas, and restricts the
23613 mailbox to the specified maximum size, though the value is not accurate to the
23614 last byte, owing to separator lines and additional headers that may get added
23615 during message delivery. When a mailbox is nearly full, large messages may get
23616 refused even though small ones are accepted, because the size of the current
23617 message is added to the quota when the check is made. This behaviour can be
23618 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23619 for exceeding the quota does not include the current message. Thus, deliveries
23620 continue until the quota has been exceeded; thereafter, no further messages are
23621 delivered. See also &%quota_warn_threshold%&.
23622
23623
23624 .option quota_directory appendfile string&!! unset
23625 This option defines the directory to check for quota purposes when delivering
23626 into individual files. The default is the delivery directory, or, if a file
23627 called &_maildirfolder_& exists in a maildir directory, the parent of the
23628 delivery directory.
23629
23630
23631 .option quota_filecount appendfile string&!! 0
23632 This option applies when the &%directory%& option is set. It limits the total
23633 number of files in the directory (compare the inode limit in system quotas). It
23634 can only be used if &%quota%& is also set. The value is expanded; an expansion
23635 failure causes delivery to be deferred. A value of zero is interpreted as
23636 &"no quota"&.
23637
23638 The option modifier &%no_check%& can be used to force delivery even if the over
23639 quota condition is met. The quota gets updated as usual.
23640
23641 .option quota_is_inclusive appendfile boolean true
23642 See &%quota%& above.
23643
23644
23645 .option quota_size_regex appendfile string unset
23646 This option applies when one of the delivery modes that writes a separate file
23647 for each message is being used. When Exim wants to find the size of one of
23648 these files in order to test the quota, it first checks &%quota_size_regex%&.
23649 If this is set to a regular expression that matches the filename, and it
23650 captures one string, that string is interpreted as a representation of the
23651 file's size. The value of &%quota_size_regex%& is not expanded.
23652
23653 This feature is useful only when users have no shell access to their mailboxes
23654 &-- otherwise they could defeat the quota simply by renaming the files. This
23655 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23656 the file length to the filename. For example:
23657 .code
23658 maildir_tag = ,S=$message_size
23659 quota_size_regex = ,S=(\d+)
23660 .endd
23661 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23662 number of lines in the message.
23663
23664 The regular expression should not assume that the length is at the end of the
23665 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23666 sometimes add other information onto the ends of message filenames.
23667
23668 Section &<<SECID136>>& contains further information.
23669
23670 This option should not be used when other message-handling software
23671 may duplicate messages by making hardlinks to the files.  When that is done Exim
23672 will count the message size once for each filename, in contrast with the actual
23673 disk usage.  When the option is not set, calculating total usage requires
23674 a system-call per file to get the size; the number of links is then available also
23675 as is used to adjust the effective size.
23676
23677
23678 .option quota_warn_message appendfile string&!! "see below"
23679 See below for the use of this option. If it is not set when
23680 &%quota_warn_threshold%& is set, it defaults to
23681 .code
23682 quota_warn_message = "\
23683   To: $local_part@$domain\n\
23684   Subject: Your mailbox\n\n\
23685   This message is automatically created \
23686   by mail delivery software.\n\n\
23687   The size of your mailbox has exceeded \
23688   a warning threshold that is\n\
23689   set by the system administrator.\n"
23690 .endd
23691
23692
23693 .option quota_warn_threshold appendfile string&!! 0
23694 .cindex "quota" "warning threshold"
23695 .cindex "mailbox" "size warning"
23696 .cindex "size" "of mailbox"
23697 This option is expanded in the same way as &%quota%& (see above). If the
23698 resulting value is greater than zero, and delivery of the message causes the
23699 size of the file or total space in the directory tree to cross the given
23700 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23701 may be specified as a percentage of it by following the value with a percent
23702 sign. For example:
23703 .code
23704 quota = 10M
23705 quota_warn_threshold = 75%
23706 .endd
23707 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23708 percent sign is ignored.
23709
23710 The warning message itself is specified by the &%quota_warn_message%& option,
23711 and it must start with a &'To:'& header line containing the recipient(s) of the
23712 warning message. These do not necessarily have to include the recipient(s) of
23713 the original message. A &'Subject:'& line should also normally be supplied. You
23714 can include any other header lines that you want. If you do not include a
23715 &'From:'& line, the default is:
23716 .code
23717 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23718 .endd
23719 .oindex &%errors_reply_to%&
23720 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23721 option.
23722
23723 The &%quota%& option does not have to be set in order to use this option; they
23724 are independent of one another except when the threshold is specified as a
23725 percentage.
23726
23727
23728 .option use_bsmtp appendfile boolean false
23729 .cindex "envelope from"
23730 .cindex "envelope sender"
23731 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23732 format, with the envelope sender and recipient(s) included as SMTP commands. If
23733 you want to include a leading HELO command with such messages, you can do
23734 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23735 for details of batch SMTP.
23736
23737
23738 .option use_crlf appendfile boolean false
23739 .cindex "carriage return"
23740 .cindex "linefeed"
23741 This option causes lines to be terminated with the two-character CRLF sequence
23742 (carriage return, linefeed) instead of just a linefeed character. In the case
23743 of batched SMTP, the byte sequence written to the file is then an exact image
23744 of what would be sent down a real SMTP connection.
23745
23746 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23747 (which are used to supply the traditional &"From&~"& and blank line separators
23748 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23749 carriage return characters if these are needed. In cases where these options
23750 have non-empty defaults, the values end with a single linefeed, so they must be
23751 changed to end with &`\r\n`& if &%use_crlf%& is set.
23752
23753
23754 .option use_fcntl_lock appendfile boolean "see below"
23755 This option controls the use of the &[fcntl()]& function to lock a file for
23756 exclusive use when a message is being appended. It is set by default unless
23757 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23758 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23759 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23760
23761
23762 .option use_flock_lock appendfile boolean false
23763 This option is provided to support the use of &[flock()]& for file locking, for
23764 the few situations where it is needed. Most modern operating systems support
23765 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23766 each other. Exim uses &[fcntl()]& locking by default.
23767
23768 This option is required only if you are using an operating system where
23769 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23770 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23771 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23772
23773 .cindex "Solaris" "&[flock()]& support"
23774 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23775 have it (and some, I think, provide a not quite right version built on top of
23776 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23777 the ability to use it, and any attempt to do so will cause a configuration
23778 error.
23779
23780 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23781 is just being mapped onto &[fcntl()]& by the OS).
23782
23783
23784 .option use_lockfile appendfile boolean "see below"
23785 If this option is turned off, Exim does not attempt to create a lock file when
23786 appending to a mailbox file. In this situation, the only locking is by
23787 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23788 sure that every MUA that is ever going to look at your users' mailboxes uses
23789 &[fcntl()]& rather than a lock file, and even then only when you are not
23790 delivering over NFS from more than one host.
23791
23792 .cindex "NFS" "lock file"
23793 In order to append to an NFS file safely from more than one host, it is
23794 necessary to take out a lock &'before'& opening the file, and the lock file
23795 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23796 file corruption.
23797
23798 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23799 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23800 except when &%mbx_format%& is set.
23801
23802
23803 .option use_mbx_lock appendfile boolean "see below"
23804 This option is available only if Exim has been compiled with SUPPORT_MBX
23805 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23806 locking rules be used. It is set by default if &%mbx_format%& is set and none
23807 of the locking options are mentioned in the configuration. The locking rules
23808 are the same as are used by the &'c-client'& library that underlies Pine and
23809 the IMAP4 and POP daemons that come with it (see the discussion below). The
23810 rules allow for shared access to the mailbox. However, this kind of locking
23811 does not work when the mailbox is NFS mounted.
23812
23813 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23814 &%use_flock_lock%& to control what kind of locking is used in implementing the
23815 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23816 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23817
23818
23819
23820
23821 .section "Operational details for appending" "SECTopappend"
23822 .cindex "appending to a file"
23823 .cindex "file" "appending"
23824 Before appending to a file, the following preparations are made:
23825
23826 .ilist
23827 If the name of the file is &_/dev/null_&, no action is taken, and a success
23828 return is given.
23829
23830 .next
23831 .cindex "directory creation"
23832 If any directories on the file's path are missing, Exim creates them if the
23833 &%create_directory%& option is set. A created directory's mode is given by the
23834 &%directory_mode%& option.
23835
23836 .next
23837 If &%file_format%& is set, the format of an existing file is checked. If this
23838 indicates that a different transport should be used, control is passed to that
23839 transport.
23840
23841 .next
23842 .cindex "file" "locking"
23843 .cindex "locking files"
23844 .cindex "NFS" "lock file"
23845 If &%use_lockfile%& is set, a lock file is built in a way that will work
23846 reliably over NFS, as follows:
23847
23848 .olist
23849 Create a &"hitching post"& file whose name is that of the lock file with the
23850 current time, primary host name, and process id added, by opening for writing
23851 as a new file. If this fails with an access error, delivery is deferred.
23852 .next
23853 Close the hitching post file, and hard link it to the lock filename.
23854 .next
23855 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23856 Unlink the hitching post name.
23857 .next
23858 Otherwise, use &[stat()]& to get information about the hitching post file, and
23859 then unlink hitching post name. If the number of links is exactly two, creation
23860 of the lock file succeeded but something (for example, an NFS server crash and
23861 restart) caused this fact not to be communicated to the &[link()]& call.
23862 .next
23863 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23864 up to &%lock_retries%& times. However, since any program that writes to a
23865 mailbox should complete its task very quickly, it is reasonable to time out old
23866 lock files that are normally the result of user agent and system crashes. If an
23867 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23868 it before trying again.
23869 .endlist olist
23870
23871 .next
23872 A call is made to &[lstat()]& to discover whether the main file exists, and if
23873 so, what its characteristics are. If &[lstat()]& fails for any reason other
23874 than non-existence, delivery is deferred.
23875
23876 .next
23877 .cindex "symbolic link" "to mailbox"
23878 .cindex "mailbox" "symbolic link"
23879 If the file does exist and is a symbolic link, delivery is deferred, unless the
23880 &%allow_symlink%& option is set, in which case the ownership of the link is
23881 checked, and then &[stat()]& is called to find out about the real file, which
23882 is then subjected to the checks below. The check on the top-level link
23883 ownership prevents one user creating a link for another's mailbox in a sticky
23884 directory, though allowing symbolic links in this case is definitely not a good
23885 idea. If there is a chain of symbolic links, the intermediate ones are not
23886 checked.
23887
23888 .next
23889 If the file already exists but is not a regular file, or if the file's owner
23890 and group (if the group is being checked &-- see &%check_group%& above) are
23891 different from the user and group under which the delivery is running,
23892 delivery is deferred.
23893
23894 .next
23895 If the file's permissions are more generous than specified, they are reduced.
23896 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23897 is set false, in which case the delivery is tried using the existing
23898 permissions.
23899
23900 .next
23901 The file's inode number is saved, and the file is then opened for appending.
23902 If this fails because the file has vanished, &(appendfile)& behaves as if it
23903 hadn't existed (see below). For any other failures, delivery is deferred.
23904
23905 .next
23906 If the file is opened successfully, check that the inode number hasn't
23907 changed, that it is still a regular file, and that the owner and permissions
23908 have not changed. If anything is wrong, defer delivery and freeze the message.
23909
23910 .next
23911 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23912 option is set. Otherwise, check that the file is being created in a permitted
23913 directory if the &%create_file%& option is set (deferring on failure), and then
23914 open for writing as a new file, with the O_EXCL and O_CREAT options,
23915 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23916 set). In this case, which can happen if the link points to a non-existent file,
23917 the file is opened for writing using O_CREAT but not O_EXCL, because
23918 that prevents link following.
23919
23920 .next
23921 .cindex "loop" "while file testing"
23922 If opening fails because the file exists, obey the tests given above for
23923 existing files. However, to avoid looping in a situation where the file is
23924 being continuously created and destroyed, the exists/not-exists loop is broken
23925 after 10 repetitions, and the message is then frozen.
23926
23927 .next
23928 If opening fails with any other error, defer delivery.
23929
23930 .next
23931 .cindex "file" "locking"
23932 .cindex "locking files"
23933 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23934 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23935 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23936 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23937 file, and an exclusive lock on the file whose name is
23938 .code
23939 /tmp/.<device-number>.<inode-number>
23940 .endd
23941 using the device and inode numbers of the open mailbox file, in accordance with
23942 the MBX locking rules. This file is created with a mode that is specified by
23943 the &%lockfile_mode%& option.
23944
23945 If Exim fails to lock the file, there are two possible courses of action,
23946 depending on the value of the locking timeout. This is obtained from
23947 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23948
23949 If the timeout value is zero, the file is closed, Exim waits for
23950 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23951 to lock it again. This happens up to &%lock_retries%& times, after which the
23952 delivery is deferred.
23953
23954 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23955 &[flock()]& are used (with the given timeout), so there has already been some
23956 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23957 immediately. It retries up to
23958 .code
23959 (lock_retries * lock_interval) / <timeout>
23960 .endd
23961 times (rounded up).
23962 .endlist
23963
23964 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23965 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23966
23967
23968 .section "Operational details for delivery to a new file" "SECTopdir"
23969 .cindex "delivery" "to single file"
23970 .cindex "&""From""& line"
23971 When the &%directory%& option is set instead of &%file%&, each message is
23972 delivered into a newly-created file or set of files. When &(appendfile)& is
23973 activated directly from a &(redirect)& router, neither &%file%& nor
23974 &%directory%& is normally set, because the path for delivery is supplied by the
23975 router. (See for example, the &(address_file)& transport in the default
23976 configuration.) In this case, delivery is to a new file if either the path name
23977 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23978
23979 No locking is required while writing the message to a new file, so the various
23980 locking options of the transport are ignored. The &"From"& line that by default
23981 separates messages in a single file is not normally needed, nor is the escaping
23982 of message lines that start with &"From"&, and there is no need to ensure a
23983 newline at the end of each message. Consequently, the default values for
23984 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23985 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23986
23987 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23988 the files in the delivery directory by default. However, you can specify a
23989 different directory by setting &%quota_directory%&. Also, for maildir
23990 deliveries (see below) the &_maildirfolder_& convention is honoured.
23991
23992
23993 .cindex "maildir format"
23994 .cindex "mailstore format"
23995 There are three different ways in which delivery to individual files can be
23996 done, controlled by the settings of the &%maildir_format%& and
23997 &%mailstore_format%& options. Note that code to support maildir or mailstore
23998 formats is not included in the binary unless SUPPORT_MAILDIR or
23999 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24000
24001 .cindex "directory creation"
24002 In all three cases an attempt is made to create the directory and any necessary
24003 sub-directories if they do not exist, provided that the &%create_directory%&
24004 option is set (the default). The location of a created directory can be
24005 constrained by setting &%create_file%&. A created directory's mode is given by
24006 the &%directory_mode%& option. If creation fails, or if the
24007 &%create_directory%& option is not set when creation is required, delivery is
24008 deferred.
24009
24010
24011
24012 .section "Maildir delivery" "SECTmaildirdelivery"
24013 .cindex "maildir format" "description of"
24014 If the &%maildir_format%& option is true, Exim delivers each message by writing
24015 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24016 directory that is defined by the &%directory%& option (the &"delivery
24017 directory"&). If the delivery is successful, the file is renamed into the
24018 &_new_& subdirectory.
24019
24020 In the filename, <&'stime'&> is the current time of day in seconds, and
24021 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24022 Exim checks that the time-of-day clock has moved on by at least one microsecond
24023 before terminating the delivery process. This guarantees uniqueness for the
24024 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24025 opening it. If any response other than ENOENT (does not exist) is given,
24026 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24027
24028 Before Exim carries out a maildir delivery, it ensures that subdirectories
24029 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24030 do not exist, Exim tries to create them and any superior directories in their
24031 path, subject to the &%create_directory%& and &%create_file%& options. If the
24032 &%maildirfolder_create_regex%& option is set, and the regular expression it
24033 contains matches the delivery directory, Exim also ensures that a file called
24034 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24035 &_maildirfolder_& file cannot be created, delivery is deferred.
24036
24037 These features make it possible to use Exim to create all the necessary files
24038 and directories in a maildir mailbox, including subdirectories for maildir++
24039 folders. Consider this example:
24040 .code
24041 maildir_format = true
24042 directory = /var/mail/$local_part_data\
24043            ${if eq{$local_part_suffix}{}{}\
24044            {/.${substr_1:$local_part_suffix}}}
24045 maildirfolder_create_regex = /\.[^/]+$
24046 .endd
24047 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24048 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24049 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24050 not match this name, so Exim will not look for or create the file
24051 &_/var/mail/pimbo/maildirfolder_&, though it will create
24052 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24053
24054 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24055 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24056 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24057 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24058 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24059
24060 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24061 not inadvertently match the toplevel maildir directory, because a
24062 &_maildirfolder_& file at top level would completely break quota calculations.
24063
24064 .cindex "quota" "in maildir delivery"
24065 .cindex "maildir++"
24066 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24067 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24068 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24069 Exim assumes the directory is a maildir++ folder directory, which is one level
24070 down from the user's top level mailbox directory. This causes it to start at
24071 the parent directory instead of the current directory when calculating the
24072 amount of space used.
24073
24074 One problem with delivering into a multi-file mailbox is that it is
24075 computationally expensive to compute the size of the mailbox for quota
24076 checking. Various approaches have been taken to reduce the amount of work
24077 needed. The next two sections describe two of them. A third alternative is to
24078 use some external process for maintaining the size data, and use the expansion
24079 of the &%mailbox_size%& option as a way of importing it into Exim.
24080
24081
24082
24083
24084 .section "Using tags to record message sizes" "SECID135"
24085 If &%maildir_tag%& is set, the string is expanded for each delivery.
24086 When the maildir file is renamed into the &_new_& sub-directory, the
24087 tag is added to its name. However, if adding the tag takes the length of the
24088 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24089 the tag is dropped and the maildir file is created with no tag.
24090
24091
24092 .vindex "&$message_size$&"
24093 Tags can be used to encode the size of files in their names; see
24094 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24095 happens after the message has been written. The value of the &$message_size$&
24096 variable is set to the number of bytes actually written. If the expansion is
24097 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24098 be deferred. The expanded tag may contain any printing characters except &"/"&.
24099 Non-printing characters in the string are ignored; if the resulting string is
24100 empty, it is ignored. If it starts with an alphanumeric character, a leading
24101 colon is inserted; this default has not proven to be the path that popular
24102 maildir implementations have chosen (but changing it in Exim would break
24103 backwards compatibility).
24104
24105 For one common implementation, you might set:
24106 .code
24107 maildir_tag = ,S=${message_size}
24108 .endd
24109 but you should check the documentation of the other software to be sure.
24110
24111 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24112 as this allows Exim to extract the size from your tag, instead of having to
24113 &[stat()]& each message file.
24114
24115
24116 .section "Using a maildirsize file" "SECID136"
24117 .cindex "quota" "in maildir delivery"
24118 .cindex "maildir format" "&_maildirsize_& file"
24119 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24120 storing quota and message size information in a file called &_maildirsize_&
24121 within the toplevel maildir directory. If this file does not exist, Exim
24122 creates it, setting the quota from the &%quota%& option of the transport. If
24123 the maildir directory itself does not exist, it is created before any attempt
24124 to write a &_maildirsize_& file.
24125
24126 The &_maildirsize_& file is used to hold information about the sizes of
24127 messages in the maildir, thus speeding up quota calculations. The quota value
24128 in the file is just a cache; if the quota is changed in the transport, the new
24129 value overrides the cached value when the next message is delivered. The cache
24130 is maintained for the benefit of other programs that access the maildir and
24131 need to know the quota.
24132
24133 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24134 file is maintained (with a zero quota setting), but no quota is imposed.
24135
24136 A regular expression is available for controlling which directories in the
24137 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24138 See the description of the &%maildir_quota_directory_regex%& option above for
24139 details.
24140
24141
24142 .section "Mailstore delivery" "SECID137"
24143 .cindex "mailstore format" "description of"
24144 If the &%mailstore_format%& option is true, each message is written as two
24145 files in the given directory. A unique base name is constructed from the
24146 message id and the current delivery process, and the files that are written use
24147 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24148 contains the message's envelope, and the &_.msg_& file contains the message
24149 itself. The base name is placed in the variable &$mailstore_basename$&.
24150
24151 During delivery, the envelope is first written to a file with the suffix
24152 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24153 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24154 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24155 file before accessing either of them. An alternative approach is to wait for
24156 the absence of a &_.tmp_& file.
24157
24158 The envelope file starts with any text defined by the &%mailstore_prefix%&
24159 option, expanded and terminated by a newline if there isn't one. Then follows
24160 the sender address on one line, then all the recipient addresses, one per line.
24161 There can be more than one recipient only if the &%batch_max%& option is set
24162 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24163 appended to the file, followed by a newline if it does not end with one.
24164
24165 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24166 failure, it is ignored. Other expansion errors are treated as serious
24167 configuration errors, and delivery is deferred. The variable
24168 &$mailstore_basename$& is available for use during these expansions.
24169
24170
24171 .section "Non-special new file delivery" "SECID138"
24172 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24173 file is created directly in the named directory. For example, when delivering
24174 messages into files in batched SMTP format for later delivery to some host (see
24175 section &<<SECTbatchSMTP>>&), a setting such as
24176 .code
24177 directory = /var/bsmtp/$host
24178 .endd
24179 might be used. A message is written to a file with a temporary name, which is
24180 then renamed when the delivery is complete. The final name is obtained by
24181 expanding the contents of the &%directory_file%& option.
24182 .ecindex IIDapptra1
24183 .ecindex IIDapptra2
24184
24185
24186
24187
24188
24189
24190 . ////////////////////////////////////////////////////////////////////////////
24191 . ////////////////////////////////////////////////////////////////////////////
24192
24193 .chapter "The autoreply transport" "CHID8"
24194 .scindex IIDauttra1 "transports" "&(autoreply)&"
24195 .scindex IIDauttra2 "&(autoreply)& transport"
24196 The &(autoreply)& transport is not a true transport in that it does not cause
24197 the message to be transmitted. Instead, it generates a new mail message as an
24198 automatic reply to the incoming message. &'References:'& and
24199 &'Auto-Submitted:'& header lines are included. These are constructed according
24200 to the rules in RFCs 2822 and 3834, respectively.
24201
24202 If the router that passes the message to this transport does not have the
24203 &%unseen%& option set, the original message (for the current recipient) is not
24204 delivered anywhere. However, when the &%unseen%& option is set on the router
24205 that passes the message to this transport, routing of the address continues, so
24206 another router can set up a normal message delivery.
24207
24208
24209 The &(autoreply)& transport is usually run as the result of mail filtering, a
24210 &"vacation"& message being the standard example. However, it can also be run
24211 directly from a router like any other transport. To reduce the possibility of
24212 message cascades, messages created by the &(autoreply)& transport always have
24213 empty envelope sender addresses, like bounce messages.
24214
24215 The parameters of the message to be sent can be specified in the configuration
24216 by options described below. However, these are used only when the address
24217 passed to the transport does not contain its own reply information. When the
24218 transport is run as a consequence of a
24219 &%mail%&
24220 or &%vacation%& command in a filter file, the parameters of the message are
24221 supplied by the filter, and passed with the address. The transport's options
24222 that define the message are then ignored (so they are not usually set in this
24223 case). The message is specified entirely by the filter or by the transport; it
24224 is never built from a mixture of options. However, the &%file_optional%&,
24225 &%mode%&, and &%return_message%& options apply in all cases.
24226
24227 &(Autoreply)& is implemented as a local transport. When used as a result of a
24228 command in a user's filter file, &(autoreply)& normally runs under the uid and
24229 gid of the user, and with appropriate current and home directories (see chapter
24230 &<<CHAPenvironment>>&).
24231
24232 There is a subtle difference between routing a message to a &(pipe)& transport
24233 that generates some text to be returned to the sender, and routing it to an
24234 &(autoreply)& transport. This difference is noticeable only if more than one
24235 address from the same message is so handled. In the case of a pipe, the
24236 separate outputs from the different addresses are gathered up and returned to
24237 the sender in a single message, whereas if &(autoreply)& is used, a separate
24238 message is generated for each address that is passed to it.
24239
24240 Non-printing characters are not permitted in the header lines generated for the
24241 message that &(autoreply)& creates, with the exception of newlines that are
24242 immediately followed by white space. If any non-printing characters are found,
24243 the transport defers.
24244 Whether characters with the top bit set count as printing characters or not is
24245 controlled by the &%print_topbitchars%& global option.
24246
24247 If any of the generic options for manipulating headers (for example,
24248 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24249 of the original message that is included in the generated message when
24250 &%return_message%& is set. They do not apply to the generated message itself.
24251
24252 .vindex "&$sender_address$&"
24253 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24254 the message, indicating that there were no recipients, it does not treat this
24255 as an error. This means that autoreplies sent to &$sender_address$& when this
24256 is empty (because the incoming message is a bounce message) do not cause
24257 problems. They are just discarded.
24258
24259
24260
24261 .section "Private options for autoreply" "SECID139"
24262 .cindex "options" "&(autoreply)& transport"
24263
24264 .option bcc autoreply string&!! unset
24265 This specifies the addresses that are to receive &"blind carbon copies"& of the
24266 message when the message is specified by the transport.
24267
24268
24269 .option cc autoreply string&!! unset
24270 This specifies recipients of the message and the contents of the &'Cc:'& header
24271 when the message is specified by the transport.
24272
24273
24274 .option file autoreply string&!! unset
24275 The contents of the file are sent as the body of the message when the message
24276 is specified by the transport. If both &%file%& and &%text%& are set, the text
24277 string comes first.
24278
24279
24280 .option file_expand autoreply boolean false
24281 If this is set, the contents of the file named by the &%file%& option are
24282 subjected to string expansion as they are added to the message.
24283
24284
24285 .option file_optional autoreply boolean false
24286 If this option is true, no error is generated if the file named by the &%file%&
24287 option or passed with the address does not exist or cannot be read.
24288
24289
24290 .option from autoreply string&!! unset
24291 This specifies the contents of the &'From:'& header when the message is
24292 specified by the transport.
24293
24294
24295 .option headers autoreply string&!! unset
24296 This specifies additional RFC 2822 headers that are to be added to the message
24297 when the message is specified by the transport. Several can be given by using
24298 &"\n"& to separate them. There is no check on the format.
24299
24300
24301 .option log autoreply string&!! unset
24302 This option names a file in which a record of every message sent is logged when
24303 the message is specified by the transport.
24304
24305
24306 .option mode autoreply "octal integer" 0600
24307 If either the log file or the &"once"& file has to be created, this mode is
24308 used.
24309
24310
24311 .option never_mail autoreply "address list&!!" unset
24312 If any run of the transport creates a message with a recipient that matches any
24313 item in the list, that recipient is quietly discarded. If all recipients are
24314 discarded, no message is created. This applies both when the recipients are
24315 generated by a filter and when they are specified in the transport.
24316
24317
24318
24319 .option once autoreply string&!! unset
24320 This option names a file or DBM database in which a record of each &'To:'&
24321 recipient is kept when the message is specified by the transport. &*Note*&:
24322 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24323
24324 If &%once%& is unset, or is set to an empty string, the message is always sent.
24325 By default, if &%once%& is set to a non-empty filename, the message
24326 is not sent if a potential recipient is already listed in the database.
24327 However, if the &%once_repeat%& option specifies a time greater than zero, the
24328 message is sent if that much time has elapsed since a message was last sent to
24329 this recipient. A setting of zero time for &%once_repeat%& (the default)
24330 prevents a message from being sent a second time &-- in this case, zero means
24331 infinity.
24332
24333 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24334 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24335 greater than zero, it changes the way Exim implements the &%once%& option.
24336 Instead of using a DBM file to record every recipient it sends to, it uses a
24337 regular file, whose size will never get larger than the given value.
24338
24339 In the file, Exim keeps a linear list of recipient addresses and the times at
24340 which they were sent messages. If the file is full when a new address needs to
24341 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24342 means that a given recipient may receive multiple messages, but at
24343 unpredictable intervals that depend on the rate of turnover of addresses in the
24344 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24345
24346
24347 .option once_file_size autoreply integer 0
24348 See &%once%& above.
24349
24350
24351 .option once_repeat autoreply time&!! 0s
24352 See &%once%& above.
24353 After expansion, the value of this option must be a valid time value.
24354
24355
24356 .option reply_to autoreply string&!! unset
24357 This specifies the contents of the &'Reply-To:'& header when the message is
24358 specified by the transport.
24359
24360
24361 .option return_message autoreply boolean false
24362 If this is set, a copy of the original message is returned with the new
24363 message, subject to the maximum size set in the &%return_size_limit%& global
24364 configuration option.
24365
24366
24367 .option subject autoreply string&!! unset
24368 This specifies the contents of the &'Subject:'& header when the message is
24369 specified by the transport. It is tempting to quote the original subject in
24370 automatic responses. For example:
24371 .code
24372 subject = Re: $h_subject:
24373 .endd
24374 There is a danger in doing this, however. It may allow a third party to
24375 subscribe your users to an opt-in mailing list, provided that the list accepts
24376 bounce messages as subscription confirmations. Well-managed lists require a
24377 non-bounce message to confirm a subscription, so the danger is relatively
24378 small.
24379
24380
24381
24382 .option text autoreply string&!! unset
24383 This specifies a single string to be used as the body of the message when the
24384 message is specified by the transport. If both &%text%& and &%file%& are set,
24385 the text comes first.
24386
24387
24388 .option to autoreply string&!! unset
24389 This specifies recipients of the message and the contents of the &'To:'& header
24390 when the message is specified by the transport.
24391 .ecindex IIDauttra1
24392 .ecindex IIDauttra2
24393
24394
24395
24396
24397 . ////////////////////////////////////////////////////////////////////////////
24398 . ////////////////////////////////////////////////////////////////////////////
24399
24400 .chapter "The lmtp transport" "CHAPLMTP"
24401 .cindex "transports" "&(lmtp)&"
24402 .cindex "&(lmtp)& transport"
24403 .cindex "LMTP" "over a pipe"
24404 .cindex "LMTP" "over a socket"
24405 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24406 specified command
24407 or by interacting with a Unix domain socket.
24408 This transport is something of a cross between the &(pipe)& and &(smtp)&
24409 transports. Exim also has support for using LMTP over TCP/IP; this is
24410 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24411 to be of minority interest, the default build-time configure in &_src/EDITME_&
24412 has it commented out. You need to ensure that
24413 .code
24414 TRANSPORT_LMTP=yes
24415 .endd
24416 .cindex "options" "&(lmtp)& transport"
24417 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24418 included in the Exim binary. The private options of the &(lmtp)& transport are
24419 as follows:
24420
24421 .option batch_id lmtp string&!! unset
24422 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24423
24424
24425 .option batch_max lmtp integer 1
24426 This limits the number of addresses that can be handled in a single delivery.
24427 Most LMTP servers can handle several addresses at once, so it is normally a
24428 good idea to increase this value. See the description of local delivery
24429 batching in chapter &<<CHAPbatching>>&.
24430
24431
24432 .option command lmtp string&!! unset
24433 This option must be set if &%socket%& is not set. The string is a command which
24434 is run in a separate process. It is split up into a command name and list of
24435 arguments, each of which is separately expanded (so expansion cannot change the
24436 number of arguments). The command is run directly, not via a shell. The message
24437 is passed to the new process using the standard input and output to operate the
24438 LMTP protocol.
24439
24440 .option ignore_quota lmtp boolean false
24441 .cindex "LMTP" "ignoring quota errors"
24442 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24443 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24444 in its response to the LHLO command.
24445
24446 .option socket lmtp string&!! unset
24447 This option must be set if &%command%& is not set. The result of expansion must
24448 be the name of a Unix domain socket. The transport connects to the socket and
24449 delivers the message to it using the LMTP protocol.
24450
24451
24452 .option timeout lmtp time 5m
24453 The transport is aborted if the created process or Unix domain socket does not
24454 respond to LMTP commands or message input within this timeout. Delivery
24455 is deferred, and will be tried again later. Here is an example of a typical
24456 LMTP transport:
24457 .code
24458 lmtp:
24459   driver = lmtp
24460   command = /some/local/lmtp/delivery/program
24461   batch_max = 20
24462   user = exim
24463 .endd
24464 This delivers up to 20 addresses at a time, in a mixture of domains if
24465 necessary, running as the user &'exim'&.
24466
24467
24468
24469 . ////////////////////////////////////////////////////////////////////////////
24470 . ////////////////////////////////////////////////////////////////////////////
24471
24472 .chapter "The pipe transport" "CHAPpipetransport"
24473 .scindex IIDpiptra1 "transports" "&(pipe)&"
24474 .scindex IIDpiptra2 "&(pipe)& transport"
24475 The &(pipe)& transport is used to deliver messages via a pipe to a command
24476 running in another process. One example is the use of &(pipe)& as a
24477 pseudo-remote transport for passing messages to some other delivery mechanism
24478 (such as UUCP). Another is the use by individual users to automatically process
24479 their incoming messages. The &(pipe)& transport can be used in one of the
24480 following ways:
24481
24482 .ilist
24483 .vindex "&$local_part$&"
24484 A router routes one address to a transport in the normal way, and the
24485 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24486 contains the local part of the address (as usual), and the command that is run
24487 is specified by the &%command%& option on the transport.
24488 .next
24489 .vindex "&$pipe_addresses$&"
24490 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24491 transport can handle more than one address in a single run. In this case, when
24492 more than one address is routed to the transport, &$local_part$& is not set
24493 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24494 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24495 that are routed to the transport.
24496 .next
24497 .vindex "&$address_pipe$&"
24498 A router redirects an address directly to a pipe command (for example, from an
24499 alias or forward file). In this case, &$address_pipe$& contains the text of the
24500 pipe command, and the &%command%& option on the transport is ignored unless
24501 &%force_command%& is set. If only one address is being transported
24502 (&%batch_max%& is not greater than one, or only one address was redirected to
24503 this pipe command), &$local_part$& contains the local part that was redirected.
24504 .endlist
24505
24506
24507 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24508 deliver messages over pipes using the LMTP interactive protocol. This is
24509 implemented by the &(lmtp)& transport.
24510
24511 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24512 &_.forward_& file, the command runs under the uid and gid of that user. In
24513 other cases, the uid and gid have to be specified explicitly, either on the
24514 transport or on the router that handles the address. Current and &"home"&
24515 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24516 details of the local delivery environment and chapter &<<CHAPbatching>>&
24517 for a discussion of local delivery batching.
24518
24519 .cindex "tainted data" "in pipe command"
24520 .cindex pipe "tainted data"
24521 Tainted data may not be used for the command name.
24522
24523
24524 .section "Concurrent delivery" "SECID140"
24525 If two messages arrive at almost the same time, and both are routed to a pipe
24526 delivery, the two pipe transports may be run concurrently. You must ensure that
24527 any pipe commands you set up are robust against this happening. If the commands
24528 write to a file, the &%exim_lock%& utility might be of use.
24529 Alternatively the &%max_parallel%& option could be used with a value
24530 of "1" to enforce serialization.
24531
24532
24533
24534
24535 .section "Returned status and data" "SECID141"
24536 .cindex "&(pipe)& transport" "returned data"
24537 If the command exits with a non-zero return code, the delivery is deemed to
24538 have failed, unless either the &%ignore_status%& option is set (in which case
24539 the return code is treated as zero), or the return code is one of those listed
24540 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24541 later"&. In this case, delivery is deferred. Details of a permanent failure are
24542 logged, but are not included in the bounce message, which merely contains
24543 &"local delivery failed"&.
24544
24545 If the command exits on a signal and the &%freeze_signal%& option is set then
24546 the message will be frozen in the queue. If that option is not set, a bounce
24547 will be sent as normal.
24548
24549 If the return code is greater than 128 and the command being run is a shell
24550 script, it normally means that the script was terminated by a signal whose
24551 value is the return code minus 128. The &%freeze_signal%& option does not
24552 apply in this case.
24553
24554 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24555 return code is set to 127. This is the value that a shell returns if it is
24556 asked to run a non-existent command. The wording for the log line suggests that
24557 a non-existent command may be the problem.
24558
24559 The &%return_output%& option can affect the result of a pipe delivery. If it is
24560 set and the command produces any output on its standard output or standard
24561 error streams, the command is considered to have failed, even if it gave a zero
24562 return code or if &%ignore_status%& is set. The output from the command is
24563 included as part of the bounce message. The &%return_fail_output%& option is
24564 similar, except that output is returned only when the command exits with a
24565 failure return code, that is, a value other than zero or a code that matches
24566 &%temp_errors%&.
24567
24568
24569
24570 .section "How the command is run" "SECThowcommandrun"
24571 .cindex "&(pipe)& transport" "path for command"
24572 The command line is (by default) broken down into a command name and arguments
24573 by the &(pipe)& transport itself. The &%allow_commands%& and
24574 &%restrict_to_path%& options can be used to restrict the commands that may be
24575 run.
24576
24577 .cindex "quoting" "in pipe command"
24578 Unquoted arguments are delimited by white space. If an argument appears in
24579 double quotes, backslash is interpreted as an escape character in the usual
24580 way. If an argument appears in single quotes, no escaping is done.
24581
24582 String expansion is applied to the command line except when it comes from a
24583 traditional &_.forward_& file (commands from a filter file are expanded). The
24584 expansion is applied to each argument in turn rather than to the whole line.
24585 For this reason, any string expansion item that contains white space must be
24586 quoted so as to be contained within a single argument. A setting such as
24587 .code
24588 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24589 .endd
24590 will not work, because the expansion item gets split between several
24591 arguments. You have to write
24592 .code
24593 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24594 .endd
24595 to ensure that it is all in one argument. The expansion is done in this way,
24596 argument by argument, so that the number of arguments cannot be changed as a
24597 result of expansion, and quotes or backslashes in inserted variables do not
24598 interact with external quoting. However, this leads to problems if you want to
24599 generate multiple arguments (or the command name plus arguments) from a single
24600 expansion. In this situation, the simplest solution is to use a shell. For
24601 example:
24602 .code
24603 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24604 .endd
24605
24606 .cindex "transport" "filter"
24607 .cindex "filter" "transport filter"
24608 .vindex "&$pipe_addresses$&"
24609 Special handling takes place when an argument consists of precisely the text
24610 &`$pipe_addresses`& (no quotes).
24611 This is not a general expansion variable; the only
24612 place this string is recognized is when it appears as an argument for a pipe or
24613 transport filter command. It causes each address that is being handled to be
24614 inserted in the argument list at that point &'as a separate argument'&. This
24615 avoids any problems with spaces or shell metacharacters, and is of use when a
24616 &(pipe)& transport is handling groups of addresses in a batch.
24617
24618 If &%force_command%& is enabled on the transport, special handling takes place
24619 for an argument that consists of precisely the text &`$address_pipe`&.  It
24620 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24621 argument is inserted in the argument list at that point
24622 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24623 the only item in the argument; in fact, if it were then &%force_command%&
24624 should behave as a no-op.  Rather, it should be used to adjust the command
24625 run while preserving the argument vector separation.
24626
24627 After splitting up into arguments and expansion, the resulting command is run
24628 in a subprocess directly from the transport, &'not'& under a shell. The
24629 message that is being delivered is supplied on the standard input, and the
24630 standard output and standard error are both connected to a single pipe that is
24631 read by Exim. The &%max_output%& option controls how much output the command
24632 may produce, and the &%return_output%& and &%return_fail_output%& options
24633 control what is done with it.
24634
24635 Not running the command under a shell (by default) lessens the security risks
24636 in cases when a command from a user's filter file is built out of data that was
24637 taken from an incoming message. If a shell is required, it can of course be
24638 explicitly specified as the command to be run. However, there are circumstances
24639 where existing commands (for example, in &_.forward_& files) expect to be run
24640 under a shell and cannot easily be modified. To allow for these cases, there is
24641 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24642 works. Instead of breaking up the command line as just described, it expands it
24643 as a single string and passes the result to &_/bin/sh_&. The
24644 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24645 with &%use_shell%&, and the whole mechanism is inherently less secure.
24646
24647
24648
24649 .section "Environment variables" "SECTpipeenv"
24650 .cindex "&(pipe)& transport" "environment for command"
24651 .cindex "environment" "&(pipe)& transport"
24652 The environment variables listed below are set up when the command is invoked.
24653 This list is a compromise for maximum compatibility with other MTAs. Note that
24654 the &%environment%& option can be used to add additional variables to this
24655 environment. The environment for the &(pipe)& transport is not subject
24656 to the &%add_environment%& and &%keep_environment%& main config options.
24657 &*Note*&: Using enviroment variables loses track of tainted data.
24658 Writers of &(pipe)& transport commands should be wary of data supplied
24659 by potential attackers.
24660 .display
24661 &`DOMAIN            `&   the domain of the address
24662 &`HOME              `&   the home directory, if set
24663 &`HOST              `&   the host name when called from a router (see below)
24664 &`LOCAL_PART        `&   see below
24665 &`LOCAL_PART_PREFIX `&   see below
24666 &`LOCAL_PART_SUFFIX `&   see below
24667 &`LOGNAME           `&   see below
24668 &`MESSAGE_ID        `&   Exim's local ID for the message
24669 &`PATH              `&   as specified by the &%path%& option below
24670 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24671 &`RECIPIENT         `&   the complete recipient address
24672 &`SENDER            `&   the sender of the message (empty if a bounce)
24673 &`SHELL             `&   &`/bin/sh`&
24674 &`TZ                `&   the value of the &%timezone%& option, if set
24675 &`USER              `&   see below
24676 .endd
24677 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24678 router, LOCAL_PART is set to the local part of the address. When it is
24679 called as a result of a forward or alias expansion, LOCAL_PART is set to
24680 the local part of the address that was expanded. In both cases, any affixes are
24681 removed from the local part, and made available in LOCAL_PART_PREFIX and
24682 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24683 same value as LOCAL_PART for compatibility with other MTAs.
24684
24685 .cindex "HOST"
24686 HOST is set only when a &(pipe)& transport is called from a router that
24687 associates hosts with an address, typically when using &(pipe)& as a
24688 pseudo-remote transport. HOST is set to the first host name specified by
24689 the router.
24690
24691 .cindex "HOME"
24692 If the transport's generic &%home_directory%& option is set, its value is used
24693 for the HOME environment variable. Otherwise, a home directory may be set
24694 by the router's &%transport_home_directory%& option, which defaults to the
24695 user's home directory if &%check_local_user%& is set.
24696
24697
24698 .section "Private options for pipe" "SECID142"
24699 .cindex "options" "&(pipe)& transport"
24700
24701
24702
24703 .option allow_commands pipe "string list&!!" unset
24704 .cindex "&(pipe)& transport" "permitted commands"
24705 The string is expanded, and is then interpreted as a colon-separated list of
24706 permitted commands. If &%restrict_to_path%& is not set, the only commands
24707 permitted are those in the &%allow_commands%& list. They need not be absolute
24708 paths; the &%path%& option is still used for relative paths. If
24709 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24710 in the &%allow_commands%& list, or a name without any slashes that is found on
24711 the path. In other words, if neither &%allow_commands%& nor
24712 &%restrict_to_path%& is set, there is no restriction on the command, but
24713 otherwise only commands that are permitted by one or the other are allowed. For
24714 example, if
24715 .code
24716 allow_commands = /usr/bin/vacation
24717 .endd
24718 and &%restrict_to_path%& is not set, the only permitted command is
24719 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24720 &%use_shell%& is set.
24721
24722
24723 .option batch_id pipe string&!! unset
24724 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24725
24726
24727 .option batch_max pipe integer 1
24728 This limits the number of addresses that can be handled in a single delivery.
24729 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24730
24731
24732 .option check_string pipe string unset
24733 As &(pipe)& writes the message, the start of each line is tested for matching
24734 &%check_string%&, and if it does, the initial matching characters are replaced
24735 by the contents of &%escape_string%&, provided both are set. The value of
24736 &%check_string%& is a literal string, not a regular expression, and the case of
24737 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24738 of &%check_string%& and &%escape_string%& are forced to values that implement
24739 the SMTP escaping protocol. Any settings made in the configuration file are
24740 ignored.
24741
24742
24743 .option command pipe string&!! unset
24744 This option need not be set when &(pipe)& is being used to deliver to pipes
24745 obtained directly from address redirections. In other cases, the option must be
24746 set, to provide a command to be run. It need not yield an absolute path (see
24747 the &%path%& option below). The command is split up into separate arguments by
24748 Exim, and each argument is separately expanded, as described in section
24749 &<<SECThowcommandrun>>& above.
24750
24751 .cindex "tainted data"
24752 No part of the resulting command may be tainted.
24753
24754
24755 .option environment pipe string&!! unset
24756 .cindex "&(pipe)& transport" "environment for command"
24757 .cindex "environment" "&(pipe)& transport"
24758 This option is used to add additional variables to the environment in which the
24759 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24760 a string which is expanded, and then interpreted as a colon-separated list of
24761 environment settings of the form <&'name'&>=<&'value'&>.
24762
24763
24764 .option escape_string pipe string unset
24765 See &%check_string%& above.
24766
24767
24768 .option freeze_exec_fail pipe boolean false
24769 .cindex "exec failure"
24770 .cindex "failure of exec"
24771 .cindex "&(pipe)& transport" "failure of exec"
24772 Failure to exec the command in a pipe transport is by default treated like
24773 any other failure while running the command. However, if &%freeze_exec_fail%&
24774 is set, failure to exec is treated specially, and causes the message to be
24775 frozen, whatever the setting of &%ignore_status%&.
24776
24777
24778 .option freeze_signal pipe boolean false
24779 .cindex "signal exit"
24780 .cindex "&(pipe)& transport", "signal exit"
24781 Normally if the process run by a command in a pipe transport exits on a signal,
24782 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24783 frozen in Exim's queue instead.
24784
24785
24786 .option force_command pipe boolean false
24787 .cindex "force command"
24788 .cindex "&(pipe)& transport", "force command"
24789 Normally when a router redirects an address directly to a pipe command
24790 the &%command%& option on the transport is ignored.  If &%force_command%&
24791 is set, the &%command%& option will used. This is especially
24792 useful for forcing a wrapper or additional argument to be added to the
24793 command. For example:
24794 .code
24795 command = /usr/bin/remote_exec myhost -- $address_pipe
24796 force_command
24797 .endd
24798
24799 Note that &$address_pipe$& is handled specially in &%command%& when
24800 &%force_command%& is set, expanding out to the original argument vector as
24801 separate items, similarly to a Unix shell &`"$@"`& construct.
24802
24803
24804 .option ignore_status pipe boolean false
24805 If this option is true, the status returned by the subprocess that is set up to
24806 run the command is ignored, and Exim behaves as if zero had been returned.
24807 Otherwise, a non-zero status or termination by signal causes an error return
24808 from the transport unless the status value is one of those listed in
24809 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24810
24811 &*Note*&: This option does not apply to timeouts, which do not return a status.
24812 See the &%timeout_defer%& option for how timeouts are handled.
24813
24814
24815 .option log_defer_output pipe boolean false
24816 .cindex "&(pipe)& transport" "logging output"
24817 If this option is set, and the status returned by the command is
24818 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24819 and any output was produced on stdout or stderr, the first line of it is
24820 written to the main log.
24821
24822
24823 .option log_fail_output pipe boolean false
24824 If this option is set, and the command returns any output on stdout or
24825 stderr, and also ends with a return code that is neither zero nor one of
24826 the return codes listed in &%temp_errors%& (that is, the delivery
24827 failed), the first line of output is written to the main log. This
24828 option and &%log_output%& are mutually exclusive.  Only one of them may
24829 be set.
24830
24831
24832 .option log_output pipe boolean false
24833 If this option is set and the command returns any output on stdout or
24834 stderr, the first line of output is written to the main log, whatever
24835 the return code. This option and &%log_fail_output%& are mutually
24836 exclusive. Only one of them may be set.
24837
24838
24839 .option max_output pipe integer 20K
24840 This specifies the maximum amount of output that the command may produce on its
24841 standard output and standard error file combined. If the limit is exceeded, the
24842 process running the command is killed. This is intended as a safety measure to
24843 catch runaway processes. The limit is applied independently of the settings of
24844 the options that control what is done with such output (for example,
24845 &%return_output%&). Because of buffering effects, the amount of output may
24846 exceed the limit by a small amount before Exim notices.
24847
24848
24849 .option message_prefix pipe string&!! "see below"
24850 The string specified here is expanded and output at the start of every message.
24851 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24852 .code
24853 message_prefix = \
24854   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24855   ${tod_bsdinbox}\n
24856 .endd
24857 .cindex "Cyrus"
24858 .cindex "&%tmail%&"
24859 .cindex "&""From""& line"
24860 This is required by the commonly used &_/usr/bin/vacation_& program.
24861 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24862 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24863 setting
24864 .code
24865 message_prefix =
24866 .endd
24867 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24868 &`\n`& to &`\r\n`& in &%message_prefix%&.
24869
24870
24871 .option message_suffix pipe string&!! "see below"
24872 The string specified here is expanded and output at the end of every message.
24873 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24874 The suffix can be suppressed by setting
24875 .code
24876 message_suffix =
24877 .endd
24878 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24879 &`\n`& to &`\r\n`& in &%message_suffix%&.
24880
24881
24882 .option path pipe string&!! "/bin:/usr/bin"
24883 This option is expanded and
24884 specifies the string that is set up in the PATH environment
24885 variable of the subprocess.
24886 If the &%command%& option does not yield an absolute path name, the command is
24887 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24888 apply to a command specified as a transport filter.
24889
24890
24891 .option permit_coredump pipe boolean false
24892 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24893 a core-dump of a pipe command, enable this command.  This enables core-dumps
24894 during delivery and affects both the Exim binary and the pipe command run.
24895 It is recommended that this option remain off unless and until you have a need
24896 for it and that this only be enabled when needed, as the risk of excessive
24897 resource consumption can be quite high.  Note also that Exim is typically
24898 installed as a setuid binary and most operating systems will inhibit coredumps
24899 of these by default, so further OS-specific action may be required.
24900
24901
24902 .option pipe_as_creator pipe boolean false
24903 .cindex "uid (user id)" "local delivery"
24904 If the generic &%user%& option is not set and this option is true, the delivery
24905 process is run under the uid that was in force when Exim was originally called
24906 to accept the message. If the group id is not otherwise set (via the generic
24907 &%group%& option), the gid that was in force when Exim was originally called to
24908 accept the message is used.
24909
24910
24911 .option restrict_to_path pipe boolean false
24912 When this option is set, any command name not listed in &%allow_commands%& must
24913 contain no slashes. The command is searched for only in the directories listed
24914 in the &%path%& option. This option is intended for use in the case when a pipe
24915 command has been generated from a user's &_.forward_& file. This is usually
24916 handled by a &(pipe)& transport called &%address_pipe%&.
24917
24918
24919 .option return_fail_output pipe boolean false
24920 If this option is true, and the command produced any output and ended with a
24921 return code other than zero or one of the codes listed in &%temp_errors%& (that
24922 is, the delivery failed), the output is returned in the bounce message.
24923 However, if the message has a null sender (that is, it is itself a bounce
24924 message), output from the command is discarded. This option and
24925 &%return_output%& are mutually exclusive. Only one of them may be set.
24926
24927
24928
24929 .option return_output pipe boolean false
24930 If this option is true, and the command produced any output, the delivery is
24931 deemed to have failed whatever the return code from the command, and the output
24932 is returned in the bounce message. Otherwise, the output is just discarded.
24933 However, if the message has a null sender (that is, it is a bounce message),
24934 output from the command is always discarded, whatever the setting of this
24935 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24936 of them may be set.
24937
24938
24939
24940 .option temp_errors pipe "string list" "see below"
24941 .cindex "&(pipe)& transport" "temporary failure"
24942 This option contains either a colon-separated list of numbers, or a single
24943 asterisk. If &%ignore_status%& is false
24944 and &%return_output%& is not set,
24945 and the command exits with a non-zero return code, the failure is treated as
24946 temporary and the delivery is deferred if the return code matches one of the
24947 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24948 codes are treated as permanent errors. The default setting contains the codes
24949 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24950 compiled on a system that does not define these macros, it assumes values of 75
24951 and 73, respectively.
24952
24953
24954 .option timeout pipe time 1h
24955 If the command fails to complete within this time, it is killed. This normally
24956 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24957 specifies no timeout. In order to ensure that any subprocesses created by the
24958 command are also killed, Exim makes the initial process a process group leader,
24959 and kills the whole process group on a timeout. However, this can be defeated
24960 if one of the processes starts a new process group.
24961
24962 .option timeout_defer pipe boolean false
24963 A timeout in a &(pipe)& transport, either in the command that the transport
24964 runs, or in a transport filter that is associated with it, is by default
24965 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24966 is set true, both kinds of timeout become temporary errors, causing the
24967 delivery to be deferred.
24968
24969 .option umask pipe "octal integer" 022
24970 This specifies the umask setting for the subprocess that runs the command.
24971
24972
24973 .option use_bsmtp pipe boolean false
24974 .cindex "envelope sender"
24975 If this option is set true, the &(pipe)& transport writes messages in &"batch
24976 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24977 commands. If you want to include a leading HELO command with such messages,
24978 you can do so by setting the &%message_prefix%& option. See section
24979 &<<SECTbatchSMTP>>& for details of batch SMTP.
24980
24981 .option use_classresources pipe boolean false
24982 .cindex "class resources (BSD)"
24983 This option is available only when Exim is running on FreeBSD, NetBSD, or
24984 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24985 resource limits when a &(pipe)& transport is run to perform a delivery. The
24986 limits for the uid under which the pipe is to run are obtained from the login
24987 class database.
24988
24989
24990 .option use_crlf pipe boolean false
24991 .cindex "carriage return"
24992 .cindex "linefeed"
24993 This option causes lines to be terminated with the two-character CRLF sequence
24994 (carriage return, linefeed) instead of just a linefeed character. In the case
24995 of batched SMTP, the byte sequence written to the pipe is then an exact image
24996 of what would be sent down a real SMTP connection.
24997
24998 The contents of the &%message_prefix%& and &%message_suffix%& options are
24999 written verbatim, so must contain their own carriage return characters if these
25000 are needed. When &%use_bsmtp%& is not set, the default values for both
25001 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25002 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25003
25004
25005 .option use_shell pipe boolean false
25006 .vindex "&$pipe_addresses$&"
25007 If this option is set, it causes the command to be passed to &_/bin/sh_&
25008 instead of being run directly from the transport, as described in section
25009 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25010 where the command is expected to be run under a shell and cannot easily be
25011 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25012 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25013 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25014 its &%-c%& option.
25015
25016
25017
25018 .section "Using an external local delivery agent" "SECID143"
25019 .cindex "local delivery" "using an external agent"
25020 .cindex "&'procmail'&"
25021 .cindex "external local delivery"
25022 .cindex "delivery" "&'procmail'&"
25023 .cindex "delivery" "by external agent"
25024 The &(pipe)& transport can be used to pass all messages that require local
25025 delivery to a separate local delivery agent such as &%procmail%&. When doing
25026 this, care must be taken to ensure that the pipe is run under an appropriate
25027 uid and gid. In some configurations one wants this to be a uid that is trusted
25028 by the delivery agent to supply the correct sender of the message. It may be
25029 necessary to recompile or reconfigure the delivery agent so that it trusts an
25030 appropriate user. The following is an example transport and router
25031 configuration for &%procmail%&:
25032 .code
25033 # transport
25034 procmail_pipe:
25035   driver = pipe
25036   command = /usr/local/bin/procmail -d $local_part_data
25037   return_path_add
25038   delivery_date_add
25039   envelope_to_add
25040   check_string = "From "
25041   escape_string = ">From "
25042   umask = 077
25043   user = $local_part_data
25044   group = mail
25045
25046 # router
25047 procmail:
25048   driver = accept
25049   check_local_user
25050   transport = procmail_pipe
25051 .endd
25052 In this example, the pipe is run as the local user, but with the group set to
25053 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25054 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25055 user to supply a correct sender address. If you do not specify either a
25056 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25057 home directory is the user's home directory by default.
25058
25059 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25060 .code
25061 IFS=" "
25062 .endd
25063 as shown in some &%procmail%& documentation, because Exim does not by default
25064 use a shell to run pipe commands.
25065
25066 .cindex "Cyrus"
25067 The next example shows a transport and a router for a system where local
25068 deliveries are handled by the Cyrus IMAP server.
25069 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25070 . but that suffix is tainted so cannot be used in a command arg
25071 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25072 .code
25073 # transport
25074 local_delivery_cyrus:
25075   driver = pipe
25076   command = /usr/cyrus/bin/deliver \
25077             -- $local_part_data
25078   user = cyrus
25079   group = mail
25080   return_output
25081   log_output
25082   message_prefix =
25083   message_suffix =
25084
25085 # router
25086 local_user_cyrus:
25087   driver = accept
25088   check_local_user
25089   transport = local_delivery_cyrus
25090 .endd
25091 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25092 &%return_output%& to cause any text written by Cyrus to be returned to the
25093 sender.
25094 .ecindex IIDpiptra1
25095 .ecindex IIDpiptra2
25096
25097
25098 . ////////////////////////////////////////////////////////////////////////////
25099 . ////////////////////////////////////////////////////////////////////////////
25100
25101 .chapter "The smtp transport" "CHAPsmtptrans"
25102 .scindex IIDsmttra1 "transports" "&(smtp)&"
25103 .scindex IIDsmttra2 "&(smtp)& transport"
25104 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25105 or LMTP protocol. The list of hosts to try can either be taken from the address
25106 that is being processed (having been set up by the router), or specified
25107 explicitly for the transport. Timeout and retry processing (see chapter
25108 &<<CHAPretry>>&) is applied to each IP address independently.
25109
25110
25111 .section "Multiple messages on a single connection" "SECID144"
25112 The sending of multiple messages over a single TCP/IP connection can arise in
25113 two ways:
25114
25115 .ilist
25116 If a message contains more than &%max_rcpt%& (see below) addresses that are
25117 routed to the same host, more than one copy of the message has to be sent to
25118 that host. In this situation, multiple copies may be sent in a single run of
25119 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25120 does when it has too many addresses to send in one message also depends on the
25121 value of the global &%remote_max_parallel%& option. Details are given in
25122 section &<<SECToutSMTPTCP>>&.)
25123 .next
25124 .cindex "hints database" "remembering routing"
25125 When a message has been successfully delivered over a TCP/IP connection, Exim
25126 looks in its hints database to see if there are any other messages awaiting a
25127 connection to the same host. If there are, a new delivery process is started
25128 for one of them, and the current TCP/IP connection is passed on to it. The new
25129 process may in turn send multiple copies and possibly create yet another
25130 process.
25131 .endlist
25132
25133
25134 For each copy sent over the same TCP/IP connection, a sequence counter is
25135 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25136 no further messages are sent over that connection.
25137
25138
25139
25140 .section "Use of the $host and $host_address variables" "SECID145"
25141 .vindex "&$host$&"
25142 .vindex "&$host_address$&"
25143 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25144 &$host_address$& are the name and IP address of the first host on the host list
25145 passed by the router. However, when the transport is about to connect to a
25146 specific host, and while it is connected to that host, &$host$& and
25147 &$host_address$& are set to the values for that host. These are the values
25148 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25149 &%serialize_hosts%&, and the various TLS options are expanded.
25150
25151
25152 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25153 .vindex &$tls_bits$&
25154 .vindex &$tls_cipher$&
25155 .vindex &$tls_peerdn$&
25156 .vindex &$tls_sni$&
25157 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25158 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25159 are the values that were set when the message was received.
25160 These are the values that are used for options that are expanded before any
25161 SMTP connections are made. Just before each connection is made, these four
25162 variables are emptied. If TLS is subsequently started, they are set to the
25163 appropriate values for the outgoing connection, and these are the values that
25164 are in force when any authenticators are run and when the
25165 &%authenticated_sender%& option is expanded.
25166
25167 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25168 and will be removed in a future release.
25169
25170
25171 .section "Private options for smtp" "SECID146"
25172 .cindex "options" "&(smtp)& transport"
25173 The private options of the &(smtp)& transport are as follows:
25174
25175
25176 .option address_retry_include_sender smtp boolean true
25177 .cindex "4&'xx'& responses" "retrying after"
25178 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25179 is the combination of sender and recipient that is delayed in subsequent queue
25180 runs until the retry time is reached. You can delay the recipient without
25181 reference to the sender (which is what earlier versions of Exim did), by
25182 setting &%address_retry_include_sender%& false. However, this can lead to
25183 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25184
25185 .option allow_localhost smtp boolean false
25186 .cindex "local host" "sending to"
25187 .cindex "fallback" "hosts specified on transport"
25188 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25189 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25190 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25191 the delivery anyway. This should be used only in special cases when the
25192 configuration ensures that no looping will result (for example, a differently
25193 configured Exim is listening on the port to which the message is sent).
25194
25195
25196 .option authenticated_sender smtp string&!! unset
25197 .cindex "Cyrus"
25198 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25199 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25200 overriding any existing authenticated sender value. If the string expansion is
25201 forced to fail, the option is ignored. Other expansion failures cause delivery
25202 to be deferred. If the result of expansion is an empty string, that is also
25203 ignored.
25204
25205 The expansion happens after the outgoing connection has been made and TLS
25206 started, if required. This means that the &$host$&, &$host_address$&,
25207 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25208 particular connection.
25209
25210 If the SMTP session is not authenticated, the expansion of
25211 &%authenticated_sender%& still happens (and can cause the delivery to be
25212 deferred if it fails), but no AUTH= item is added to MAIL commands
25213 unless &%authenticated_sender_force%& is true.
25214
25215 This option allows you to use the &(smtp)& transport in LMTP mode to
25216 deliver mail to Cyrus IMAP and provide the proper local part as the
25217 &"authenticated sender"&, via a setting such as:
25218 .code
25219 authenticated_sender = $local_part
25220 .endd
25221 This removes the need for IMAP subfolders to be assigned special ACLs to
25222 allow direct delivery to those subfolders.
25223
25224 Because of expected uses such as that just described for Cyrus (when no
25225 domain is involved), there is no checking on the syntax of the provided
25226 value.
25227
25228
25229 .option authenticated_sender_force smtp boolean false
25230 If this option is set true, the &%authenticated_sender%& option's value
25231 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25232 authenticated as a client.
25233
25234
25235 .option command_timeout smtp time 5m
25236 .cindex timeout "smtp transport command"
25237 This sets a timeout for receiving a response to an SMTP command that has been
25238 sent out. It is also used when waiting for the initial banner line from the
25239 remote host. Its value must not be zero.
25240
25241
25242 .option connect_timeout smtp time 5m
25243 .cindex timeout "smtp transport connect"
25244 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25245 to a remote host. A setting of zero allows the system timeout (typically
25246 several minutes) to act. To have any effect, the value of this option must be
25247 less than the system timeout. However, it has been observed that on some
25248 systems there is no system timeout, which is why the default value for this
25249 option is 5 minutes, a value recommended by RFC 1123.
25250
25251
25252 .option connection_max_messages smtp integer 500
25253 .cindex "SMTP" "passed connection"
25254 .cindex "SMTP" "multiple deliveries"
25255 .cindex "multiple SMTP deliveries"
25256 This controls the maximum number of separate message deliveries that are sent
25257 over a single TCP/IP connection. If the value is zero, there is no limit.
25258 For testing purposes, this value can be overridden by the &%-oB%& command line
25259 option.
25260
25261
25262 .option dane_require_tls_ciphers smtp string&!! unset
25263 .cindex "TLS" "requiring specific ciphers for DANE"
25264 .cindex "cipher" "requiring specific"
25265 .cindex DANE "TLS ciphers"
25266 This option may be used to override &%tls_require_ciphers%& for connections
25267 where DANE has been determined to be in effect.
25268 If not set, then &%tls_require_ciphers%& will be used.
25269 Normal SMTP delivery is not able to make strong demands of TLS cipher
25270 configuration, because delivery will fall back to plaintext.  Once DANE has
25271 been determined to be in effect, there is no plaintext fallback and making the
25272 TLS cipherlist configuration stronger will increase security, rather than
25273 counter-intuitively decreasing it.
25274 If the option expands to be empty or is forced to fail, then it will
25275 be treated as unset and &%tls_require_ciphers%& will be used instead.
25276
25277
25278 .option data_timeout smtp time 5m
25279 .cindex timeout "for transmitted SMTP data blocks"
25280 This sets a timeout for the transmission of each block in the data portion of
25281 the message. As a result, the overall timeout for a message depends on the size
25282 of the message. Its value must not be zero. See also &%final_timeout%&.
25283
25284
25285 .option dkim_canon smtp string&!! unset
25286 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25287 .option dkim_domain smtp "string list&!!" unset
25288 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25289 .option dkim_hash smtp string&!! sha256
25290 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25291 .option dkim_identity smtp string&!! unset
25292 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25293 .option dkim_private_key smtp string&!! unset
25294 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25295 .option dkim_selector smtp string&!! unset
25296 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25297 .option dkim_strict smtp string&!! unset
25298 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25299 .option dkim_sign_headers smtp string&!! "per RFC"
25300 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25301 .option dkim_timestamps smtp string&!! unset
25302 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25303
25304
25305 .option delay_after_cutoff smtp boolean true
25306 .cindex "final cutoff" "retries, controlling"
25307 .cindex retry "final cutoff"
25308 This option controls what happens when all remote IP addresses for a given
25309 domain have been inaccessible for so long that they have passed their retry
25310 cutoff times.
25311
25312 In the default state, if the next retry time has not been reached for any of
25313 them, the address is bounced without trying any deliveries. In other words,
25314 Exim delays retrying an IP address after the final cutoff time until a new
25315 retry time is reached, and can therefore bounce an address without ever trying
25316 a delivery, when machines have been down for a long time. Some people are
25317 unhappy at this prospect, so...
25318
25319 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25320 addresses are past their final cutoff time, Exim tries to deliver to those
25321 IP addresses that have not been tried since the message arrived. If there are
25322 none, of if they all fail, the address is bounced. In other words, it does not
25323 delay when a new message arrives, but immediately tries those expired IP
25324 addresses that haven't been tried since the message arrived. If there is a
25325 continuous stream of messages for the dead hosts, unsetting
25326 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25327 to them.
25328
25329
25330 .option dns_qualify_single smtp boolean true
25331 If the &%hosts%& or &%fallback_hosts%& option is being used,
25332 and the &%gethostbyname%& option is false,
25333 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25334 in chapter &<<CHAPdnslookup>>& for more details.
25335
25336
25337 .option dns_search_parents smtp boolean false
25338 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25339 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25340 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25341 details.
25342
25343
25344 .option dnssec_request_domains smtp "domain list&!!" *
25345 .cindex "MX record" "security"
25346 .cindex "DNSSEC" "MX lookup"
25347 .cindex "security" "MX lookup"
25348 .cindex "DNS" "DNSSEC"
25349 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25350 the DNSSEC request bit set. Setting this transport option is only useful if the
25351 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25352 router option.
25353
25354
25355
25356 .option dnssec_require_domains smtp "domain list&!!" unset
25357 .cindex "MX record" "security"
25358 .cindex "DNSSEC" "MX lookup"
25359 .cindex "security" "MX lookup"
25360 .cindex "DNS" "DNSSEC"
25361 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25362 the DNSSEC request bit set.  Setting this transport option is only
25363 useful if the transport overrides or sets the host names. See the
25364 &%dnssec_require_domains%& router option.
25365
25366
25367
25368 .option dscp smtp string&!! unset
25369 .cindex "DCSP" "outbound"
25370 This option causes the DSCP value associated with a socket to be set to one
25371 of a number of fixed strings or to numeric value.
25372 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25373 Common values include &`throughput`&, &`mincost`&, and on newer systems
25374 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25375
25376 The outbound packets from Exim will be marked with this value in the header
25377 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25378 that these values will have any effect, not be stripped by networking
25379 equipment, or do much of anything without cooperation with your Network
25380 Engineer and those of all network operators between the source and destination.
25381
25382
25383 .option fallback_hosts smtp "string list" unset
25384 .cindex "fallback" "hosts specified on transport"
25385 String expansion is not applied to this option. The argument must be a
25386 colon-separated list of host names or IP addresses, optionally also including
25387 port numbers, though the separator can be changed, as described in section
25388 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25389 item in a &%route_list%& setting for the &(manualroute)& router, as described
25390 in section &<<SECTformatonehostitem>>&.
25391
25392 Fallback hosts can also be specified on routers, which associate them with the
25393 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25394 &%fallback_hosts%& specified on the transport is used only if the address does
25395 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25396 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25397 However, &%hosts_randomize%& does apply to fallback host lists.
25398
25399 If Exim is unable to deliver to any of the hosts for a particular address, and
25400 the errors are not permanent rejections, the address is put on a separate
25401 transport queue with its host list replaced by the fallback hosts, unless the
25402 address was routed via MX records and the current host was in the original MX
25403 list. In that situation, the fallback host list is not used.
25404
25405 Once normal deliveries are complete, the fallback queue is delivered by
25406 re-running the same transports with the new host lists. If several failing
25407 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25408 copy of the message is sent.
25409
25410 The resolution of the host names on the fallback list is controlled by the
25411 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25412 both to cases when the host list comes with the address and when it is taken
25413 from &%hosts%&. This option provides a &"use a smart host only if delivery
25414 fails"& facility.
25415
25416
25417 .option final_timeout smtp time 10m
25418 .cindex timeout "for transmitted SMTP data accept"
25419 This is the timeout that applies while waiting for the response to the final
25420 line containing just &"."& that terminates a message. Its value must not be
25421 zero.
25422
25423 .option gethostbyname smtp boolean false
25424 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25425 being used, names are looked up using &[gethostbyname()]&
25426 (or &[getipnodebyname()]& when available)
25427 instead of using the DNS. Of course, that function may in fact use the DNS, but
25428 it may also consult other sources of information such as &_/etc/hosts_&.
25429
25430 .option gnutls_compat_mode smtp boolean unset
25431 This option controls whether GnuTLS is used in compatibility mode in an Exim
25432 server. This reduces security slightly, but improves interworking with older
25433 implementations of TLS.
25434
25435 .option helo_data smtp string&!! "see below"
25436 .cindex "HELO" "argument, setting"
25437 .cindex "EHLO" "argument, setting"
25438 .cindex "LHLO argument setting"
25439 The value of this option is expanded after a connection to a another host has
25440 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25441 command that starts the outgoing SMTP or LMTP session. The default value of the
25442 option is:
25443 .code
25444 $primary_hostname
25445 .endd
25446 During the expansion, the variables &$host$& and &$host_address$& are set to
25447 the identity of the remote host, and the variables &$sending_ip_address$& and
25448 &$sending_port$& are set to the local IP address and port number that are being
25449 used. These variables can be used to generate different values for different
25450 servers or different local IP addresses. For example, if you want the string
25451 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25452 interface address, you could use this:
25453 .code
25454 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25455   {${listextract{1}{<\n $value}}} \
25456   {$primary_hostname}}
25457 .endd
25458 The use of &%helo_data%& applies both to sending messages and when doing
25459 callouts.
25460
25461 .option host_name_extract smtp "string list&!!" "see below"
25462 .cindex "load balancer" "hosts behind"
25463 .cindex TLS resumption
25464 Some mail-accepting sites
25465 (notably Microsoft)
25466 operate many servers behind a network load-balancer.  When this is done,
25467 with separated TLS session caches, TLS session resuption becomes problematic.
25468 It will only succeed when the same server happens to be selected by the
25469 load-balancer, matching the session stored in the client's cache.
25470
25471 Exim can pull out a server name, if there is one, from the response to the
25472 client's SMTP EHLO command.
25473 The default value of this option:
25474 .code
25475     ${if and { {match {$host} {.outlook.com\$}} \
25476                {match {$item} {\N^250-([\w.]+)\s\N}} \
25477              } {$1}}
25478 .endd
25479 suffices for one known case.
25480 During the expansion of this option the &$item$& variable will have the
25481 server's EHLO response.
25482 The result of the option expansion is included in the key used to store and
25483 retrieve the TLS session, for session resumption.
25484
25485 Operators of high-load sites may wish to evaluate their logs for indications
25486 of other destination sites operating load-balancers, and develop a suitable
25487 expression for this option.
25488 The smtp:ehlo event and the &$tls_out_resumption$& variable
25489 will be useful for such work.
25490
25491 .option hosts smtp "string list&!!" unset
25492 Hosts are associated with an address by a router such as &(dnslookup)&, which
25493 finds the hosts by looking up the address domain in the DNS, or by
25494 &(manualroute)&, which has lists of hosts in its configuration. However,
25495 email addresses can be passed to the &(smtp)& transport by any router, and not
25496 all of them can provide an associated list of hosts.
25497
25498 The &%hosts%& option specifies a list of hosts to be used if the address being
25499 processed does not have any hosts associated with it. The hosts specified by
25500 &%hosts%& are also used, whether or not the address has its own hosts, if
25501 &%hosts_override%& is set.
25502
25503 The string is first expanded, before being interpreted as a colon-separated
25504 list of host names or IP addresses, possibly including port numbers. The
25505 separator may be changed to something other than colon, as described in section
25506 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25507 item in a &%route_list%& setting for the &(manualroute)& router, as described
25508 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25509 of the &(manualroute)& router is not available here.
25510
25511 If the expansion fails, delivery is deferred. Unless the failure was caused by
25512 the inability to complete a lookup, the error is logged to the panic log as
25513 well as the main log. Host names are looked up either by searching directly for
25514 address records in the DNS or by calling &[gethostbyname()]& (or
25515 &[getipnodebyname()]& when available), depending on the setting of the
25516 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25517 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25518 address are used.
25519
25520 During delivery, the hosts are tried in order, subject to their retry status,
25521 unless &%hosts_randomize%& is set.
25522
25523
25524 .option hosts_avoid_esmtp smtp "host list&!!" unset
25525 .cindex "ESMTP, avoiding use of"
25526 .cindex "HELO" "forcing use of"
25527 .cindex "EHLO" "avoiding use of"
25528 .cindex "PIPELINING" "avoiding the use of"
25529 This option is for use with broken hosts that announce ESMTP facilities (for
25530 example, PIPELINING) and then fail to implement them properly. When a host
25531 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25532 start of the SMTP session. This means that it cannot use any of the ESMTP
25533 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25534
25535
25536 .option hosts_avoid_pipelining smtp "host list&!!" unset
25537 .cindex "PIPELINING" "avoiding the use of"
25538 .cindex "ESMTP extensions" PIPELINING
25539 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25540 that matches this list, even if the server host advertises PIPELINING support.
25541
25542 .option hosts_pipe_connect smtp "host list&!!" unset
25543 .cindex "pipelining" "early connection"
25544 .cindex "pipelining" PIPECONNECT
25545 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25546 this option controls which to hosts the facility watched for
25547 and recorded, and used for subsequent connections.
25548
25549 The retry hints database is used for the record,
25550 and records are subject to the &%retry_data_expire%& option.
25551 When used, the pipelining saves on roundtrip times.
25552 It also turns SMTP into a client-first protocol
25553 so combines well with TCP Fast Open.
25554
25555 See also the &%pipelining_connect_advertise_hosts%& main option.
25556
25557 Note:
25558 When the facility is used, if the transport &%interface%& option is unset
25559 the &%helo_data%& option
25560 will be expanded before the &$sending_ip_address$& variable
25561 is filled in.
25562 A check is made for the use of that variable, without the
25563 presence of a &"def:"& test on it, but suitably complex coding
25564 can avoid the check and produce unexpected results.
25565 You have been warned.
25566
25567
25568 .option hosts_avoid_tls smtp "host list&!!" unset
25569 .cindex "TLS" "avoiding for certain hosts"
25570 Exim will not try to start a TLS session when delivering to any host that
25571 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25572
25573 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25574 .cindex "TLS" "avoiding for certain hosts"
25575 Exim will not try to start a TLS session for a verify callout,
25576 or when delivering in cutthrough mode,
25577 to any host that matches this list.
25578
25579
25580 .option hosts_max_try smtp integer 5
25581 .cindex "host" "maximum number to try"
25582 .cindex "limit" "number of hosts tried"
25583 .cindex "limit" "number of MX tried"
25584 .cindex "MX record" "maximum tried"
25585 This option limits the number of IP addresses that are tried for any one
25586 delivery in cases where there are temporary delivery errors. Section
25587 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25588
25589
25590 .option hosts_max_try_hardlimit smtp integer 50
25591 This is an additional check on the maximum number of IP addresses that Exim
25592 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25593 why it exists.
25594
25595
25596
25597 .option hosts_nopass_tls smtp "host list&!!" unset
25598 .cindex "TLS" "passing connection"
25599 .cindex "multiple SMTP deliveries"
25600 .cindex "TLS" "multiple message deliveries"
25601 For any host that matches this list, a connection on which a TLS session has
25602 been started will not be passed to a new delivery process for sending another
25603 message on the same connection. See section &<<SECTmulmessam>>& for an
25604 explanation of when this might be needed.
25605
25606 .option hosts_noproxy_tls smtp "host list&!!" unset
25607 .cindex "TLS" "passing connection"
25608 .cindex "multiple SMTP deliveries"
25609 .cindex "TLS" "multiple message deliveries"
25610 For any host that matches this list, a TLS session which has
25611 been started will not be passed to a new delivery process for sending another
25612 message on the same session.
25613
25614 The traditional implementation closes down TLS and re-starts it in the new
25615 process, on the same open TCP connection, for each successive message
25616 sent.  If permitted by this option a pipe to to the new process is set up
25617 instead, and the original process maintains the TLS connection and proxies
25618 the SMTP connection from and to the new process and any subsequents.
25619 The new process has no access to TLS information, so cannot include it in
25620 logging.
25621
25622
25623
25624 .option hosts_override smtp boolean false
25625 If this option is set and the &%hosts%& option is also set, any hosts that are
25626 attached to the address are ignored, and instead the hosts specified by the
25627 &%hosts%& option are always used. This option does not apply to
25628 &%fallback_hosts%&.
25629
25630
25631 .option hosts_randomize smtp boolean false
25632 .cindex "randomized host list"
25633 .cindex "host" "list of; randomized"
25634 .cindex "fallback" "randomized hosts"
25635 If this option is set, and either the list of hosts is taken from the
25636 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25637 were not obtained from MX records (this includes fallback hosts from the
25638 router), and were not randomized by the router, the order of trying the hosts
25639 is randomized each time the transport runs. Randomizing the order of a host
25640 list can be used to do crude load sharing.
25641
25642 When &%hosts_randomize%& is true, a host list may be split into groups whose
25643 order is separately randomized. This makes it possible to set up MX-like
25644 behaviour. The boundaries between groups are indicated by an item that is just
25645 &`+`& in the host list. For example:
25646 .code
25647 hosts = host1:host2:host3:+:host4:host5
25648 .endd
25649 The order of the first three hosts and the order of the last two hosts is
25650 randomized for each use, but the first three always end up before the last two.
25651 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25652
25653 .option hosts_require_auth smtp "host list&!!" unset
25654 .cindex "authentication" "required by client"
25655 This option provides a list of servers for which authentication must succeed
25656 before Exim will try to transfer a message. If authentication fails for
25657 servers which are not in this list, Exim tries to send unauthenticated. If
25658 authentication fails for one of these servers, delivery is deferred. This
25659 temporary error is detectable in the retry rules, so it can be turned into a
25660 hard failure if required. See also &%hosts_try_auth%&, and chapter
25661 &<<CHAPSMTPAUTH>>& for details of authentication.
25662
25663
25664 .option hosts_request_ocsp smtp "host list&!!" "see below"
25665 .cindex "TLS" "requiring for certain servers"
25666 Exim will request a Certificate Status on a
25667 TLS session for any host that matches this list.
25668 &%tls_verify_certificates%& should also be set for the transport.
25669
25670 .new
25671 The default is &"**"& if DANE is not in use for the connection,
25672 or if DANE-TA us used.
25673 It is empty if DANE-EE is used.
25674 .wen
25675
25676 .option hosts_require_alpn smtp "host list&!!" unset
25677 .cindex ALPN "require negotiation in client"
25678 .cindex TLS ALPN
25679 .cindex TLS "Application Layer Protocol Names"
25680 If the TLS library supports ALPN
25681 then a successful negotiation of ALPN will be required for any host
25682 matching the list, for TLS to be used.
25683 See also the &%tls_alpn%& option.
25684
25685 &*Note*&: prevention of fallback to in-clear connection is not
25686 managed by this option; see &%hosts_require_tls%&.
25687
25688 .option hosts_require_dane smtp "host list&!!" unset
25689 .cindex DANE "transport options"
25690 .cindex DANE "requiring for certain servers"
25691 If built with DANE support, Exim  will require that a DNSSEC-validated
25692 TLSA record is present for any host matching the list,
25693 and that a DANE-verified TLS connection is made.
25694 There will be no fallback to in-clear communication.
25695 See the &%dnssec_request_domains%& router and transport options.
25696 See section &<<SECDANE>>&.
25697
25698 .option hosts_require_ocsp smtp "host list&!!" unset
25699 .cindex "TLS" "requiring for certain servers"
25700 Exim will request, and check for a valid Certificate Status being given, on a
25701 TLS session for any host that matches this list.
25702 &%tls_verify_certificates%& should also be set for the transport.
25703
25704 .option hosts_require_tls smtp "host list&!!" unset
25705 .cindex "TLS" "requiring for certain servers"
25706 Exim will insist on using a TLS session when delivering to any host that
25707 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25708 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25709 incoming messages, use an appropriate ACL.
25710
25711 .option hosts_try_auth smtp "host list&!!" unset
25712 .cindex "authentication" "optional in client"
25713 This option provides a list of servers to which, provided they announce
25714 authentication support, Exim will attempt to authenticate as a client when it
25715 connects. If authentication fails
25716 and &%hosts_require_auth%& permits,
25717 Exim will try to transfer the message unauthenticated.
25718 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25719
25720 .option hosts_try_chunking smtp "host list&!!" *
25721 .cindex CHUNKING "enabling, in client"
25722 .cindex BDAT "SMTP command"
25723 .cindex "RFC 3030" "CHUNKING"
25724 This option provides a list of servers to which, provided they announce
25725 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25726 Unless DKIM signing is being done,
25727 BDAT will not be used in conjunction with a transport filter.
25728
25729 .option hosts_try_dane smtp "host list&!!" *
25730 .cindex DANE "transport options"
25731 .cindex DANE "attempting for certain servers"
25732 If built with DANE support, Exim  will look up a
25733 TLSA record for any host matching the list,
25734 If one is found and that lookup was DNSSEC-validated,
25735 then Exim requires that a DANE-verified TLS connection is made for that host;
25736 there will be no fallback to in-clear communication.
25737 See the &%dnssec_request_domains%& router and transport options.
25738 See section &<<SECDANE>>&.
25739
25740 .option hosts_try_fastopen smtp "host list&!!" *
25741 .cindex "fast open, TCP" "enabling, in client"
25742 .cindex "TCP Fast Open" "enabling, in client"
25743 .cindex "RFC 7413" "TCP Fast Open"
25744 This option provides a list of servers to which, provided
25745 the facility is supported by this system, Exim will attempt to
25746 perform a TCP Fast Open.
25747 No data is sent on the SYN segment but, if the remote server also
25748 supports the facility, it can send its SMTP banner immediately after
25749 the SYN,ACK segment.  This can save up to one round-trip time.
25750
25751 The facility is only active for previously-contacted servers,
25752 as the initiator must present a cookie in the SYN segment.
25753
25754 On (at least some) current Linux distributions the facility must be enabled
25755 in the kernel by the sysadmin before the support is usable.
25756 There is no option for control of the server side; if the system supports
25757 it it is always enabled.  Note that lengthy operations in the connect ACL,
25758 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25759
25760 .option hosts_try_prdr smtp "host list&!!" *
25761 .cindex "PRDR" "enabling, optional in client"
25762 .cindex "ESMTP extensions" PRDR
25763 This option provides a list of servers to which, provided they announce
25764 PRDR support, Exim will attempt to negotiate PRDR
25765 for multi-recipient messages.
25766 The option can usually be left as default.
25767
25768 .option interface smtp "string list&!!" unset
25769 .cindex "bind IP address"
25770 .cindex "IP address" "binding"
25771 .vindex "&$host$&"
25772 .vindex "&$host_address$&"
25773 This option specifies which interface to bind to when making an outgoing SMTP
25774 call. The value is an IP address, not an interface name such as
25775 &`eth0`&. Do not confuse this with the interface address that was used when a
25776 message was received, which is in &$received_ip_address$&, formerly known as
25777 &$interface_address$&. The name was changed to minimize confusion with the
25778 outgoing interface address. There is no variable that contains an outgoing
25779 interface address because, unless it is set by this option, its value is
25780 unknown.
25781
25782 During the expansion of the &%interface%& option the variables &$host$& and
25783 &$host_address$& refer to the host to which a connection is about to be made
25784 during the expansion of the string. Forced expansion failure, or an empty
25785 string result causes the option to be ignored. Otherwise, after expansion, the
25786 string must be a list of IP addresses, colon-separated by default, but the
25787 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25788 For example:
25789 .code
25790 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25791 .endd
25792 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25793 connection. If none of them are the correct type, the option is ignored. If
25794 &%interface%& is not set, or is ignored, the system's IP functions choose which
25795 interface to use if the host has more than one.
25796
25797
25798 .option keepalive smtp boolean true
25799 .cindex "keepalive" "on outgoing connection"
25800 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25801 connections. When set, it causes the kernel to probe idle connections
25802 periodically, by sending packets with &"old"& sequence numbers. The other end
25803 of the connection should send a acknowledgment if the connection is still okay
25804 or a reset if the connection has been aborted. The reason for doing this is
25805 that it has the beneficial effect of freeing up certain types of connection
25806 that can get stuck when the remote host is disconnected without tidying up the
25807 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25808 unreachable hosts.
25809
25810
25811 .option lmtp_ignore_quota smtp boolean false
25812 .cindex "LMTP" "ignoring quota errors"
25813 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25814 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25815 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25816
25817 .option max_rcpt smtp integer&!! 100
25818 .cindex "RCPT" "maximum number of outgoing"
25819 This option,
25820 .new
25821 after expansion,
25822 .wen
25823 limits the number of RCPT commands that are sent in a single
25824 SMTP message transaction.
25825 A value setting of zero disables the limit.
25826
25827 .new
25828 If a constant is given,
25829 .wen
25830 each set of addresses is treated independently, and
25831 so can cause parallel connections to the same host if &%remote_max_parallel%&
25832 permits this.
25833
25834
25835 .option message_linelength_limit smtp integer 998
25836 .cindex "line length" limit
25837 This option sets the maximum line length, in bytes, that the transport
25838 will send.  Any messages with lines exceeding the given value
25839 will fail and a failure-DSN ("bounce") message will if possible be returned
25840 to the sender.
25841 The default value is that defined by the SMTP standards.
25842
25843 It is generally wise to also check in the data ACL so that messages
25844 received via SMTP can be refused without producing a bounce.
25845
25846
25847 .option multi_domain smtp boolean&!! true
25848 .vindex "&$domain$&"
25849 When this option is set, the &(smtp)& transport can handle a number of
25850 addresses containing a mixture of different domains provided they all resolve
25851 to the same list of hosts. Turning the option off restricts the transport to
25852 handling only one domain at a time. This is useful if you want to use
25853 &$domain$& in an expansion for the transport, because it is set only when there
25854 is a single domain involved in a remote delivery.
25855
25856 It is expanded per-address and can depend on any of
25857 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25858 &$host$&, &$host_address$& and &$host_port$&.
25859
25860 If the connection is DANE-enabled then this option is ignored;
25861 only messages having the domain used for the DANE TLSA lookup are
25862 sent on the connection.
25863
25864 .option port smtp string&!! "see below"
25865 .cindex "port" "sending TCP/IP"
25866 .cindex "TCP/IP" "setting outgoing port"
25867 This option specifies the TCP/IP port on the server to which Exim connects.
25868 &*Note:*& Do not confuse this with the port that was used when a message was
25869 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25870 The name was changed to minimize confusion with the outgoing port. There is no
25871 variable that contains an outgoing port.
25872
25873 If the value of this option begins with a digit it is taken as a port number;
25874 otherwise it is looked up using &[getservbyname()]&. The default value is
25875 normally &"smtp"&,
25876 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25877 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25878 If the expansion fails, or if a port number cannot be found, delivery
25879 is deferred.
25880
25881 Note that at least one Linux distribution has been seen failing
25882 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25883
25884
25885
25886 .option protocol smtp string smtp
25887 .cindex "LMTP" "over TCP/IP"
25888 .cindex "ssmtp protocol" "outbound"
25889 .cindex "TLS" "SSL-on-connect outbound"
25890 .vindex "&$port$&"
25891 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25892 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25893 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25894 deliveries into closed message stores. Exim also has support for running LMTP
25895 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25896
25897 If this option is set to &"smtps"&, the default value for the &%port%& option
25898 changes to &"smtps"&, and the transport initiates TLS immediately after
25899 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25900 The Internet standards bodies used to strongly discourage use of this mode,
25901 but as of RFC 8314 it is preferred over STARTTLS for message submission
25902 (as distinct from MTA-MTA communication).
25903
25904
25905 .option retry_include_ip_address smtp boolean&!! true
25906 Exim normally includes both the host name and the IP address in the key it
25907 constructs for indexing retry data after a temporary delivery failure. This
25908 means that when one of several IP addresses for a host is failing, it gets
25909 tried periodically (controlled by the retry rules), but use of the other IP
25910 addresses is not affected.
25911
25912 However, in some dialup environments hosts are assigned a different IP address
25913 each time they connect. In this situation the use of the IP address as part of
25914 the retry key leads to undesirable behaviour. Setting this option false causes
25915 Exim to use only the host name.
25916 Since it is expanded it can be made to depend on the host or domain.
25917
25918
25919 .option serialize_hosts smtp "host list&!!" unset
25920 .cindex "serializing connections"
25921 .cindex "host" "serializing connections"
25922 Because Exim operates in a distributed manner, if several messages for the same
25923 host arrive at around the same time, more than one simultaneous connection to
25924 the remote host can occur. This is not usually a problem except when there is a
25925 slow link between the hosts. In that situation it may be helpful to restrict
25926 Exim to one connection at a time. This can be done by setting
25927 &%serialize_hosts%& to match the relevant hosts.
25928
25929 .cindex "hints database" "serializing deliveries to a host"
25930 Exim implements serialization by means of a hints database in which a record is
25931 written whenever a process connects to one of the restricted hosts. The record
25932 is deleted when the connection is completed. Obviously there is scope for
25933 records to get left lying around if there is a system or program crash. To
25934 guard against this, Exim ignores any records that are more than six hours old.
25935
25936 If you set up this kind of serialization, you should also arrange to delete the
25937 relevant hints database whenever your system reboots. The names of the files
25938 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25939 may be one or two files, depending on the type of DBM in use. The same files
25940 are used for ETRN serialization.
25941
25942 See also the &%max_parallel%& generic transport option.
25943
25944
25945 .option size_addition smtp integer 1024
25946 .cindex "SIZE" "ESMTP extension"
25947 .cindex "message" "size issue for transport filter"
25948 .cindex "size" "of message"
25949 .cindex "transport" "filter"
25950 .cindex "filter" "transport filter"
25951 If a remote SMTP server indicates that it supports the SIZE option of the
25952 MAIL command, Exim uses this to pass over the message size at the start of
25953 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25954 sends, to allow for headers and other text that may be added during delivery by
25955 configuration options or in a transport filter. It may be necessary to increase
25956 this if a lot of text is added to messages.
25957
25958 Alternatively, if the value of &%size_addition%& is set negative, it disables
25959 the use of the SIZE option altogether.
25960
25961
25962 .option socks_proxy smtp string&!! unset
25963 .cindex proxy SOCKS
25964 This option enables use of SOCKS proxies for connections made by the
25965 transport.  For details see section &<<SECTproxySOCKS>>&.
25966
25967
25968 .option tls_alpn smtp string&!! unset
25969 .cindex TLS "Application Layer Protocol Names"
25970 .cindex TLS ALPN
25971 .cindex ALPN "set name in client"
25972 If this option is set
25973 and the TLS library supports ALPN,
25974 the value given is used.
25975
25976 As of writing no value has been standardised for email use.
25977 The authors suggest using &"smtp"&.
25978
25979
25980
25981 .option tls_certificate smtp string&!! unset
25982 .cindex "TLS" "client certificate, location of"
25983 .cindex "certificate" "client, location of"
25984 .vindex "&$host$&"
25985 .vindex "&$host_address$&"
25986 The value of this option must be the absolute path to a file which contains the
25987 client's certificate, for possible use when sending a message over an encrypted
25988 connection. The values of &$host$& and &$host_address$& are set to the name and
25989 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25990 details of TLS.
25991
25992 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25993 certificate when sending messages as a client. The global option of the same
25994 name specifies the certificate for Exim as a server; it is not automatically
25995 assumed that the same certificate should be used when Exim is operating as a
25996 client.
25997
25998
25999 .option tls_crl smtp string&!! unset
26000 .cindex "TLS" "client certificate revocation list"
26001 .cindex "certificate" "revocation list for client"
26002 This option specifies a certificate revocation list. The expanded value must
26003 be the name of a file that contains a CRL in PEM format.
26004
26005
26006 .option tls_dh_min_bits smtp integer 1024
26007 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26008 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26009 key agreement is negotiated, the server will provide a large prime number
26010 for use.  This option establishes the minimum acceptable size of that number.
26011 If the parameter offered by the server is too small, then the TLS handshake
26012 will fail.
26013
26014 Only supported when using GnuTLS.
26015
26016
26017 .option tls_privatekey smtp string&!! unset
26018 .cindex "TLS" "client private key, location of"
26019 .vindex "&$host$&"
26020 .vindex "&$host_address$&"
26021 The value of this option must be the absolute path to a file which contains the
26022 client's private key. This is used when sending a message over an encrypted
26023 connection using a client certificate. The values of &$host$& and
26024 &$host_address$& are set to the name and address of the server during the
26025 expansion. If this option is unset, or the expansion is forced to fail, or the
26026 result is an empty string, the private key is assumed to be in the same file as
26027 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26028
26029
26030 .option tls_require_ciphers smtp string&!! unset
26031 .cindex "TLS" "requiring specific ciphers"
26032 .cindex "cipher" "requiring specific"
26033 .vindex "&$host$&"
26034 .vindex "&$host_address$&"
26035 The value of this option must be a list of permitted cipher suites, for use
26036 when setting up an outgoing encrypted connection. (There is a global option of
26037 the same name for controlling incoming connections.) The values of &$host$& and
26038 &$host_address$& are set to the name and address of the server during the
26039 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26040 is used in different ways by OpenSSL and GnuTLS (see sections
26041 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26042 ciphers is a preference order.
26043
26044
26045 .option tls_resumption_hosts smtp "host list&!!" unset
26046 .cindex TLS resumption
26047 This option controls which connections to use the TLS resumption feature.
26048 See &<<SECTresumption>>& for details.
26049
26050
26051
26052 .option tls_sni smtp string&!! unset
26053 .cindex "TLS" "Server Name Indication"
26054 .cindex "TLS" SNI
26055 .cindex SNI "setting in client"
26056 .vindex "&$tls_sni$&"
26057 If this option is set
26058 and the connection is not DANE-validated
26059 then it sets the $tls_out_sni variable and causes any
26060 TLS session to pass this value as the Server Name Indication extension to
26061 the remote side, which can be used by the remote side to select an appropriate
26062 certificate and private key for the session.
26063
26064 See &<<SECTtlssni>>& for more information.
26065
26066 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26067 TLS extensions.
26068
26069
26070
26071
26072 .option tls_tempfail_tryclear smtp boolean true
26073 .cindex "4&'xx'& responses" "to STARTTLS"
26074 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26075 setting up a TLS session, this option determines whether or not Exim should try
26076 to deliver the message unencrypted. If it is set false, delivery to the
26077 current host is deferred; if there are other hosts, they are tried. If this
26078 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26079 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26080 TLS negotiation fails, Exim closes the current connection (because it is in an
26081 unknown state), opens a new one to the same host, and then tries the delivery
26082 in clear.
26083
26084
26085 .option tls_try_verify_hosts smtp "host list&!!" *
26086 .cindex "TLS" "server certificate verification"
26087 .cindex "certificate" "verification of server"
26088 This option gives a list of hosts for which, on encrypted connections,
26089 certificate verification will be tried but need not succeed.
26090 The &%tls_verify_certificates%& option must also be set.
26091 Note that unless the host is in this list
26092 TLS connections will be denied to hosts using self-signed certificates
26093 when &%tls_verify_certificates%& is matched.
26094 The &$tls_out_certificate_verified$& variable is set when
26095 certificate verification succeeds.
26096
26097
26098 .option tls_verify_cert_hostnames smtp "host list&!!" *
26099 .cindex "TLS" "server certificate hostname verification"
26100 .cindex "certificate" "verification of server"
26101 This option give a list of hosts for which,
26102 while verifying the server certificate,
26103 checks will be included on the host name
26104 (note that this will generally be the result of a DNS MX lookup)
26105 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
26106 limited to being the initial component of a 3-or-more component FQDN.
26107
26108 There is no equivalent checking on client certificates.
26109
26110
26111 .option tls_verify_certificates smtp string&!! system
26112 .cindex "TLS" "server certificate verification"
26113 .cindex "certificate" "verification of server"
26114 .vindex "&$host$&"
26115 .vindex "&$host_address$&"
26116 The value of this option must be either the
26117 word "system"
26118 or the absolute path to
26119 a file or directory containing permitted certificates for servers,
26120 for use when setting up an encrypted connection.
26121
26122 The "system" value for the option will use a location compiled into the SSL library.
26123 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26124 is taken as empty and an explicit location
26125 must be specified.
26126
26127 The use of a directory for the option value is not available for GnuTLS versions
26128 preceding 3.3.6 and a single file must be used.
26129
26130 With OpenSSL the certificates specified
26131 explicitly
26132 either by file or directory
26133 are added to those given by the system default location.
26134
26135 The values of &$host$& and
26136 &$host_address$& are set to the name and address of the server during the
26137 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26138
26139 For back-compatibility,
26140 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26141 (a single-colon empty list counts as being set)
26142 and certificate verification fails the TLS connection is closed.
26143
26144
26145 .option tls_verify_hosts smtp "host list&!!" unset
26146 .cindex "TLS" "server certificate verification"
26147 .cindex "certificate" "verification of server"
26148 This option gives a list of hosts for which, on encrypted connections,
26149 certificate verification must succeed.
26150 The &%tls_verify_certificates%& option must also be set.
26151 If both this option and &%tls_try_verify_hosts%& are unset
26152 operation is as if this option selected all hosts.
26153 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26154 that connections use TLS.
26155 Fallback to in-clear communication will be done unless restricted by
26156 the &%hosts_require_tls%& option.
26157
26158 .option utf8_downconvert smtp integer&!! -1
26159 .cindex utf8 "address downconversion"
26160 .cindex i18n "utf8 address downconversion"
26161 If built with internationalization support,
26162 this option controls conversion of UTF-8 in message envelope addresses
26163 to a-label form.
26164 If, after expansion, the value is 1, 0, or -1 then this value overrides
26165 any value previously set for the message.  Otherwise, any previously
26166 set value is used.  To permit use of a previous value,
26167 set this option to an empty string.
26168 For details on the values see section &<<SECTi18nMTA>>&.
26169
26170
26171
26172
26173 .section "How the limits for the number of hosts to try are used" &&&
26174          "SECTvalhosmax"
26175 .cindex "host" "maximum number to try"
26176 .cindex "limit" "hosts; maximum number tried"
26177 There are two options that are concerned with the number of hosts that are
26178 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26179 &%hosts_max_try_hardlimit%&.
26180
26181
26182 The &%hosts_max_try%& option limits the number of hosts that are tried
26183 for a single delivery. However, despite the term &"host"& in its name, the
26184 option actually applies to each IP address independently. In other words, a
26185 multihomed host is treated as several independent hosts, just as it is for
26186 retrying.
26187
26188 Many of the larger ISPs have multiple MX records which often point to
26189 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26190 created as a result of routing one of these domains.
26191
26192 Trying every single IP address on such a long list does not seem sensible; if
26193 several at the top of the list fail, it is reasonable to assume there is some
26194 problem that is likely to affect all of them. Roughly speaking, the value of
26195 &%hosts_max_try%& is the maximum number that are tried before deferring the
26196 delivery. However, the logic cannot be quite that simple.
26197
26198 Firstly, IP addresses that are skipped because their retry times have not
26199 arrived do not count, and in addition, addresses that are past their retry
26200 limits are also not counted, even when they are tried. This means that when
26201 some IP addresses are past their retry limits, more than the value of
26202 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26203 that all IP addresses are considered before timing out an email address (but
26204 see below for an exception).
26205
26206 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26207 list to see if there is a subsequent host with a different (higher valued) MX.
26208 If there is, that host is considered next, and the current IP address is used
26209 but not counted. This behaviour helps in the case of a domain with a retry rule
26210 that hardly ever delays any hosts, as is now explained:
26211
26212 Consider the case of a long list of hosts with one MX value, and a few with a
26213 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26214 hosts at the top of the list are tried at first. With the default retry rule,
26215 which specifies increasing retry times, the higher MX hosts are eventually
26216 tried when those at the top of the list are skipped because they have not
26217 reached their retry times.
26218
26219 However, it is common practice to put a fixed short retry time on domains for
26220 large ISPs, on the grounds that their servers are rarely down for very long.
26221 Unfortunately, these are exactly the domains that tend to resolve to long lists
26222 of hosts. The short retry time means that the lowest MX hosts are tried every
26223 time. The attempts may be in a different order because of random sorting, but
26224 without the special MX check, the higher MX hosts would never be tried until
26225 all the lower MX hosts had timed out (which might be several days), because
26226 there are always some lower MX hosts that have reached their retry times. With
26227 the special check, Exim considers at least one IP address from each MX value at
26228 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26229 reached.
26230
26231 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26232 particular, Exim normally eventually tries all the IP addresses before timing
26233 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26234 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26235 been set up with hundreds of IP addresses for some domains. It can
26236 take a very long time indeed for an address to time out in these cases.
26237
26238 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26239 Exim never tries more than this number of IP addresses; if it hits this limit
26240 and they are all timed out, the email address is bounced, even though not all
26241 possible IP addresses have been tried.
26242 .ecindex IIDsmttra1
26243 .ecindex IIDsmttra2
26244
26245
26246
26247
26248
26249 . ////////////////////////////////////////////////////////////////////////////
26250 . ////////////////////////////////////////////////////////////////////////////
26251
26252 .chapter "Address rewriting" "CHAPrewrite"
26253 .scindex IIDaddrew "rewriting" "addresses"
26254 There are some circumstances in which Exim automatically rewrites domains in
26255 addresses. The two most common are when an address is given without a domain
26256 (referred to as an &"unqualified address"&) or when an address contains an
26257 abbreviated domain that is expanded by DNS lookup.
26258
26259 Unqualified envelope addresses are accepted only for locally submitted
26260 messages, or for messages that are received from hosts matching
26261 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26262 appropriate. Unqualified addresses in header lines are qualified if they are in
26263 locally submitted messages, or messages from hosts that are permitted to send
26264 unqualified envelope addresses. Otherwise, unqualified addresses in header
26265 lines are neither qualified nor rewritten.
26266
26267 One situation in which Exim does &'not'& automatically rewrite a domain is
26268 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26269 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26270 do this. The new RFCs do not contain this suggestion.
26271
26272
26273 .section "Explicitly configured address rewriting" "SECID147"
26274 This chapter describes the rewriting rules that can be used in the
26275 main rewrite section of the configuration file, and also in the generic
26276 &%headers_rewrite%& option that can be set on any transport.
26277
26278 Some people believe that configured address rewriting is a Mortal Sin.
26279 Others believe that life is not possible without it. Exim provides the
26280 facility; you do not have to use it.
26281
26282 The main rewriting rules that appear in the &"rewrite"& section of the
26283 configuration file are applied to addresses in incoming messages, both envelope
26284 addresses and addresses in header lines. Each rule specifies the types of
26285 address to which it applies.
26286
26287 Whether or not addresses in header lines are rewritten depends on the origin of
26288 the headers and the type of rewriting. Global rewriting, that is, rewriting
26289 rules from the rewrite section of the configuration file, is applied only to
26290 those headers that were received with the message. Header lines that are added
26291 by ACLs or by a system filter or by individual routers or transports (which
26292 are specific to individual recipient addresses) are not rewritten by the global
26293 rules.
26294
26295 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26296 applies all headers except those added by routers and transports. That is, as
26297 well as the headers that were received with the message, it also applies to
26298 headers that were added by an ACL or a system filter.
26299
26300
26301 In general, rewriting addresses from your own system or domain has some
26302 legitimacy. Rewriting other addresses should be done only with great care and
26303 in special circumstances. The author of Exim believes that rewriting should be
26304 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26305 Although it can sometimes be used as a routing tool, this is very strongly
26306 discouraged.
26307
26308 There are two commonly encountered circumstances where rewriting is used, as
26309 illustrated by these examples:
26310
26311 .ilist
26312 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26313 exchange mail with each other behind a firewall, but there is only a single
26314 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26315 &'hitch.fict.example'& when sending mail off-site.
26316 .next
26317 A host rewrites the local parts of its own users so that, for example,
26318 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26319 .endlist
26320
26321
26322
26323 .section "When does rewriting happen?" "SECID148"
26324 .cindex "rewriting" "timing of"
26325 .cindex "&ACL;" "rewriting addresses in"
26326 Configured address rewriting can take place at several different stages of a
26327 message's processing.
26328
26329 .vindex "&$sender_address$&"
26330 At the start of an ACL for MAIL, the sender address may have been rewritten
26331 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26332 ordinary rewrite rules have yet been applied. If, however, the sender address
26333 is verified in the ACL, it is rewritten before verification, and remains
26334 rewritten thereafter. The subsequent value of &$sender_address$& is the
26335 rewritten address. This also applies if sender verification happens in a
26336 RCPT ACL. Otherwise, when the sender address is not verified, it is
26337 rewritten as soon as a message's header lines have been received.
26338
26339 .vindex "&$domain$&"
26340 .vindex "&$local_part$&"
26341 Similarly, at the start of an ACL for RCPT, the current recipient's address
26342 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26343 rewrite rules have yet been applied to it. However, the behaviour is different
26344 from the sender address when a recipient is verified. The address is rewritten
26345 for the verification, but the rewriting is not remembered at this stage. The
26346 value of &$local_part$& and &$domain$& after verification are always the same
26347 as they were before (that is, they contain the unrewritten &-- except for
26348 SMTP-time rewriting &-- address).
26349
26350 As soon as a message's header lines have been received, all the envelope
26351 recipient addresses are permanently rewritten, and rewriting is also applied to
26352 the addresses in the header lines (if configured). This happens before adding
26353 any header lines that were specified in MAIL or RCPT ACLs, and
26354 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26355 before the DATA ACL and &[local_scan()]& functions are run.
26356
26357 When an address is being routed, either for delivery or for verification,
26358 rewriting is applied immediately to child addresses that are generated by
26359 redirection, unless &%no_rewrite%& is set on the router.
26360
26361 .cindex "envelope from"
26362 .cindex "envelope sender" "rewriting at transport time"
26363 .cindex "rewriting" "at transport time"
26364 .cindex "header lines" "rewriting at transport time"
26365 At transport time, additional rewriting of addresses in header lines can be
26366 specified by setting the generic &%headers_rewrite%& option on a transport.
26367 This option contains rules that are identical in form to those in the rewrite
26368 section of the configuration file. They are applied to the original message
26369 header lines and any that were added by ACLs or a system filter. They are not
26370 applied to header lines that are added by routers or the transport.
26371
26372 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26373 transport option. However, it is not possible to rewrite envelope recipients at
26374 transport time.
26375
26376
26377
26378
26379 .section "Testing the rewriting rules that apply on input" "SECID149"
26380 .cindex "rewriting" "testing"
26381 .cindex "testing" "rewriting"
26382 Exim's input rewriting configuration appears in a part of the runtime
26383 configuration file headed by &"begin rewrite"&. It can be tested by the
26384 &%-brw%& command line option. This takes an address (which can be a full RFC
26385 2822 address) as its argument. The output is a list of how the address would be
26386 transformed by the rewriting rules for each of the different places it might
26387 appear in an incoming message, that is, for each different header and for the
26388 envelope sender and recipient fields. For example,
26389 .code
26390 exim -brw ph10@exim.workshop.example
26391 .endd
26392 might produce the output
26393 .code
26394 sender: Philip.Hazel@exim.workshop.example
26395 from: Philip.Hazel@exim.workshop.example
26396 to: ph10@exim.workshop.example
26397 cc: ph10@exim.workshop.example
26398 bcc: ph10@exim.workshop.example
26399 reply-to: Philip.Hazel@exim.workshop.example
26400 env-from: Philip.Hazel@exim.workshop.example
26401 env-to: ph10@exim.workshop.example
26402 .endd
26403 which shows that rewriting has been set up for that address when used in any of
26404 the source fields, but not when it appears as a recipient address. At the
26405 present time, there is no equivalent way of testing rewriting rules that are
26406 set for a particular transport.
26407
26408
26409 .section "Rewriting rules" "SECID150"
26410 .cindex "rewriting" "rules"
26411 The rewrite section of the configuration file consists of lines of rewriting
26412 rules in the form
26413 .display
26414 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26415 .endd
26416 Rewriting rules that are specified for the &%headers_rewrite%& generic
26417 transport option are given as a colon-separated list. Each item in the list
26418 takes the same form as a line in the main rewriting configuration (except that
26419 any colons must be doubled, of course).
26420
26421 The formats of source patterns and replacement strings are described below.
26422 Each is terminated by white space, unless enclosed in double quotes, in which
26423 case normal quoting conventions apply inside the quotes. The flags are single
26424 characters which may appear in any order. Spaces and tabs between them are
26425 ignored.
26426
26427 For each address that could potentially be rewritten, the rules are scanned in
26428 order, and replacements for the address from earlier rules can themselves be
26429 replaced by later rules (but see the &"q"& and &"R"& flags).
26430
26431 The order in which addresses are rewritten is undefined, may change between
26432 releases, and must not be relied on, with one exception: when a message is
26433 received, the envelope sender is always rewritten first, before any header
26434 lines are rewritten. For example, the replacement string for a rewrite of an
26435 address in &'To:'& must not assume that the message's address in &'From:'& has
26436 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26437 that the envelope sender has already been rewritten.
26438
26439 .vindex "&$domain$&"
26440 .vindex "&$local_part$&"
26441 The variables &$local_part$& and &$domain$& can be used in the replacement
26442 string to refer to the address that is being rewritten. Note that lookup-driven
26443 rewriting can be done by a rule of the form
26444 .code
26445 *@*   ${lookup ...
26446 .endd
26447 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26448 refer to the address that is being rewritten.
26449
26450
26451 .section "Rewriting patterns" "SECID151"
26452 .cindex "rewriting" "patterns"
26453 .cindex "address list" "in a rewriting pattern"
26454 The source pattern in a rewriting rule is any item which may appear in an
26455 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26456 single-item address list, which means that it is expanded before being tested
26457 against the address. As always, if you use a regular expression as a pattern,
26458 you must take care to escape dollar and backslash characters, or use the &`\N`&
26459 facility to suppress string expansion within the regular expression.
26460
26461 Domains in patterns should be given in lower case. Local parts in patterns are
26462 case-sensitive. If you want to do case-insensitive matching of local parts, you
26463 can use a regular expression that starts with &`^(?i)`&.
26464
26465 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26466 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26467 depending on the type of match which occurred. These can be used in the
26468 replacement string to insert portions of the incoming address. &$0$& always
26469 refers to the complete incoming address. When a regular expression is used, the
26470 numerical variables are set from its capturing subexpressions. For other types
26471 of pattern they are set as follows:
26472
26473 .ilist
26474 If a local part or domain starts with an asterisk, the numerical variables
26475 refer to the character strings matched by asterisks, with &$1$& associated with
26476 the first asterisk, and &$2$& with the second, if present. For example, if the
26477 pattern
26478 .code
26479 *queen@*.fict.example
26480 .endd
26481 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26482 .code
26483 $0 = hearts-queen@wonderland.fict.example
26484 $1 = hearts-
26485 $2 = wonderland
26486 .endd
26487 Note that if the local part does not start with an asterisk, but the domain
26488 does, it is &$1$& that contains the wild part of the domain.
26489
26490 .next
26491 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26492 of the domain are placed in the next available numerical variables. Suppose,
26493 for example, that the address &'foo@bar.baz.example'& is processed by a
26494 rewriting rule of the form
26495 .display
26496 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26497 .endd
26498 and the key in the file that matches the domain is &`*.baz.example`&. Then
26499 .code
26500 $1 = foo
26501 $2 = bar
26502 $3 = baz.example
26503 .endd
26504 If the address &'foo@baz.example'& is looked up, this matches the same
26505 wildcard file entry, and in this case &$2$& is set to the empty string, but
26506 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26507 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26508 whole domain. For non-partial domain lookups, no numerical variables are set.
26509 .endlist
26510
26511
26512 .section "Rewriting replacements" "SECID152"
26513 .cindex "rewriting" "replacements"
26514 If the replacement string for a rule is a single asterisk, addresses that
26515 match the pattern and the flags are &'not'& rewritten, and no subsequent
26516 rewriting rules are scanned. For example,
26517 .code
26518 hatta@lookingglass.fict.example  *  f
26519 .endd
26520 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26521 &'From:'& headers.
26522
26523 .vindex "&$domain$&"
26524 .vindex "&$local_part$&"
26525 If the replacement string is not a single asterisk, it is expanded, and must
26526 yield a fully qualified address. Within the expansion, the variables
26527 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26528 Any letters they contain retain their original case &-- they are not lower
26529 cased. The numerical variables are set up according to the type of pattern that
26530 matched the address, as described above. If the expansion is forced to fail by
26531 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26532 current rule is abandoned, but subsequent rules may take effect. Any other
26533 expansion failure causes the entire rewriting operation to be abandoned, and an
26534 entry written to the panic log.
26535
26536
26537
26538 .subsection "Rewriting flags" "SSECID153"
26539 There are three different kinds of flag that may appear on rewriting rules:
26540
26541 .ilist
26542 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26543 c, f, h, r, s, t.
26544 .next
26545 A flag that specifies rewriting at SMTP time: S.
26546 .next
26547 Flags that control the rewriting process: Q, q, R, w.
26548 .endlist
26549
26550 For rules that are part of the &%headers_rewrite%& generic transport option,
26551 E, F, T, and S are not permitted.
26552
26553
26554
26555 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26556          "SSECID154"
26557 .cindex rewriting flags
26558 If none of the following flag letters, nor the &"S"& flag (see section
26559 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26560 and to both the sender and recipient fields of the envelope, whereas a
26561 transport-time rewriting rule just applies to all headers. Otherwise, the
26562 rewriting rule is skipped unless the relevant addresses are being processed.
26563 .display
26564 &`E`&       rewrite all envelope fields
26565 &`F`&       rewrite the envelope From field
26566 &`T`&       rewrite the envelope To field
26567 &`b`&       rewrite the &'Bcc:'& header
26568 &`c`&       rewrite the &'Cc:'& header
26569 &`f`&       rewrite the &'From:'& header
26570 &`h`&       rewrite all headers
26571 &`r`&       rewrite the &'Reply-To:'& header
26572 &`s`&       rewrite the &'Sender:'& header
26573 &`t`&       rewrite the &'To:'& header
26574 .endd
26575 "All headers" means all of the headers listed above that can be selected
26576 individually, plus their &'Resent-'& versions. It does not include
26577 other headers such as &'Subject:'& etc.
26578
26579 You should be particularly careful about rewriting &'Sender:'& headers, and
26580 restrict this to special known cases in your own domains.
26581
26582
26583 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26584 .cindex SMTP "rewriting malformed addresses"
26585 .cindex RCPT "rewriting argument of"
26586 .cindex MAIL "rewriting argument of"
26587 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26588 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26589 before any other processing; even before syntax checking. The pattern is
26590 required to be a regular expression, and it is matched against the whole of the
26591 data for the command, including any surrounding angle brackets.
26592
26593 .vindex "&$domain$&"
26594 .vindex "&$local_part$&"
26595 This form of rewrite rule allows for the handling of addresses that are not
26596 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26597 input). Because the input is not required to be a syntactically valid address,
26598 the variables &$local_part$& and &$domain$& are not available during the
26599 expansion of the replacement string. The result of rewriting replaces the
26600 original address in the MAIL or RCPT command.
26601
26602
26603 .subsection "Flags controlling the rewriting process" SSECID155
26604 There are four flags which control the way the rewriting process works. These
26605 take effect only when a rule is invoked, that is, when the address is of the
26606 correct type (matches the flags) and matches the pattern:
26607
26608 .ilist
26609 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26610 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26611 absence of &"Q"& the rewritten address must always include a domain.
26612 .next
26613 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26614 even if no rewriting actually takes place because of a &"fail"& in the
26615 expansion. The &"q"& flag is not effective if the address is of the wrong type
26616 (does not match the flags) or does not match the pattern.
26617 .next
26618 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26619 address, up to ten times. It can be combined with the &"q"& flag, to stop
26620 rewriting once it fails to match (after at least one successful rewrite).
26621 .next
26622 .cindex "rewriting" "whole addresses"
26623 When an address in a header is rewritten, the rewriting normally applies only
26624 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26625 left unchanged. For example, rewriting might change
26626 .code
26627 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26628 .endd
26629 into
26630 .code
26631 From: Ford Prefect <prefectf@hitch.fict.example>
26632 .endd
26633 .cindex "RFC 2047"
26634 Sometimes there is a need to replace the whole address item, and this can be
26635 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26636 causes an address in a header line to be rewritten, the entire address is
26637 replaced, not just the working part. The replacement must be a complete RFC
26638 2822 address, including the angle brackets if necessary. If text outside angle
26639 brackets contains a character whose value is greater than 126 or less than 32
26640 (except for tab), the text is encoded according to RFC 2047. The character set
26641 is taken from &%headers_charset%&, which gets its default at build time.
26642
26643 When the &"w"& flag is set on a rule that causes an envelope address to be
26644 rewritten, all but the working part of the replacement address is discarded.
26645 .endlist
26646
26647
26648 .section "Rewriting examples" "SECID156"
26649 Here is an example of the two common rewriting paradigms:
26650 .code
26651 *@*.hitch.fict.example  $1@hitch.fict.example
26652 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26653                      {$value}fail}@hitch.fict.example bctfrF
26654 .endd
26655 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26656 the string expansion to fail if the lookup does not succeed. In this context it
26657 has the effect of leaving the original address unchanged, but Exim goes on to
26658 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26659 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26660 explicitly, which would cause the rewritten address to be the same as before,
26661 at the cost of a small bit of processing. Not supplying either of these is an
26662 error, since the rewritten address would then contain no local part.
26663
26664 The first example above replaces the domain with a superior, more general
26665 domain. This may not be desirable for certain local parts. If the rule
26666 .code
26667 root@*.hitch.fict.example  *
26668 .endd
26669 were inserted before the first rule, rewriting would be suppressed for the
26670 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26671
26672 Rewriting can be made conditional on a number of tests, by making use of
26673 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26674 messages that originate outside the local host:
26675 .code
26676 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26677                          {$1@hitch.fict.example}fail}"
26678 .endd
26679 The replacement string is quoted in this example because it contains white
26680 space.
26681
26682 .cindex "rewriting" "bang paths"
26683 .cindex "bang paths" "rewriting"
26684 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26685 an address it treats it as an unqualified local part which it qualifies with
26686 the local qualification domain (if the source of the message is local or if the
26687 remote host is permitted to send unqualified addresses). Rewriting can
26688 sometimes be used to handle simple bang paths with a fixed number of
26689 components. For example, the rule
26690 .code
26691 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26692 .endd
26693 rewrites a two-component bang path &'host.name!user'& as the domain address
26694 &'user@host.name'&. However, there is a security implication in using this as
26695 a global rewriting rule for envelope addresses. It can provide a backdoor
26696 method for using your system as a relay, because the incoming addresses appear
26697 to be local. If the bang path addresses are received via SMTP, it is safer to
26698 use the &"S"& flag to rewrite them as they are received, so that relay checking
26699 can be done on the rewritten addresses.
26700 .ecindex IIDaddrew
26701
26702
26703
26704
26705
26706 . ////////////////////////////////////////////////////////////////////////////
26707 . ////////////////////////////////////////////////////////////////////////////
26708
26709 .chapter "Retry configuration" "CHAPretry"
26710 .scindex IIDretconf1 "retry" "configuration, description of"
26711 .scindex IIDregconf2 "configuration file" "retry section"
26712 The &"retry"& section of the runtime configuration file contains a list of
26713 retry rules that control how often Exim tries to deliver messages that cannot
26714 be delivered at the first attempt. If there are no retry rules (the section is
26715 empty or not present), there are no retries. In this situation, temporary
26716 errors are treated as permanent. The default configuration contains a single,
26717 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26718 line option can be used to test which retry rule will be used for a given
26719 address, domain and error.
26720
26721 The most common cause of retries is temporary failure to deliver to a remote
26722 host because the host is down, or inaccessible because of a network problem.
26723 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26724 address) basis, not on a per-message basis. Thus, if one message has recently
26725 been delayed, delivery of a new message to the same host is not immediately
26726 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26727 log selector is set, the message
26728 .cindex "retry" "time not reached"
26729 &"retry time not reached"& is written to the main log whenever a delivery is
26730 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26731 the handling of errors during remote deliveries.
26732
26733 Retry processing applies to routing as well as to delivering, except as covered
26734 in the next paragraph. The retry rules do not distinguish between these
26735 actions. It is not possible, for example, to specify different behaviour for
26736 failures to route the domain &'snark.fict.example'& and failures to deliver to
26737 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26738 added complication, so did not implement it. However, although they share the
26739 same retry rule, the actual retry times for routing and transporting a given
26740 domain are maintained independently.
26741
26742 When a delivery is not part of a queue run (typically an immediate delivery on
26743 receipt of a message), the routers are always run, and local deliveries are
26744 always attempted, even if retry times are set for them. This makes for better
26745 behaviour if one particular message is causing problems (for example, causing
26746 quota overflow, or provoking an error in a filter file). If such a delivery
26747 suffers a temporary failure, the retry data is updated as normal, and
26748 subsequent delivery attempts from queue runs occur only when the retry time for
26749 the local address is reached.
26750
26751 .section "Changing retry rules" "SECID157"
26752 If you change the retry rules in your configuration, you should consider
26753 whether or not to delete the retry data that is stored in Exim's spool area in
26754 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26755 always safe; that is why they are called &"hints"&.
26756
26757 The hints retry data contains suggested retry times based on the previous
26758 rules. In the case of a long-running problem with a remote host, it might
26759 record the fact that the host has timed out. If your new rules increase the
26760 timeout time for such a host, you should definitely remove the old retry data
26761 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26762 messages that it should now be retaining.
26763
26764
26765
26766 .section "Format of retry rules" "SECID158"
26767 .cindex "retry" "rules"
26768 Each retry rule occupies one line and consists of three or four parts,
26769 separated by white space: a pattern, an error name, an optional list of sender
26770 addresses, and a list of retry parameters. The pattern and sender lists must be
26771 enclosed in double quotes if they contain white space. The rules are searched
26772 in order until one is found where the pattern, error name, and sender list (if
26773 present) match the failing host or address, the error that occurred, and the
26774 message's sender, respectively.
26775
26776
26777 The pattern is any single item that may appear in an address list (see section
26778 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26779 which means that it is expanded before being tested against the address that
26780 has been delayed. A negated address list item is permitted. Address
26781 list processing treats a plain domain name as if it were preceded by &"*@"&,
26782 which makes it possible for many retry rules to start with just a domain. For
26783 example,
26784 .code
26785 lookingglass.fict.example        *  F,24h,30m;
26786 .endd
26787 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26788 whereas
26789 .code
26790 alice@lookingglass.fict.example  *  F,24h,30m;
26791 .endd
26792 applies only to temporary failures involving the local part &%alice%&.
26793 In practice, almost all rules start with a domain name pattern without a local
26794 part.
26795
26796 .cindex "regular expressions" "in retry rules"
26797 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26798 must match a complete address, not just a domain, because that is how regular
26799 expressions work in address lists.
26800 .display
26801 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26802 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26803 .endd
26804
26805
26806 .section "Choosing which retry rule to use for address errors" "SECID159"
26807 When Exim is looking for a retry rule after a routing attempt has failed (for
26808 example, after a DNS timeout), each line in the retry configuration is tested
26809 against the complete address only if &%retry_use_local_part%& is set for the
26810 router. Otherwise, only the domain is used, except when matching against a
26811 regular expression, when the local part of the address is replaced with &"*"&.
26812 A domain on its own can match a domain pattern, or a pattern that starts with
26813 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26814 &%check_local_user%& is true, and false for other routers.
26815
26816 Similarly, when Exim is looking for a retry rule after a local delivery has
26817 failed (for example, after a mailbox full error), each line in the retry
26818 configuration is tested against the complete address only if
26819 &%retry_use_local_part%& is set for the transport (it defaults true for all
26820 local transports).
26821
26822 .cindex "4&'xx'& responses" "retry rules for"
26823 However, when Exim is looking for a retry rule after a remote delivery attempt
26824 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26825 whole address is always used as the key when searching the retry rules. The
26826 rule that is found is used to create a retry time for the combination of the
26827 failing address and the message's sender. It is the combination of sender and
26828 recipient that is delayed in subsequent queue runs until its retry time is
26829 reached. You can delay the recipient without regard to the sender by setting
26830 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26831 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26832 commands.
26833
26834
26835
26836 .section "Choosing which retry rule to use for host and message errors" &&&
26837          "SECID160"
26838 For a temporary error that is not related to an individual address (for
26839 example, a connection timeout), each line in the retry configuration is checked
26840 twice. First, the name of the remote host is used as a domain name (preceded by
26841 &"*@"& when matching a regular expression). If this does not match the line,
26842 the domain from the email address is tried in a similar fashion. For example,
26843 suppose the MX records for &'a.b.c.example'& are
26844 .code
26845 a.b.c.example  MX  5  x.y.z.example
26846                MX  6  p.q.r.example
26847                MX  7  m.n.o.example
26848 .endd
26849 and the retry rules are
26850 .code
26851 p.q.r.example    *      F,24h,30m;
26852 a.b.c.example    *      F,4d,45m;
26853 .endd
26854 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26855 first rule matches neither the host nor the domain, so Exim looks at the second
26856 rule. This does not match the host, but it does match the domain, so it is used
26857 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26858 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26859 first retry rule is used, because it matches the host.
26860
26861 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26862 first rule to determine retry times, but for all the other hosts for the domain
26863 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26864 routing to &'a.b.c.example'& suffers a temporary failure.
26865
26866 &*Note*&: The host name is used when matching the patterns, not its IP address.
26867 However, if a message is routed directly to an IP address without the use of a
26868 host name, for example, if a &(manualroute)& router contains a setting such as:
26869 .code
26870 route_list = *.a.example  192.168.34.23
26871 .endd
26872 then the &"host name"& that is used when searching for a retry rule is the
26873 textual form of the IP address.
26874
26875 .section "Retry rules for specific errors" "SECID161"
26876 .cindex "retry" "specific errors; specifying"
26877 The second field in a retry rule is the name of a particular error, or an
26878 asterisk, which matches any error. The errors that can be tested for are:
26879
26880 .vlist
26881 .vitem &%auth_failed%&
26882 Authentication failed when trying to send to a host in the
26883 &%hosts_require_auth%& list in an &(smtp)& transport.
26884
26885 .vitem &%data_4xx%&
26886 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26887 after the command, or after sending the message's data.
26888
26889 .vitem &%mail_4xx%&
26890 A 4&'xx'& error was received for an outgoing MAIL command.
26891
26892 .vitem &%rcpt_4xx%&
26893 A 4&'xx'& error was received for an outgoing RCPT command.
26894 .endlist
26895
26896 For the three 4&'xx'& errors, either the first or both of the x's can be given
26897 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26898 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26899 and have retries every ten minutes with a one-hour timeout, you could set up a
26900 retry rule of this form:
26901 .code
26902 the.domain.name  rcpt_452   F,1h,10m
26903 .endd
26904 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26905 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26906
26907 .vlist
26908 .vitem &%lost_connection%&
26909 A server unexpectedly closed the SMTP connection. There may, of course,
26910 legitimate reasons for this (host died, network died), but if it repeats a lot
26911 for the same host, it indicates something odd.
26912
26913 .vitem &%lookup%&
26914 A DNS lookup for a host failed.
26915 Note that a &%dnslookup%& router will need to have matched
26916 its &%fail_defer_domains%& option for this retry type to be usable.
26917 Also note that a &%manualroute%& router will probably need
26918 its &%host_find_failed%& option set to &%defer%&.
26919
26920 .vitem &%refused_MX%&
26921 A connection to a host obtained from an MX record was refused.
26922
26923 .vitem &%refused_A%&
26924 A connection to a host not obtained from an MX record was refused.
26925
26926 .vitem &%refused%&
26927 A connection was refused.
26928
26929 .vitem &%timeout_connect_MX%&
26930 A connection attempt to a host obtained from an MX record timed out.
26931
26932 .vitem &%timeout_connect_A%&
26933 A connection attempt to a host not obtained from an MX record timed out.
26934
26935 .vitem &%timeout_connect%&
26936 A connection attempt timed out.
26937
26938 .vitem &%timeout_MX%&
26939 There was a timeout while connecting or during an SMTP session with a host
26940 obtained from an MX record.
26941
26942 .vitem &%timeout_A%&
26943 There was a timeout while connecting or during an SMTP session with a host not
26944 obtained from an MX record.
26945
26946 .vitem &%timeout%&
26947 There was a timeout while connecting or during an SMTP session.
26948
26949 .vitem &%tls_required%&
26950 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26951 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26952 to STARTTLS, or there was a problem setting up the TLS connection.
26953
26954 .vitem &%quota%&
26955 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26956 transport.
26957
26958 .vitem &%quota_%&<&'time'&>
26959 .cindex "quota" "error testing in retry rule"
26960 .cindex "retry" "quota error testing"
26961 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26962 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26963 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26964 for four days.
26965 .endlist
26966
26967 .cindex "mailbox" "time of last read"
26968 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26969 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26970 it should be based on the last time that the user accessed the mailbox.
26971 However, it is not always possible to determine this. Exim uses the following
26972 heuristic rules:
26973
26974 .ilist
26975 If the mailbox is a single file, the time of last access (the &"atime"&) is
26976 used. As no new messages are being delivered (because the mailbox is over
26977 quota), Exim does not access the file, so this is the time of last user access.
26978 .next
26979 .cindex "maildir format" "time of last read"
26980 For a maildir delivery, the time of last modification of the &_new_&
26981 subdirectory is used. As the mailbox is over quota, no new files are created in
26982 the &_new_& subdirectory, because no new messages are being delivered. Any
26983 change to the &_new_& subdirectory is therefore assumed to be the result of an
26984 MUA moving a new message to the &_cur_& directory when it is first read. The
26985 time that is used is therefore the last time that the user read a new message.
26986 .next
26987 For other kinds of multi-file mailbox, the time of last access cannot be
26988 obtained, so a retry rule that uses this type of error field is never matched.
26989 .endlist
26990
26991 The quota errors apply both to system-enforced quotas and to Exim's own quota
26992 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26993 when a local delivery is deferred because a partition is full (the ENOSPC
26994 error).
26995
26996
26997
26998 .section "Retry rules for specified senders" "SECID162"
26999 .cindex "retry" "rules; sender-specific"
27000 You can specify retry rules that apply only when the failing message has a
27001 specific sender. In particular, this can be used to define retry rules that
27002 apply only to bounce messages. The third item in a retry rule can be of this
27003 form:
27004 .display
27005 &`senders=`&<&'address list'&>
27006 .endd
27007 The retry timings themselves are then the fourth item. For example:
27008 .code
27009 *   rcpt_4xx   senders=:   F,1h,30m
27010 .endd
27011 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27012 host. If the address list contains white space, it must be enclosed in quotes.
27013 For example:
27014 .code
27015 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27016 .endd
27017 &*Warning*&: This facility can be unhelpful if it is used for host errors
27018 (which do not depend on the recipient). The reason is that the sender is used
27019 only to match the retry rule. Once the rule has been found for a host error,
27020 its contents are used to set a retry time for the host, and this will apply to
27021 all messages, not just those with specific senders.
27022
27023 When testing retry rules using &%-brt%&, you can supply a sender using the
27024 &%-f%& command line option, like this:
27025 .code
27026 exim -f "" -brt user@dom.ain
27027 .endd
27028 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27029 list is never matched.
27030
27031
27032
27033
27034
27035 .section "Retry parameters" "SECID163"
27036 .cindex "retry" "parameters in rules"
27037 The third (or fourth, if a senders list is present) field in a retry rule is a
27038 sequence of retry parameter sets, separated by semicolons. Each set consists of
27039 .display
27040 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27041 .endd
27042 The letter identifies the algorithm for computing a new retry time; the cutoff
27043 time is the time beyond which this algorithm no longer applies, and the
27044 arguments vary the algorithm's action. The cutoff time is measured from the
27045 time that the first failure for the domain (combined with the local part if
27046 relevant) was detected, not from the time the message was received.
27047
27048 .cindex "retry" "algorithms"
27049 .cindex "retry" "fixed intervals"
27050 .cindex "retry" "increasing intervals"
27051 .cindex "retry" "random intervals"
27052 The available algorithms are:
27053
27054 .ilist
27055 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27056 the interval.
27057 .next
27058 &'G'&: retry at geometrically increasing intervals. The first argument
27059 specifies a starting value for the interval, and the second a multiplier, which
27060 is used to increase the size of the interval at each retry.
27061 .next
27062 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27063 retry, the previous interval is multiplied by the factor in order to get a
27064 maximum for the next interval. The minimum interval is the first argument of
27065 the parameter, and an actual interval is chosen randomly between them. Such a
27066 rule has been found to be helpful in cluster configurations when all the
27067 members of the cluster restart at once, and may therefore synchronize their
27068 queue processing times.
27069 .endlist
27070
27071 When computing the next retry time, the algorithm definitions are scanned in
27072 order until one whose cutoff time has not yet passed is reached. This is then
27073 used to compute a new retry time that is later than the current time. In the
27074 case of fixed interval retries, this simply means adding the interval to the
27075 current time. For geometrically increasing intervals, retry intervals are
27076 computed from the rule's parameters until one that is greater than the previous
27077 interval is found. The main configuration variable
27078 .cindex "limit" "retry interval"
27079 .cindex "retry" "interval, maximum"
27080 .oindex "&%retry_interval_max%&"
27081 &%retry_interval_max%& limits the maximum interval between retries. It
27082 cannot be set greater than &`24h`&, which is its default value.
27083
27084 A single remote domain may have a number of hosts associated with it, and each
27085 host may have more than one IP address. Retry algorithms are selected on the
27086 basis of the domain name, but are applied to each IP address independently. If,
27087 for example, a host has two IP addresses and one is unusable, Exim will
27088 generate retry times for it and will not try to use it until its next retry
27089 time comes. Thus the good IP address is likely to be tried first most of the
27090 time.
27091
27092 .cindex "hints database" "use for retrying"
27093 Retry times are hints rather than promises. Exim does not make any attempt to
27094 run deliveries exactly at the computed times. Instead, a queue runner process
27095 starts delivery processes for delayed messages periodically, and these attempt
27096 new deliveries only for those addresses that have passed their next retry time.
27097 If a new message arrives for a deferred address, an immediate delivery attempt
27098 occurs only if the address has passed its retry time. In the absence of new
27099 messages, the minimum time between retries is the interval between queue runner
27100 processes. There is not much point in setting retry times of five minutes if
27101 your queue runners happen only once an hour, unless there are a significant
27102 number of incoming messages (which might be the case on a system that is
27103 sending everything to a smart host, for example).
27104
27105 The data in the retry hints database can be inspected by using the
27106 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27107 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27108 &'exinext'& utility script can be used to find out what the next retry times
27109 are for the hosts associated with a particular mail domain, and also for local
27110 deliveries that have been deferred.
27111
27112
27113 .section "Retry rule examples" "SECID164"
27114 Here are some example retry rules:
27115 .code
27116 alice@wonderland.fict.example quota_5d  F,7d,3h
27117 wonderland.fict.example       quota_5d
27118 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27119 lookingglass.fict.example     *         F,24h,30m;
27120 *                 refused_A   F,2h,20m;
27121 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27122 .endd
27123 The first rule sets up special handling for mail to
27124 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27125 mailbox has not been read for at least 5 days. Retries continue every three
27126 hours for 7 days. The second rule handles over-quota errors for all other local
27127 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27128 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27129 fail are bounced immediately if the mailbox has not been read for at least 5
27130 days.
27131
27132 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27133 happen every 15 minutes for an hour, then with geometrically increasing
27134 intervals until two days have passed since a delivery first failed. After the
27135 first hour there is a delay of one hour, then two hours, then four hours, and
27136 so on (this is a rather extreme example).
27137
27138 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27139 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27140 all other domains, with special action for connection refusal from hosts that
27141 were not obtained from an MX record.
27142
27143 The final rule in a retry configuration should always have asterisks in the
27144 first two fields so as to provide a general catch-all for any addresses that do
27145 not have their own special handling. This example tries every 15 minutes for 2
27146 hours, then with intervals starting at one hour and increasing by a factor of
27147 1.5 up to 16 hours, then every 8 hours up to 5 days.
27148
27149
27150
27151 .section "Timeout of retry data" "SECID165"
27152 .cindex "timeout" "of retry data"
27153 .oindex "&%retry_data_expire%&"
27154 .cindex "hints database" "data expiry"
27155 .cindex "retry" "timeout of data"
27156 Exim timestamps the data that it writes to its retry hints database. When it
27157 consults the data during a delivery it ignores any that is older than the value
27158 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27159 been tried for 7 days, Exim will try to deliver to it immediately a message
27160 arrives, and if that fails, it will calculate a retry time as if it were
27161 failing for the first time.
27162
27163 This improves the behaviour for messages routed to rarely-used hosts such as MX
27164 backups. If such a host was down at one time, and happens to be down again when
27165 Exim tries a month later, using the old retry data would imply that it had been
27166 down all the time, which is not a justified assumption.
27167
27168 If a host really is permanently dead, this behaviour causes a burst of retries
27169 every now and again, but only if messages routed to it are rare. If there is a
27170 message at least once every 7 days the retry data never expires.
27171
27172
27173
27174
27175 .section "Long-term failures" "SECID166"
27176 .cindex "delivery failure, long-term"
27177 .cindex "retry" "after long-term failure"
27178 Special processing happens when an email address has been failing for so long
27179 that the cutoff time for the last algorithm is reached. For example, using the
27180 default retry rule:
27181 .code
27182 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27183 .endd
27184 the cutoff time is four days. Reaching the retry cutoff is independent of how
27185 long any specific message has been failing; it is the length of continuous
27186 failure for the recipient address that counts.
27187
27188 When the cutoff time is reached for a local delivery, or for all the IP
27189 addresses associated with a remote delivery, a subsequent delivery failure
27190 causes Exim to give up on the address, and a bounce message is generated.
27191 In order to cater for new messages that use the failing address, a next retry
27192 time is still computed from the final algorithm, and is used as follows:
27193
27194 For local deliveries, one delivery attempt is always made for any subsequent
27195 messages. If this delivery fails, the address fails immediately. The
27196 post-cutoff retry time is not used.
27197
27198 .cindex "final cutoff" "retries, controlling"
27199 .cindex retry "final cutoff"
27200 If the delivery is remote, there are two possibilities, controlled by the
27201 .oindex "&%delay_after_cutoff%&"
27202 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27203 default. Until the post-cutoff retry time for one of the IP addresses,
27204 as set by the &%retry_data_expire%& option, is
27205 reached, the failing email address is bounced immediately, without a delivery
27206 attempt taking place. After that time, one new delivery attempt is made to
27207 those IP addresses that are past their retry times, and if that still fails,
27208 the address is bounced and new retry times are computed.
27209
27210 In other words, when all the hosts for a given email address have been failing
27211 for a long time, Exim bounces rather then defers until one of the hosts' retry
27212 times is reached. Then it tries once, and bounces if that attempt fails. This
27213 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27214 to a broken destination, but if the host does recover, Exim will eventually
27215 notice.
27216
27217 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27218 addresses are past their final cutoff time, Exim tries to deliver to those IP
27219 addresses that have not been tried since the message arrived. If there are
27220 no suitable IP addresses, or if they all fail, the address is bounced. In other
27221 words, it does not delay when a new message arrives, but tries the expired
27222 addresses immediately, unless they have been tried since the message arrived.
27223 If there is a continuous stream of messages for the failing domains, setting
27224 &%delay_after_cutoff%& false means that there will be many more attempts to
27225 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27226 true.
27227
27228 .section "Deliveries that work intermittently" "SECID167"
27229 .cindex "retry" "intermittently working deliveries"
27230 Some additional logic is needed to cope with cases where a host is
27231 intermittently available, or when a message has some attribute that prevents
27232 its delivery when others to the same address get through. In this situation,
27233 because some messages are successfully delivered, the &"retry clock"& for the
27234 host or address keeps getting reset by the successful deliveries, and so
27235 failing messages remain in the queue for ever because the cutoff time is never
27236 reached.
27237
27238 Two exceptional actions are applied to prevent this happening. The first
27239 applies to errors that are related to a message rather than a remote host.
27240 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27241 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27242 commands, and quota failures. For this type of error, if a message's arrival
27243 time is earlier than the &"first failed"& time for the error, the earlier time
27244 is used when scanning the retry rules to decide when to try next and when to
27245 time out the address.
27246
27247 The exceptional second action applies in all cases. If a message has been on
27248 the queue for longer than the cutoff time of any applicable retry rule for a
27249 given address, a delivery is attempted for that address, even if it is not yet
27250 time, and if this delivery fails, the address is timed out. A new retry time is
27251 not computed in this case, so that other messages for the same address are
27252 considered immediately.
27253 .ecindex IIDretconf1
27254 .ecindex IIDregconf2
27255
27256
27257
27258
27259
27260
27261 . ////////////////////////////////////////////////////////////////////////////
27262 . ////////////////////////////////////////////////////////////////////////////
27263
27264 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27265 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27266 .scindex IIDauthconf2 "authentication"
27267 The &"authenticators"& section of Exim's runtime configuration is concerned
27268 with SMTP authentication. This facility is an extension to the SMTP protocol,
27269 described in RFC 2554, which allows a client SMTP host to authenticate itself
27270 to a server. This is a common way for a server to recognize clients that are
27271 permitted to use it as a relay. SMTP authentication is not of relevance to the
27272 transfer of mail between servers that have no managerial connection with each
27273 other.
27274
27275 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27276 prior to Exim 4.95 names would be silently truncated at this length, but now
27277 it is enforced.
27278
27279 .cindex "AUTH" "description of"
27280 .cindex "ESMTP extensions" AUTH
27281 Very briefly, the way SMTP authentication works is as follows:
27282
27283 .olist
27284 The server advertises a number of authentication &'mechanisms'& in response to
27285 the client's EHLO command.
27286 .next
27287 The client issues an AUTH command, naming a specific mechanism. The command
27288 may, optionally, contain some authentication data.
27289 .next
27290 The server may issue one or more &'challenges'&, to which the client must send
27291 appropriate responses. In simple authentication mechanisms, the challenges are
27292 just prompts for user names and passwords. The server does not have to issue
27293 any challenges &-- in some mechanisms the relevant data may all be transmitted
27294 with the AUTH command.
27295 .next
27296 The server either accepts or denies authentication.
27297 .next
27298 If authentication succeeds, the client may optionally make use of the AUTH
27299 option on the MAIL command to pass an authenticated sender in subsequent
27300 mail transactions. Authentication lasts for the remainder of the SMTP
27301 connection.
27302 .next
27303 If authentication fails, the client may give up, or it may try a different
27304 authentication mechanism, or it may try transferring mail over the
27305 unauthenticated connection.
27306 .endlist
27307
27308 If you are setting up a client, and want to know which authentication
27309 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27310 SMTP port) on the server, and issue an EHLO command. The response to this
27311 includes the list of supported mechanisms. For example:
27312 .display
27313 &`$ `&&*&`telnet server.example 25`&*&
27314 &`Trying 192.168.34.25...`&
27315 &`Connected to server.example.`&
27316 &`Escape character is &#x0027;^]&#x0027;.`&
27317 &`220 server.example ESMTP Exim 4.20 ...`&
27318 &*&`ehlo client.example`&*&
27319 &`250-server.example Hello client.example [10.8.4.5]`&
27320 &`250-SIZE 52428800`&
27321 &`250-PIPELINING`&
27322 &`250-AUTH PLAIN`&
27323 &`250 HELP`&
27324 .endd
27325 The second-last line of this example output shows that the server supports
27326 authentication using the PLAIN mechanism. In Exim, the different authentication
27327 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27328 routers and transports, which authenticators are included in the binary is
27329 controlled by build-time definitions. The following are currently available,
27330 included by setting
27331 .code
27332 AUTH_CRAM_MD5=yes
27333 AUTH_CYRUS_SASL=yes
27334 AUTH_DOVECOT=yes
27335 AUTH_EXTERNAL=yes
27336 AUTH_GSASL=yes
27337 AUTH_HEIMDAL_GSSAPI=yes
27338 AUTH_PLAINTEXT=yes
27339 AUTH_SPA=yes
27340 AUTH_TLS=yes
27341 .endd
27342 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27343 authentication mechanism (RFC 2195), and the second provides an interface to
27344 the Cyrus SASL authentication library.
27345 The third is an interface to Dovecot's authentication system, delegating the
27346 work via a socket interface.
27347 The fourth provides for negotiation of authentication done via non-SMTP means,
27348 as defined by RFC 4422 Appendix A.
27349 The fifth provides an interface to the GNU SASL authentication library, which
27350 provides mechanisms but typically not data sources.
27351 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27352 supporting setting a server keytab.
27353 The seventh can be configured to support
27354 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27355 not formally documented, but used by several MUAs.
27356 The eighth authenticator
27357 supports Microsoft's &'Secure Password Authentication'& mechanism.
27358 The last is an Exim authenticator but not an SMTP one;
27359 instead it can use information from a TLS negotiation.
27360
27361 The authenticators are configured using the same syntax as other drivers (see
27362 section &<<SECTfordricon>>&). If no authenticators are required, no
27363 authentication section need be present in the configuration file. Each
27364 authenticator can in principle have both server and client functions. When Exim
27365 is receiving SMTP mail, it is acting as a server; when it is sending out
27366 messages over SMTP, it is acting as a client. Authenticator configuration
27367 options are provided for use in both these circumstances.
27368
27369 To make it clear which options apply to which situation, the prefixes
27370 &%server_%& and &%client_%& are used on option names that are specific to
27371 either the server or the client function, respectively. Server and client
27372 functions are disabled if none of their options are set. If an authenticator is
27373 to be used for both server and client functions, a single definition, using
27374 both sets of options, is required. For example:
27375 .code
27376 cram:
27377   driver = cram_md5
27378   public_name = CRAM-MD5
27379   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27380   client_name = ph10
27381   client_secret = secret2
27382 .endd
27383 The &%server_%& option is used when Exim is acting as a server, and the
27384 &%client_%& options when it is acting as a client.
27385
27386 Descriptions of the individual authenticators are given in subsequent chapters.
27387 The remainder of this chapter covers the generic options for the
27388 authenticators, followed by general discussion of the way authentication works
27389 in Exim.
27390
27391 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27392 per-mechanism basis.  Please read carefully to determine which variables hold
27393 account labels such as usercodes and which hold passwords or other
27394 authenticating data.
27395
27396 Note that some mechanisms support two different identifiers for accounts: the
27397 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27398 and &'authz'& are commonly encountered.  The American spelling is standard here.
27399 Conceptually, authentication data such as passwords are tied to the identifier
27400 used to authenticate; servers may have rules to permit one user to act as a
27401 second user, so that after login the session is treated as though that second
27402 user had logged in.  That second user is the &'authorization id'&.  A robust
27403 configuration might confirm that the &'authz'& field is empty or matches the
27404 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27405 as verified data, the &'authz'& as an unverified request which the server might
27406 choose to honour.
27407
27408 A &'realm'& is a text string, typically a domain name, presented by a server
27409 to a client to help it select an account and credentials to use.  In some
27410 mechanisms, the client and server provably agree on the realm, but clients
27411 typically can not treat the realm as secure data to be blindly trusted.
27412
27413
27414
27415 .section "Generic options for authenticators" "SECID168"
27416 .cindex "authentication" "generic options"
27417 .cindex "options" "generic; for authenticators"
27418
27419 .option client_condition authenticators string&!! unset
27420 When Exim is authenticating as a client, it skips any authenticator whose
27421 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27422 used, for example, to skip plain text authenticators when the connection is not
27423 encrypted by a setting such as:
27424 .code
27425 client_condition = ${if !eq{$tls_out_cipher}{}}
27426 .endd
27427
27428
27429 .option client_set_id authenticators string&!! unset
27430 When client authentication succeeds, this condition is expanded; the
27431 result is used in the log lines for outbound messages.
27432 Typically it will be the user name used for authentication.
27433
27434
27435 .option driver authenticators string unset
27436 This option must always be set. It specifies which of the available
27437 authenticators is to be used.
27438
27439
27440 .option public_name authenticators string unset
27441 This option specifies the name of the authentication mechanism that the driver
27442 implements, and by which it is known to the outside world. These names should
27443 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27444 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27445 defaults to the driver's instance name.
27446
27447
27448 .option server_advertise_condition authenticators string&!! unset
27449 When a server is about to advertise an authentication mechanism, the condition
27450 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27451 mechanism is not advertised.
27452 If the expansion fails, the mechanism is not advertised. If the failure was not
27453 forced, and was not caused by a lookup defer, the incident is logged.
27454 See section &<<SECTauthexiser>>& below for further discussion.
27455
27456
27457 .option server_condition authenticators string&!! unset
27458 This option must be set for a &%plaintext%& server authenticator, where it
27459 is used directly to control authentication. See section &<<SECTplainserver>>&
27460 for details.
27461
27462 For the &(gsasl)& authenticator, this option is required for various
27463 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27464
27465 For the other authenticators, &%server_condition%& can be used as an additional
27466 authentication or authorization mechanism that is applied after the other
27467 authenticator conditions succeed. If it is set, it is expanded when the
27468 authenticator would otherwise return a success code. If the expansion is forced
27469 to fail, authentication fails. Any other expansion failure causes a temporary
27470 error code to be returned. If the result of a successful expansion is an empty
27471 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27472 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27473 other result, a temporary error code is returned, with the expanded string as
27474 the error text.
27475
27476
27477 .option server_debug_print authenticators string&!! unset
27478 If this option is set and authentication debugging is enabled (see the &%-d%&
27479 command line option), the string is expanded and included in the debugging
27480 output when the authenticator is run as a server. This can help with checking
27481 out the values of variables.
27482 If expansion of the string fails, the error message is written to the debugging
27483 output, and Exim carries on processing.
27484
27485
27486 .option server_set_id authenticators string&!! unset
27487 .vindex "&$authenticated_id$&"
27488 .vindex "&$authenticated_fail_id$&"
27489 When an Exim server successfully authenticates a client, this string is
27490 expanded using data from the authentication, and preserved for any incoming
27491 messages in the variable &$authenticated_id$&. It is also included in the log
27492 lines for incoming messages. For example, a user/password authenticator
27493 configuration might preserve the user name that was used to authenticate, and
27494 refer to it subsequently during delivery of the message.
27495 On a failing authentication the expansion result is instead saved in
27496 the &$authenticated_fail_id$& variable.
27497 If expansion fails, the option is ignored.
27498
27499
27500 .option server_mail_auth_condition authenticators string&!! unset
27501 This option allows a server to discard authenticated sender addresses supplied
27502 as part of MAIL commands in SMTP connections that are authenticated by the
27503 driver on which &%server_mail_auth_condition%& is set. The option is not used
27504 as part of the authentication process; instead its (unexpanded) value is
27505 remembered for later use.
27506 How it is used is described in the following section.
27507
27508
27509
27510
27511
27512 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27513 .cindex "authentication" "sender; authenticated"
27514 .cindex "AUTH" "on MAIL command"
27515 When a client supplied an AUTH= item on a MAIL command, Exim applies
27516 the following checks before accepting it as the authenticated sender of the
27517 message:
27518
27519 .ilist
27520 If the connection is not using extended SMTP (that is, HELO was used rather
27521 than EHLO), the use of AUTH= is a syntax error.
27522 .next
27523 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27524 .next
27525 .vindex "&$authenticated_sender$&"
27526 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27527 running, the value of &$authenticated_sender$& is set to the value obtained
27528 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27529 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27530 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27531 given for the MAIL command.
27532 .next
27533 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27534 is accepted and placed in &$authenticated_sender$& only if the client has
27535 authenticated.
27536 .next
27537 If the AUTH= value was accepted by either of the two previous rules, and
27538 the client has authenticated, and the authenticator has a setting for the
27539 &%server_mail_auth_condition%&, the condition is checked at this point. The
27540 valued that was saved from the authenticator is expanded. If the expansion
27541 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27542 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27543 the value of &$authenticated_sender$& is retained and passed on with the
27544 message.
27545 .endlist
27546
27547
27548 When &$authenticated_sender$& is set for a message, it is passed on to other
27549 hosts to which Exim authenticates as a client. Do not confuse this value with
27550 &$authenticated_id$&, which is a string obtained from the authentication
27551 process, and which is not usually a complete email address.
27552
27553 .vindex "&$sender_address$&"
27554 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27555 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27556 therefore make use of &$authenticated_sender$&. The converse is not true: the
27557 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27558 ACL is run.
27559
27560
27561
27562 .section "Authentication on an Exim server" "SECTauthexiser"
27563 .cindex "authentication" "on an Exim server"
27564 When Exim receives an EHLO command, it advertises the public names of those
27565 authenticators that are configured as servers, subject to the following
27566 conditions:
27567
27568 .ilist
27569 The client host must match &%auth_advertise_hosts%& (default *).
27570 .next
27571 If the &%server_advertise_condition%& option is set, its expansion must not
27572 yield the empty string, &"0"&, &"no"&, or &"false"&.
27573 .endlist
27574
27575 The order in which the authenticators are defined controls the order in which
27576 the mechanisms are advertised.
27577
27578 Some mail clients (for example, some versions of Netscape) require the user to
27579 provide a name and password for authentication whenever AUTH is advertised,
27580 even though authentication may not in fact be needed (for example, Exim may be
27581 set up to allow unconditional relaying from the client by an IP address check).
27582 You can make such clients more friendly by not advertising AUTH to them.
27583 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27584 that runs for RCPT) to relay without authentication, you should set
27585 .code
27586 auth_advertise_hosts = ! 10.9.8.0/24
27587 .endd
27588 so that no authentication mechanisms are advertised to them.
27589
27590 The &%server_advertise_condition%& controls the advertisement of individual
27591 authentication mechanisms. For example, it can be used to restrict the
27592 advertisement of a particular mechanism to encrypted connections, by a setting
27593 such as:
27594 .code
27595 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27596 .endd
27597 .vindex "&$tls_in_cipher$&"
27598 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27599 yields &"yes"&, which allows the advertisement to happen.
27600
27601 When an Exim server receives an AUTH command from a client, it rejects it
27602 immediately if AUTH was not advertised in response to an earlier EHLO
27603 command. This is the case if
27604
27605 .ilist
27606 The client host does not match &%auth_advertise_hosts%&; or
27607 .next
27608 No authenticators are configured with server options; or
27609 .next
27610 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27611 server authenticators.
27612 .endlist
27613
27614
27615 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27616 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27617 AUTH is accepted from any client host.
27618
27619 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27620 server authentication mechanism that was advertised in response to EHLO and
27621 that matches the one named in the AUTH command. If it finds one, it runs
27622 the appropriate authentication protocol, and authentication either succeeds or
27623 fails. If there is no matching advertised mechanism, the AUTH command is
27624 rejected with a 504 error.
27625
27626 .vindex "&$received_protocol$&"
27627 .vindex "&$sender_host_authenticated$&"
27628 When a message is received from an authenticated host, the value of
27629 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27630 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27631 public name) of the authenticator driver that successfully authenticated the
27632 client from which the message was received. This variable is empty if there was
27633 no successful authentication.
27634
27635 .cindex authentication "expansion item"
27636 Successful authentication sets up information used by the
27637 &%authresults%& expansion item.
27638
27639 .new
27640 .cindex authentication "failure event, server"
27641 If an authenticator is run and does not succeed,
27642 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27643 While the event is being processed the variables
27644 &$sender_host_authenticated$& (with the authenticator name)
27645 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27646 will be valid.
27647 If the event is serviced and a string is returned then the string will be logged
27648 instead of the default log line.
27649 See <<CHAPevents>> for details on events.
27650 .wen
27651
27652
27653 .section "Testing server authentication" "SECID169"
27654 .cindex "authentication" "testing a server"
27655 .cindex "AUTH" "testing a server"
27656 .cindex "base64 encoding" "creating authentication test data"
27657 Exim's &%-bh%& option can be useful for testing server authentication
27658 configurations. The data for the AUTH command has to be sent using base64
27659 encoding. A quick way to produce such data for testing is the following Perl
27660 script:
27661 .code
27662 use MIME::Base64;
27663 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27664 .endd
27665 .cindex "binary zero" "in authentication data"
27666 This interprets its argument as a Perl string, and then encodes it. The
27667 interpretation as a Perl string allows binary zeros, which are required for
27668 some kinds of authentication, to be included in the data. For example, a
27669 command line to run this script on such data might be
27670 .code
27671 encode '\0user\0password'
27672 .endd
27673 Note the use of single quotes to prevent the shell interpreting the
27674 backslashes, so that they can be interpreted by Perl to specify characters
27675 whose code value is zero.
27676
27677 &*Warning 1*&: If either of the user or password strings starts with an octal
27678 digit, you must use three zeros instead of one after the leading backslash. If
27679 you do not, the octal digit that starts your string will be incorrectly
27680 interpreted as part of the code for the first character.
27681
27682 &*Warning 2*&: If there are characters in the strings that Perl interprets
27683 specially, you must use a Perl escape to prevent them being misinterpreted. For
27684 example, a command such as
27685 .code
27686 encode '\0user@domain.com\0pas$$word'
27687 .endd
27688 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27689
27690 If you have the &%mimencode%& command installed, another way to produce
27691 base64-encoded strings is to run the command
27692 .code
27693 echo -e -n `\0user\0password' | mimencode
27694 .endd
27695 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27696 in the argument, and the &%-n%& option specifies no newline at the end of its
27697 output. However, not all versions of &%echo%& recognize these options, so you
27698 should check your version before relying on this suggestion.
27699
27700
27701
27702 .section "Authentication by an Exim client" "SECID170"
27703 .cindex "authentication" "on an Exim client"
27704 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27705 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27706 announces support for authentication, and the host matches an entry in either
27707 of these options, Exim (as a client) tries to authenticate as follows:
27708
27709 .ilist
27710 For each authenticator that is configured as a client, in the order in which
27711 they are defined in the configuration, it searches the authentication
27712 mechanisms announced by the server for one whose name matches the public name
27713 of the authenticator.
27714 .next
27715 .vindex "&$host$&"
27716 .vindex "&$host_address$&"
27717 When it finds one that matches, it runs the authenticator's client code. The
27718 variables &$host$& and &$host_address$& are available for any string expansions
27719 that the client might do. They are set to the server's name and IP address. If
27720 any expansion is forced to fail, the authentication attempt is abandoned, and
27721 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27722 delivery to be deferred.
27723 .next
27724 If the result of the authentication attempt is a temporary error or a timeout,
27725 Exim abandons trying to send the message to the host for the moment. It will
27726 try again later. If there are any backup hosts available, they are tried in the
27727 usual way.
27728
27729 .new
27730 .next
27731 .cindex authentication "failure event, client"
27732 If the response to authentication is a permanent error (5&'xx'& code),
27733 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27734 While the event is being processed the variable
27735 &$sender_host_authenticated$& (with the authenticator name)
27736 will be valid.
27737 If the event is serviced and a string is returned then the string will be logged.
27738 See <<CHAPevents>> for details on events.
27739 .wen
27740
27741 .next
27742 If the response to authentication is a permanent error (5&'xx'& code), Exim
27743 carries on searching the list of authenticators and tries another one if
27744 possible. If all authentication attempts give permanent errors, or if there are
27745 no attempts because no mechanisms match (or option expansions force failure),
27746 what happens depends on whether the host matches &%hosts_require_auth%& or
27747 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27748 delivery is deferred. The error can be detected in the retry rules, and thereby
27749 turned into a permanent error if you wish. In the second case, Exim tries to
27750 deliver the message unauthenticated.
27751 .endlist
27752
27753 Note that the hostlist test for whether to do authentication can be
27754 confused if name-IP lookups change between the time the peer is decided
27755 upon and the time that the transport runs.  For example, with a manualroute
27756 router given a host name, and with DNS "round-robin" used by that name: if
27757 the local resolver cache times out between the router and the transport
27758 running, the transport may get an IP for the name for its authentication
27759 check which does not match the connection peer IP.
27760 No authentication will then be done, despite the names being identical.
27761
27762 For such cases use a separate transport which always authenticates.
27763
27764 .cindex "AUTH" "on MAIL command"
27765 When Exim has authenticated itself to a remote server, it adds the AUTH
27766 parameter to the MAIL commands it sends, if it has an authenticated sender for
27767 the message. If the message came from a remote host, the authenticated sender
27768 is the one that was receiving on an incoming MAIL command, provided that the
27769 incoming connection was authenticated and the &%server_mail_auth%& condition
27770 allowed the authenticated sender to be retained. If a local process calls Exim
27771 to send a message, the sender address that is built from the login name and
27772 &%qualify_domain%& is treated as authenticated. However, if the
27773 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27774 the authenticated sender that was received with the message.
27775 .ecindex IIDauthconf1
27776 .ecindex IIDauthconf2
27777
27778
27779
27780
27781
27782
27783 . ////////////////////////////////////////////////////////////////////////////
27784 . ////////////////////////////////////////////////////////////////////////////
27785
27786 .chapter "The plaintext authenticator" "CHAPplaintext"
27787 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27788 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27789 The &(plaintext)& authenticator can be configured to support the PLAIN and
27790 LOGIN authentication mechanisms, both of which transfer authentication data as
27791 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27792 security risk; you are strongly advised to insist on the use of SMTP encryption
27793 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27794 use unencrypted plain text, you should not use the same passwords for SMTP
27795 connections as you do for login accounts.
27796
27797 .section "Avoiding cleartext use" "SECTplain_TLS"
27798 The following generic option settings will disable &(plaintext)& authenticators when
27799 TLS is not being used:
27800 .code
27801   server_advertise_condition = ${if def:tls_in_cipher }
27802   client_condition =           ${if def:tls_out_cipher}
27803 .endd
27804
27805 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27806 but is still vulnerable to a Man In The Middle attack unless certificates
27807 (including their names) have been properly verified.
27808
27809 .section "Plaintext server options" "SECID171"
27810 .cindex "options" "&(plaintext)& authenticator (server)"
27811 When configured as a server, &(plaintext)& uses the following options:
27812
27813 .option server_condition authenticators string&!! unset
27814 This is actually a global authentication option, but it must be set in order to
27815 configure the &(plaintext)& driver as a server. Its use is described below.
27816
27817 .option server_prompts plaintext "string list&!!" unset
27818 The contents of this option, after expansion, must be a colon-separated list of
27819 prompt strings. If expansion fails, a temporary authentication rejection is
27820 given.
27821
27822 .section "Using plaintext in a server" "SECTplainserver"
27823 .cindex "AUTH" "in &(plaintext)& authenticator"
27824 .cindex "binary zero" "in &(plaintext)& authenticator"
27825 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27826         "in &(plaintext)& authenticator"
27827 .vindex "&$auth1$&, &$auth2$&, etc"
27828 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27829
27830 When running as a server, &(plaintext)& performs the authentication test by
27831 expanding a string. The data sent by the client with the AUTH command, or in
27832 response to subsequent prompts, is base64 encoded, and so may contain any byte
27833 values when decoded. If any data is supplied with the command, it is treated as
27834 a list of strings, separated by NULs (binary zeros), the first three of which
27835 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27836 (neither LOGIN nor PLAIN uses more than three strings).
27837
27838 For compatibility with previous releases of Exim, the values are also placed in
27839 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27840 variables for this purpose is now deprecated, as it can lead to confusion in
27841 string expansions that also use them for other things.
27842
27843 If there are more strings in &%server_prompts%& than the number of strings
27844 supplied with the AUTH command, the remaining prompts are used to obtain more
27845 data. Each response from the client may be a list of NUL-separated strings.
27846
27847 .vindex "&$authenticated_id$&"
27848 Once a sufficient number of data strings have been received,
27849 &%server_condition%& is expanded. If the expansion is forced to fail,
27850 authentication fails. Any other expansion failure causes a temporary error code
27851 to be returned. If the result of a successful expansion is an empty string,
27852 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27853 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27854 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27855 For any other result, a temporary error code is returned, with the expanded
27856 string as the error text.
27857
27858 &*Warning*&: If you use a lookup in the expansion to find the user's
27859 password, be sure to make the authentication fail if the user is unknown.
27860 There are good and bad examples at the end of the next section.
27861
27862
27863
27864 .section "The PLAIN authentication mechanism" "SECID172"
27865 .cindex "PLAIN authentication mechanism"
27866 .cindex authentication PLAIN
27867 .cindex "binary zero" "in &(plaintext)& authenticator"
27868 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27869 sent as one item of data (that is, one combined string containing two NUL
27870 separators). The data is sent either as part of the AUTH command, or
27871 subsequently in response to an empty prompt from the server.
27872
27873 The second and third strings are a user name and a corresponding password.
27874 Using a single fixed user name and password as an example, this could be
27875 configured as follows:
27876 .code
27877 fixed_plain:
27878   driver = plaintext
27879   public_name = PLAIN
27880   server_prompts = :
27881   server_condition = \
27882     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27883   server_set_id = $auth2
27884 .endd
27885 Note that the default result strings from &%if%& (&"true"& or an empty string)
27886 are exactly what we want here, so they need not be specified. Obviously, if the
27887 password contains expansion-significant characters such as dollar, backslash,
27888 or closing brace, they have to be escaped.
27889
27890 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27891 the end of a string list are ignored). If all the data comes as part of the
27892 AUTH command, as is commonly the case, the prompt is not used. This
27893 authenticator is advertised in the response to EHLO as
27894 .code
27895 250-AUTH PLAIN
27896 .endd
27897 and a client host can authenticate itself by sending the command
27898 .code
27899 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27900 .endd
27901 As this contains three strings (more than the number of prompts), no further
27902 data is required from the client. Alternatively, the client may just send
27903 .code
27904 AUTH PLAIN
27905 .endd
27906 to initiate authentication, in which case the server replies with an empty
27907 prompt. The client must respond with the combined data string.
27908
27909 The data string is base64 encoded, as required by the RFC. This example,
27910 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27911 represents a zero byte. This is split up into three strings, the first of which
27912 is empty. The &%server_condition%& option in the authenticator checks that the
27913 second two are &`username`& and &`mysecret`& respectively.
27914
27915 Having just one fixed user name and password, as in this example, is not very
27916 realistic, though for a small organization with only a handful of
27917 authenticating clients it could make sense.
27918
27919 A more sophisticated instance of this authenticator could use the user name in
27920 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27921 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27922 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27923 This is an incorrect example:
27924 .code
27925 server_condition = \
27926   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27927 .endd
27928 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27929 which it then compares to the supplied password (&$auth3$&). Why is this example
27930 incorrect? It works fine for existing users, but consider what happens if a
27931 non-existent user name is given. The lookup fails, but as no success/failure
27932 strings are given for the lookup, it yields an empty string. Thus, to defeat
27933 the authentication, all a client has to do is to supply a non-existent user
27934 name and an empty password. The correct way of writing this test is:
27935 .code
27936 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27937   {${if eq{$value}{$auth3}}} {false}}
27938 .endd
27939 In this case, if the lookup succeeds, the result is checked; if the lookup
27940 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27941 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27942 always fails if its second argument is empty. However, the second way of
27943 writing the test makes the logic clearer.
27944
27945
27946 .section "The LOGIN authentication mechanism" "SECID173"
27947 .cindex "LOGIN authentication mechanism"
27948 .cindex authentication LOGIN
27949 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27950 in a number of programs. No data is sent with the AUTH command. Instead, a
27951 user name and password are supplied separately, in response to prompts. The
27952 plaintext authenticator can be configured to support this as in this example:
27953 .code
27954 fixed_login:
27955   driver = plaintext
27956   public_name = LOGIN
27957   server_prompts = User Name : Password
27958   server_condition = \
27959     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27960   server_set_id = $auth1
27961 .endd
27962 Because of the way plaintext operates, this authenticator accepts data supplied
27963 with the AUTH command (in contravention of the specification of LOGIN), but
27964 if the client does not supply it (as is the case for LOGIN clients), the prompt
27965 strings are used to obtain two data items.
27966
27967 Some clients are very particular about the precise text of the prompts. For
27968 example, Outlook Express is reported to recognize only &"Username:"& and
27969 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27970 strings. It uses the &%ldapauth%& expansion condition to check the user
27971 name and password by binding to an LDAP server:
27972 .code
27973 login:
27974   driver = plaintext
27975   public_name = LOGIN
27976   server_prompts = Username:: : Password::
27977   server_condition = ${if and{{ \
27978     !eq{}{$auth1} }{ \
27979     ldapauth{\
27980       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27981       pass=${quote:$auth2} \
27982       ldap://ldap.example.org/} }} }
27983   server_set_id = uid=$auth1,ou=people,o=example.org
27984 .endd
27985 We have to check that the username is not empty before using it, because LDAP
27986 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27987 operator to correctly quote the DN for authentication. However, the basic
27988 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27989 correct one to use for the password, because quoting is needed only to make
27990 the password conform to the Exim syntax. At the LDAP level, the password is an
27991 uninterpreted string.
27992
27993
27994 .section "Support for different kinds of authentication" "SECID174"
27995 A number of string expansion features are provided for the purpose of
27996 interfacing to different ways of user authentication. These include checking
27997 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27998 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27999 &<<SECTexpcond>>&.
28000
28001
28002
28003
28004 .section "Using plaintext in a client" "SECID175"
28005 .cindex "options" "&(plaintext)& authenticator (client)"
28006 The &(plaintext)& authenticator has two client options:
28007
28008 .option client_ignore_invalid_base64 plaintext boolean false
28009 If the client receives a server prompt that is not a valid base64 string,
28010 authentication is abandoned by default. However, if this option is set true,
28011 the error in the challenge is ignored and the client sends the response as
28012 usual.
28013
28014 .option client_send plaintext string&!! unset
28015 The string is a colon-separated list of authentication data strings. Each
28016 string is independently expanded before being sent to the server. The first
28017 string is sent with the AUTH command; any more strings are sent in response
28018 to prompts from the server. Before each string is expanded, the value of the
28019 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28020 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28021 way. Thus, the prompt that is received in response to sending the first string
28022 (with the AUTH command) can be used in the expansion of the second string, and
28023 so on. If an invalid base64 string is received when
28024 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28025 &$auth$&<&'n'&> variable.
28026
28027 &*Note*&: You cannot use expansion to create multiple strings, because
28028 splitting takes priority and happens first.
28029
28030 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28031 the data, further processing is applied to each string before it is sent. If
28032 there are any single circumflex characters in the string, they are converted to
28033 NULs. Should an actual circumflex be required as data, it must be doubled in
28034 the string.
28035
28036 This is an example of a client configuration that implements the PLAIN
28037 authentication mechanism with a fixed user name and password:
28038 .code
28039 fixed_plain:
28040   driver = plaintext
28041   public_name = PLAIN
28042   client_send = ^username^mysecret
28043 .endd
28044 The lack of colons means that the entire text is sent with the AUTH
28045 command, with the circumflex characters converted to NULs.
28046 Note that due to the ambiguity of parsing three consectutive circumflex characters
28047 there is no way to provide a password having a leading circumflex.
28048
28049
28050 A similar example
28051 that uses the LOGIN mechanism is:
28052 .code
28053 fixed_login:
28054   driver = plaintext
28055   public_name = LOGIN
28056   client_send = : username : mysecret
28057 .endd
28058 The initial colon means that the first string is empty, so no data is sent with
28059 the AUTH command itself. The remaining strings are sent in response to
28060 prompts.
28061 .ecindex IIDplaiauth1
28062 .ecindex IIDplaiauth2
28063
28064
28065
28066
28067 . ////////////////////////////////////////////////////////////////////////////
28068 . ////////////////////////////////////////////////////////////////////////////
28069
28070 .chapter "The cram_md5 authenticator" "CHID9"
28071 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28072 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28073 .cindex "CRAM-MD5 authentication mechanism"
28074 .cindex authentication CRAM-MD5
28075 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28076 sends a challenge string to the client, and the response consists of a user
28077 name and the CRAM-MD5 digest of the challenge string combined with a secret
28078 string (password) which is known to both server and client. Thus, the secret
28079 is not sent over the network as plain text, which makes this authenticator more
28080 secure than &(plaintext)&. However, the downside is that the secret has to be
28081 available in plain text at either end.
28082
28083
28084 .section "Using cram_md5 as a server" "SECID176"
28085 .cindex "options" "&(cram_md5)& authenticator (server)"
28086 This authenticator has one server option, which must be set to configure the
28087 authenticator as a server:
28088
28089 .option server_secret cram_md5 string&!! unset
28090 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28091 When the server receives the client's response, the user name is placed in
28092 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28093 obtain the password for that user. The server then computes the CRAM-MD5 digest
28094 that the client should have sent, and checks that it received the correct
28095 string. If the expansion of &%server_secret%& is forced to fail, authentication
28096 fails. If the expansion fails for some other reason, a temporary error code is
28097 returned to the client.
28098
28099 For compatibility with previous releases of Exim, the user name is also placed
28100 in &$1$&. However, the use of this variables for this purpose is now
28101 deprecated, as it can lead to confusion in string expansions that also use
28102 numeric variables for other things.
28103
28104 For example, the following authenticator checks that the user name given by the
28105 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28106 user name, authentication fails.
28107 .code
28108 fixed_cram:
28109   driver = cram_md5
28110   public_name = CRAM-MD5
28111   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28112   server_set_id = $auth1
28113 .endd
28114 .vindex "&$authenticated_id$&"
28115 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28116 name in &$authenticated_id$&. A more typical configuration might look up the
28117 secret string in a file, using the user name as the key. For example:
28118 .code
28119 lookup_cram:
28120   driver = cram_md5
28121   public_name = CRAM-MD5
28122   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28123                   {$value}fail}
28124   server_set_id = $auth1
28125 .endd
28126 Note that this expansion explicitly forces failure if the lookup fails
28127 because &$auth1$& contains an unknown user name.
28128
28129 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28130 using the relevant libraries, you need to know the realm to specify in the
28131 lookup and then ask for the &"userPassword"& attribute for that user in that
28132 realm, with:
28133 .code
28134 cyrusless_crammd5:
28135   driver = cram_md5
28136   public_name = CRAM-MD5
28137   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28138                   dbmjz{/etc/sasldb2}{$value}fail}
28139   server_set_id = $auth1
28140 .endd
28141
28142 .section "Using cram_md5 as a client" "SECID177"
28143 .cindex "options" "&(cram_md5)& authenticator (client)"
28144 When used as a client, the &(cram_md5)& authenticator has two options:
28145
28146
28147
28148 .option client_name cram_md5 string&!! "the primary host name"
28149 This string is expanded, and the result used as the user name data when
28150 computing the response to the server's challenge.
28151
28152
28153 .option client_secret cram_md5 string&!! unset
28154 This option must be set for the authenticator to work as a client. Its value is
28155 expanded and the result used as the secret string when computing the response.
28156
28157
28158 .vindex "&$host$&"
28159 .vindex "&$host_address$&"
28160 Different user names and secrets can be used for different servers by referring
28161 to &$host$& or &$host_address$& in the options. Forced failure of either
28162 expansion string is treated as an indication that this authenticator is not
28163 prepared to handle this case. Exim moves on to the next configured client
28164 authenticator. Any other expansion failure causes Exim to give up trying to
28165 send the message to the current server.
28166
28167 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28168 strings, is:
28169 .code
28170 fixed_cram:
28171   driver = cram_md5
28172   public_name = CRAM-MD5
28173   client_name = ph10
28174   client_secret = secret
28175 .endd
28176 .ecindex IIDcramauth1
28177 .ecindex IIDcramauth2
28178
28179
28180
28181 . ////////////////////////////////////////////////////////////////////////////
28182 . ////////////////////////////////////////////////////////////////////////////
28183
28184 .chapter "The cyrus_sasl authenticator" "CHID10"
28185 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28186 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28187 .cindex "Cyrus" "SASL library"
28188 .cindex "Kerberos"
28189 The code for this authenticator was provided by Matthew Byng-Maddick while
28190 at A L Digital Ltd.
28191
28192 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28193 library implementation of the RFC 2222 (&"Simple Authentication and Security
28194 Layer"&). This library supports a number of authentication mechanisms,
28195 including PLAIN and LOGIN, but also several others that Exim does not support
28196 directly. In particular, there is support for Kerberos authentication.
28197
28198 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28199 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28200 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28201 name of the driver to determine which mechanism to support.
28202
28203 Where access to some kind of secret file is required, for example, in GSSAPI
28204 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28205 user, and that the Cyrus SASL library has no way of escalating privileges
28206 by default. You may also find you need to set environment variables,
28207 depending on the driver you are using.
28208
28209 The application name provided by Exim is &"exim"&, so various SASL options may
28210 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28211 Kerberos, note that because of limitations in the GSSAPI interface,
28212 changing the server keytab might need to be communicated down to the Kerberos
28213 layer independently. The mechanism for doing so is dependent upon the Kerberos
28214 implementation.
28215
28216 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28217 may be set to point to an alternative keytab file. Exim will pass this
28218 variable through from its own inherited environment when started as root or the
28219 Exim user. The keytab file needs to be readable by the Exim user.
28220 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28221 environment variable.  In practice, for those releases, the Cyrus authenticator
28222 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28223 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28224
28225
28226 .section "Using cyrus_sasl as a server" "SECID178"
28227 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28228 (on a successful authentication) into &$auth1$&. For compatibility with
28229 previous releases of Exim, the username is also placed in &$1$&. However, the
28230 use of this variable for this purpose is now deprecated, as it can lead to
28231 confusion in string expansions that also use numeric variables for other
28232 things.
28233
28234
28235 .option server_hostname cyrus_sasl string&!! "see below"
28236 This option selects the hostname that is used when communicating with the
28237 library. The default value is &`$primary_hostname`&. It is up to the underlying
28238 SASL plug-in what it does with this data.
28239
28240
28241 .option server_mech cyrus_sasl string "see below"
28242 This option selects the authentication mechanism this driver should use. The
28243 default is the value of the generic &%public_name%& option. This option allows
28244 you to use a different underlying mechanism from the advertised name. For
28245 example:
28246 .code
28247 sasl:
28248   driver = cyrus_sasl
28249   public_name = X-ANYTHING
28250   server_mech = CRAM-MD5
28251   server_set_id = $auth1
28252 .endd
28253
28254 .option server_realm cyrus_sasl string&!! unset
28255 This specifies the SASL realm that the server claims to be in.
28256
28257
28258 .option server_service cyrus_sasl string &`smtp`&
28259 This is the SASL service that the server claims to implement.
28260
28261
28262 For straightforward cases, you do not need to set any of the authenticator's
28263 private options. All you need to do is to specify an appropriate mechanism as
28264 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28265 PLAIN, you could have two authenticators as follows:
28266 .code
28267 sasl_cram_md5:
28268   driver = cyrus_sasl
28269   public_name = CRAM-MD5
28270   server_set_id = $auth1
28271
28272 sasl_plain:
28273   driver = cyrus_sasl
28274   public_name = PLAIN
28275   server_set_id = $auth2
28276 .endd
28277 Cyrus SASL does implement the LOGIN authentication method, even though it is
28278 not a standard method. It is disabled by default in the source distribution,
28279 but it is present in many binary distributions.
28280 .ecindex IIDcyrauth1
28281 .ecindex IIDcyrauth2
28282
28283
28284
28285
28286 . ////////////////////////////////////////////////////////////////////////////
28287 . ////////////////////////////////////////////////////////////////////////////
28288 .chapter "The dovecot authenticator" "CHAPdovecot"
28289 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28290 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28291 This authenticator is an interface to the authentication facility of the
28292 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28293 Note that Dovecot must be configured to use auth-client not auth-userdb.
28294 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28295 to use the same mechanisms for SMTP authentication. This is a server
28296 authenticator only. There is only one non-generic option:
28297
28298 .option server_socket dovecot string unset
28299
28300 This option must specify the UNIX socket that is the interface to Dovecot
28301 authentication. The &%public_name%& option must specify an authentication
28302 mechanism that Dovecot is configured to support. You can have several
28303 authenticators for different mechanisms. For example:
28304 .code
28305 dovecot_plain:
28306   driver = dovecot
28307   public_name = PLAIN
28308   server_advertise_condition = ${if def:tls_in_cipher}
28309   server_socket = /var/run/dovecot/auth-client
28310   server_set_id = $auth1
28311
28312 dovecot_ntlm:
28313   driver = dovecot
28314   public_name = NTLM
28315   server_socket = /var/run/dovecot/auth-client
28316   server_set_id = $auth1
28317 .endd
28318
28319 .new
28320 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28321 should not be advertised on cleartext SMTP connections.
28322 See the discussion in section &<<SECTplain_TLS>>&.
28323 .wen
28324
28325 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28326 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28327 option is passed in the Dovecot authentication command. If, for a TLS
28328 connection, a client certificate has been verified, the &"valid-client-cert"&
28329 option is passed. When authentication succeeds, the identity of the user
28330 who authenticated is placed in &$auth1$&.
28331
28332 The Dovecot configuration to match the above will look
28333 something like:
28334 .code
28335 conf.d/10-master.conf :-
28336
28337 service auth {
28338 ...
28339 #SASL
28340   unix_listener auth-client {
28341     mode = 0660
28342     user = mail
28343   }
28344 ...
28345 }
28346
28347 conf.d/10-auth.conf :-
28348
28349 auth_mechanisms = plain login ntlm
28350 .endd
28351
28352 .ecindex IIDdcotauth1
28353 .ecindex IIDdcotauth2
28354
28355
28356 . ////////////////////////////////////////////////////////////////////////////
28357 . ////////////////////////////////////////////////////////////////////////////
28358 .chapter "The gsasl authenticator" "CHAPgsasl"
28359 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28360 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28361 .cindex "authentication" "GNU SASL"
28362 .cindex "authentication" "SASL"
28363 .cindex "authentication" "EXTERNAL"
28364 .cindex "authentication" "ANONYMOUS"
28365 .cindex "authentication" "PLAIN"
28366 .cindex "authentication" "LOGIN"
28367 .cindex "authentication" "DIGEST-MD5"
28368 .cindex "authentication" "CRAM-MD5"
28369 .cindex "authentication" "SCRAM family"
28370 The &(gsasl)& authenticator provides integration for the GNU SASL
28371 library and the mechanisms it provides.  This is new as of the 4.80 release
28372 and there are a few areas where the library does not let Exim smoothly
28373 scale to handle future authentication mechanisms, so no guarantee can be
28374 made that any particular new authentication mechanism will be supported
28375 without code changes in Exim.
28376
28377 The library is expected to add support in an upcoming
28378 realease for the SCRAM-SHA-256 method.
28379 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28380 when this happens.
28381
28382 To see the list of mechanisms supported by the library run Exim with "auth" debug
28383 enabled and look for a line containing "GNU SASL supports".
28384 Note however that some may not have been tested from Exim.
28385
28386
28387 .option client_authz gsasl string&!! unset
28388 This option can be used to supply an &'authorization id'&
28389 which is different to the &'authentication_id'& provided
28390 by &%client_username%& option.
28391 If unset or (after expansion) empty it is not used,
28392 which is the common case.
28393
28394 .option client_channelbinding gsasl boolean false
28395 See &%server_channelbinding%& below.
28396
28397 .option client_password gsasl string&!! unset
28398 This option is exapanded before use, and should result in
28399 the password to be used, in clear.
28400
28401 .option client_username gsasl string&!! unset
28402 This option is exapanded before use, and should result in
28403 the account name to be used.
28404
28405
28406 .option client_spassword gsasl string&!! unset
28407 This option is only supported for library versions 1.9.1 and greater.
28408 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28409
28410 If a SCRAM mechanism is being used and this option is set
28411 and correctly sized
28412 it is used in preference to &%client_password%&.
28413 The value after expansion should be
28414 a 40 (for SHA-1) or 64 (for SHA-256) character string
28415 with the PBKDF2-prepared password, hex-encoded.
28416
28417 Note that this value will depend on the salt and iteration-count
28418 supplied by the server.
28419 The option is expanded before use.
28420 During the expansion &$auth1$& is set with the client username,
28421 &$auth2$& with the iteration count, and
28422 &$auth3$& with the salt.
28423
28424 The intent of this option
28425 is to support clients that can cache thes salted password
28426 to save on recalculation costs.
28427 The cache lookup should return an unusable value
28428 (eg. an empty string)
28429 if the salt or iteration count has changed
28430
28431 If the authentication succeeds then the above variables are set,
28432 .vindex "&$auth4$&"
28433 plus the calculated salted password value value in &$auth4$&,
28434 during the expansion of the &%client_set_id%& option.
28435 A side-effect of this expansion can be used to prime the cache.
28436
28437
28438 .option server_channelbinding gsasl boolean false
28439 Some authentication mechanisms are able to use external context at both ends
28440 of the session to bind the authentication to that context, and fail the
28441 authentication process if that context differs.  Specifically, some TLS
28442 ciphersuites can provide identifying information about the cryptographic
28443 context.
28444
28445 This should have meant that certificate identity and verification becomes a
28446 non-issue, as a man-in-the-middle attack will cause the correct client and
28447 server to see different identifiers and authentication will fail.
28448
28449 This is
28450 only usable by mechanisms which support "channel binding"; at time of
28451 writing, that's the SCRAM family.
28452 When using this feature the "-PLUS" variants of the method names need to be used.
28453
28454 This defaults off to ensure smooth upgrade across Exim releases, in case
28455 this option causes some clients to start failing.  Some future release
28456 of Exim might have switched the default to be true.
28457
28458 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28459 . Do not plan to rely upon this feature for security, ever, without consulting
28460 . with a subject matter expert (a cryptographic engineer).
28461
28462 This option was deprecated in previous releases due to doubts over
28463 the "Triple Handshake" vulnerability.
28464 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28465 Session Resumption was used) for safety.
28466
28467
28468 .option server_hostname gsasl string&!! "see below"
28469 This option selects the hostname that is used when communicating with the
28470 library. The default value is &`$primary_hostname`&.
28471 Some mechanisms will use this data.
28472
28473
28474 .option server_mech gsasl string "see below"
28475 This option selects the authentication mechanism this driver should use. The
28476 default is the value of the generic &%public_name%& option. This option allows
28477 you to use a different underlying mechanism from the advertised name. For
28478 example:
28479 .code
28480 sasl:
28481   driver = gsasl
28482   public_name = X-ANYTHING
28483   server_mech = CRAM-MD5
28484   server_set_id = $auth1
28485 .endd
28486
28487
28488 .option server_password gsasl string&!! unset
28489 Various mechanisms need access to the cleartext password on the server, so
28490 that proof-of-possession can be demonstrated on the wire, without sending
28491 the password itself.
28492
28493 The data available for lookup varies per mechanism.
28494 In all cases, &$auth1$& is set to the &'authentication id'&.
28495 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28496 if available, else the empty string.
28497 The &$auth3$& variable will always be the &'realm'& if available,
28498 else the empty string.
28499
28500 A forced failure will cause authentication to defer.
28501
28502 If using this option, it may make sense to set the &%server_condition%&
28503 option to be simply "true".
28504
28505
28506 .option server_realm gsasl string&!! unset
28507 This specifies the SASL realm that the server claims to be in.
28508 Some mechanisms will use this data.
28509
28510
28511 .option server_scram_iter gsasl string&!! 4096
28512 This option provides data for the SCRAM family of mechanisms.
28513 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28514 when this option is expanded.
28515
28516 The result of expansion should be a decimal number,
28517 and represents both a lower-bound on the security, and
28518 a compute cost factor imposed on the client
28519 (if it does not cache results, or the server changes
28520 either the iteration count or the salt).
28521 A minimum value of 4096 is required by the standards
28522 for all current SCRAM mechanism variants.
28523
28524 .option server_scram_salt gsasl string&!! unset
28525 This option provides data for the SCRAM family of mechanisms.
28526 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28527 when this option is expanded.
28528 The value should be a base64-encoded string,
28529 of random data typically 4-to-16 bytes long.
28530 If unset or empty after expansion the library will provides a value for the
28531 protocol conversation.
28532
28533
28534 .option server_key gsasl string&!! unset
28535 .option server_skey gsasl string&!! unset
28536 These options can be used for the SCRAM family of mechanisms
28537 to provide stored information related to a password,
28538 the storage of which is preferable to plaintext.
28539
28540 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28541 &%server_skey%& is StoredKey.
28542
28543 They are only available for version 1.9.0 (or later) of the gsasl library.
28544 When this is so, the macros
28545 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28546 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28547 will be defined.
28548
28549 The &$authN$& variables are available when these options are expanded.
28550
28551 If set, the results of expansion should for each
28552 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28553 of base64-coded data, and will be used in preference to the
28554 &%server_password%& option.
28555 If unset or not of the right length, &%server_password%& will be used.
28556
28557 The libgsasl library release includes a utility &'gsasl'& which can be used
28558 to generate these values.
28559
28560
28561 .option server_service gsasl string &`smtp`&
28562 This is the SASL service that the server claims to implement.
28563 Some mechanisms will use this data.
28564
28565
28566 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28567 .vindex "&$auth1$&, &$auth2$&, etc"
28568 These may be set when evaluating specific options, as detailed above.
28569 They will also be set when evaluating &%server_condition%&.
28570
28571 Unless otherwise stated below, the &(gsasl)& integration will use the following
28572 meanings for these variables:
28573
28574 .ilist
28575 .vindex "&$auth1$&"
28576 &$auth1$&: the &'authentication id'&
28577 .next
28578 .vindex "&$auth2$&"
28579 &$auth2$&: the &'authorization id'&
28580 .next
28581 .vindex "&$auth3$&"
28582 &$auth3$&: the &'realm'&
28583 .endlist
28584
28585 On a per-mechanism basis:
28586
28587 .ilist
28588 .cindex "authentication" "EXTERNAL"
28589 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28590 the &%server_condition%& option must be present.
28591 .next
28592 .cindex "authentication" "ANONYMOUS"
28593 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28594 the &%server_condition%& option must be present.
28595 .next
28596 .cindex "authentication" "GSSAPI"
28597 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28598 &$auth2$& will be set to the &'authorization id'&,
28599 the &%server_condition%& option must be present.
28600 .endlist
28601
28602 An &'anonymous token'& is something passed along as an unauthenticated
28603 identifier; this is analogous to FTP anonymous authentication passing an
28604 email address, or software-identifier@, as the "password".
28605
28606
28607 An example showing the password having the realm specified in the callback
28608 and demonstrating a Cyrus SASL to GSASL migration approach is:
28609 .code
28610 gsasl_cyrusless_crammd5:
28611   driver = gsasl
28612   public_name = CRAM-MD5
28613   server_realm = imap.example.org
28614   server_password = ${lookup{$auth1:$auth3:userPassword}\
28615                     dbmjz{/etc/sasldb2}{$value}fail}
28616   server_set_id = ${quote:$auth1}
28617   server_condition = yes
28618 .endd
28619
28620
28621 . ////////////////////////////////////////////////////////////////////////////
28622 . ////////////////////////////////////////////////////////////////////////////
28623
28624 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28625 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28626 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28627 .cindex "authentication" "GSSAPI"
28628 .cindex "authentication" "Kerberos"
28629 The &(heimdal_gssapi)& authenticator provides server integration for the
28630 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28631 reliably.
28632
28633 .option server_hostname heimdal_gssapi string&!! "see below"
28634 This option selects the hostname that is used, with &%server_service%&,
28635 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28636 identifier.  The default value is &`$primary_hostname`&.
28637
28638 .option server_keytab heimdal_gssapi string&!! unset
28639 If set, then Heimdal will not use the system default keytab (typically
28640 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28641 The value should be a pathname, with no &"file:"& prefix.
28642
28643 .option server_service heimdal_gssapi string&!! "smtp"
28644 This option specifies the service identifier used, in conjunction with
28645 &%server_hostname%&, for building the identifier for finding credentials
28646 from the keytab.
28647
28648
28649 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28650 Beware that these variables will typically include a realm, thus will appear
28651 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28652 not verified, so a malicious client can set it to anything.
28653
28654 The &$auth1$& field should be safely trustable as a value from the Key
28655 Distribution Center.  Note that these are not quite email addresses.
28656 Each identifier is for a role, and so the left-hand-side may include a
28657 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28658
28659 .vindex "&$auth1$&, &$auth2$&, etc"
28660 .ilist
28661 .vindex "&$auth1$&"
28662 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28663 .next
28664 .vindex "&$auth2$&"
28665 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28666 authentication.  If that was empty, this will also be set to the
28667 GSS Display Name.
28668 .endlist
28669
28670
28671 . ////////////////////////////////////////////////////////////////////////////
28672 . ////////////////////////////////////////////////////////////////////////////
28673
28674 .chapter "The spa authenticator" "CHAPspa"
28675 .scindex IIDspaauth1 "&(spa)& authenticator"
28676 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28677 .cindex "authentication" "Microsoft Secure Password"
28678 .cindex "authentication" "NTLM"
28679 .cindex "Microsoft Secure Password Authentication"
28680 .cindex "NTLM authentication"
28681 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28682 Password Authentication'& mechanism,
28683 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28684 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28685 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28686 server side was subsequently contributed by Tom Kistner. The mechanism works as
28687 follows:
28688
28689 .ilist
28690 After the AUTH command has been accepted, the client sends an SPA
28691 authentication request based on the user name and optional domain.
28692 .next
28693 The server sends back a challenge.
28694 .next
28695 The client builds a challenge response which makes use of the user's password
28696 and sends it to the server, which then accepts or rejects it.
28697 .endlist
28698
28699 Encryption is used to protect the password in transit.
28700
28701
28702
28703 .section "Using spa as a server" "SECID179"
28704 .cindex "options" "&(spa)& authenticator (server)"
28705 The &(spa)& authenticator has just one server option:
28706
28707 .option server_password spa string&!! unset
28708 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28709 This option is expanded, and the result must be the cleartext password for the
28710 authenticating user, whose name is at this point in &$auth1$&. For
28711 compatibility with previous releases of Exim, the user name is also placed in
28712 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28713 it can lead to confusion in string expansions that also use numeric variables
28714 for other things. For example:
28715 .code
28716 spa:
28717   driver = spa
28718   public_name = NTLM
28719   server_password = \
28720     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28721 .endd
28722 If the expansion is forced to fail, authentication fails. Any other expansion
28723 failure causes a temporary error code to be returned.
28724
28725
28726
28727
28728
28729 .section "Using spa as a client" "SECID180"
28730 .cindex "options" "&(spa)& authenticator (client)"
28731 The &(spa)& authenticator has the following client options:
28732
28733
28734
28735 .option client_domain spa string&!! unset
28736 This option specifies an optional domain for the authentication.
28737
28738
28739 .option client_password spa string&!! unset
28740 This option specifies the user's password, and must be set.
28741
28742
28743 .option client_username spa string&!! unset
28744 This option specifies the user name, and must be set. Here is an example of a
28745 configuration of this authenticator for use with the mail servers at
28746 &'msn.com'&:
28747 .code
28748 msn:
28749   driver = spa
28750   public_name = MSN
28751   client_username = msn/msn_username
28752   client_password = msn_plaintext_password
28753   client_domain = DOMAIN_OR_UNSET
28754 .endd
28755 .ecindex IIDspaauth1
28756 .ecindex IIDspaauth2
28757
28758
28759
28760
28761
28762 . ////////////////////////////////////////////////////////////////////////////
28763 . ////////////////////////////////////////////////////////////////////////////
28764
28765 .chapter "The external authenticator" "CHAPexternauth"
28766 .scindex IIDexternauth1 "&(external)& authenticator"
28767 .scindex IIDexternauth2 "authenticators" "&(external)&"
28768 .cindex "authentication" "Client Certificate"
28769 .cindex "authentication" "X509"
28770 .cindex "Certificate-based authentication"
28771 The &(external)& authenticator provides support for
28772 authentication based on non-SMTP information.
28773 The specification is in RFC 4422 Appendix A
28774 (&url(https://tools.ietf.org/html/rfc4422)).
28775 It is only a transport and negotiation mechanism;
28776 the process of authentication is entirely controlled
28777 by the server configuration.
28778
28779 The client presents an identity in-clear.
28780 It is probably wise for a server to only advertise,
28781 and for clients to only attempt,
28782 this authentication method on a secure (eg. under TLS) connection.
28783
28784 One possible use, compatible with the
28785 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28786 is for using X509 client certificates.
28787
28788 It thus overlaps in function with the TLS authenticator
28789 (see &<<CHAPtlsauth>>&)
28790 but is a full SMTP SASL authenticator
28791 rather than being implicit for TLS-connection carried
28792 client certificates only.
28793
28794 The examples and discussion in this chapter assume that
28795 client-certificate authentication is being done.
28796
28797 The client must present a certificate,
28798 for which it must have been requested via the
28799 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28800 (see &<<CHAPTLS>>&).
28801 For authentication to be effective the certificate should be
28802 verifiable against a trust-anchor certificate known to the server.
28803
28804 .section "External options" "SECTexternsoptions"
28805 .cindex "options" "&(external)& authenticator (server)"
28806 The &(external)& authenticator has two server options:
28807
28808 .option server_param2 external string&!! unset
28809 .option server_param3 external string&!! unset
28810 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28811 These options are expanded before the &%server_condition%& option
28812 and the result are placed in &$auth2$& and &$auth3$& resectively.
28813 If the expansion is forced to fail, authentication fails. Any other expansion
28814 failure causes a temporary error code to be returned.
28815
28816 They can be used to clarify the coding of a complex &%server_condition%&.
28817
28818 .section "Using external in a server" "SECTexternserver"
28819 .cindex "AUTH" "in &(external)& authenticator"
28820 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28821         "in &(external)& authenticator"
28822 .vindex "&$auth1$&, &$auth2$&, etc"
28823 .cindex "base64 encoding" "in &(external)& authenticator"
28824
28825 When running as a server, &(external)& performs the authentication test by
28826 expanding a string. The data sent by the client with the AUTH command, or in
28827 response to subsequent prompts, is base64 encoded, and so may contain any byte
28828 values when decoded. The decoded value is treated as
28829 an identity for authentication and
28830 placed in the expansion variable &$auth1$&.
28831
28832 For compatibility with previous releases of Exim, the value is also placed in
28833 the expansion variable &$1$&. However, the use of this
28834 variable for this purpose is now deprecated, as it can lead to confusion in
28835 string expansions that also use them for other things.
28836
28837 .vindex "&$authenticated_id$&"
28838 Once an identity has been received,
28839 &%server_condition%& is expanded. If the expansion is forced to fail,
28840 authentication fails. Any other expansion failure causes a temporary error code
28841 to be returned. If the result of a successful expansion is an empty string,
28842 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28843 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28844 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28845 For any other result, a temporary error code is returned, with the expanded
28846 string as the error text.
28847
28848 Example:
28849 .code
28850 ext_ccert_san_mail:
28851   driver =            external
28852   public_name =       EXTERNAL
28853
28854   server_advertise_condition = $tls_in_certificate_verified
28855   server_param2 =     ${certextract {subj_altname,mail,>:} \
28856                                     {$tls_in_peercert}}
28857   server_condition =  ${if forany {$auth2} \
28858                             {eq {$item}{$auth1}}}
28859   server_set_id =     $auth1
28860 .endd
28861 This accepts a client certificate that is verifiable against any
28862 of your configured trust-anchors
28863 (which usually means the full set of public CAs)
28864 and which has a mail-SAN matching the claimed identity sent by the client.
28865
28866 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28867 The account name is therefore guessable by an opponent.
28868 TLS 1.3 protects both server and client certificates, and is not vulnerable
28869 in this way.
28870
28871
28872 .section "Using external in a client" "SECTexternclient"
28873 .cindex "options" "&(external)& authenticator (client)"
28874 The &(external)& authenticator has one client option:
28875
28876 .option client_send external string&!! unset
28877 This option is expanded and sent with the AUTH command as the
28878 identity being asserted.
28879
28880 Example:
28881 .code
28882 ext_ccert:
28883   driver =      external
28884   public_name = EXTERNAL
28885
28886   client_condition = ${if !eq{$tls_out_cipher}{}}
28887   client_send = myaccount@smarthost.example.net
28888 .endd
28889
28890
28891 .ecindex IIDexternauth1
28892 .ecindex IIDexternauth2
28893
28894
28895
28896
28897
28898 . ////////////////////////////////////////////////////////////////////////////
28899 . ////////////////////////////////////////////////////////////////////////////
28900
28901 .chapter "The tls authenticator" "CHAPtlsauth"
28902 .scindex IIDtlsauth1 "&(tls)& authenticator"
28903 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28904 .cindex "authentication" "Client Certificate"
28905 .cindex "authentication" "X509"
28906 .cindex "Certificate-based authentication"
28907 The &(tls)& authenticator provides server support for
28908 authentication based on client certificates.
28909
28910 It is not an SMTP authentication mechanism and is not
28911 advertised by the server as part of the SMTP EHLO response.
28912 It is an Exim authenticator in the sense that it affects
28913 the protocol element of the log line, can be tested for
28914 by the &%authenticated%& ACL condition, and can set
28915 the &$authenticated_id$& variable.
28916
28917 The client must present a verifiable certificate,
28918 for which it must have been requested via the
28919 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28920 (see &<<CHAPTLS>>&).
28921
28922 If an authenticator of this type is configured it is
28923 run before any SMTP-level communication is done,
28924 and can authenticate the connection.
28925 If it does, SMTP authentication is not offered.
28926
28927 A maximum of one authenticator of this type may be present.
28928
28929
28930 .cindex "options" "&(tls)& authenticator (server)"
28931 The &(tls)& authenticator has three server options:
28932
28933 .option server_param1 tls string&!! unset
28934 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28935 This option is expanded after the TLS negotiation and
28936 the result is placed in &$auth1$&.
28937 If the expansion is forced to fail, authentication fails. Any other expansion
28938 failure causes a temporary error code to be returned.
28939
28940 .option server_param2 tls string&!! unset
28941 .option server_param3 tls string&!! unset
28942 As above, for &$auth2$& and &$auth3$&.
28943
28944 &%server_param1%& may also be spelled &%server_param%&.
28945
28946
28947 Example:
28948 .code
28949 tls:
28950   driver = tls
28951   server_param1 =     ${certextract {subj_altname,mail,>:} \
28952                                     {$tls_in_peercert}}
28953   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28954                                  {forany {$auth1} \
28955                             {!= {0} \
28956                                 {${lookup ldap{ldap:///\
28957                          mailname=${quote_ldap_dn:${lc:$item}},\
28958                          ou=users,LDAP_DC?mailid} {$value}{0} \
28959                        }    }  } }}}
28960   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28961 .endd
28962 This accepts a client certificate that is verifiable against any
28963 of your configured trust-anchors
28964 (which usually means the full set of public CAs)
28965 and which has a SAN with a good account name.
28966
28967 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28968 The account name is therefore guessable by an opponent.
28969 TLS 1.3 protects both server and client certificates, and is not vulnerable
28970 in this way.
28971 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28972
28973 . An alternative might use
28974 . .code
28975 .   server_param1 = ${sha256:$tls_in_peercert}
28976 . .endd
28977 . to require one of a set of specific certs that define a given account
28978 . (the verification is still required, but mostly irrelevant).
28979 . This would help for per-device use.
28980 .
28981 . However, for the future we really need support for checking a
28982 . user cert in LDAP - which probably wants a base-64 DER.
28983
28984 .ecindex IIDtlsauth1
28985 .ecindex IIDtlsauth2
28986
28987
28988 Note that because authentication is traditionally an SMTP operation,
28989 the &%authenticated%& ACL condition cannot be used in
28990 a connect- or helo-ACL.
28991
28992
28993
28994 . ////////////////////////////////////////////////////////////////////////////
28995 . ////////////////////////////////////////////////////////////////////////////
28996
28997 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28998          "Encrypted SMTP connections"
28999 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29000 .scindex IIDencsmtp2 "SMTP" "encryption"
29001 .cindex "TLS" "on SMTP connection"
29002 .cindex "OpenSSL"
29003 .cindex "GnuTLS"
29004 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29005 Sockets Layer), is implemented by making use of the OpenSSL library or the
29006 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29007 cryptographic code in the Exim distribution itself for implementing TLS. In
29008 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29009 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29010 You also need to understand the basic concepts of encryption at a managerial
29011 level, and in particular, the way that public keys, private keys, and
29012 certificates are used.
29013
29014 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29015 connection is established, the client issues a STARTTLS command. If the
29016 server accepts this, the client and the server negotiate an encryption
29017 mechanism. If the negotiation succeeds, the data that subsequently passes
29018 between them is encrypted.
29019
29020 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29021 and if so, what cipher suite is in use, whether the client supplied a
29022 certificate, and whether or not that certificate was verified. This makes it
29023 possible for an Exim server to deny or accept certain commands based on the
29024 encryption state.
29025
29026 &*Warning*&: Certain types of firewall and certain anti-virus products can
29027 disrupt TLS connections. You need to turn off SMTP scanning for these products
29028 in order to get TLS to work.
29029
29030
29031
29032 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29033          "SECID284"
29034 .cindex "submissions protocol"
29035 .cindex "ssmtp protocol"
29036 .cindex "smtps protocol"
29037 .cindex "SMTP" "submissions protocol"
29038 .cindex "SMTP" "ssmtp protocol"
29039 .cindex "SMTP" "smtps protocol"
29040 The history of port numbers for TLS in SMTP is a little messy and has been
29041 contentious.  As of RFC 8314, the common practice of using the historically
29042 allocated port 465 for "email submission but with TLS immediately upon connect
29043 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29044 by them in preference to STARTTLS.
29045
29046 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29047 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29048 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29049
29050 This approach was, for a while, officially abandoned when encrypted SMTP was
29051 standardized, but many clients kept using it, even as the TCP port number was
29052 reassigned for other use.
29053 Thus you may encounter guidance claiming that you shouldn't enable use of
29054 this port.
29055 In practice, a number of mail-clients have only ever supported submissions,
29056 not submission with STARTTLS upgrade.
29057 Ideally, offer both submission (587) and submissions (465) service.
29058
29059 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29060 global option. Its value must be a list of port numbers;
29061 the most common use is expected to be:
29062 .code
29063 tls_on_connect_ports = 465
29064 .endd
29065 The port numbers specified by this option apply to all SMTP connections, both
29066 via the daemon and via &'inetd'&. You still need to specify all the ports that
29067 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29068 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29069 an extra port &-- rather, it specifies different behaviour on a port that is
29070 defined elsewhere.
29071
29072 There is also a &%-tls-on-connect%& command line option. This overrides
29073 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29074
29075
29076
29077
29078
29079
29080 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29081 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29082 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29083 To build Exim to use OpenSSL you need to set
29084 .code
29085 USE_OPENSSL=yes
29086 .endd
29087 in Local/Makefile.
29088
29089 To build Exim to use GnuTLS, you need to set
29090 .code
29091 USE_GNUTLS=yes
29092 .endd
29093 in Local/Makefile.
29094
29095 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29096 include files and libraries for GnuTLS can be found.
29097
29098 There are some differences in usage when using GnuTLS instead of OpenSSL:
29099
29100 .ilist
29101 The &%tls_verify_certificates%& option
29102 cannot be the path of a directory
29103 for GnuTLS versions before 3.3.6
29104 (for later versions, or OpenSSL, it can be either).
29105 .next
29106 The default value for &%tls_dhparam%& differs for historical reasons.
29107 .next
29108 .vindex "&$tls_in_peerdn$&"
29109 .vindex "&$tls_out_peerdn$&"
29110 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29111 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29112 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29113 .next
29114 OpenSSL identifies cipher suites using hyphens as separators, for example:
29115 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29116 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29117 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29118 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29119 to handle its own older variants) when processing lists of cipher suites in the
29120 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29121 option).
29122 .next
29123 The &%tls_require_ciphers%& options operate differently, as described in the
29124 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29125 .next
29126 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29127 When using OpenSSL, this option is ignored.
29128 (If an API is found to let OpenSSL be configured in this way,
29129 let the Exim Maintainers know and we'll likely use it).
29130 .next
29131 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29132 main option, it must be ordered to match the &%tls_certificate%& list.
29133 .next
29134 Some other recently added features may only be available in one or the other.
29135 This should be documented with the feature.  If the documentation does not
29136 explicitly state that the feature is infeasible in the other TLS
29137 implementation, then patches are welcome.
29138 .next
29139 The output from "exim -bV" will show which (if any) support was included
29140 in the build.
29141 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29142 .endlist
29143
29144
29145 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29146 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29147 an explicit path; if the latter, then the text about generation still applies,
29148 but not the chosen filename.
29149 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29150 See the documentation of &%tls_dhparam%& for more information.
29151
29152 GnuTLS uses D-H parameters that may take a substantial amount of time
29153 to compute. It is unreasonable to re-compute them for every TLS session.
29154 Therefore, Exim keeps this data in a file in its spool directory, called
29155 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29156 of bits requested.
29157 The file is owned by the Exim user and is readable only by
29158 its owner. Every Exim process that start up GnuTLS reads the D-H
29159 parameters from this file. If the file does not exist, the first Exim process
29160 that needs it computes the data and writes it to a temporary file which is
29161 renamed once it is complete. It does not matter if several Exim processes do
29162 this simultaneously (apart from wasting a few resources). Once a file is in
29163 place, new Exim processes immediately start using it.
29164
29165 For maximum security, the parameters that are stored in this file should be
29166 recalculated periodically, the frequency depending on your paranoia level.
29167 If you are avoiding using the fixed D-H primes published in RFCs, then you
29168 are concerned about some advanced attacks and will wish to do this; if you do
29169 not regenerate then you might as well stick to the standard primes.
29170
29171 Arranging this is easy in principle; just delete the file when you want new
29172 values to be computed. However, there may be a problem. The calculation of new
29173 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29174 If the system is not very active, &_/dev/random_& may delay returning data
29175 until enough randomness (entropy) is available. This may cause Exim to hang for
29176 a substantial amount of time, causing timeouts on incoming connections.
29177
29178 The solution is to generate the parameters externally to Exim. They are stored
29179 in &_gnutls-params-N_& in PEM format, which means that they can be
29180 generated externally using the &(certtool)& command that is part of GnuTLS.
29181
29182 To replace the parameters with new ones, instead of deleting the file
29183 and letting Exim re-create it, you can generate new parameters using
29184 &(certtool)& and, when this has been done, replace Exim's cache file by
29185 renaming. The relevant commands are something like this:
29186 .code
29187 # ls
29188 [ look for file; assume gnutls-params-2236 is the most recent ]
29189 # rm -f new-params
29190 # touch new-params
29191 # chown exim:exim new-params
29192 # chmod 0600 new-params
29193 # certtool --generate-dh-params --bits 2236 >>new-params
29194 # openssl dhparam -noout -text -in new-params | head
29195 [ check the first line, make sure it's not more than 2236;
29196   if it is, then go back to the start ("rm") and repeat
29197   until the size generated is at most the size requested ]
29198 # chmod 0400 new-params
29199 # mv new-params gnutls-params-2236
29200 .endd
29201 If Exim never has to generate the parameters itself, the possibility of
29202 stalling is removed.
29203
29204 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29205 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29206 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29207 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29208 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29209 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29210 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29211 which applies to all D-H usage, client or server.  If the value returned by
29212 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29213 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29214 limit, which is still much higher than Exim historically used.
29215
29216 The filename and bits used will change as the GnuTLS maintainers change the
29217 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29218 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29219 2432 bits, while NSS is limited to 2236 bits.
29220
29221 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29222 increase the chance of the generated prime actually being within acceptable
29223 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29224 procedure above.  There is no sane procedure available to Exim to double-check
29225 the size of the generated prime, so it might still be too large.
29226
29227
29228 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29229 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29230 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29231 There is a function in the OpenSSL library that can be passed a list of cipher
29232 suites before the cipher negotiation takes place. This specifies which ciphers
29233 are acceptable for TLS versions prior to 1.3.
29234 The list is colon separated and may contain names like
29235 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29236 directly to this function call.
29237 Many systems will install the OpenSSL manual-pages, so you may have
29238 &'ciphers(1)'& available to you.
29239 The following quotation from the OpenSSL
29240 documentation specifies what forms of item are allowed in the cipher string:
29241
29242 .ilist
29243 It can consist of a single cipher suite such as RC4-SHA.
29244 .next
29245 It can represent a list of cipher suites containing a certain algorithm,
29246 or cipher suites of a certain type. For example SHA1 represents all
29247 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29248 SSL v3 algorithms.
29249 .next
29250 Lists of cipher suites can be combined in a single cipher string using
29251 the + character. This is used as a logical and operation. For example
29252 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29253 algorithms.
29254 .endlist
29255
29256 Each cipher string can be optionally preceded by one of the characters &`!`&,
29257 &`-`& or &`+`&.
29258 .ilist
29259 If &`!`& is used, the ciphers are permanently deleted from the list. The
29260 ciphers deleted can never reappear in the list even if they are explicitly
29261 stated.
29262 .next
29263 If &`-`& is used, the ciphers are deleted from the list, but some or all
29264 of the ciphers can be added again by later options.
29265 .next
29266 If &`+`& is used, the ciphers are moved to the end of the list. This
29267 option does not add any new ciphers; it just moves matching existing ones.
29268 .endlist
29269
29270 If none of these characters is present, the string is interpreted as
29271 a list of ciphers to be appended to the current preference list. If the list
29272 includes any ciphers already present they will be ignored: that is, they will
29273 not be moved to the end of the list.
29274 .endlist
29275
29276 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29277 string:
29278 .code
29279 # note single-quotes to get ! past any shell history expansion
29280 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29281 .endd
29282
29283 This example will let the library defaults be permitted on the MX port, where
29284 there's probably no identity verification anyway, but ups the ante on the
29285 submission ports where the administrator might have some influence on the
29286 choice of clients used:
29287 .code
29288 # OpenSSL variant; see man ciphers(1)
29289 tls_require_ciphers = ${if =={$received_port}{25}\
29290                            {DEFAULT}\
29291                            {HIGH:!MD5:!SHA1}}
29292 .endd
29293
29294 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29295 .code
29296 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29297 .endd
29298
29299 For TLS version 1.3 the control available is less fine-grained
29300 and Exim does not provide access to it at present.
29301 The value of the &%tls_require_ciphers%& option is ignored when
29302 TLS version 1.3 is negotiated.
29303
29304 As of writing the library default cipher suite list for TLSv1.3 is
29305 .code
29306 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29307 .endd
29308
29309
29310 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29311          "SECTreqciphgnu"
29312 .cindex "GnuTLS" "specifying parameters for"
29313 .cindex "TLS" "specifying ciphers (GnuTLS)"
29314 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29315 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29316 .cindex "TLS" "specifying protocols (GnuTLS)"
29317 .cindex "TLS" "specifying priority string (GnuTLS)"
29318 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29319 The GnuTLS library allows the caller to provide a "priority string", documented
29320 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29321 ciphersuite specification in OpenSSL.
29322
29323 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29324 and controls both protocols and ciphers.
29325
29326 The &%tls_require_ciphers%& option is available both as an global option,
29327 controlling how Exim behaves as a server, and also as an option of the
29328 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29329 the value is string expanded.  The resulting string is not an Exim list and
29330 the string is given to the GnuTLS library, so that Exim does not need to be
29331 aware of future feature enhancements of GnuTLS.
29332
29333 Documentation of the strings accepted may be found in the GnuTLS manual, under
29334 "Priority strings".  This is online as
29335 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29336 but beware that this relates to GnuTLS 3, which may be newer than the version
29337 installed on your system.  If you are using GnuTLS 3,
29338 then the example code
29339 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29340 on that site can be used to test a given string.
29341
29342 For example:
29343 .code
29344 # Disable older versions of protocols
29345 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29346 .endd
29347
29348 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29349 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29350 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29351
29352 This example will let the library defaults be permitted on the MX port, where
29353 there's probably no identity verification anyway, and lowers security further
29354 by increasing compatibility; but this ups the ante on the submission ports
29355 where the administrator might have some influence on the choice of clients
29356 used:
29357 .code
29358 # GnuTLS variant
29359 tls_require_ciphers = ${if =={$received_port}{25}\
29360                            {NORMAL:%COMPAT}\
29361                            {SECURE128}}
29362 .endd
29363
29364
29365 .section "Configuring an Exim server to use TLS" "SECID182"
29366 .cindex "TLS" "configuring an Exim server"
29367 .cindex "ESMTP extensions" STARTTLS
29368 When Exim has been built with TLS support, it advertises the availability of
29369 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29370 but not to any others. The default value of this option is *, which means
29371 that STARTTLS is always advertised.  Set it to blank to never advertise;
29372 this is reasonable for systems that want to use TLS only as a client.
29373
29374 If STARTTLS is to be used you
29375 need to set some other options in order to make TLS available.
29376
29377 If a client issues a STARTTLS command and there is some configuration
29378 problem in the server, the command is rejected with a 454 error. If the client
29379 persists in trying to issue SMTP commands, all except QUIT are rejected
29380 with the error
29381 .code
29382 554 Security failure
29383 .endd
29384 If a STARTTLS command is issued within an existing TLS session, it is
29385 rejected with a 554 error code.
29386
29387 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29388 must be set to match some hosts. The default is * which matches all hosts.
29389
29390 If this is all you do, TLS encryption will be enabled but not authentication -
29391 meaning that the peer has no assurance it is actually you he is talking to.
29392 You gain protection from a passive sniffer listening on the wire but not
29393 from someone able to intercept the communication.
29394
29395 Further protection requires some further configuration at the server end.
29396
29397 To make TLS work you need to set, in the server,
29398 .code
29399 tls_certificate = /some/file/name
29400 tls_privatekey = /some/file/name
29401 .endd
29402 These options are, in fact, expanded strings, so you can make them depend on
29403 the identity of the client that is connected if you wish. The first file
29404 contains the server's X509 certificate, and the second contains the private key
29405 that goes with it. These files need to be
29406 PEM format and readable by the Exim user, and must
29407 always be given as full path names.
29408 The key must not be password-protected.
29409 They can be the same file if both the
29410 certificate and the key are contained within it. If &%tls_privatekey%& is not
29411 set, or if its expansion is forced to fail or results in an empty string, this
29412 is assumed to be the case. The certificate file may also contain intermediate
29413 certificates that need to be sent to the client to enable it to authenticate
29414 the server's certificate.
29415
29416 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29417 colon-separated lists of file paths.  Ciphers using given authentication
29418 algorithms require the presence of a suitable certificate to supply the
29419 public-key.  The server selects among the certificates to present to the
29420 client depending on the selected cipher, hence the priority ordering for
29421 ciphers will affect which certificate is used.
29422
29423 If you do not understand about certificates and keys, please try to find a
29424 source of this background information, which is not Exim-specific. (There are a
29425 few comments below in section &<<SECTcerandall>>&.)
29426
29427 &*Note*&: These options do not apply when Exim is operating as a client &--
29428 they apply only in the case of a server. If you need to use a certificate in an
29429 Exim client, you must set the options of the same names in an &(smtp)&
29430 transport.
29431
29432 With just these options, an Exim server will be able to use TLS. It does not
29433 require the client to have a certificate (but see below for how to insist on
29434 this). There is one other option that may be needed in other situations. If
29435 .code
29436 tls_dhparam = /some/file/name
29437 .endd
29438 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29439 with the parameters contained in the file.
29440 Set this to &`none`& to disable use of DH entirely, by making no prime
29441 available:
29442 .code
29443 tls_dhparam = none
29444 .endd
29445 This may also be set to a string identifying a standard prime to be used for
29446 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29447 used is &`ike23`&.  There are a few standard primes available, see the
29448 documentation for &%tls_dhparam%& for the complete list.
29449
29450 See the command
29451 .code
29452 openssl dhparam
29453 .endd
29454 for a way of generating file data.
29455
29456 The strings supplied for these three options are expanded every time a client
29457 host connects. It is therefore possible to use different certificates and keys
29458 for different hosts, if you so wish, by making use of the client's IP address
29459 in &$sender_host_address$& to control the expansion. If a string expansion is
29460 forced to fail, Exim behaves as if the option is not set.
29461
29462 .cindex "cipher" "logging"
29463 .cindex "log" "TLS cipher"
29464 .vindex "&$tls_in_cipher$&"
29465 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29466 an incoming TLS connection. It is included in the &'Received:'& header of an
29467 incoming message (by default &-- you can, of course, change this), and it is
29468 also included in the log line that records a message's arrival, keyed by
29469 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29470 condition can be used to test for specific cipher suites in ACLs.
29471
29472 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29473 can check the name of the cipher suite and vary their actions accordingly. The
29474 cipher suite names vary, depending on which TLS library is being used. For
29475 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29476 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29477 documentation for more details.
29478
29479 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29480 (again depending on the &%tls_cipher%& log selector).
29481
29482
29483 .subsection "Requesting and verifying client certificates"
29484 .cindex "certificate" "verification of client"
29485 .cindex "TLS" "client certificate verification"
29486 If you want an Exim server to request a certificate when negotiating a TLS
29487 session with a client, you must set either &%tls_verify_hosts%& or
29488 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29489 apply to all TLS connections. For any host that matches one of these options,
29490 Exim requests a certificate as part of the setup of the TLS session. The
29491 contents of the certificate are verified by comparing it with a list of
29492 expected trust-anchors or certificates.
29493 These may be the system default set (depending on library version),
29494 an explicit file or,
29495 depending on library version, a directory, identified by
29496 &%tls_verify_certificates%&.
29497
29498 A file can contain multiple certificates, concatenated end to end. If a
29499 directory is used
29500 (OpenSSL only),
29501 each certificate must be in a separate file, with a name (or a symbolic link)
29502 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29503 certificate. You can compute the relevant hash by running the command
29504 .code
29505 openssl x509 -hash -noout -in /cert/file
29506 .endd
29507 where &_/cert/file_& contains a single certificate.
29508
29509 There is no checking of names of the client against the certificate
29510 Subject Name or Subject Alternate Names.
29511
29512 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29513 what happens if the client does not supply a certificate, or if the certificate
29514 does not match any of the certificates in the collection named by
29515 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29516 attempt to set up a TLS session is aborted, and the incoming connection is
29517 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29518 session continues. ACLs that run for subsequent SMTP commands can detect the
29519 fact that no certificate was verified, and vary their actions accordingly. For
29520 example, you can insist on a certificate before accepting a message for
29521 relaying, but not when the message is destined for local delivery.
29522
29523 .vindex "&$tls_in_peerdn$&"
29524 When a client supplies a certificate (whether it verifies or not), the value of
29525 the Distinguished Name of the certificate is made available in the variable
29526 &$tls_in_peerdn$& during subsequent processing of the message.
29527
29528 .cindex "log" "distinguished name"
29529 Because it is often a long text string, it is not included in the log line or
29530 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29531 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29532 &%received_header_text%& to change the &'Received:'& header. When no
29533 certificate is supplied, &$tls_in_peerdn$& is empty.
29534
29535
29536 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29537 .cindex certificate caching
29538 .cindex privatekey caching
29539 .cindex crl caching
29540 .cindex ocsp caching
29541 .cindex ciphers caching
29542 .cindex "CA bundle" caching
29543 .cindex "certificate authorities" caching
29544 .cindex tls_certificate caching
29545 .cindex tls_privatekey caching
29546 .cindex tls_crl caching
29547 .cindex tls_ocsp_file caching
29548 .cindex tls_require_ciphers caching
29549 .cindex tls_verify_certificate caching
29550 .cindex caching certificate
29551 .cindex caching privatekey
29552 .cindex caching crl
29553 .cindex caching ocsp
29554 .cindex caching ciphers
29555 .cindex caching "certificate authorities
29556 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29557 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29558 expandable elements,
29559 then the associated information is loaded at daemon startup.
29560 It is made available
29561 to child processes forked for handling received SMTP connections.
29562
29563 This caching is currently only supported under Linux and FreeBSD.
29564
29565 If caching is not possible, for example if an item has to be dependent
29566 on the peer host so contains a &$sender_host_name$& expansion, the load
29567 of the associated information is done at the startup of the TLS connection.
29568
29569 The cache is invalidated and reloaded after any changes to the directories
29570 containing files specified by these options.
29571
29572 The information specified by the main option &%tls_verify_certificates%&
29573 is similarly cached so long as it specifies files explicitly
29574 or (under GnuTLS) is the string &"system,cache"&.
29575 The latter case is not automatically invalidated;
29576 it is the operator's responsibility to arrange for a daemon restart
29577 any time the system certificate authority bundle is updated.
29578 A HUP signal is sufficient for this.
29579 The value &"system"& results in no caching under GnuTLS.
29580
29581 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29582 is acceptable in configurations for the Exim executavble.
29583
29584 Caching of the system Certificate Authorities bundle can
29585 save siginificant time and processing on every TLS connection
29586 accepted by Exim.
29587
29588
29589
29590
29591 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29592 .cindex "cipher" "logging"
29593 .cindex "log" "TLS cipher"
29594 .cindex "log" "distinguished name"
29595 .cindex "TLS" "configuring an Exim client"
29596 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29597 deliveries as well as to incoming, the latter one causing logging of the
29598 server certificate's DN. The remaining client configuration for TLS is all
29599 within the &(smtp)& transport.
29600
29601 .cindex "ESMTP extensions" STARTTLS
29602 It is not necessary to set any options to have TLS work in the &(smtp)&
29603 transport. If Exim is built with TLS support, and TLS is advertised by a
29604 server, the &(smtp)& transport always tries to start a TLS session. However,
29605 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29606 transport) to a list of server hosts for which TLS should not be used.
29607
29608 If you do not want Exim to attempt to send messages unencrypted when an attempt
29609 to set up an encrypted connection fails in any way, you can set
29610 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29611 those hosts, delivery is always deferred if an encrypted connection cannot be
29612 set up. If there are any other hosts for the address, they are tried in the
29613 usual way.
29614
29615 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29616 the message unencrypted. It always does this if the response to STARTTLS is
29617 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29618 session after a success response code, what happens is controlled by the
29619 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29620 delivery to this host is deferred, and other hosts (if available) are tried. If
29621 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29622 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29623 negotiation fails, Exim closes the current connection (because it is in an
29624 unknown state), opens a new one to the same host, and then tries the delivery
29625 unencrypted.
29626
29627 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29628 transport provide the client with a certificate, which is passed to the server
29629 if it requests it.
29630 This is an optional thing for TLS connections, although either end
29631 may insist on it.
29632 If the server is Exim, it will request a certificate only if
29633 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29634
29635 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29636 for client use (they are usable for server use).
29637 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29638 in failed connections.
29639
29640 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29641 specifies a collection of expected server certificates.
29642 These may be
29643 the system default set (depending on library version),
29644 a file,
29645 or (depending on library version) a directory.
29646 The client verifies the server's certificate
29647 against this collection, taking into account any revoked certificates that are
29648 in the list defined by &%tls_crl%&.
29649 Failure to verify fails the TLS connection unless either of the
29650 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29651
29652 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29653 certificate verification to the listed servers.  Verification either must
29654 or need not succeed respectively.
29655
29656 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29657 name checks are made on the server certificate.
29658 The match against this list is, as per other Exim usage, the
29659 IP for the host.  That is most closely associated with the
29660 name on the DNS A (or AAAA) record for the host.
29661 However, the name that needs to be in the certificate
29662 is the one at the head of any CNAME chain leading to the A record.
29663 The option defaults to always checking.
29664
29665 The &(smtp)& transport has two OCSP-related options:
29666 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29667 is requested and required for the connection to proceed.  The default
29668 value is empty.
29669 &%hosts_request_ocsp%&; a host-list for which (additionally)
29670 a Certificate Status is requested (but not necessarily verified).  The default
29671 value is "*" meaning that requests are made unless configured
29672 otherwise.
29673
29674 The host(s) should also be in &%hosts_require_tls%&, and
29675 &%tls_verify_certificates%& configured for the transport,
29676 for OCSP to be relevant.
29677
29678 If
29679 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29680 list of permitted cipher suites. If either of these checks fails, delivery to
29681 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29682 alternative hosts, if any.
29683
29684  &*Note*&:
29685 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29686 is operating as a client. Exim does not assume that a server certificate (set
29687 by the global options of the same name) should also be used when operating as a
29688 client.
29689
29690 .vindex "&$host$&"
29691 .vindex "&$host_address$&"
29692 All the TLS options in the &(smtp)& transport are expanded before use, with
29693 &$host$& and &$host_address$& containing the name and address of the server to
29694 which the client is connected. Forced failure of an expansion causes Exim to
29695 behave as if the relevant option were unset.
29696
29697 .vindex &$tls_out_bits$&
29698 .vindex &$tls_out_cipher$&
29699 .vindex &$tls_out_peerdn$&
29700 .vindex &$tls_out_sni$&
29701 Before an SMTP connection is established, the
29702 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29703 variables are emptied. (Until the first connection, they contain the values
29704 that were set when the message was received.) If STARTTLS is subsequently
29705 successfully obeyed, these variables are set to the relevant values for the
29706 outgoing connection.
29707
29708
29709
29710 .subsection "Caching of static client configuration items" SECTclientTLScache
29711 .cindex certificate caching
29712 .cindex privatekey caching
29713 .cindex crl caching
29714 .cindex ciphers caching
29715 .cindex "CA bundle" caching
29716 .cindex "certificate authorities" caching
29717 .cindex tls_certificate caching
29718 .cindex tls_privatekey caching
29719 .cindex tls_crl caching
29720 .cindex tls_require_ciphers caching
29721 .cindex tls_verify_certificate caching
29722 .cindex caching certificate
29723 .cindex caching privatekey
29724 .cindex caching crl
29725 .cindex caching ciphers
29726 .cindex caching "certificate authorities
29727 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29728 and &%tls_crl%& have values with no
29729 expandable elements,
29730 then the associated information is loaded per smtp transport
29731 at daemon startup, at the start of a queue run, or on a
29732 command-line specified message delivery.
29733 It is made available
29734 to child processes forked for handling making SMTP connections.
29735
29736 This caching is currently only supported under Linux.
29737
29738 If caching is not possible, the load
29739 of the associated information is done at the startup of the TLS connection.
29740
29741 The cache is invalidated in the daemon
29742 and reloaded after any changes to the directories
29743 containing files specified by these options.
29744
29745 The information specified by the main option &%tls_verify_certificates%&
29746 is similarly cached so long as it specifies files explicitly
29747 or (under GnuTLS) is the string &"system,cache"&.
29748 The latter case is not automatically invaludated;
29749 it is the operator's responsibility to arrange for a daemon restart
29750 any time the system certificate authority bundle is updated.
29751 A HUP signal is sufficient for this.
29752 The value &"system"& results in no caching under GnuTLS.
29753
29754 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29755 is acceptable in configurations for the Exim executavble.
29756
29757 Caching of the system Certificate Authorities bundle can
29758 save siginificant time and processing on every TLS connection
29759 initiated by Exim.
29760
29761
29762
29763
29764 .section "Use of TLS Server Name Indication" "SECTtlssni"
29765 .cindex "TLS" "Server Name Indication"
29766 .cindex "TLS" SNI
29767 .cindex SNI
29768 .vindex "&$tls_in_sni$&"
29769 .oindex "&%tls_in_sni%&"
29770 With TLS1.0 or above, there is an extension mechanism by which extra
29771 information can be included at various points in the protocol.  One of these
29772 extensions, documented in RFC 6066 (and before that RFC 4366) is
29773 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29774 client in the initial handshake, so that the server can examine the servername
29775 within and possibly choose to use different certificates and keys (and more)
29776 for this session.
29777
29778 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29779 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29780 address.
29781
29782 With SMTP to MX, there are the same problems here as in choosing the identity
29783 against which to validate a certificate: you can't rely on insecure DNS to
29784 provide the identity which you then cryptographically verify.  So this will
29785 be of limited use in that environment.
29786
29787 With SMTP to Submission, there is a well-defined hostname which clients are
29788 connecting to and can validate certificates against.  Thus clients &*can*&
29789 choose to include this information in the TLS negotiation.  If this becomes
29790 wide-spread, then hosters can choose to present different certificates to
29791 different clients.  Or even negotiate different cipher suites.
29792
29793 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29794 if not empty, will be sent on a TLS session as part of the handshake.  There's
29795 nothing more to it.  Choosing a sensible value not derived insecurely is the
29796 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29797 for the lifetime of the client connection (including during authentication).
29798
29799 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29800 is forced to the name of the destination host, after any MX- or CNAME-following.
29801
29802 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29803 received from a client.
29804 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29805
29806 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29807 option (prior to expansion) then the following options will be re-expanded
29808 during TLS session handshake, to permit alternative values to be chosen:
29809
29810 .ilist
29811 &%tls_certificate%&
29812 .next
29813 &%tls_crl%&
29814 .next
29815 &%tls_privatekey%&
29816 .next
29817 &%tls_verify_certificates%&
29818 .next
29819 &%tls_ocsp_file%&
29820 .endlist
29821
29822 Great care should be taken to deal with matters of case, various injection
29823 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29824 can always be referenced; it is important to remember that &$tls_in_sni$& is
29825 arbitrary unverified data provided prior to authentication.
29826 Further, the initial certificate is loaded before SNI has arrived, so
29827 an expansion for &%tls_certificate%& must have a default which is used
29828 when &$tls_in_sni$& is empty.
29829
29830 The Exim developers are proceeding cautiously and so far no other TLS options
29831 are re-expanded.
29832
29833 When Exim is built against OpenSSL, OpenSSL must have been built with support
29834 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29835 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29836 see &`-servername`& in the output, then OpenSSL has support.
29837
29838 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29839 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29840 built, then you have SNI support).
29841
29842 .subsection ALPN
29843 .cindex TLS ALPN
29844 .cindex ALPN "general information"
29845 .cindex TLS "Application Layer Protocol Names"
29846 There is a TLS feature related to SNI
29847 called Application Layer Protocol Name (ALPN).
29848 This is intended to declare, or select, what protocol layer will be using a TLS
29849 connection.
29850 The client for the connection proposes a set of protocol names, and
29851 the server responds with a selected one.
29852 It is not, as of 2021, commonly used for SMTP connections.
29853 However, to guard against misdirected or malicious use of web clients
29854 (which often do use ALPN) against MTA ports, Exim by default check that
29855 there is no incompatible ALPN specified by a client for a TLS connection.
29856 If there is, the connection is rejected.
29857
29858 As a client Exim does not supply ALPN by default.
29859 The behaviour of both client and server can be configured using the options
29860 &%tls_alpn%& and &%hosts_require_alpn%&.
29861 There are no variables providing observability.
29862 Some feature-specific logging may appear on denied connections, but this
29863 depends on the behaviour of the peer
29864 (not all peers can send a feature-specific TLS Alert).
29865
29866 This feature is available when Exim is built with
29867 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29868 the macro _HAVE_TLS_ALPN will be defined when this is so.
29869
29870
29871
29872 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29873          "SECTmulmessam"
29874 .cindex "multiple SMTP deliveries with TLS"
29875 .cindex "TLS" "multiple message deliveries"
29876 Exim sends multiple messages down the same TCP/IP connection by starting up
29877 an entirely new delivery process for each message, passing the socket from
29878 one process to the next. This implementation does not fit well with the use
29879 of TLS, because there is quite a lot of state information associated with a TLS
29880 connection, not just a socket identification. Passing all the state information
29881 to a new process is not feasible. Consequently, for sending using TLS Exim
29882 starts an additional proxy process for handling the encryption, piping the
29883 unencrypted data stream from and to the delivery processes.
29884
29885 An older mode of operation can be enabled on a per-host basis by the
29886 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29887 this list the proxy process described above is not used; instead Exim
29888 shuts down an existing TLS session being run by the delivery process
29889 before passing the socket to a new process. The new process may then
29890 try to start a new TLS session, and if successful, may try to re-authenticate
29891 if AUTH is in use, before sending the next message.
29892
29893 The RFC is not clear as to whether or not an SMTP session continues in clear
29894 after TLS has been shut down, or whether TLS may be restarted again later, as
29895 just described. However, if the server is Exim, this shutdown and
29896 reinitialization works. It is not known which (if any) other servers operate
29897 successfully if the client closes a TLS session and continues with unencrypted
29898 SMTP, but there are certainly some that do not work. For such servers, Exim
29899 should not pass the socket to another process, because the failure of the
29900 subsequent attempt to use it would cause Exim to record a temporary host error,
29901 and delay other deliveries to that host.
29902
29903 To test for this case, Exim sends an EHLO command to the server after
29904 closing down the TLS session. If this fails in any way, the connection is
29905 closed instead of being passed to a new delivery process, but no retry
29906 information is recorded.
29907
29908 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29909 &(smtp)& transport to match those hosts for which Exim should not pass
29910 connections to new processes if TLS has been used.
29911
29912
29913
29914
29915 .section "Certificates and all that" "SECTcerandall"
29916 .cindex "certificate" "references to discussion"
29917 In order to understand fully how TLS works, you need to know about
29918 certificates, certificate signing, and certificate authorities.
29919 This is a large topic and an introductory guide is unsuitable for the Exim
29920 reference manual, so instead we provide pointers to existing documentation.
29921
29922 The Apache web-server was for a long time the canonical guide, so their
29923 documentation is a good place to start; their SSL module's Introduction
29924 document is currently at
29925 .display
29926 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29927 .endd
29928 and their FAQ is at
29929 .display
29930 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29931 .endd
29932
29933 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29934 0-201-61598-3) in 2001, contains both introductory and more in-depth
29935 descriptions.
29936 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29937 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29938 Ivan is the author of the popular TLS testing tools at
29939 &url(https://www.ssllabs.com/).
29940
29941
29942 .subsection "Certificate chains" SECID186
29943 A file named by &%tls_certificate%& may contain more than one
29944 certificate. This is useful in the case where the certificate that is being
29945 sent is validated by an intermediate certificate which the other end does
29946 not have. Multiple certificates must be in the correct order in the file.
29947 First the host's certificate itself, then the first intermediate
29948 certificate to validate the issuer of the host certificate, then the next
29949 intermediate certificate to validate the issuer of the first intermediate
29950 certificate, and so on, until finally (optionally) the root certificate.
29951 The root certificate must already be trusted by the recipient for
29952 validation to succeed, of course, but if it's not preinstalled, sending the
29953 root certificate along with the rest makes it available for the user to
29954 install if the receiving end is a client MUA that can interact with a user.
29955
29956 Note that certificates using MD5 are unlikely to work on today's Internet;
29957 even if your libraries allow loading them for use in Exim when acting as a
29958 server, increasingly clients will not accept such certificates.  The error
29959 diagnostics in such a case can be frustratingly vague.
29960
29961
29962
29963 .subsection "Self-signed certificates" SECID187
29964 .cindex "certificate" "self-signed"
29965 You can create a self-signed certificate using the &'req'& command provided
29966 with OpenSSL, like this:
29967 . ==== Do not shorten the duration here without reading and considering
29968 . ==== the text below.  Please leave it at 9999 days.
29969 .code
29970 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29971             -days 9999 -nodes
29972 .endd
29973 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29974 delimited and so can be identified independently. The &%-days%& option
29975 specifies a period for which the certificate is valid. The &%-nodes%& option is
29976 important: if you do not set it, the key is encrypted with a passphrase
29977 that you are prompted for, and any use that is made of the key causes more
29978 prompting for the passphrase. This is not helpful if you are going to use
29979 this certificate and key in an MTA, where prompting is not possible.
29980
29981 . ==== I expect to still be working 26 years from now.  The less technical
29982 . ==== debt I create, in terms of storing up trouble for my later years, the
29983 . ==== happier I will be then.  We really have reached the point where we
29984 . ==== should start, at the very least, provoking thought and making folks
29985 . ==== pause before proceeding, instead of leaving all the fixes until two
29986 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29987 . ==== -pdp, 2012
29988 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29989 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29990 the above command might produce a date in the past.  Think carefully about
29991 the lifetime of the systems you're deploying, and either reduce the duration
29992 of the certificate or reconsider your platform deployment.  (At time of
29993 writing, reducing the duration is the most likely choice, but the inexorable
29994 progression of time takes us steadily towards an era where this will not
29995 be a sensible resolution).
29996
29997 A self-signed certificate made in this way is sufficient for testing, and
29998 may be adequate for all your requirements if you are mainly interested in
29999 encrypting transfers, and not in secure identification.
30000
30001 However, many clients require that the certificate presented by the server be a
30002 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30003 certificate. In this situation, the self-signed certificate described above
30004 must be installed on the client host as a trusted root &'certification
30005 authority'& (CA), and the certificate used by Exim must be a user certificate
30006 signed with that self-signed certificate.
30007
30008 For information on creating self-signed CA certificates and using them to sign
30009 user certificates, see the &'General implementation overview'& chapter of the
30010 Open-source PKI book, available online at
30011 &url(https://sourceforge.net/projects/ospkibook/).
30012
30013
30014 .subsection "Revoked certificates"
30015 .cindex "TLS" "revoked certificates"
30016 .cindex "revocation list"
30017 .cindex "certificate" "revocation list"
30018 .cindex "OCSP" "stapling"
30019 There are three ways for a certificate to be made unusable
30020 before its expiry.
30021
30022 .ilist
30023 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30024 certificates are revoked. If you have such a list, you can pass it to an Exim
30025 server using the global option called &%tls_crl%& and to an Exim client using
30026 an identically named option for the &(smtp)& transport. In each case, the value
30027 of the option is expanded and must then be the name of a file that contains a
30028 CRL in PEM format.
30029 The downside is that clients have to periodically re-download a potentially huge
30030 file from every certificate authority they know of.
30031
30032 .next
30033 The way with most moving parts at query time is Online Certificate
30034 Status Protocol (OCSP), where the client verifies the certificate
30035 against an OCSP server run by the CA.  This lets the CA track all
30036 usage of the certs.  It requires running software with access to the
30037 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30038 is based on HTTP and can be proxied accordingly.
30039
30040 The only widespread OCSP server implementation (known to this writer)
30041 comes as part of OpenSSL and aborts on an invalid request, such as
30042 connecting to the port and then disconnecting.  This requires
30043 re-entering the passphrase each time some random client does this.
30044
30045 .next
30046 The third way is OCSP Stapling; in this, the server using a certificate
30047 issued by the CA periodically requests an OCSP proof of validity from
30048 the OCSP server, then serves it up inline as part of the TLS
30049 negotiation.   This approach adds no extra round trips, does not let the
30050 CA track users, scales well with number of certs issued by the CA and is
30051 resilient to temporary OCSP server failures, as long as the server
30052 starts retrying to fetch an OCSP proof some time before its current
30053 proof expires.  The downside is that it requires server support.
30054
30055 Unless Exim is built with the support disabled,
30056 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30057 support for OCSP stapling is included.
30058
30059 There is a global option called &%tls_ocsp_file%&.
30060 The file specified therein is expected to be in DER format, and contain
30061 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30062 option will be re-expanded for SNI, if the &%tls_certificate%& option
30063 contains &`tls_in_sni`&, as per other TLS options.
30064
30065 Exim does not at this time implement any support for fetching a new OCSP
30066 proof.  The burden is on the administrator to handle this, outside of
30067 Exim.  The file specified should be replaced atomically, so that the
30068 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30069 on each connection, so a new file will be handled transparently on the
30070 next connection.
30071
30072 When built with OpenSSL Exim will check for a valid next update timestamp
30073 in the OCSP proof; if not present, or if the proof has expired, it will be
30074 ignored.
30075
30076 For the client to be able to verify the stapled OCSP the server must
30077 also supply, in its stapled information, any intermediate
30078 certificates for the chain leading to the OCSP proof from the signer
30079 of the server certificate.  There may be zero or one such. These
30080 intermediate certificates should be added to the server OCSP stapling
30081 file named by &%tls_ocsp_file%&.
30082
30083 Note that the proof only covers the terminal server certificate,
30084 not any of the chain from CA to it.
30085
30086 There is no current way to staple a proof for a client certificate.
30087
30088 .code
30089   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30090   OCSP server is supplied.  The server URL may be included in the
30091   server certificate, if the CA is helpful.
30092
30093   One failure mode seen was the OCSP Signer cert expiring before the end
30094   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30095   noted this as invalid overall, but the re-fetch script did not.
30096 .endd
30097 .endlist
30098
30099
30100 .ecindex IIDencsmtp1
30101 .ecindex IIDencsmtp2
30102
30103
30104 .section "TLS Resumption" "SECTresumption"
30105 .cindex TLS resumption
30106 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30107 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30108 (or later).
30109
30110 Session resumption (this is the "stateless" variant) involves the server sending
30111 a "session ticket" to the client on one connection, which can be stored by the
30112 client and used for a later session.  The ticket contains sufficient state for
30113 the server to reconstruct the TLS session, avoiding some expensive crypto
30114 calculation and (on TLS1.2) one full packet roundtrip time.
30115
30116 .ilist
30117 Operational cost/benefit:
30118
30119  The extra data being transmitted costs a minor amount, and the client has
30120  extra costs in storing and retrieving the data.
30121
30122  In the Exim/Gnutls implementation the extra cost on an initial connection
30123  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30124  The saved cost on a subsequent connection is about 4ms; three or more
30125  connections become a net win.  On longer network paths, two or more
30126  connections will have an average lower startup time thanks to the one
30127  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30128  packet roundtrips.
30129
30130 .cindex "hints database" tls
30131  Since a new hints DB is used on the TLS client,
30132  the hints DB maintenance should be updated to additionally handle "tls".
30133
30134 .next
30135 Security aspects:
30136
30137  The session ticket is encrypted, but is obviously an additional security
30138  vulnarability surface.  An attacker able to decrypt it would have access
30139  all connections using the resumed session.
30140  The session ticket encryption key is not committed to storage by the server
30141  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30142  overlap; GnuTLS 6hr but does not specify any overlap).
30143  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30144  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30145
30146  There is a question-mark over the security of the Diffie-Helman parameters
30147  used for session negotiation.
30148
30149 .next
30150 Observability:
30151
30152  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30153  element.
30154
30155  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30156  have bits 0-4 indicating respectively
30157  support built, client requested ticket, client offered session,
30158  server issued ticket, resume used.  A suitable decode list is provided
30159  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30160
30161 .next
30162 Control:
30163
30164 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30165 exim, operating as a server, will offer resumption to clients.
30166 Current best practice is to not offer the feature to MUA connection.
30167 Commonly this can be done like this:
30168 .code
30169 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30170 .endd
30171 If the peer host matches the list after expansion then resumption
30172 is offered and/or accepted.
30173
30174 The &%tls_resumption_hosts%& smtp transport option performs the
30175 equivalent function for operation as a client.
30176 If the peer host matches the list after expansion then resumption
30177 is attempted (if a stored session is available) or the information
30178 stored (if supplied by the peer).
30179
30180
30181 .next
30182 Issues:
30183
30184  In a resumed session:
30185 .ilist
30186   The variables &$tls_{in,out}_cipher$& will have values different
30187  to the original (under GnuTLS).
30188 .next
30189   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30190  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30191 . XXX need to do something with that hosts_require_ocsp
30192 .endlist
30193
30194 .endlist
30195
30196
30197 .section DANE "SECDANE"
30198 .cindex DANE
30199 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30200 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30201 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30202 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30203 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30204 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30205
30206 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30207 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30208 by (a) is thought to be smaller than that of the set of root CAs.
30209
30210 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30211 fail to pass on a server's STARTTLS.
30212
30213 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30214 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30215 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30216
30217 DANE requires a server operator to do three things:
30218 .olist
30219 Run DNSSEC.  This provides assurance to clients
30220 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30221 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30222 DNSSEC.
30223 .next
30224 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30225 .next
30226 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30227 .endlist
30228
30229 There are no changes to Exim specific to server-side operation of DANE.
30230 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30231 in &_Local/Makefile_&.
30232 If it has been included, the macro "_HAVE_DANE" will be defined.
30233
30234 .subsection "DNS records"
30235 A TLSA record consist of 4 fields, the "Certificate Usage", the
30236 "Selector", the "Matching type", and the "Certificate Association Data".
30237 For a detailed description of the TLSA record see
30238 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30239
30240 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30241 These are the "Trust Anchor" and "End Entity" variants.
30242 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30243 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30244 this is appropriate for a single system, using a self-signed certificate.
30245 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30246 well-known one.
30247 A private CA at simplest is just a self-signed certificate (with certain
30248 attributes) which is used to sign server certificates, but running one securely
30249 does require careful arrangement.
30250 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30251 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30252 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30253 all of which point to a single TLSA record.
30254 DANE-TA and DANE-EE can both be used together.
30255
30256 Our recommendation is to use DANE with a certificate from a public CA,
30257 because this enables a variety of strategies for remote clients to verify
30258 your certificate.
30259 You can then publish information both via DANE and another technology,
30260 "MTA-STS", described below.
30261
30262 When you use DANE-TA to publish trust anchor information, you ask entities
30263 outside your administrative control to trust the Certificate Authority for
30264 connections to you.
30265 If using a private CA then you should expect others to still apply the
30266 technical criteria they'd use for a public CA to your certificates.
30267 In particular, you should probably try to follow current best practices for CA
30268 operation around hash algorithms and key sizes.
30269 Do not expect other organizations to lower their security expectations just
30270 because a particular profile might be reasonable for your own internal use.
30271
30272 When this text was last updated, this in practice means to avoid use of SHA-1
30273 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30274 than 4096, for interoperability); to use keyUsage fields correctly; to use
30275 random serial numbers.
30276 The list of requirements is subject to change as best practices evolve.
30277 If you're not already using a private CA, or it doesn't meet these
30278 requirements, then we encourage you to avoid all these issues and use a public
30279 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30280
30281 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30282 a "Matching Type" (3rd) field of SHA2-512(2).
30283
30284 For the "Certificate Authority Data" (4th) field, commands like
30285
30286 .code
30287   openssl x509 -pubkey -noout <certificate.pem \
30288   | openssl rsa -outform der -pubin 2>/dev/null \
30289   | openssl sha512 \
30290   | awk '{print $2}'
30291 .endd
30292
30293 are workable to create a hash of the certificate's public key.
30294
30295 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30296
30297 .code
30298   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30299 .endd
30300
30301 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30302 is useful for quickly generating TLSA records.
30303
30304
30305 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30306
30307 The Certificate issued by the CA published in the DANE-TA model should be
30308 issued using a strong hash algorithm.
30309 Exim, and importantly various other MTAs sending to you, will not
30310 re-enable hash algorithms which have been disabled by default in TLS
30311 libraries.
30312 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30313 interoperability (and probably the maximum too, in 2018).
30314
30315 .subsection "Interaction with OCSP"
30316 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30317 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30318 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30319
30320 .code
30321   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30322                                  {= {4}{$tls_out_tlsa_usage}} } \
30323                          {*}{}}
30324 .endd
30325
30326 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30327 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30328 found. If the definition of &%hosts_request_ocsp%& includes the
30329 string "tls_out_tlsa_usage", they are re-expanded in time to
30330 control the OCSP request.
30331
30332 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30333 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30334
30335
30336 .subsection "Client configuration"
30337 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30338 and &%dane_require_tls_ciphers%&.
30339 The &"require"& variant will result in failure if the target host is not
30340 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30341 the &%dnssec_request_domains%& router or transport option.
30342
30343 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30344
30345 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30346 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30347 will be required for the host.  If it does not, the host will not
30348 be used; there is no fallback to non-DANE or non-TLS.
30349
30350 If DANE is requested and usable, then the TLS cipher list configuration
30351 prefers to use the option &%dane_require_tls_ciphers%& and falls
30352 back to &%tls_require_ciphers%& only if that is unset.
30353 This lets you configure "decent crypto" for DANE and "better than nothing
30354 crypto" as the default.  Note though that while GnuTLS lets the string control
30355 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30356 limited to ciphersuite constraints.
30357
30358 If DANE is requested and useable (see above) the following transport options are ignored:
30359 .code
30360   hosts_require_tls
30361   tls_verify_hosts
30362   tls_try_verify_hosts
30363   tls_verify_certificates
30364   tls_crl
30365   tls_verify_cert_hostnames
30366   tls_sni
30367 .endd
30368
30369 If DANE is not usable, whether requested or not, and CA-anchored
30370 verification evaluation is wanted, the above variables should be set appropriately.
30371
30372 The router and transport option &%dnssec_request_domains%& must not be
30373 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30374
30375 .subsection Observability
30376 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30377
30378 There is a new variable &$tls_out_dane$& which will have "yes" if
30379 verification succeeded using DANE and "no" otherwise (only useful
30380 in combination with events; see &<<CHAPevents>>&),
30381 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30382
30383 .cindex DANE reporting
30384 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30385 to achieve DANE-verified connection, if one was either requested and offered, or
30386 required.  This is intended to support TLS-reporting as defined in
30387 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30388 The &$event_data$& will be one of the Result Types defined in
30389 Section 4.3 of that document.
30390
30391 .subsection General
30392 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30393
30394 DANE is specified in published RFCs and decouples certificate authority trust
30395 selection from a "race to the bottom" of "you must trust everything for mail
30396 to get through".
30397 There is an alternative technology called MTA-STS, which
30398 instead publishes MX trust anchor information on an HTTPS website.  At the
30399 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30400 Exim has no support for MTA-STS as a client, but Exim mail server operators
30401 can choose to publish information describing their TLS configuration using
30402 MTA-STS to let those clients who do use that protocol derive trust
30403 information.
30404
30405 The MTA-STS design requires a certificate from a public Certificate Authority
30406 which is recognized by clients sending to you.
30407 That selection of which CAs are trusted by others is outside your control.
30408
30409 The most interoperable course of action is probably to use
30410 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30411 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30412 records for DANE clients (such as Exim and Postfix) and to publish anchor
30413 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30414 domain itself (with caveats around occasionally broken MTA-STS because of
30415 incompatible specification changes prior to reaching RFC status).
30416
30417
30418
30419 . ////////////////////////////////////////////////////////////////////////////
30420 . ////////////////////////////////////////////////////////////////////////////
30421
30422 .chapter "Access control lists" "CHAPACL"
30423 .scindex IIDacl "&ACL;" "description"
30424 .cindex "control of incoming mail"
30425 .cindex "message" "controlling incoming"
30426 .cindex "policy control" "access control lists"
30427 Access Control Lists (ACLs) are defined in a separate section of the runtime
30428 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30429 name, terminated by a colon. Here is a complete ACL section that contains just
30430 one very small ACL:
30431 .code
30432 begin acl
30433 small_acl:
30434   accept   hosts = one.host.only
30435 .endd
30436 You can have as many lists as you like in the ACL section, and the order in
30437 which they appear does not matter. The lists are self-terminating.
30438
30439 The majority of ACLs are used to control Exim's behaviour when it receives
30440 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30441 when a local process submits a message using SMTP by specifying the &%-bs%&
30442 option. The most common use is for controlling which recipients are accepted
30443 in incoming messages. In addition, you can define an ACL that is used to check
30444 local non-SMTP messages. The default configuration file contains an example of
30445 a realistic ACL for checking RCPT commands. This is discussed in chapter
30446 &<<CHAPdefconfil>>&.
30447
30448
30449 .section "Testing ACLs" "SECID188"
30450 The &%-bh%& command line option provides a way of testing your ACL
30451 configuration locally by running a fake SMTP session with which you interact.
30452
30453
30454 .section "Specifying when ACLs are used" "SECID189"
30455 .cindex "&ACL;" "options for specifying"
30456 In order to cause an ACL to be used, you have to name it in one of the relevant
30457 options in the main part of the configuration. These options are:
30458 .cindex "AUTH" "ACL for"
30459 .cindex "DATA" "ACLs for"
30460 .cindex "ETRN" "ACL for"
30461 .cindex "EXPN" "ACL for"
30462 .cindex "HELO" "ACL for"
30463 .cindex "EHLO" "ACL for"
30464 .cindex "DKIM" "ACL for"
30465 .cindex "MAIL" "ACL for"
30466 .cindex "QUIT, ACL for"
30467 .cindex "RCPT" "ACL for"
30468 .cindex "STARTTLS, ACL for"
30469 .cindex "VRFY" "ACL for"
30470 .cindex "SMTP" "connection, ACL for"
30471 .cindex "non-SMTP messages" "ACLs for"
30472 .cindex "MIME content scanning" "ACL for"
30473 .cindex "PRDR" "ACL for"
30474
30475 .table2 140pt
30476 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30477 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30478 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30479 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30480 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30481 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30482 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30483 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30484 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30485 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30486 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30487 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30488 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30489 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30490 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30491 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30492 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30493 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30494 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30495 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30496 .endtable
30497
30498 For example, if you set
30499 .code
30500 acl_smtp_rcpt = small_acl
30501 .endd
30502 the little ACL defined above is used whenever Exim receives a RCPT command
30503 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30504 done when RCPT commands arrive. A rejection of RCPT should cause the
30505 sending MTA to give up on the recipient address contained in the RCPT
30506 command, whereas rejection at other times may cause the client MTA to keep on
30507 trying to deliver the message. It is therefore recommended that you do as much
30508 testing as possible at RCPT time.
30509
30510
30511 .subsection "The non-SMTP ACLs" SECID190
30512 .cindex "non-SMTP messages" "ACLs for"
30513 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30514 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30515 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30516 the state of the SMTP connection such as encryption and authentication) are not
30517 relevant and are forbidden in these ACLs. However, the sender and recipients
30518 are known, so the &%senders%& and &%sender_domains%& conditions and the
30519 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30520 &$authenticated_sender$& are also available. You can specify added header lines
30521 in any of these ACLs.
30522
30523 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30524 non-SMTP message, before any of the message has been read. (This is the
30525 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30526 batched SMTP input, it runs after the DATA command has been reached. The
30527 result of this ACL is ignored; it cannot be used to reject a message. If you
30528 really need to, you could set a value in an ACL variable here and reject based
30529 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30530 controls, and in particular, it can be used to set
30531 .code
30532 control = suppress_local_fixups
30533 .endd
30534 This cannot be used in the other non-SMTP ACLs because by the time they are
30535 run, it is too late.
30536
30537 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30538 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30539
30540 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30541 kind of rejection is treated as permanent, because there is no way of sending a
30542 temporary error for these kinds of message.
30543
30544
30545 .subsection "The SMTP connect ACL" SECID191
30546 .cindex "SMTP" "connection, ACL for"
30547 .oindex &%smtp_banner%&
30548 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30549 session, after the test specified by &%host_reject_connection%& (which is now
30550 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30551 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30552 the message override the banner message that is otherwise specified by the
30553 &%smtp_banner%& option.
30554
30555 .new
30556 For tls-on-connect connections, the ACL is run before the TLS connection
30557 is accepted; if the ACL does not accept then the TCP connection is dropped without
30558 any TLS startup attempt and without any SMTP response being transmitted.
30559 .wen
30560
30561
30562 .subsection "The EHLO/HELO ACL" SECID192
30563 .cindex "EHLO" "ACL for"
30564 .cindex "HELO" "ACL for"
30565 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30566 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30567 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30568 Note that a client may issue more than one EHLO or HELO command in an SMTP
30569 session, and indeed is required to issue a new EHLO or HELO after successfully
30570 setting up encryption following a STARTTLS command.
30571
30572 Note also that a deny neither forces the client to go away nor means that
30573 mail will be refused on the connection.  Consider checking for
30574 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30575
30576 If the command is accepted by an &%accept%& verb that has a &%message%&
30577 modifier, the message may not contain more than one line (it will be truncated
30578 at the first newline and a panic logged if it does). Such a message cannot
30579 affect the EHLO options that are listed on the second and subsequent lines of
30580 an EHLO response.
30581
30582
30583 .subsection "The DATA ACLs" SECID193
30584 .cindex "DATA" "ACLs for"
30585 Two ACLs are associated with the DATA command, because it is two-stage
30586 command, with two responses being sent to the client.
30587 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30588 is obeyed. This gives you control after all the RCPT commands, but before
30589 the message itself is received. It offers the opportunity to give a negative
30590 response to the DATA command before the data is transmitted. Header lines
30591 added by MAIL or RCPT ACLs are not visible at this time, but any that
30592 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30593
30594 You cannot test the contents of the message, for example, to verify addresses
30595 in the headers, at RCPT time or when the DATA command is received. Such
30596 tests have to appear in the ACL that is run after the message itself has been
30597 received, before the final response to the DATA command is sent. This is
30598 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30599 associated with the DATA command.
30600
30601 .cindex CHUNKING "BDAT command"
30602 .cindex BDAT "SMTP command"
30603 .cindex "RFC 3030" CHUNKING
30604 If CHUNKING was advertised and a BDAT command sequence is received,
30605 the &%acl_smtp_predata%& ACL is not run.
30606 . XXX why not?  It should be possible, for the first BDAT.
30607 The &%acl_smtp_data%& is run after the last BDAT command and all of
30608 the data specified is received.
30609
30610 For both of these ACLs, it is not possible to reject individual recipients. An
30611 error response rejects the entire message. Unfortunately, it is known that some
30612 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30613 before or after the data) correctly &-- they keep the message on their queues
30614 and try again later, but that is their problem, though it does waste some of
30615 your resources.
30616
30617 The &%acl_smtp_data%& ACL is run after
30618 the &%acl_smtp_data_prdr%&,
30619 the &%acl_smtp_dkim%&
30620 and the &%acl_smtp_mime%& ACLs.
30621
30622 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30623 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30624 enabled (which is the default).
30625
30626 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30627 received, and is executed for each DKIM signature found in a message.  If not
30628 otherwise specified, the default action is to accept.
30629
30630 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30631
30632 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30633
30634
30635 .subsection "The SMTP MIME ACL" SECID194
30636 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30637 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30638
30639 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30640
30641
30642 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30643 .cindex "PRDR" "ACL for"
30644 .oindex "&%prdr_enable%&"
30645 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30646 with PRDR support enabled (which is the default).
30647 It becomes active only when the PRDR feature is negotiated between
30648 client and server for a message, and more than one recipient
30649 has been accepted.
30650
30651 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30652 has been received, and is executed once for each recipient of the message
30653 with &$local_part$& and &$domain$& valid.
30654 The test may accept, defer or deny for individual recipients.
30655 The &%acl_smtp_data%& will still be called after this ACL and
30656 can reject the message overall, even if this ACL has accepted it
30657 for some or all recipients.
30658
30659 PRDR may be used to support per-user content filtering.  Without it
30660 one must defer any recipient after the first that has a different
30661 content-filter configuration.  With PRDR, the RCPT-time check
30662 .cindex "PRDR" "variable for"
30663 for this can be disabled when the variable &$prdr_requested$&
30664 is &"yes"&.
30665 Any required difference in behaviour of the main DATA-time
30666 ACL should however depend on the PRDR-time ACL having run, as Exim
30667 will avoid doing so in some situations (e.g. single-recipient mails).
30668
30669 See also the &%prdr_enable%& global option
30670 and the &%hosts_try_prdr%& smtp transport option.
30671
30672 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30673 If the ACL is not defined, processing completes as if
30674 the feature was not requested by the client.
30675
30676 .subsection "The QUIT ACL" SECTQUITACL
30677 .cindex "QUIT, ACL for"
30678 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30679 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30680 does not in fact control any access.
30681 For this reason, it may only accept
30682 or warn as its final result.
30683
30684 This ACL can be used for tasks such as custom logging at the end of an SMTP
30685 session. For example, you can use ACL variables in other ACLs to count
30686 messages, recipients, etc., and log the totals at QUIT time using one or
30687 more &%logwrite%& modifiers on a &%warn%& verb.
30688
30689 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30690 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30691
30692 You do not need to have a final &%accept%&, but if you do, you can use a
30693 &%message%& modifier to specify custom text that is sent as part of the 221
30694 response to QUIT.
30695
30696 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30697 failure (for example, failure to open a log file, or when Exim is bombing out
30698 because it has detected an unrecoverable error), all SMTP commands from the
30699 client are given temporary error responses until QUIT is received or the
30700 connection is closed. In these special cases, the QUIT ACL does not run.
30701
30702
30703 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30704 .vindex &$acl_smtp_notquit$&
30705 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30706 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30707 trouble, such as being unable to write to its log files, this ACL is not run,
30708 because it might try to do things (such as write to log files) that make the
30709 situation even worse.
30710
30711 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30712 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30713 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30714 and &%warn%&.
30715
30716 .vindex &$smtp_notquit_reason$&
30717 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30718 to a string that indicates the reason for the termination of the SMTP
30719 connection. The possible values are:
30720 .table2
30721 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30722 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30723 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30724 .irow &`connection-lost`&          "The SMTP connection has been lost"
30725 .irow &`data-timeout`&             "Timeout while reading message data"
30726 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30727 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30728 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30729 .irow &`synchronization-error`&    "SMTP synchronization error"
30730 .irow &`tls-failed`&               "TLS failed to start"
30731 .endtable
30732 In most cases when an SMTP connection is closed without having received QUIT,
30733 Exim sends an SMTP response message before actually closing the connection.
30734 With the exception of the &`acl-drop`& case, the default message can be
30735 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30736 &%drop%& verb in another ACL, it is the message from the other ACL that is
30737 used.
30738
30739
30740 .section "Finding an ACL to use" "SECID195"
30741 .cindex "&ACL;" "finding which to use"
30742 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30743 you can use different ACLs in different circumstances. For example,
30744 .code
30745 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30746                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30747 .endd
30748 In the default configuration file there are some example settings for
30749 providing an RFC 4409 message &"submission"& service on port 587 and
30750 an RFC 8314 &"submissions"& service on port 465. You can use a string
30751 expansion like this to choose an ACL for MUAs on these ports which is
30752 more appropriate for this purpose than the default ACL on port 25.
30753
30754 The expanded string does not have to be the name of an ACL in the
30755 configuration file; there are other possibilities. Having expanded the
30756 string, Exim searches for an ACL as follows:
30757
30758 .ilist
30759 If the string begins with a slash, Exim uses it as a filename, and reads its
30760 contents as an ACL. The lines are processed in the same way as lines in the
30761 Exim configuration file. In particular, continuation lines are supported, blank
30762 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30763 If the file does not exist or cannot be read, an error occurs (typically
30764 causing a temporary failure of whatever caused the ACL to be run). For example:
30765 .code
30766 acl_smtp_data = /etc/acls/\
30767   ${lookup{$sender_host_address}lsearch\
30768   {/etc/acllist}{$value}{default}}
30769 .endd
30770 This looks up an ACL file to use on the basis of the host's IP address, falling
30771 back to a default if the lookup fails. If an ACL is successfully read from a
30772 file, it is retained in memory for the duration of the Exim process, so that it
30773 can be re-used without having to re-read the file.
30774 .next
30775 If the string does not start with a slash, and does not contain any spaces,
30776 Exim searches the ACL section of the configuration for an ACL whose name
30777 matches the string.
30778 .next
30779 If no named ACL is found, or if the string contains spaces, Exim parses
30780 the string as an inline ACL. This can save typing in cases where you just
30781 want to have something like
30782 .code
30783 acl_smtp_vrfy = accept
30784 .endd
30785 in order to allow free use of the VRFY command. Such a string may contain
30786 newlines; it is processed in the same way as an ACL that is read from a file.
30787 .endlist
30788
30789
30790
30791
30792 .section "ACL return codes" "SECID196"
30793 .cindex "&ACL;" "return codes"
30794 Except for the QUIT ACL, which does not affect the SMTP return code (see
30795 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30796 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30797 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30798 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30799 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30800 This also causes a 4&'xx'& return code.
30801
30802 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30803 &"deny"&, because there is no mechanism for passing temporary errors to the
30804 submitters of non-SMTP messages.
30805
30806
30807 ACLs that are relevant to message reception may also return &"discard"&. This
30808 has the effect of &"accept"&, but causes either the entire message or an
30809 individual recipient address to be discarded. In other words, it is a
30810 blackholing facility. Use it with care.
30811
30812 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30813 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30814 RCPT ACL is to discard just the one recipient address. If there are no
30815 recipients left when the message's data is received, the DATA ACL is not
30816 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30817 remaining recipients. The &"discard"& return is not permitted for the
30818 &%acl_smtp_predata%& ACL.
30819
30820 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30821 is done on the address and the result determines the SMTP response.
30822
30823
30824 .cindex "&[local_scan()]& function" "when all recipients discarded"
30825 The &[local_scan()]& function is always run, even if there are no remaining
30826 recipients; it may create new recipients.
30827
30828
30829
30830 .section "Unset ACL options" "SECID197"
30831 .cindex "&ACL;" "unset options"
30832 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30833 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30834 not defined at all. For any defined ACL, the default action when control
30835 reaches the end of the ACL statements is &"deny"&.
30836
30837 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30838 these two are ACLs that are used only for their side effects. They cannot be
30839 used to accept or reject anything.
30840
30841 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30842 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30843 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30844 when the ACL is not defined is &"accept"&.
30845
30846 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30847 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30848 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30849 messages over an SMTP connection. For an example, see the ACL in the default
30850 configuration file.
30851
30852
30853
30854
30855 .section "Data for message ACLs" "SECID198"
30856 .cindex "&ACL;" "data for message ACL"
30857 .vindex &$domain$&
30858 .vindex &$local_part$&
30859 .vindex &$sender_address$&
30860 .vindex &$sender_host_address$&
30861 .vindex &$smtp_command$&
30862 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30863 that contain information about the host and the message's sender (for example,
30864 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30865 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30866 &$local_part$& are set from the argument address. The entire SMTP command
30867 is available in &$smtp_command$&.
30868
30869 When an ACL for the AUTH parameter of MAIL is running, the variables that
30870 contain information about the host are set, but &$sender_address$& is not yet
30871 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30872 how it is used.
30873
30874 .vindex "&$message_size$&"
30875 The &$message_size$& variable is set to the value of the SIZE parameter on
30876 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30877 that parameter is not given. The value is updated to the true message size by
30878 the time the final DATA ACL is run (after the message data has been
30879 received).
30880
30881 .vindex "&$rcpt_count$&"
30882 .vindex "&$recipients_count$&"
30883 The &$rcpt_count$& variable increases by one for each RCPT command received.
30884 The &$recipients_count$& variable increases by one each time a RCPT command is
30885 accepted, so while an ACL for RCPT is being processed, it contains the number
30886 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30887 &$rcpt_count$& contains the total number of RCPT commands, and
30888 &$recipients_count$& contains the total number of accepted recipients.
30889
30890
30891
30892
30893
30894 .section "Data for non-message ACLs" "SECTdatfornon"
30895 .cindex "&ACL;" "data for non-message ACL"
30896 .vindex &$smtp_command_argument$&
30897 .vindex &$smtp_command$&
30898 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30899 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30900 and the entire SMTP command is available in &$smtp_command$&.
30901 These variables can be tested using a &%condition%& condition. For example,
30902 here is an ACL for use with AUTH, which insists that either the session is
30903 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30904 does not permit authentication methods that use cleartext passwords on
30905 unencrypted connections.
30906 .code
30907 acl_check_auth:
30908   accept encrypted = *
30909   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30910                      {CRAM-MD5}}
30911   deny   message   = TLS encryption or CRAM-MD5 required
30912 .endd
30913 (Another way of applying this restriction is to arrange for the authenticators
30914 that use cleartext passwords not to be advertised when the connection is not
30915 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30916 option to do this.)
30917
30918
30919
30920 .section "Format of an ACL" "SECID199"
30921 .cindex "&ACL;" "format of"
30922 .cindex "&ACL;" "verbs, definition of"
30923 An individual ACL consists of a number of statements. Each statement starts
30924 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30925 Modifiers can change the way the verb operates, define error and log messages,
30926 set variables, insert delays, and vary the processing of accepted messages.
30927
30928 If all the conditions are met, the verb is obeyed. The same condition may be
30929 used (with different arguments) more than once in the same statement. This
30930 provides a means of specifying an &"and"& conjunction between conditions. For
30931 example:
30932 .code
30933 deny  dnslists = list1.example
30934       dnslists = list2.example
30935 .endd
30936 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30937 the conditions and modifiers when it reaches a condition that fails. What
30938 happens then depends on the verb (and in one case, on a special modifier). Not
30939 all the conditions make sense at every testing point. For example, you cannot
30940 test a sender address in the ACL that is run for a VRFY command.
30941
30942
30943 .section "ACL verbs" "SECID200"
30944 The ACL verbs are as follows:
30945
30946 .ilist
30947 .cindex "&%accept%& ACL verb"
30948 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30949 of the conditions are not met, what happens depends on whether &%endpass%&
30950 appears among the conditions (for syntax see below). If the failing condition
30951 is before &%endpass%&, control is passed to the next ACL statement; if it is
30952 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30953 check a RCPT command:
30954 .code
30955 accept domains = +local_domains
30956        endpass
30957        verify = recipient
30958 .endd
30959 If the recipient domain does not match the &%domains%& condition, control
30960 passes to the next statement. If it does match, the recipient is verified, and
30961 the command is accepted if verification succeeds. However, if verification
30962 fails, the ACL yields &"deny"&, because the failing condition is after
30963 &%endpass%&.
30964
30965 The &%endpass%& feature has turned out to be confusing to many people, so its
30966 use is not recommended nowadays. It is always possible to rewrite an ACL so
30967 that &%endpass%& is not needed, and it is no longer used in the default
30968 configuration.
30969
30970 .cindex "&%message%& ACL modifier" "with &%accept%&"
30971 If a &%message%& modifier appears on an &%accept%& statement, its action
30972 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30973 (when an &%accept%& verb either accepts or passes control to the next
30974 statement), &%message%& can be used to vary the message that is sent when an
30975 SMTP command is accepted. For example, in a RCPT ACL you could have:
30976 .display
30977 &`accept  `&<&'some conditions'&>
30978 &`        message = OK, I will allow you through today`&
30979 .endd
30980 You can specify an SMTP response code, optionally followed by an &"extended
30981 response code"& at the start of the message, but the first digit must be the
30982 same as would be sent by default, which is 2 for an &%accept%& verb.
30983
30984 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30985 an error message that is used when access is denied. This behaviour is retained
30986 for backward compatibility, but current &"best practice"& is to avoid the use
30987 of &%endpass%&.
30988
30989
30990 .next
30991 .cindex "&%defer%& ACL verb"
30992 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30993 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30994 &%defer%& is the same as &%deny%&, because there is no way of sending a
30995 temporary error. For a RCPT command, &%defer%& is much the same as using a
30996 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30997 be used in any ACL, and even for a recipient it might be a simpler approach.
30998
30999
31000 .next
31001 .cindex "&%deny%& ACL verb"
31002 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31003 the conditions are not met, control is passed to the next ACL statement. For
31004 example,
31005 .code
31006 deny dnslists = blackholes.mail-abuse.org
31007 .endd
31008 rejects commands from hosts that are on a DNS black list.
31009
31010
31011 .next
31012 .cindex "&%discard%& ACL verb"
31013 &%discard%&: This verb behaves like &%accept%&, except that it returns
31014 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31015 that are concerned with receiving messages. When all the conditions are true,
31016 the sending entity receives a &"success"& response. However, &%discard%& causes
31017 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31018 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31019 message's recipients are discarded. Recipients that are discarded before DATA
31020 do not appear in the log line when the &%received_recipients%& log selector is set.
31021
31022 If the &%log_message%& modifier is set when &%discard%& operates,
31023 its contents are added to the line that is automatically written to the log.
31024 The &%message%& modifier operates exactly as it does for &%accept%&.
31025
31026
31027 .next
31028 .cindex "&%drop%& ACL verb"
31029 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31030 forcibly closed after the 5&'xx'& error message has been sent. For example:
31031 .code
31032 drop   condition = ${if > {$rcpt_count}{20}}
31033        message   = I don't take more than 20 RCPTs
31034 .endd
31035 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31036 The connection is always dropped after sending a 550 response.
31037
31038 .next
31039 .cindex "&%require%& ACL verb"
31040 &%require%&: If all the conditions are met, control is passed to the next ACL
31041 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31042 example, when checking a RCPT command,
31043 .code
31044 require message = Sender did not verify
31045         verify  = sender
31046 .endd
31047 passes control to subsequent statements only if the message's sender can be
31048 verified. Otherwise, it rejects the command. Note the positioning of the
31049 &%message%& modifier, before the &%verify%& condition. The reason for this is
31050 discussed in section &<<SECTcondmodproc>>&.
31051
31052 .next
31053 .cindex "&%warn%& ACL verb"
31054 &%warn%&: If all the conditions are true, a line specified by the
31055 &%log_message%& modifier is written to Exim's main log. Control always passes
31056 to the next ACL statement. If any condition is false, the log line is not
31057 written. If an identical log line is requested several times in the same
31058 message, only one copy is actually written to the log. If you want to force
31059 duplicates to be written, use the &%logwrite%& modifier instead.
31060
31061 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31062 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31063 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31064 first failing condition. There is more about adding header lines in section
31065 &<<SECTaddheadacl>>&.
31066
31067 If any condition on a &%warn%& statement cannot be completed (that is, there is
31068 some sort of defer), the log line specified by &%log_message%& is not written.
31069 This does not include the case of a forced failure from a lookup, which
31070 is considered to be a successful completion. After a defer, no further
31071 conditions or modifiers in the &%warn%& statement are processed. The incident
31072 is logged, and the ACL continues to be processed, from the next statement
31073 onwards.
31074
31075
31076 .vindex "&$acl_verify_message$&"
31077 When one of the &%warn%& conditions is an address verification that fails, the
31078 text of the verification failure message is in &$acl_verify_message$&. If you
31079 want this logged, you must set it up explicitly. For example:
31080 .code
31081 warn   !verify = sender
31082        log_message = sender verify failed: $acl_verify_message
31083 .endd
31084 .endlist
31085
31086 At the end of each ACL there is an implicit unconditional &%deny%&.
31087
31088 As you can see from the examples above, the conditions and modifiers are
31089 written one to a line, with the first one on the same line as the verb, and
31090 subsequent ones on following lines. If you have a very long condition, you can
31091 continue it onto several physical lines by the usual backslash continuation
31092 mechanism. It is conventional to align the conditions vertically.
31093
31094
31095
31096 .section "ACL variables" "SECTaclvariables"
31097 .cindex "&ACL;" "variables"
31098 There are some special variables that can be set during ACL processing. They
31099 can be used to pass information between different ACLs, different invocations
31100 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31101 transports, and filters that are used to deliver a message. The names of these
31102 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31103 an underscore, but the remainder of the name can be any sequence of
31104 alphanumeric characters and underscores that you choose. There is no limit on
31105 the number of ACL variables. The two sets act as follows:
31106 .ilist
31107 The values of those variables whose names begin with &$acl_c$& persist
31108 throughout an SMTP connection. They are never reset. Thus, a value that is set
31109 while receiving one message is still available when receiving the next message
31110 on the same SMTP connection.
31111 .next
31112 The values of those variables whose names begin with &$acl_m$& persist only
31113 while a message is being received. They are reset afterwards. They are also
31114 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31115 .endlist
31116
31117 When a message is accepted, the current values of all the ACL variables are
31118 preserved with the message and are subsequently made available at delivery
31119 time. The ACL variables are set by a modifier called &%set%&. For example:
31120 .code
31121 accept hosts = whatever
31122        set acl_m4 = some value
31123 accept authenticated = *
31124        set acl_c_auth = yes
31125 .endd
31126 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31127 be set. If you want to set a variable without taking any action, you can use a
31128 &%warn%& verb without any other modifiers or conditions.
31129
31130 .oindex &%strict_acl_vars%&
31131 What happens if a syntactically valid but undefined ACL variable is
31132 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31133 false (the default), an empty string is substituted; if it is true, an
31134 error is generated.
31135
31136 Versions of Exim before 4.64 have a limited set of numbered variables, but
31137 their names are compatible, so there is no problem with upgrading.
31138
31139
31140 .section "Condition and modifier processing" "SECTcondmodproc"
31141 .cindex "&ACL;" "conditions; processing"
31142 .cindex "&ACL;" "modifiers; processing"
31143 An exclamation mark preceding a condition negates its result. For example:
31144 .code
31145 deny   domains = *.dom.example
31146       !verify  = recipient
31147 .endd
31148 causes the ACL to return &"deny"& if the recipient domain ends in
31149 &'dom.example'& and the recipient address cannot be verified. Sometimes
31150 negation can be used on the right-hand side of a condition. For example, these
31151 two statements are equivalent:
31152 .code
31153 deny  hosts = !192.168.3.4
31154 deny !hosts =  192.168.3.4
31155 .endd
31156 However, for many conditions (&%verify%& being a good example), only left-hand
31157 side negation of the whole condition is possible.
31158
31159 The arguments of conditions and modifiers are expanded. A forced failure
31160 of an expansion causes a condition to be ignored, that is, it behaves as if the
31161 condition is true. Consider these two statements:
31162 .code
31163 accept  senders = ${lookup{$host_name}lsearch\
31164                   {/some/file}{$value}fail}
31165 accept  senders = ${lookup{$host_name}lsearch\
31166                   {/some/file}{$value}{}}
31167 .endd
31168 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31169 the returned list is searched, but if the lookup fails the behaviour is
31170 different in the two cases. The &%fail%& in the first statement causes the
31171 condition to be ignored, leaving no further conditions. The &%accept%& verb
31172 therefore succeeds. The second statement, however, generates an empty list when
31173 the lookup fails. No sender can match an empty list, so the condition fails,
31174 and therefore the &%accept%& also fails.
31175
31176 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31177 specify actions that are taken as the conditions for a statement are checked;
31178 others specify text for messages that are used when access is denied or a
31179 warning is generated. The &%control%& modifier affects the way an incoming
31180 message is handled.
31181
31182 The positioning of the modifiers in an ACL statement is important, because the
31183 processing of a verb ceases as soon as its outcome is known. Only those
31184 modifiers that have already been encountered will take effect. For example,
31185 consider this use of the &%message%& modifier:
31186 .code
31187 require message = Can't verify sender
31188         verify  = sender
31189         message = Can't verify recipient
31190         verify  = recipient
31191         message = This message cannot be used
31192 .endd
31193 If sender verification fails, Exim knows that the result of the statement is
31194 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31195 so its text is used as the error message. If sender verification succeeds, but
31196 recipient verification fails, the second message is used. If recipient
31197 verification succeeds, the third message becomes &"current"&, but is never used
31198 because there are no more conditions to cause failure.
31199
31200 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31201 modifier that is used, because all the conditions must be true for rejection to
31202 happen. Specifying more than one &%message%& modifier does not make sense, and
31203 the message can even be specified after all the conditions. For example:
31204 .code
31205 deny   hosts = ...
31206       !senders = *@my.domain.example
31207        message = Invalid sender from client host
31208 .endd
31209 The &"deny"& result does not happen until the end of the statement is reached,
31210 by which time Exim has set up the message.
31211
31212
31213
31214 .section "ACL modifiers" "SECTACLmodi"
31215 .cindex "&ACL;" "modifiers; list of"
31216 The ACL modifiers are as follows:
31217
31218 .vlist
31219 .vitem &*add_header*&&~=&~<&'text'&>
31220 This modifier specifies one or more header lines that are to be added to an
31221 incoming message, assuming, of course, that the message is ultimately
31222 accepted. For details, see section &<<SECTaddheadacl>>&.
31223
31224 .vitem &*continue*&&~=&~<&'text'&>
31225 .cindex "&%continue%& ACL modifier"
31226 .cindex "database" "updating in ACL"
31227 This modifier does nothing of itself, and processing of the ACL always
31228 continues with the next condition or modifier. The value of &%continue%& is in
31229 the side effects of expanding its argument. Typically this could be used to
31230 update a database. It is really just a syntactic tidiness, to avoid having to
31231 write rather ugly lines like this:
31232 .display
31233 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31234 .endd
31235 Instead, all you need is
31236 .display
31237 &`continue = `&<&'some expansion'&>
31238 .endd
31239
31240 .vitem &*control*&&~=&~<&'text'&>
31241 .cindex "&%control%& ACL modifier"
31242 This modifier affects the subsequent processing of the SMTP connection or of an
31243 incoming message that is accepted. The effect of the first type of control
31244 lasts for the duration of the connection, whereas the effect of the second type
31245 lasts only until the current message has been received. The message-specific
31246 controls always apply to the whole message, not to individual recipients,
31247 even if the &%control%& modifier appears in a RCPT ACL.
31248
31249 As there are now quite a few controls that can be applied, they are described
31250 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31251 in several different ways. For example:
31252
31253 . ==== As this is a nested list, any displays it contains must be indented
31254 . ==== as otherwise they are too far to the left. That comment applies only
31255 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31256 . ==== way.
31257
31258 .ilist
31259 It can be at the end of an &%accept%& statement:
31260 .code
31261     accept  ...some conditions
31262             control = queue
31263 .endd
31264 In this case, the control is applied when this statement yields &"accept"&, in
31265 other words, when the conditions are all true.
31266
31267 .next
31268 It can be in the middle of an &%accept%& statement:
31269 .code
31270     accept  ...some conditions...
31271             control = queue
31272             ...some more conditions...
31273 .endd
31274 If the first set of conditions are true, the control is applied, even if the
31275 statement does not accept because one of the second set of conditions is false.
31276 In this case, some subsequent statement must yield &"accept"& for the control
31277 to be relevant.
31278
31279 .next
31280 It can be used with &%warn%& to apply the control, leaving the
31281 decision about accepting or denying to a subsequent verb. For
31282 example:
31283 .code
31284     warn    ...some conditions...
31285             control = freeze
31286     accept  ...
31287 .endd
31288 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31289 &%logwrite%&, so it does not add anything to the message and does not write a
31290 log entry.
31291
31292 .next
31293 If you want to apply a control unconditionally, you can use it with a
31294 &%require%& verb. For example:
31295 .code
31296     require  control = no_multiline_responses
31297 .endd
31298 .endlist
31299
31300 .vitem &*delay*&&~=&~<&'time'&>
31301 .cindex "&%delay%& ACL modifier"
31302 .oindex "&%-bh%&"
31303 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31304 the time interval before proceeding. However, when testing Exim using the
31305 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31306 output instead). The time is given in the usual Exim notation, and the delay
31307 happens as soon as the modifier is processed. In an SMTP session, pending
31308 output is flushed before the delay is imposed.
31309
31310 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31311 example:
31312 .code
31313 deny    ...some conditions...
31314         delay = 30s
31315 .endd
31316 The delay happens if all the conditions are true, before the statement returns
31317 &"deny"&. Compare this with:
31318 .code
31319 deny    delay = 30s
31320         ...some conditions...
31321 .endd
31322 which waits for 30s before processing the conditions. The &%delay%& modifier
31323 can also be used with &%warn%& and together with &%control%&:
31324 .code
31325 warn    ...some conditions...
31326         delay = 2m
31327         control = freeze
31328 accept  ...
31329 .endd
31330
31331 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31332 responses to several commands are no longer buffered and sent in one packet (as
31333 they would normally be) because all output is flushed before imposing the
31334 delay. This optimization is disabled so that a number of small delays do not
31335 appear to the client as one large aggregated delay that might provoke an
31336 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31337 using a &%control%& modifier to set &%no_delay_flush%&.
31338
31339
31340 .vitem &*endpass*&
31341 .cindex "&%endpass%& ACL modifier"
31342 This modifier, which has no argument, is recognized only in &%accept%& and
31343 &%discard%& statements. It marks the boundary between the conditions whose
31344 failure causes control to pass to the next statement, and the conditions whose
31345 failure causes the ACL to return &"deny"&. This concept has proved to be
31346 confusing to some people, so the use of &%endpass%& is no longer recommended as
31347 &"best practice"&. See the description of &%accept%& above for more details.
31348
31349
31350 .vitem &*log_message*&&~=&~<&'text'&>
31351 .cindex "&%log_message%& ACL modifier"
31352 This modifier sets up a message that is used as part of the log message if the
31353 ACL denies access or a &%warn%& statement's conditions are true. For example:
31354 .code
31355 require log_message = wrong cipher suite $tls_in_cipher
31356         encrypted   = DES-CBC3-SHA
31357 .endd
31358 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31359 example:
31360 .display
31361 &`discard `&<&'some conditions'&>
31362 &`        log_message = Discarded $local_part@$domain because...`&
31363 .endd
31364 When access is denied, &%log_message%& adds to any underlying error message
31365 that may exist because of a condition failure. For example, while verifying a
31366 recipient address, a &':fail:'& redirection might have already set up a
31367 message.
31368
31369 The message may be defined before the conditions to which it applies, because
31370 the string expansion does not happen until Exim decides that access is to be
31371 denied. This means that any variables that are set by the condition are
31372 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31373 variables are set after a DNS black list lookup succeeds. If the expansion of
31374 &%log_message%& fails, or if the result is an empty string, the modifier is
31375 ignored.
31376
31377 .vindex "&$acl_verify_message$&"
31378 If you want to use a &%warn%& statement to log the result of an address
31379 verification, you can use &$acl_verify_message$& to include the verification
31380 error message.
31381
31382 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31383 the start of the logged message. If the same warning log message is requested
31384 more than once while receiving  a single email message, only one copy is
31385 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31386 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31387 is logged for a successful &%warn%& statement.
31388
31389 If &%log_message%& is not present and there is no underlying error message (for
31390 example, from the failure of address verification), but &%message%& is present,
31391 the &%message%& text is used for logging rejections. However, if any text for
31392 logging contains newlines, only the first line is logged. In the absence of
31393 both &%log_message%& and &%message%&, a default built-in message is used for
31394 logging rejections.
31395
31396
31397 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31398 .cindex "&%log_reject_target%& ACL modifier"
31399 .cindex "logging in ACL" "specifying which log"
31400 This modifier makes it possible to specify which logs are used for messages
31401 about ACL rejections. Its argument is a colon-separated list of words that can
31402 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31403 may be empty, in which case a rejection is not logged at all. For example, this
31404 ACL fragment writes no logging information when access is denied:
31405 .display
31406 &`deny `&<&'some conditions'&>
31407 &`     log_reject_target =`&
31408 .endd
31409 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31410 permanent and temporary rejections. Its effect lasts for the rest of the
31411 current ACL.
31412
31413
31414 .vitem &*logwrite*&&~=&~<&'text'&>
31415 .cindex "&%logwrite%& ACL modifier"
31416 .cindex "logging in ACL" "immediate"
31417 This modifier writes a message to a log file as soon as it is encountered when
31418 processing an ACL. (Compare &%log_message%&, which, except in the case of
31419 &%warn%& and &%discard%&, is used only if the ACL statement denies
31420 access.) The &%logwrite%& modifier can be used to log special incidents in
31421 ACLs. For example:
31422 .display
31423 &`accept `&<&'some special conditions'&>
31424 &`       control  = freeze`&
31425 &`       logwrite = froze message because ...`&
31426 .endd
31427 By default, the message is written to the main log. However, it may begin
31428 with a colon, followed by a comma-separated list of log names, and then
31429 another colon, to specify exactly which logs are to be written. For
31430 example:
31431 .code
31432 logwrite = :main,reject: text for main and reject logs
31433 logwrite = :panic: text for panic log only
31434 .endd
31435
31436
31437 .vitem &*message*&&~=&~<&'text'&>
31438 .cindex "&%message%& ACL modifier"
31439 This modifier sets up a text string that is expanded and used as a response
31440 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31441 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31442 there is some complication if &%endpass%& is involved; see the description of
31443 &%accept%& for details.)
31444
31445 The expansion of the message happens at the time Exim decides that the ACL is
31446 to end, not at the time it processes &%message%&. If the expansion fails, or
31447 generates an empty string, the modifier is ignored. Here is an example where
31448 &%message%& must be specified first, because the ACL ends with a rejection if
31449 the &%hosts%& condition fails:
31450 .code
31451 require  message = Host not recognized
31452          hosts = 10.0.0.0/8
31453 .endd
31454 (Once a condition has failed, no further conditions or modifiers are
31455 processed.)
31456
31457 .cindex "SMTP" "error codes"
31458 .oindex "&%smtp_banner%&
31459 For ACLs that are triggered by SMTP commands, the message is returned as part
31460 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31461 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31462 is accepted. In the case of the connect ACL, accepting with a message modifier
31463 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31464 accept message may not contain more than one line (otherwise it will be
31465 truncated at the first newline and a panic logged), and it cannot affect the
31466 EHLO options.
31467
31468 When SMTP is involved, the message may begin with an overriding response code,
31469 consisting of three digits optionally followed by an &"extended response code"&
31470 of the form &'n.n.n'&, each code being followed by a space. For example:
31471 .code
31472 deny  message = 599 1.2.3 Host not welcome
31473       hosts = 192.168.34.0/24
31474 .endd
31475 The first digit of the supplied response code must be the same as would be sent
31476 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31477 access, but for the predata ACL, note that the default success code is 354, not
31478 2&'xx'&.
31479
31480 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31481 the message modifier cannot override the 221 response code.
31482
31483 The text in a &%message%& modifier is literal; any quotes are taken as
31484 literals, but because the string is expanded, backslash escapes are processed
31485 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31486 response.
31487
31488 .vindex "&$acl_verify_message$&"
31489 While the text is being expanded, the &$acl_verify_message$& variable
31490 contains any message previously set.
31491 Afterwards, &$acl_verify_message$& is cleared.
31492
31493 If &%message%& is used on a statement that verifies an address, the message
31494 specified overrides any message that is generated by the verification process.
31495 However, the original message is available in the variable
31496 &$acl_verify_message$&, so you can incorporate it into your message if you
31497 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31498 routers to be passed back as part of the SMTP response, you should either not
31499 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31500
31501 For compatibility with previous releases of Exim, a &%message%& modifier that
31502 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31503 modifier, but this usage is now deprecated. However, &%message%& acts only when
31504 all the conditions are true, wherever it appears in an ACL command, whereas
31505 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31506 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31507 effect.
31508
31509
31510 .vitem &*queue*&&~=&~<&'text'&>
31511 .cindex "&%queue%& ACL modifier"
31512 .cindex "named queues" "selecting in ACL"
31513 This modifier specifies the use of a named queue for spool files
31514 for the message.
31515 It can only be used before the message is received (i.e. not in
31516 the DATA ACL).
31517 This could be used, for example, for known high-volume burst sources
31518 of traffic, or for quarantine of messages.
31519 Separate queue-runner processes will be needed for named queues.
31520 If the text after expansion is empty, the default queue is used.
31521
31522
31523 .vitem &*remove_header*&&~=&~<&'text'&>
31524 This modifier specifies one or more header names in a colon-separated list
31525  that are to be removed from an incoming message, assuming, of course, that
31526 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31527
31528
31529 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31530 .cindex "&%set%& ACL modifier"
31531 This modifier puts a value into one of the ACL variables (see section
31532 &<<SECTaclvariables>>&).
31533
31534
31535 .vitem &*udpsend*&&~=&~<&'parameters'&>
31536 .cindex "UDP communications"
31537 This modifier sends a UDP packet, for purposes such as statistics
31538 collection or behaviour monitoring. The parameters are expanded, and
31539 the result of the expansion must be a colon-separated list consisting
31540 of a destination server, port number, and the packet contents. The
31541 server can be specified as a host name or IPv4 or IPv6 address. The
31542 separator can be changed with the usual angle bracket syntax. For
31543 example, you might want to collect information on which hosts connect
31544 when:
31545 .code
31546 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31547              $tod_zulu $sender_host_address
31548 .endd
31549 .endlist
31550
31551
31552
31553
31554 .section "Use of the control modifier" "SECTcontrols"
31555 .cindex "&%control%& ACL modifier"
31556 The &%control%& modifier supports the following settings:
31557
31558 .vlist
31559 .vitem &*control&~=&~allow_auth_unadvertised*&
31560 This modifier allows a client host to use the SMTP AUTH command even when it
31561 has not been advertised in response to EHLO. Furthermore, because there are
31562 apparently some really broken clients that do this, Exim will accept AUTH after
31563 HELO (rather than EHLO) when this control is set. It should be used only if you
31564 really need it, and you should limit its use to those broken clients that do
31565 not work without it. For example:
31566 .code
31567 warn hosts   = 192.168.34.25
31568      control = allow_auth_unadvertised
31569 .endd
31570 Normally, when an Exim server receives an AUTH command, it checks the name of
31571 the authentication mechanism that is given in the command to ensure that it
31572 matches an advertised mechanism. When this control is set, the check that a
31573 mechanism has been advertised is bypassed. Any configured mechanism can be used
31574 by the client. This control is permitted only in the connection and HELO ACLs.
31575
31576
31577 .vitem &*control&~=&~caseful_local_part*& &&&
31578        &*control&~=&~caselower_local_part*&
31579 .cindex "&ACL;" "case of local part in"
31580 .cindex "case of local parts"
31581 .vindex "&$local_part$&"
31582 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31583 (that is, during RCPT processing). By default, the contents of &$local_part$&
31584 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31585 any uppercase letters in the original local part are restored in &$local_part$&
31586 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31587 is encountered.
31588
31589 These controls affect only the current recipient. Moreover, they apply only to
31590 local part handling that takes place directly in the ACL (for example, as a key
31591 in lookups). If a test to verify the recipient is obeyed, the case-related
31592 handling of the local part during the verification is controlled by the router
31593 configuration (see the &%caseful_local_part%& generic router option).
31594
31595 This facility could be used, for example, to add a spam score to local parts
31596 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31597 spam score:
31598 .code
31599 warn  control = caseful_local_part
31600       set acl_m4 = ${eval:\
31601                      $acl_m4 + \
31602                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31603                     }
31604       control = caselower_local_part
31605 .endd
31606 Notice that we put back the lower cased version afterwards, assuming that
31607 is what is wanted for subsequent tests.
31608
31609
31610 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31611 .cindex "&ACL;" "cutthrough routing"
31612 .cindex "cutthrough" "requesting"
31613 This option requests delivery be attempted while the item is being received.
31614
31615 The option is usable in the RCPT ACL.
31616 If enabled for a message received via smtp and routed to an smtp transport,
31617 and only one transport, interface, destination host and port combination
31618 is used for all recipients of the message,
31619 then the delivery connection is made while the receiving connection is open
31620 and data is copied from one to the other.
31621
31622 An attempt to set this option for any recipient but the first
31623 for a mail will be quietly ignored.
31624 If a recipient-verify callout
31625 (with use_sender)
31626 connection is subsequently
31627 requested in the same ACL it is held open and used for
31628 any subsequent recipients and the data,
31629 otherwise one is made after the initial RCPT ACL completes.
31630
31631 Note that routers are used in verify mode,
31632 and cannot depend on content of received headers.
31633 Note also that headers cannot be
31634 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31635 Headers may be modified by routers (subject to the above) and transports.
31636 The &'Received-By:'& header is generated as soon as the body reception starts,
31637 rather than the traditional time after the full message is received;
31638 this will affect the timestamp.
31639
31640 All the usual ACLs are called; if one results in the message being
31641 rejected, all effort spent in delivery (including the costs on
31642 the ultimate destination) will be wasted.
31643 Note that in the case of data-time ACLs this includes the entire
31644 message body.
31645
31646 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31647 of outgoing messages is done, because it sends data to the ultimate destination
31648 before the entire message has been received from the source.
31649 It is not supported for messages received with the SMTP PRDR
31650 or CHUNKING
31651 options in use.
31652
31653 Should the ultimate destination system positively accept or reject the mail,
31654 a corresponding indication is given to the source system and nothing is queued.
31655 If the item is successfully delivered in cutthrough mode
31656 the delivery log lines are tagged with ">>" rather than "=>" and appear
31657 before the acceptance "<=" line.
31658
31659 If there is a temporary error the item is queued for later delivery in the
31660 usual fashion.
31661 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31662 to the control; the default value is &"spool"& and the alternate value
31663 &"pass"& copies an SMTP defer response from the target back to the initiator
31664 and does not queue the message.
31665 Note that this is independent of any recipient verify conditions in the ACL.
31666
31667 Delivery in this mode avoids the generation of a bounce mail to a
31668 (possibly faked)
31669 sender when the destination system is doing content-scan based rejection.
31670
31671
31672 .vitem &*control&~=&~debug/*&<&'options'&>
31673 .cindex "&ACL;" "enabling debug logging"
31674 .cindex "debugging" "enabling from an ACL"
31675 This control turns on debug logging, almost as though Exim had been invoked
31676 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31677 by default called &'debuglog'&.
31678
31679 Logging set up by the control will be maintained across spool residency.
31680
31681 Options are a slash-separated list.
31682 If an option takes an argument, the option name and argument are separated by
31683 an equals character.
31684 Several options are supported:
31685 .display
31686 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31687                      The argument, which may access any variables already defined,
31688                      is appended to the default name.
31689
31690 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31691                      using the same values as the &`-d`& command-line option.
31692
31693 stop                 Logging started with this control may be
31694                      stopped by using this option.
31695
31696 kill                 Logging started with this control may be
31697                      stopped by using this option.
31698                      Additionally the debug file will be removed,
31699                      providing one means for speculative debug tracing.
31700
31701 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31702                      for pre-trigger debug capture.
31703                      Debug lines are recorded in the buffer until
31704                      and if) a trigger occurs; at which time they are
31705                      dumped to the debug file.  Newer lines displace the
31706                      oldest if the buffer is full.  After a trigger,
31707                      immediate writes to file are done as normal.
31708
31709 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31710                      see above) to be copied to file.  A reason of &*now*&
31711                      take effect immediately; one of &*paniclog*& triggers
31712                      on a write to the panic log.
31713 .endd
31714
31715 Some examples (which depend on variables that don't exist in all
31716 contexts):
31717 .code
31718       control = debug
31719       control = debug/tag=.$sender_host_address
31720       control = debug/opts=+expand+acl
31721       control = debug/tag=.$message_exim_id/opts=+expand
31722       control = debug/kill
31723       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31724       control = debug/trigger=now
31725 .endd
31726
31727
31728 .vitem &*control&~=&~dkim_disable_verify*&
31729 .cindex "disable DKIM verify"
31730 .cindex "DKIM" "disable verify"
31731 This control turns off DKIM verification processing entirely.  For details on
31732 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31733
31734
31735 .vitem &*control&~=&~dmarc_disable_verify*&
31736 .cindex "disable DMARC verify"
31737 .cindex "DMARC" "disable verify"
31738 This control turns off DMARC verification processing entirely.  For details on
31739 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31740
31741
31742 .vitem &*control&~=&~dscp/*&<&'value'&>
31743 .cindex "&ACL;" "setting DSCP value"
31744 .cindex "DSCP" "inbound"
31745 This option causes the DSCP value associated with the socket for the inbound
31746 connection to be adjusted to a given value, given as one of a number of fixed
31747 strings or to numeric value.
31748 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31749 Common values include &`throughput`&, &`mincost`&, and on newer systems
31750 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31751
31752 The outbound packets from Exim will be marked with this value in the header
31753 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31754 that these values will have any effect, not be stripped by networking
31755 equipment, or do much of anything without cooperation with your Network
31756 Engineer and those of all network operators between the source and destination.
31757
31758
31759 .vitem &*control&~=&~enforce_sync*& &&&
31760        &*control&~=&~no_enforce_sync*&
31761 .cindex "SMTP" "synchronization checking"
31762 .cindex "synchronization checking in SMTP"
31763 These controls make it possible to be selective about when SMTP synchronization
31764 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31765 state of the switch (it is true by default). See the description of this option
31766 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31767
31768 The effect of these two controls lasts for the remainder of the SMTP
31769 connection. They can appear in any ACL except the one for the non-SMTP
31770 messages. The most straightforward place to put them is in the ACL defined by
31771 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31772 before the first synchronization check. The expected use is to turn off the
31773 synchronization checks for badly-behaved hosts that you nevertheless need to
31774 work with.
31775
31776
31777 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31778 .cindex "fake defer"
31779 .cindex "defer, fake"
31780 This control works in exactly the same way as &%fakereject%& (described below)
31781 except that it causes an SMTP 450 response after the message data instead of a
31782 550 response. You must take care when using &%fakedefer%& because it causes the
31783 messages to be duplicated when the sender retries. Therefore, you should not
31784 use &%fakedefer%& if the message is to be delivered normally.
31785
31786 .vitem &*control&~=&~fakereject/*&<&'message'&>
31787 .cindex "fake rejection"
31788 .cindex "rejection, fake"
31789 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31790 words, only when an SMTP message is being received. If Exim accepts the
31791 message, instead the final 250 response, a 550 rejection message is sent.
31792 However, Exim proceeds to deliver the message as normal. The control applies
31793 only to the current message, not to any subsequent ones that may be received in
31794 the same SMTP connection.
31795
31796 The text for the 550 response is taken from the &%control%& modifier. If no
31797 message is supplied, the following is used:
31798 .code
31799 550-Your message has been rejected but is being
31800 550-kept for evaluation.
31801 550-If it was a legitimate message, it may still be
31802 550 delivered to the target recipient(s).
31803 .endd
31804 This facility should be used with extreme caution.
31805
31806 .vitem &*control&~=&~freeze*&
31807 .cindex "frozen messages" "forcing in ACL"
31808 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31809 other words, only when a message is being received. If the message is accepted,
31810 it is placed on Exim's queue and frozen. The control applies only to the
31811 current message, not to any subsequent ones that may be received in the same
31812 SMTP connection.
31813
31814 This modifier can optionally be followed by &`/no_tell`&. If the global option
31815 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31816 is told about the freezing), provided all the &*control=freeze*& modifiers that
31817 are obeyed for the current message have the &`/no_tell`& option.
31818
31819 .vitem &*control&~=&~no_delay_flush*&
31820 .cindex "SMTP" "output flushing, disabling for delay"
31821 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31822 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31823 use. This control, as long as it is encountered before the &%delay%& modifier,
31824 disables such output flushing.
31825
31826 .vitem &*control&~=&~no_callout_flush*&
31827 .cindex "SMTP" "output flushing, disabling for callout"
31828 Exim normally flushes SMTP output before performing a callout in an ACL, to
31829 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31830 use. This control, as long as it is encountered before the &%verify%& condition
31831 that causes the callout, disables such output flushing.
31832
31833 .vitem &*control&~=&~no_mbox_unspool*&
31834 This control is available when Exim is compiled with the content scanning
31835 extension. Content scanning may require a copy of the current message, or parts
31836 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31837 or spam scanner. Normally, such copies are deleted when they are no longer
31838 needed. If this control is set, the copies are not deleted. The control applies
31839 only to the current message, not to any subsequent ones that may be received in
31840 the same SMTP connection. It is provided for debugging purposes and is unlikely
31841 to be useful in production.
31842
31843 .vitem &*control&~=&~no_multiline_responses*&
31844 .cindex "multiline responses, suppressing"
31845 This control is permitted for any ACL except the one for non-SMTP messages.
31846 It seems that there are broken clients in use that cannot handle multiline
31847 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31848
31849 If this control is set, multiline SMTP responses from ACL rejections are
31850 suppressed. One way of doing this would have been to put out these responses as
31851 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31852 (&"use multiline responses for more"& it says &-- ha!), and some of the
31853 responses might get close to that. So this facility, which is after all only a
31854 sop to broken clients, is implemented by doing two very easy things:
31855
31856 .ilist
31857 Extra information that is normally output as part of a rejection caused by
31858 sender verification failure is omitted. Only the final line (typically &"sender
31859 verification failed"&) is sent.
31860 .next
31861 If a &%message%& modifier supplies a multiline response, only the first
31862 line is output.
31863 .endlist
31864
31865 The setting of the switch can, of course, be made conditional on the
31866 calling host. Its effect lasts until the end of the SMTP connection.
31867
31868 .vitem &*control&~=&~no_pipelining*&
31869 .cindex "PIPELINING" "suppressing advertising"
31870 .cindex "ESMTP extensions" PIPELINING
31871 This control turns off the advertising of the PIPELINING extension to SMTP in
31872 the current session. To be useful, it must be obeyed before Exim sends its
31873 response to an EHLO command. Therefore, it should normally appear in an ACL
31874 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31875 &%pipelining_advertise_hosts%&.
31876
31877 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31878        &*control&~=&~queue_only*&
31879 .oindex "&%queue%&"
31880 .oindex "&%queue_only%&"
31881 .cindex "queueing incoming messages"
31882 .cindex queueing "forcing in ACL"
31883 .cindex "first pass routing"
31884 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31885 other words, only when a message is being received. If the message is accepted,
31886 it is placed on Exim's queue and left there for delivery by a subsequent queue
31887 runner.
31888 If used with no options set,
31889 no immediate delivery process is started. In other words, it has the
31890 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31891
31892 If the &'first_pass_route'& option is given then
31893 the behaviour is like the command-line &'-oqds'& option;
31894 a delivery process is started which stops short of making
31895 any SMTP delivery.  The benefit is that the hints database will be updated for
31896 the message being waiting for a specific host, and a later queue run will be
31897 able to send all such messages on a single connection.
31898
31899 The control only applies to the current message, not to any subsequent ones that
31900  may be received in the same SMTP connection.
31901
31902 .vitem &*control&~=&~submission/*&<&'options'&>
31903 .cindex "message" "submission"
31904 .cindex "submission mode"
31905 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31906 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31907 the current message is a submission from a local MUA. In this case, Exim
31908 operates in &"submission mode"&, and applies certain fixups to the message if
31909 necessary. For example, it adds a &'Date:'& header line if one is not present.
31910 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31911 late (the message has already been created).
31912
31913 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31914 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31915 submission mode; the available options for this control are described there.
31916 The control applies only to the current message, not to any subsequent ones
31917 that may be received in the same SMTP connection.
31918
31919 .vitem &*control&~=&~suppress_local_fixups*&
31920 .cindex "submission fixups, suppressing"
31921 This control applies to locally submitted (non TCP/IP) messages, and is the
31922 complement of &`control = submission`&. It disables the fixups that are
31923 normally applied to locally-submitted messages. Specifically:
31924
31925 .ilist
31926 Any &'Sender:'& header line is left alone (in this respect, it is a
31927 dynamic version of &%local_sender_retain%&).
31928 .next
31929 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31930 .next
31931 There is no check that &'From:'& corresponds to the actual sender.
31932 .endlist ilist
31933
31934 This control may be useful when a remotely-originated message is accepted,
31935 passed to some scanning program, and then re-submitted for delivery. It can be
31936 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31937 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31938 data is read.
31939
31940 &*Note:*& This control applies only to the current message, not to any others
31941 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31942
31943 .vitem &*control&~=&~utf8_downconvert*&
31944 This control enables conversion of UTF-8 in message envelope addresses
31945 to a-label form.
31946 For details see section &<<SECTi18nMTA>>&.
31947 .endlist vlist
31948
31949
31950 .section "Summary of message fixup control" "SECTsummesfix"
31951 All four possibilities for message fixups can be specified:
31952
31953 .ilist
31954 Locally submitted, fixups applied: the default.
31955 .next
31956 Locally submitted, no fixups applied: use
31957 &`control = suppress_local_fixups`&.
31958 .next
31959 Remotely submitted, no fixups applied: the default.
31960 .next
31961 Remotely submitted, fixups applied: use &`control = submission`&.
31962 .endlist
31963
31964
31965
31966 .section "Adding header lines in ACLs" "SECTaddheadacl"
31967 .cindex "header lines" "adding in an ACL"
31968 .cindex "header lines" "position of added lines"
31969 .cindex "&%add_header%& ACL modifier"
31970 The &%add_header%& modifier can be used to add one or more extra header lines
31971 to an incoming message, as in this example:
31972 .code
31973 warn dnslists = sbl.spamhaus.org : \
31974                 dialup.mail-abuse.org
31975      add_header = X-blacklisted-at: $dnslist_domain
31976 .endd
31977 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31978 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31979 receiving a message). The message must ultimately be accepted for
31980 &%add_header%& to have any significant effect. You can use &%add_header%& with
31981 any ACL verb, including &%deny%& (though this is potentially useful only in a
31982 RCPT ACL).
31983
31984 Headers will not be added to the message if the modifier is used in
31985 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31986
31987 Leading and trailing newlines are removed from
31988 the data for the &%add_header%& modifier; if it then
31989 contains one or more newlines that
31990 are not followed by a space or a tab, it is assumed to contain multiple header
31991 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31992 front of any line that is not a valid header line.
31993
31994 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31995 They are added to the message before processing the DATA and MIME ACLs.
31996 However, if an identical header line is requested more than once, only one copy
31997 is actually added to the message. Further header lines may be accumulated
31998 during the DATA and MIME ACLs, after which they are added to the message, again
31999 with duplicates suppressed. Thus, it is possible to add two identical header
32000 lines to an SMTP message, but only if one is added before DATA and one after.
32001 In the case of non-SMTP messages, new headers are accumulated during the
32002 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32003 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32004 are included in the entry that is written to the reject log.
32005
32006 .cindex "header lines" "added; visibility of"
32007 Header lines are not visible in string expansions
32008 of message headers
32009 until they are added to the
32010 message. It follows that header lines defined in the MAIL, RCPT, and predata
32011 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32012 header lines that are added by the DATA or MIME ACLs are not visible in those
32013 ACLs. Because of this restriction, you cannot use header lines as a way of
32014 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32015 this, you can use ACL variables, as described in section
32016 &<<SECTaclvariables>>&.
32017
32018 The list of headers yet to be added is given by the &%$headers_added%& variable.
32019
32020 The &%add_header%& modifier acts immediately as it is encountered during the
32021 processing of an ACL. Notice the difference between these two cases:
32022 .display
32023 &`accept add_header = ADDED: some text`&
32024 &`       `&<&'some condition'&>
32025
32026 &`accept `&<&'some condition'&>
32027 &`       add_header = ADDED: some text`&
32028 .endd
32029 In the first case, the header line is always added, whether or not the
32030 condition is true. In the second case, the header line is added only if the
32031 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32032 ACL statement. All those that are encountered before a condition fails are
32033 honoured.
32034
32035 .cindex "&%warn%& ACL verb"
32036 For compatibility with previous versions of Exim, a &%message%& modifier for a
32037 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32038 effect only if all the conditions are true, even if it appears before some of
32039 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32040 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32041 are present on a &%warn%& verb, both are processed according to their
32042 specifications.
32043
32044 By default, new header lines are added to a message at the end of the existing
32045 header lines. However, you can specify that any particular header line should
32046 be added right at the start (before all the &'Received:'& lines), immediately
32047 after the first block of &'Received:'& lines, or immediately before any line
32048 that is not a &'Received:'& or &'Resent-something:'& header.
32049
32050 This is done by specifying &":at_start:"&, &":after_received:"&, or
32051 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32052 header line, respectively. (Header text cannot start with a colon, as there has
32053 to be a header name first.) For example:
32054 .code
32055 warn add_header = \
32056        :after_received:X-My-Header: something or other...
32057 .endd
32058 If more than one header line is supplied in a single &%add_header%& modifier,
32059 each one is treated independently and can therefore be placed differently. If
32060 you add more than one line at the start, or after the Received: block, they end
32061 up in reverse order.
32062
32063 &*Warning*&: This facility currently applies only to header lines that are
32064 added in an ACL. It does NOT work for header lines that are added in a
32065 system filter or in a router or transport.
32066
32067
32068
32069 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32070 .cindex "header lines" "removing in an ACL"
32071 .cindex "header lines" "position of removed lines"
32072 .cindex "&%remove_header%& ACL modifier"
32073 The &%remove_header%& modifier can be used to remove one or more header lines
32074 from an incoming message, as in this example:
32075 .code
32076 warn   message        = Remove internal headers
32077        remove_header  = x-route-mail1 : x-route-mail2
32078 .endd
32079 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32080 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32081 receiving a message). The message must ultimately be accepted for
32082 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32083 with any ACL verb, including &%deny%&, though this is really not useful for
32084 any verb that doesn't result in a delivered message.
32085
32086 Headers will not be removed from the message if the modifier is used in
32087 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32088
32089 More than one header can be removed at the same time by using a colon separated
32090 list of header names. The header matching is case insensitive. Wildcards are
32091 not permitted, nor is list expansion performed, so you cannot use hostlists to
32092 create a list of headers, however both connection and message variable expansion
32093 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32094 .code
32095 warn   hosts           = +internal_hosts
32096        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32097 warn   message         = Remove internal headers
32098        remove_header   = $acl_c_ihdrs
32099 .endd
32100 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32101 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32102 If multiple header lines match, all are removed.
32103 There is no harm in attempting to remove the same header twice nor in removing
32104 a non-existent header. Further header lines to be removed may be accumulated
32105 during the DATA and MIME ACLs, after which they are removed from the message,
32106 if present. In the case of non-SMTP messages, headers to be removed are
32107 accumulated during the non-SMTP ACLs, and are removed from the message after
32108 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32109 ACL, there really is no effect because there is no logging of what headers
32110 would have been removed.
32111
32112 .cindex "header lines" "removed; visibility of"
32113 Header lines are not visible in string expansions until the DATA phase when it
32114 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32115 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32116 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32117 this restriction, you cannot use header lines as a way of controlling data
32118 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32119 you should instead use ACL variables, as described in section
32120 &<<SECTaclvariables>>&.
32121
32122 The &%remove_header%& modifier acts immediately as it is encountered during the
32123 processing of an ACL. Notice the difference between these two cases:
32124 .display
32125 &`accept remove_header = X-Internal`&
32126 &`       `&<&'some condition'&>
32127
32128 &`accept `&<&'some condition'&>
32129 &`       remove_header = X-Internal`&
32130 .endd
32131 In the first case, the header line is always removed, whether or not the
32132 condition is true. In the second case, the header line is removed only if the
32133 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32134 same ACL statement. All those that are encountered before a condition fails
32135 are honoured.
32136
32137 &*Warning*&: This facility currently applies only to header lines that are
32138 present during ACL processing. It does NOT remove header lines that are added
32139 in a system filter or in a router or transport.
32140
32141
32142
32143
32144 .section "ACL conditions" "SECTaclconditions"
32145 .cindex "&ACL;" "conditions; list of"
32146 Some of the conditions listed in this section are available only when Exim is
32147 compiled with the content-scanning extension. They are included here briefly
32148 for completeness. More detailed descriptions can be found in the discussion on
32149 content scanning in chapter &<<CHAPexiscan>>&.
32150
32151 Not all conditions are relevant in all circumstances. For example, testing
32152 senders and recipients does not make sense in an ACL that is being run as the
32153 result of the arrival of an ETRN command, and checks on message headers can be
32154 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32155 can use the same condition (with different parameters) more than once in the
32156 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32157 The conditions are as follows:
32158
32159
32160 .vlist
32161 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32162 .cindex "&ACL;" "nested"
32163 .cindex "&ACL;" "indirect"
32164 .cindex "&ACL;" "arguments"
32165 .cindex "&%acl%& ACL condition"
32166 The possible values of the argument are the same as for the
32167 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32168 &"accept"& the condition is true; if it returns &"deny"& the condition is
32169 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32170 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32171 condition false. This means that further processing of the &%warn%& verb
32172 ceases, but processing of the ACL continues.
32173
32174 If the argument is a named ACL, up to nine space-separated optional values
32175 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32176 and $acl_narg is set to the count of values.
32177 Previous values of these variables are restored after the call returns.
32178 The name and values are expanded separately.
32179 Note that spaces in complex expansions which are used as arguments
32180 will act as argument separators.
32181
32182 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32183 the connection is dropped. If it returns &"discard"&, the verb must be
32184 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32185 conditions are tested.
32186
32187 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32188 loops. This condition allows you to use different ACLs in different
32189 circumstances. For example, different ACLs can be used to handle RCPT commands
32190 for different local users or different local domains.
32191
32192 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32193 .cindex "&%authenticated%& ACL condition"
32194 .cindex "authentication" "ACL checking"
32195 .cindex "&ACL;" "testing for authentication"
32196 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32197 the name of the authenticator is tested against the list. To test for
32198 authentication by any authenticator, you can set
32199 .code
32200 authenticated = *
32201 .endd
32202
32203 .vitem &*condition&~=&~*&<&'string'&>
32204 .cindex "&%condition%& ACL condition"
32205 .cindex "customizing" "ACL condition"
32206 .cindex "&ACL;" "customized test"
32207 .cindex "&ACL;" "testing, customized"
32208 This feature allows you to make up custom conditions. If the result of
32209 expanding the string is an empty string, the number zero, or one of the strings
32210 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32211 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32212 any other value, some error is assumed to have occurred, and the ACL returns
32213 &"defer"&. However, if the expansion is forced to fail, the condition is
32214 ignored. The effect is to treat it as true, whether it is positive or
32215 negative.
32216
32217 .vitem &*decode&~=&~*&<&'location'&>
32218 .cindex "&%decode%& ACL condition"
32219 This condition is available only when Exim is compiled with the
32220 content-scanning extension, and it is allowed only in the ACL defined by
32221 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32222 If all goes well, the condition is true. It is false only if there are
32223 problems such as a syntax error or a memory shortage. For more details, see
32224 chapter &<<CHAPexiscan>>&.
32225
32226 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32227 .cindex "&%dnslists%& ACL condition"
32228 .cindex "DNS list" "in ACL"
32229 .cindex "black list (DNS)"
32230 .cindex "&ACL;" "testing a DNS list"
32231 This condition checks for entries in DNS black lists. These are also known as
32232 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32233 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32234 different variants of this condition to describe briefly here. See sections
32235 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32236
32237 .vitem &*domains&~=&~*&<&'domain&~list'&>
32238 .cindex "&%domains%& ACL condition"
32239 .cindex "domain" "ACL checking"
32240 .cindex "&ACL;" "testing a recipient domain"
32241 .vindex "&$domain_data$&"
32242 This condition is relevant only in a RCPT ACL. It checks that the domain
32243 of the recipient address is in the domain list. If percent-hack processing is
32244 enabled, it is done before this test is done. If the check succeeds with a
32245 lookup, the result of the lookup is placed in &$domain_data$& until the next
32246 &%domains%& test.
32247
32248 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32249 use &%domains%& in a DATA ACL.
32250
32251
32252 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32253 .cindex "&%encrypted%& ACL condition"
32254 .cindex "encryption" "checking in an ACL"
32255 .cindex "&ACL;" "testing for encryption"
32256 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32257 name of the cipher suite in use is tested against the list. To test for
32258 encryption without testing for any specific cipher suite(s), set
32259 .code
32260 encrypted = *
32261 .endd
32262
32263
32264 .vitem &*hosts&~=&~*&<&'host&~list'&>
32265 .cindex "&%hosts%& ACL condition"
32266 .cindex "host" "ACL checking"
32267 .cindex "&ACL;" "testing the client host"
32268 This condition tests that the calling host matches the host list. If you have
32269 name lookups or wildcarded host names and IP addresses in the same host list,
32270 you should normally put the IP addresses first. For example, you could have:
32271 .code
32272 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32273 .endd
32274 The lookup in this example uses the host name for its key. This is implied by
32275 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32276 and it wouldn't matter which way round you had these two items.)
32277
32278 The reason for the problem with host names lies in the left-to-right way that
32279 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32280 but when it reaches an item that requires a host name, it fails if it cannot
32281 find a host name to compare with the pattern. If the above list is given in the
32282 opposite order, the &%accept%& statement fails for a host whose name cannot be
32283 found, even if its IP address is 10.9.8.7.
32284
32285 If you really do want to do the name check first, and still recognize the IP
32286 address even if the name lookup fails, you can rewrite the ACL like this:
32287 .code
32288 accept hosts = dbm;/etc/friendly/hosts
32289 accept hosts = 10.9.8.7
32290 .endd
32291 The default action on failing to find the host name is to assume that the host
32292 is not in the list, so the first &%accept%& statement fails. The second
32293 statement can then check the IP address.
32294
32295 .vindex "&$host_data$&"
32296 If a &%hosts%& condition is satisfied by means of a lookup, the result
32297 of the lookup is made available in the &$host_data$& variable. This
32298 allows you, for example, to set up a statement like this:
32299 .code
32300 deny  hosts = net-lsearch;/some/file
32301       message = $host_data
32302 .endd
32303 which gives a custom error message for each denied host.
32304
32305 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32306 .cindex "&%local_parts%& ACL condition"
32307 .cindex "local part" "ACL checking"
32308 .cindex "&ACL;" "testing a local part"
32309 .vindex "&$local_part_data$&"
32310 This condition is relevant only in a RCPT ACL. It checks that the local
32311 part of the recipient address is in the list. If percent-hack processing is
32312 enabled, it is done before this test. If the check succeeds with a lookup, the
32313 result of the lookup is placed in &$local_part_data$&, which remains set until
32314 the next &%local_parts%& test.
32315
32316 .vitem &*malware&~=&~*&<&'option'&>
32317 .cindex "&%malware%& ACL condition"
32318 .cindex "&ACL;" "virus scanning"
32319 .cindex "&ACL;" "scanning for viruses"
32320 This condition is available only when Exim is compiled with the
32321 content-scanning extension
32322 and only after a DATA command.
32323 It causes the incoming message to be scanned for
32324 viruses. For details, see chapter &<<CHAPexiscan>>&.
32325
32326 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32327 .cindex "&%mime_regex%& ACL condition"
32328 .cindex "&ACL;" "testing by regex matching"
32329 This condition is available only when Exim is compiled with the
32330 content-scanning extension, and it is allowed only in the ACL defined by
32331 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32332 with any of the regular expressions. For details, see chapter
32333 &<<CHAPexiscan>>&.
32334
32335 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32336 .cindex "rate limiting"
32337 This condition can be used to limit the rate at which a user or host submits
32338 messages. Details are given in section &<<SECTratelimiting>>&.
32339
32340 .vitem &*recipients&~=&~*&<&'address&~list'&>
32341 .cindex "&%recipients%& ACL condition"
32342 .cindex "recipient" "ACL checking"
32343 .cindex "&ACL;" "testing a recipient"
32344 This condition is relevant only in a RCPT ACL. It checks the entire
32345 recipient address against a list of recipients.
32346
32347 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32348 .cindex "&%regex%& ACL condition"
32349 .cindex "&ACL;" "testing by regex matching"
32350 This condition is available only when Exim is compiled with the
32351 content-scanning extension, and is available only in the DATA, MIME, and
32352 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32353 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32354
32355 .vitem &*seen&~=&~*&<&'parameters'&>
32356 .cindex "&%seen%& ACL condition"
32357 This condition can be used to test if a situation has been previously met,
32358 for example for greylisting.
32359 Details are given in section &<<SECTseen>>&.
32360
32361 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32362 .cindex "&%sender_domains%& ACL condition"
32363 .cindex "sender" "ACL checking"
32364 .cindex "&ACL;" "testing a sender domain"
32365 .vindex "&$domain$&"
32366 .vindex "&$sender_address_domain$&"
32367 This condition tests the domain of the sender of the message against the given
32368 domain list. &*Note*&: The domain of the sender address is in
32369 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32370 of this condition. This is an exception to the general rule for testing domain
32371 lists. It is done this way so that, if this condition is used in an ACL for a
32372 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32373 influence the sender checking.
32374
32375 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32376 relaying, because sender addresses are easily, and commonly, forged.
32377
32378 .vitem &*senders&~=&~*&<&'address&~list'&>
32379 .cindex "&%senders%& ACL condition"
32380 .cindex "sender" "ACL checking"
32381 .cindex "&ACL;" "testing a sender"
32382 This condition tests the sender of the message against the given list. To test
32383 for a bounce message, which has an empty sender, set
32384 .code
32385 senders = :
32386 .endd
32387 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32388 relaying, because sender addresses are easily, and commonly, forged.
32389
32390 .vitem &*spam&~=&~*&<&'username'&>
32391 .cindex "&%spam%& ACL condition"
32392 .cindex "&ACL;" "scanning for spam"
32393 This condition is available only when Exim is compiled with the
32394 content-scanning extension. It causes the incoming message to be scanned by
32395 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32396
32397 .vitem &*verify&~=&~certificate*&
32398 .cindex "&%verify%& ACL condition"
32399 .cindex "TLS" "client certificate verification"
32400 .cindex "certificate" "verification of client"
32401 .cindex "&ACL;" "certificate verification"
32402 .cindex "&ACL;" "testing a TLS certificate"
32403 This condition is true in an SMTP session if the session is encrypted, and a
32404 certificate was received from the client, and the certificate was verified. The
32405 server requests a certificate only if the client matches &%tls_verify_hosts%&
32406 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32407
32408 .vitem &*verify&~=&~csa*&
32409 .cindex "CSA verification"
32410 This condition checks whether the sending host (the client) is authorized to
32411 send email. Details of how this works are given in section
32412 &<<SECTverifyCSA>>&.
32413
32414 .vitem &*verify&~=&~header_names_ascii*&
32415 .cindex "&%verify%& ACL condition"
32416 .cindex "&ACL;" "verifying header names only ASCII"
32417 .cindex "header lines" "verifying header names only ASCII"
32418 .cindex "verifying" "header names only ASCII"
32419 This condition is relevant only in an ACL that is run after a message has been
32420 received.
32421 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32422 It checks all header names (not the content) to make sure
32423 there are no non-ASCII characters, also excluding control characters.  The
32424 allowable characters are decimal ASCII values 33 through 126.
32425
32426 Exim itself will handle headers with non-ASCII characters, but it can cause
32427 problems for downstream applications, so this option will allow their
32428 detection and rejection in the DATA ACL's.
32429
32430 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32431 .cindex "&%verify%& ACL condition"
32432 .cindex "&ACL;" "verifying sender in the header"
32433 .cindex "header lines" "verifying the sender in"
32434 .cindex "sender" "verifying in header"
32435 .cindex "verifying" "sender in header"
32436 This condition is relevant only in an ACL that is run after a message has been
32437 received, that is, in an ACL specified by &%acl_smtp_data%& or
32438 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32439 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32440 is loosely thought of as a &"sender"& address (hence the name of the test).
32441 However, an address that appears in one of these headers need not be an address
32442 that accepts bounce messages; only sender addresses in envelopes are required
32443 to accept bounces. Therefore, if you use the callout option on this check, you
32444 might want to arrange for a non-empty address in the MAIL command.
32445
32446 Details of address verification and the options are given later, starting at
32447 section &<<SECTaddressverification>>& (callouts are described in section
32448 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32449 condition to restrict it to bounce messages only:
32450 .code
32451 deny    senders = :
32452        !verify  = header_sender
32453         message = A valid sender header is required for bounces
32454 .endd
32455
32456 .vitem &*verify&~=&~header_syntax*&
32457 .cindex "&%verify%& ACL condition"
32458 .cindex "&ACL;" "verifying header syntax"
32459 .cindex "header lines" "verifying syntax"
32460 .cindex "verifying" "header syntax"
32461 This condition is relevant only in an ACL that is run after a message has been
32462 received, that is, in an ACL specified by &%acl_smtp_data%& or
32463 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32464 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32465 and &'Bcc:'&), returning true if there are no problems.
32466 Unqualified addresses (local parts without domains) are
32467 permitted only in locally generated messages and from hosts that match
32468 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32469 appropriate.
32470
32471 Note that this condition is a syntax check only. However, a common spamming
32472 ploy used to be to send syntactically invalid headers such as
32473 .code
32474 To: @
32475 .endd
32476 and this condition can be used to reject such messages, though they are not as
32477 common as they used to be.
32478
32479 .vitem &*verify&~=&~helo*&
32480 .cindex "&%verify%& ACL condition"
32481 .cindex "&ACL;" "verifying HELO/EHLO"
32482 .cindex "HELO" "verifying"
32483 .cindex "EHLO" "verifying"
32484 .cindex "verifying" "EHLO"
32485 .cindex "verifying" "HELO"
32486 This condition is true if a HELO or EHLO command has been received from the
32487 client host, and its contents have been verified. If there has been no previous
32488 attempt to verify the HELO/EHLO contents, it is carried out when this
32489 condition is encountered. See the description of the &%helo_verify_hosts%& and
32490 &%helo_try_verify_hosts%& options for details of how to request verification
32491 independently of this condition, and for detail of the verification.
32492
32493 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32494 option), this condition is always true.
32495
32496
32497 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32498 .cindex "verifying" "not blind"
32499 .cindex "bcc recipients, verifying none"
32500 This condition checks that there are no blind (bcc) recipients in the message.
32501 Every envelope recipient must appear either in a &'To:'& header line or in a
32502 &'Cc:'& header line for this condition to be true. Local parts are checked
32503 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32504 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32505 used only in a DATA or non-SMTP ACL.
32506
32507 There is one possible option, &`case_insensitive`&.  If this is present then
32508 local parts are checked case-insensitively.
32509
32510 There are, of course, many legitimate messages that make use of blind (bcc)
32511 recipients. This check should not be used on its own for blocking messages.
32512
32513
32514 .vitem &*verify&~=&~recipient/*&<&'options'&>
32515 .cindex "&%verify%& ACL condition"
32516 .cindex "&ACL;" "verifying recipient"
32517 .cindex "recipient" "verifying"
32518 .cindex "verifying" "recipient"
32519 .vindex "&$address_data$&"
32520 This condition is relevant only after a RCPT command. It verifies the current
32521 recipient. Details of address verification are given later, starting at section
32522 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32523 of &$address_data$& is the last value that was set while routing the address.
32524 This applies even if the verification fails. When an address that is being
32525 verified is redirected to a single address, verification continues with the new
32526 address, and in that case, the subsequent value of &$address_data$& is the
32527 value for the child address.
32528
32529 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32530 .cindex "&%verify%& ACL condition"
32531 .cindex "&ACL;" "verifying host reverse lookup"
32532 .cindex "host" "verifying reverse lookup"
32533 This condition ensures that a verified host name has been looked up from the IP
32534 address of the client host. (This may have happened already if the host name
32535 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32536 Verification ensures that the host name obtained from a reverse DNS lookup, or
32537 one of its aliases, does, when it is itself looked up in the DNS, yield the
32538 original IP address.
32539
32540 There is one possible option, &`defer_ok`&.  If this is present and a
32541 DNS operation returns a temporary error, the verify condition succeeds.
32542
32543 If this condition is used for a locally generated message (that is, when there
32544 is no client host involved), it always succeeds.
32545
32546 .vitem &*verify&~=&~sender/*&<&'options'&>
32547 .cindex "&%verify%& ACL condition"
32548 .cindex "&ACL;" "verifying sender"
32549 .cindex "sender" "verifying"
32550 .cindex "verifying" "sender"
32551 This condition is relevant only after a MAIL or RCPT command, or after a
32552 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32553 the message's sender is empty (that is, this is a bounce message), the
32554 condition is true. Otherwise, the sender address is verified.
32555
32556 .vindex "&$address_data$&"
32557 .vindex "&$sender_address_data$&"
32558 If there is data in the &$address_data$& variable at the end of routing, its
32559 value is placed in &$sender_address_data$& at the end of verification. This
32560 value can be used in subsequent conditions and modifiers in the same ACL
32561 statement. It does not persist after the end of the current statement. If you
32562 want to preserve the value for longer, you can save it in an ACL variable.
32563
32564 Details of verification are given later, starting at section
32565 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32566 to avoid doing it more than once per message.
32567
32568 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32569 .cindex "&%verify%& ACL condition"
32570 This is a variation of the previous option, in which a modified address is
32571 verified as a sender.
32572
32573 Note that '/' is legal in local-parts; if the address may have such
32574 (eg. is generated from the received message)
32575 they must be protected from the options parsing by doubling:
32576 .code
32577 verify = sender=${listquote{/}{${address:$h_sender:}}}
32578 .endd
32579 .endlist
32580
32581
32582
32583 .section "Using DNS lists" "SECTmorednslists"
32584 .cindex "DNS list" "in ACL"
32585 .cindex "black list (DNS)"
32586 .cindex "&ACL;" "testing a DNS list"
32587 In its simplest form, the &%dnslists%& condition tests whether the calling host
32588 is on at least one of a number of DNS lists by looking up the inverted IP
32589 address in one or more DNS domains. (Note that DNS list domains are not mail
32590 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32591 special options instead.) For example, if the calling host's IP
32592 address is 192.168.62.43, and the ACL statement is
32593 .code
32594 deny dnslists = blackholes.mail-abuse.org : \
32595                 dialups.mail-abuse.org
32596 .endd
32597 the following records are looked up:
32598 .code
32599 43.62.168.192.blackholes.mail-abuse.org
32600 43.62.168.192.dialups.mail-abuse.org
32601 .endd
32602 As soon as Exim finds an existing DNS record, processing of the list stops.
32603 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32604 to test that a host is on more than one list (an &"and"& conjunction), you can
32605 use two separate conditions:
32606 .code
32607 deny dnslists = blackholes.mail-abuse.org
32608      dnslists = dialups.mail-abuse.org
32609 .endd
32610 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32611 behaves as if the host does not match the list item, that is, as if the DNS
32612 record does not exist. If there are further items in the DNS list, they are
32613 processed.
32614
32615 This is usually the required action when &%dnslists%& is used with &%deny%&
32616 (which is the most common usage), because it prevents a DNS failure from
32617 blocking mail. However, you can change this behaviour by putting one of the
32618 following special items in the list:
32619 .itable none 0 0 2 25* left 75* left
32620 .irow "+include_unknown"   "behave as if the item is on the list"
32621 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32622 .irow "+defer_unknown  "   "give a temporary error"
32623 .endtable
32624 .cindex "&`+include_unknown`&"
32625 .cindex "&`+exclude_unknown`&"
32626 .cindex "&`+defer_unknown`&"
32627 Each of these applies to any subsequent items on the list. For example:
32628 .code
32629 deny dnslists = +defer_unknown : foo.bar.example
32630 .endd
32631 Testing the list of domains stops as soon as a match is found. If you want to
32632 warn for one list and block for another, you can use two different statements:
32633 .code
32634 deny  dnslists = blackholes.mail-abuse.org
32635 warn  dnslists = dialups.mail-abuse.org
32636       message  = X-Warn: sending host is on dialups list
32637 .endd
32638 .cindex caching "of dns lookup"
32639 .cindex DNS TTL
32640 DNS list lookups are cached by Exim for the duration of the SMTP session
32641 (but limited by the DNS return TTL value),
32642 so a lookup based on the IP address is done at most once for any incoming
32643 connection (assuming long-enough TTL).
32644 Exim does not share information between multiple incoming
32645 connections (but your local name server cache should be active).
32646
32647 There are a number of DNS lists to choose from, some commercial, some free,
32648 or free for small deployments.  An overview can be found at
32649 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32650
32651
32652
32653 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32654 .cindex "DNS list" "keyed by explicit IP address"
32655 By default, the IP address that is used in a DNS list lookup is the IP address
32656 of the calling host. However, you can specify another IP address by listing it
32657 after the domain name, introduced by a slash. For example:
32658 .code
32659 deny dnslists = black.list.tld/192.168.1.2
32660 .endd
32661 This feature is not very helpful with explicit IP addresses; it is intended for
32662 use with IP addresses that are looked up, for example, the IP addresses of the
32663 MX hosts or nameservers of an email sender address. For an example, see section
32664 &<<SECTmulkeyfor>>& below.
32665
32666
32667
32668
32669 .subsection "DNS lists keyed on domain names" SECID202
32670 .cindex "DNS list" "keyed by domain name"
32671 There are some lists that are keyed on domain names rather than inverted IP
32672 addresses (see, e.g., the &'domain based zones'& link at
32673 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32674 with these lists. You can change the name that is looked up in a DNS list by
32675 listing it after the domain name, introduced by a slash. For example,
32676 .code
32677 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32678       message  = Sender's domain is listed at $dnslist_domain
32679 .endd
32680 This particular example is useful only in ACLs that are obeyed after the
32681 RCPT or DATA commands, when a sender address is available. If (for
32682 example) the message's sender is &'user@tld.example'& the name that is looked
32683 up by this example is
32684 .code
32685 tld.example.dsn.rfc-ignorant.org
32686 .endd
32687 A single &%dnslists%& condition can contain entries for both names and IP
32688 addresses. For example:
32689 .code
32690 deny dnslists = sbl.spamhaus.org : \
32691                 dsn.rfc-ignorant.org/$sender_address_domain
32692 .endd
32693 The first item checks the sending host's IP address; the second checks a domain
32694 name. The whole condition is true if either of the DNS lookups succeeds.
32695
32696
32697
32698
32699 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32700 .cindex "DNS list" "multiple keys for"
32701 The syntax described above for looking up explicitly-defined values (either
32702 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32703 name for the DNS list, what follows the slash can in fact be a list of items.
32704 As with all lists in Exim, the default separator is a colon. However, because
32705 this is a sublist within the list of DNS blacklist domains, it is necessary
32706 either to double the separators like this:
32707 .code
32708 dnslists = black.list.tld/name.1::name.2
32709 .endd
32710 or to change the separator character, like this:
32711 .code
32712 dnslists = black.list.tld/<;name.1;name.2
32713 .endd
32714 If an item in the list is an IP address, it is inverted before the DNS
32715 blacklist domain is appended. If it is not an IP address, no inversion
32716 occurs. Consider this condition:
32717 .code
32718 dnslists = black.list.tld/<;192.168.1.2;a.domain
32719 .endd
32720 The DNS lookups that occur are:
32721 .code
32722 2.1.168.192.black.list.tld
32723 a.domain.black.list.tld
32724 .endd
32725 Once a DNS record has been found (that matches a specific IP return
32726 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32727 are done. If there is a temporary DNS error, the rest of the sublist of domains
32728 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32729 only if no other DNS lookup in this sublist succeeds. In other words, a
32730 successful lookup for any of the items in the sublist overrides a temporary
32731 error for a previous item.
32732
32733 The ability to supply a list of items after the slash is in some sense just a
32734 syntactic convenience. These two examples have the same effect:
32735 .code
32736 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32737 dnslists = black.list.tld/a.domain::b.domain
32738 .endd
32739 However, when the data for the list is obtained from a lookup, the second form
32740 is usually much more convenient. Consider this example:
32741 .code
32742 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32743                                    ${lookup dnsdb {>|mxh=\
32744                                    $sender_address_domain} }} }
32745      message  = The mail servers for the domain \
32746                 $sender_address_domain \
32747                 are listed at $dnslist_domain ($dnslist_value); \
32748                 see $dnslist_text.
32749 .endd
32750 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32751 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32752 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32753 of expanding the condition might be something like this:
32754 .code
32755 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32756 .endd
32757 Thus, this example checks whether or not the IP addresses of the sender
32758 domain's mail servers are on the Spamhaus black list.
32759
32760 The key that was used for a successful DNS list lookup is put into the variable
32761 &$dnslist_matched$& (see section &<<SECID204>>&).
32762
32763
32764
32765
32766 .subsection "Data returned by DNS lists" SECID203
32767 .cindex "DNS list" "data returned from"
32768 DNS lists are constructed using address records in the DNS. The original RBL
32769 just used the address 127.0.0.1 on the right hand side of each record, but the
32770 RBL+ list and some other lists use a number of values with different meanings.
32771 The values used on the RBL+ list are:
32772 .itable none 0 0 2 20* left 80* left
32773 .irow 127.1.0.1  "RBL"
32774 .irow 127.1.0.2  "DUL"
32775 .irow 127.1.0.3  "DUL and RBL"
32776 .irow 127.1.0.4  "RSS"
32777 .irow 127.1.0.5  "RSS and RBL"
32778 .irow 127.1.0.6  "RSS and DUL"
32779 .irow 127.1.0.7  "RSS and DUL and RBL"
32780 .endtable
32781 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32782 different values. Some DNS lists may return more than one address record;
32783 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32784
32785 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32786 range. If a DNSBL operator loses control of the domain, lookups on it
32787 may start returning other addresses.  Because of this, Exim now ignores
32788 returned values outside the 127/8 region.
32789
32790
32791 .subsection "Variables set from DNS lists" SECID204
32792 .cindex "expansion" "variables, set from DNS list"
32793 .cindex "DNS list" "variables set from"
32794 .vindex "&$dnslist_domain$&"
32795 .vindex "&$dnslist_matched$&"
32796 .vindex "&$dnslist_text$&"
32797 .vindex "&$dnslist_value$&"
32798 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32799 the name of the overall domain that matched (for example,
32800 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32801 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32802 the DNS record. When the key is an IP address, it is not reversed in
32803 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32804 cases, for example:
32805 .code
32806 deny dnslists = spamhaus.example
32807 .endd
32808 the key is also available in another variable (in this case,
32809 &$sender_host_address$&). In more complicated cases, however, this is not true.
32810 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32811 might generate a dnslists lookup like this:
32812 .code
32813 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32814 .endd
32815 If this condition succeeds, the value in &$dnslist_matched$& might be
32816 &`192.168.6.7`& (for example).
32817
32818 If more than one address record is returned by the DNS lookup, all the IP
32819 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32820 The variable &$dnslist_text$& contains the contents of any associated TXT
32821 record. For lists such as RBL+ the TXT record for a merged entry is often not
32822 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32823 information.
32824
32825 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32826 &-- even if these appear before the condition in the ACL, they are not
32827 expanded until after it has failed. For example:
32828 .code
32829 deny    hosts = !+local_networks
32830         message = $sender_host_address is listed \
32831                   at $dnslist_domain
32832         dnslists = rbl-plus.mail-abuse.example
32833 .endd
32834
32835
32836
32837 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32838 .cindex "DNS list" "matching specific returned data"
32839 You can add an equals sign and an IP address after a &%dnslists%& domain name
32840 in order to restrict its action to DNS records with a matching right hand side.
32841 For example,
32842 .code
32843 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32844 .endd
32845 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32846 any address record is considered to be a match. For the moment, we assume
32847 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32848 describes how multiple records are handled.
32849
32850 More than one IP address may be given for checking, using a comma as a
32851 separator. These are alternatives &-- if any one of them matches, the
32852 &%dnslists%& condition is true. For example:
32853 .code
32854 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32855 .endd
32856 If you want to specify a constraining address list and also specify names or IP
32857 addresses to be looked up, the constraining address list must be specified
32858 first. For example:
32859 .code
32860 deny dnslists = dsn.rfc-ignorant.org\
32861                 =127.0.0.2/$sender_address_domain
32862 .endd
32863
32864 If the character &`&&`& is used instead of &`=`&, the comparison for each
32865 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32866 In other words, the listed addresses are used as bit masks. The comparison is
32867 true if all the bits in the mask are present in the address that is being
32868 tested. For example:
32869 .code
32870 dnslists = a.b.c&0.0.0.3
32871 .endd
32872 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32873 want to test whether one bit or another bit is present (as opposed to both
32874 being present), you must use multiple values. For example:
32875 .code
32876 dnslists = a.b.c&0.0.0.1,0.0.0.2
32877 .endd
32878 matches if the final component of the address is an odd number or two times
32879 an odd number.
32880
32881
32882
32883 .subsection "Negated DNS matching conditions" SECID205
32884 You can supply a negative list of IP addresses as part of a &%dnslists%&
32885 condition. Whereas
32886 .code
32887 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32888 .endd
32889 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32890 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32891 .code
32892 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32893 .endd
32894 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32895 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32896 words, the result of the test is inverted if an exclamation mark appears before
32897 the &`=`& (or the &`&&`&) sign.
32898
32899 &*Note*&: This kind of negation is not the same as negation in a domain,
32900 host, or address list (which is why the syntax is different).
32901
32902 If you are using just one list, the negation syntax does not gain you much. The
32903 previous example is precisely equivalent to
32904 .code
32905 deny  dnslists = a.b.c
32906      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32907 .endd
32908 However, if you are using multiple lists, the negation syntax is clearer.
32909 Consider this example:
32910 .code
32911 deny  dnslists = sbl.spamhaus.org : \
32912                  list.dsbl.org : \
32913                  dnsbl.njabl.org!=127.0.0.3 : \
32914                  relays.ordb.org
32915 .endd
32916 Using only positive lists, this would have to be:
32917 .code
32918 deny  dnslists = sbl.spamhaus.org : \
32919                  list.dsbl.org
32920 deny  dnslists = dnsbl.njabl.org
32921      !dnslists = dnsbl.njabl.org=127.0.0.3
32922 deny  dnslists = relays.ordb.org
32923 .endd
32924 which is less clear, and harder to maintain.
32925
32926 Negation can also be used with a bitwise-and restriction.
32927 The dnslists condition with only be trus if a result is returned
32928 by the lookup which, anded with the restriction, is all zeroes.
32929 For example:
32930 .code
32931 deny dnslists = zen.spamhaus.org!&0.255.255.0
32932 .endd
32933
32934
32935
32936
32937 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
32938 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32939 thereby providing more than one IP address. When an item in a &%dnslists%& list
32940 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32941 the match to specific results from the DNS lookup, there are two ways in which
32942 the checking can be handled. For example, consider the condition:
32943 .code
32944 dnslists = a.b.c=127.0.0.1
32945 .endd
32946 What happens if the DNS lookup for the incoming IP address yields both
32947 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32948 condition true because at least one given value was found, or is it false
32949 because at least one of the found values was not listed? And how does this
32950 affect negated conditions? Both possibilities are provided for with the help of
32951 additional separators &`==`& and &`=&&`&.
32952
32953 .ilist
32954 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32955 IP addresses matches one of the listed addresses. For the example above, the
32956 condition is true because 127.0.0.1 matches.
32957 .next
32958 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32959 looked up IP addresses matches one of the listed addresses. If the condition is
32960 changed to:
32961 .code
32962 dnslists = a.b.c==127.0.0.1
32963 .endd
32964 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32965 false because 127.0.0.2 is not listed. You would need to have:
32966 .code
32967 dnslists = a.b.c==127.0.0.1,127.0.0.2
32968 .endd
32969 for the condition to be true.
32970 .endlist
32971
32972 When &`!`& is used to negate IP address matching, it inverts the result, giving
32973 the precise opposite of the behaviour above. Thus:
32974 .ilist
32975 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32976 addresses matches one of the listed addresses. Consider:
32977 .code
32978 dnslists = a.b.c!&0.0.0.1
32979 .endd
32980 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32981 false because 127.0.0.1 matches.
32982 .next
32983 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32984 looked up IP address that does not match. Consider:
32985 .code
32986 dnslists = a.b.c!=&0.0.0.1
32987 .endd
32988 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32989 true, because 127.0.0.2 does not match. You would need to have:
32990 .code
32991 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32992 .endd
32993 for the condition to be false.
32994 .endlist
32995 When the DNS lookup yields only a single IP address, there is no difference
32996 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32997
32998
32999
33000
33001 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33002 .cindex "DNS list" "information from merged"
33003 When the facility for restricting the matching IP values in a DNS list is used,
33004 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33005 the true reason for rejection. This happens when lists are merged and the IP
33006 address in the A record is used to distinguish them; unfortunately there is
33007 only one TXT record. One way round this is not to use merged lists, but that
33008 can be inefficient because it requires multiple DNS lookups where one would do
33009 in the vast majority of cases when the host of interest is not on any of the
33010 lists.
33011
33012 A less inefficient way of solving this problem is available. If
33013 two domain names, comma-separated, are given, the second is used first to
33014 do an initial check, making use of any IP value restrictions that are set.
33015 If there is a match, the first domain is used, without any IP value
33016 restrictions, to get the TXT record. As a byproduct of this, there is also
33017 a check that the IP being tested is indeed on the first list. The first
33018 domain is the one that is put in &$dnslist_domain$&. For example:
33019 .code
33020 deny   dnslists = \
33021          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33022          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33023        message  = \
33024          rejected because $sender_host_address is blacklisted \
33025          at $dnslist_domain\n$dnslist_text
33026 .endd
33027 For the first blacklist item, this starts by doing a lookup in
33028 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33029 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33030 value, and as long as something is found, it looks for the corresponding TXT
33031 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33032 The second blacklist item is processed similarly.
33033
33034 If you are interested in more than one merged list, the same list must be
33035 given several times, but because the results of the DNS lookups are cached,
33036 the DNS calls themselves are not repeated. For example:
33037 .code
33038 deny dnslists = \
33039          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33040          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33041          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33042          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33043 .endd
33044 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33045 values matches (or if no record is found), this is the only lookup that is
33046 done. Only if there is a match is one of the more specific lists consulted.
33047
33048
33049
33050 .subsection "DNS lists and IPv6" SECTmorednslistslast
33051 .cindex "IPv6" "DNS black lists"
33052 .cindex "DNS list" "IPv6 usage"
33053 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33054 nibble by nibble. For example, if the calling host's IP address is
33055 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33056 .code
33057 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33058   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33059 .endd
33060 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33061 lists contain wildcard records, intended for IPv4, that interact badly with
33062 IPv6. For example, the DNS entry
33063 .code
33064 *.3.some.list.example.    A    127.0.0.1
33065 .endd
33066 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33067 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33068
33069 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33070 &%condition%& condition, as in this example:
33071 .code
33072 deny   condition = ${if isip4{$sender_host_address}}
33073        dnslists  = some.list.example
33074 .endd
33075
33076 If an explicit key is being used for a DNS lookup and it may be an IPv6
33077 address you should specify alternate list separators for both the outer
33078 (DNS list name) list and inner (lookup keys) list:
33079 .code
33080        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33081 .endd
33082
33083
33084 .section "Previously seen user and hosts" "SECTseen"
33085 .cindex "&%seen%& ACL condition"
33086 .cindex greylisting
33087 The &%seen%& ACL condition can be used to test whether a
33088 situation has been previously met.
33089 It uses a hints database to record a timestamp against a key.
33090 The syntax of the condition is:
33091 .display
33092 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33093 .endd
33094
33095 For example,
33096 .code
33097 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33098 .endd
33099 in a RCPT ACL will implement simple greylisting.
33100
33101 The parameters for the condition are
33102 a possible minus sign,
33103 then an interval,
33104 then, slash-separated, a list of options.
33105 The interval is taken as an offset before the current time,
33106 and used for the test.
33107 If the interval is preceded by a minus sign then the condition returns
33108 whether a record is found which is before the test time.
33109 Otherwise, the condition returns whether one is found which is since the
33110 test time.
33111
33112 Options are read in order with later ones overriding earlier ones.
33113
33114 The default key is &$sender_host_address$&.
33115 An explicit key can be set using a &%key=value%& option.
33116
33117 If a &%readonly%& option is given then
33118 no record create or update is done.
33119 If a &%write%& option is given then
33120 a record create or update is always done.
33121 An update is done if the test is for &"since"&.
33122 If none of those hold and there was no existing record,
33123 a record is created.
33124
33125 Creates and updates are marked with the current time.
33126
33127 Finally, a &"before"& test which succeeds, and for which the record
33128 is old enough, will be refreshed with a timestamp of the test time.
33129 This can prevent tidying of the database from removing the entry.
33130 The interval for this is, by default, 10 days.
33131 An explicit interval can be set using a
33132 &%refresh=value%& option.
33133
33134 Note that &"seen"& should be added to the list of hints databases
33135 for maintenance if this ACL condition is used.
33136
33137
33138 .section "Rate limiting incoming messages" "SECTratelimiting"
33139 .cindex "rate limiting" "client sending"
33140 .cindex "limiting client sending rates"
33141 .oindex "&%smtp_ratelimit_*%&"
33142 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33143 which clients can send email. This is more powerful than the
33144 &%smtp_ratelimit_*%& options, because those options control the rate of
33145 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33146 works across all connections (concurrent and sequential) from the same client
33147 host. The syntax of the &%ratelimit%& condition is:
33148 .display
33149 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33150 .endd
33151 If the average client sending rate is less than &'m'& messages per time
33152 period &'p'& then the condition is false; otherwise it is true.
33153
33154 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33155 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33156 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33157 of &'p'&.
33158
33159 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33160 time interval, for example, &`8h`& for eight hours. A larger time constant
33161 means that it takes Exim longer to forget a client's past behaviour. The
33162 parameter &'m'& is the maximum number of messages that a client is permitted to
33163 send in each time interval. It also specifies the number of messages permitted
33164 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33165 constant, you can allow a client to send more messages in a burst without
33166 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33167 both small, messages must be sent at an even rate.
33168
33169 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33170 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33171 when deploying the &%ratelimit%& ACL condition. The script prints usage
33172 instructions when it is run with no arguments.
33173
33174 The key is used to look up the data for calculating the client's average
33175 sending rate. This data is stored in Exim's spool directory, alongside the
33176 retry and other hints databases. The default key is &$sender_host_address$&,
33177 which means Exim computes the sending rate of each client host IP address.
33178 By changing the key you can change how Exim identifies clients for the purpose
33179 of ratelimiting. For example, to limit the sending rate of each authenticated
33180 user, independent of the computer they are sending from, set the key to
33181 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33182 example, &$authenticated_id$& is only meaningful if the client has
33183 authenticated (which you can check with the &%authenticated%& ACL condition).
33184
33185 The lookup key does not have to identify clients: If you want to limit the
33186 rate at which a recipient receives messages, you can use the key
33187 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33188 ACL.
33189
33190 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33191 specifies what Exim measures the rate of, for example, messages or recipients
33192 or bytes. You can adjust the measurement using the &%unique=%& and/or
33193 &%count=%& options. You can also control when Exim updates the recorded rate
33194 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33195 separated by a slash, like the other parameters. They may appear in any order.
33196
33197 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33198 any options that alter the meaning of the stored data. The limit &'m'& is not
33199 stored, so you can alter the configured maximum rate and Exim will still
33200 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33201 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33202 behaviour. The lookup key is not affected by changes to the update mode and
33203 the &%count=%& option.
33204
33205
33206 .subsection "Ratelimit options for what is being measured" ratoptmea
33207 .cindex "rate limiting" "per_* options"
33208 .vlist
33209 .vitem per_conn
33210 .cindex "rate limiting" per_conn
33211 This option limits the client's connection rate. It is not
33212 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33213 &%acl_not_smtp_start%& ACLs.
33214
33215 .vitem per_mail
33216 .cindex "rate limiting" per_conn
33217 This option limits the client's rate of sending messages. This is
33218 the default if none of the &%per_*%& options is specified. It can be used in
33219 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33220 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33221
33222 .vitem per_byte
33223 .cindex "rate limiting" per_conn
33224 This option limits the sender's email bandwidth. It can be used in
33225 the same ACLs as the &%per_mail%& option, though it is best to use this option
33226 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33227 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33228 in its MAIL command, which may be inaccurate or completely missing. You can
33229 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33230 in kilobytes, megabytes, or gigabytes, respectively.
33231
33232 .vitem per_rcpt
33233 .cindex "rate limiting" per_rcpt
33234 This option causes Exim to limit the rate at which recipients are
33235 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33236 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33237 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33238 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33239 in either case the rate limiting engine will see a message with many
33240 recipients as a large high-speed burst.
33241
33242 .vitem per_addr
33243 .cindex "rate limiting" per_addr
33244 This option is like the &%per_rcpt%& option, except it counts the
33245 number of different recipients that the client has sent messages to in the
33246 last time period. That is, if the client repeatedly sends messages to the same
33247 recipient, its measured rate is not increased. This option can only be used in
33248 &%acl_smtp_rcpt%&.
33249
33250 .vitem per_cmd
33251 .cindex "rate limiting" per_cmd
33252 This option causes Exim to recompute the rate every time the
33253 condition is processed. This can be used to limit the rate of any SMTP
33254 command. If it is used in multiple ACLs it can limit the aggregate rate of
33255 multiple different commands.
33256
33257 .vitem count
33258 .cindex "rate limiting" count
33259 This option can be used to alter how much Exim adds to the client's
33260 measured rate.
33261 A value is required, after an equals sign.
33262 For example, the &%per_byte%& option is equivalent to
33263 &`per_mail/count=$message_size`&.
33264 If there is no &%count=%& option, Exim
33265 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33266 other than &%acl_smtp_rcpt%&).
33267 The count does not have to be an integer.
33268
33269 .vitem unique
33270 .cindex "rate limiting" unique
33271 This option is described in section &<<ratoptuniq>>& below.
33272 .endlist
33273
33274
33275 .subsection "Ratelimit update modes" ratoptupd
33276 .cindex "rate limiting" "reading data without updating"
33277 You can specify one of three options with the &%ratelimit%& condition to
33278 control when its database is updated. This section describes the &%readonly%&
33279 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33280
33281 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33282 previously-computed rate to check against the limit.
33283
33284 For example, you can test the client's sending rate and deny it access (when
33285 it is too fast) in the connect ACL. If the client passes this check then it
33286 can go on to send a message, in which case its recorded rate will be updated
33287 in the MAIL ACL. Subsequent connections from the same client will check this
33288 new rate.
33289 .code
33290 acl_check_connect:
33291  deny ratelimit = 100 / 5m / readonly
33292       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33293                   (max $sender_rate_limit)
33294 # ...
33295 acl_check_mail:
33296  warn ratelimit = 100 / 5m / strict
33297       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33298                   (max $sender_rate_limit)
33299 .endd
33300
33301 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33302 processing a message then it may increase the client's measured rate more than
33303 it should. For example, this will happen if you check the &%per_rcpt%& option
33304 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33305 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33306 multiple update problems by using the &%readonly%& option on later ratelimit
33307 checks.
33308
33309 The &%per_*%& options described above do not make sense in some ACLs. If you
33310 use a &%per_*%& option in an ACL where it is not normally permitted then the
33311 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33312 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33313 next section) so you must specify the &%readonly%& option explicitly.
33314
33315
33316 .subsection "Ratelimit options for handling fast clients" ratoptfast
33317 .cindex "rate limiting" "strict and leaky modes"
33318 If a client's average rate is greater than the maximum, the rate limiting
33319 engine can react in two possible ways, depending on the presence of the
33320 &%strict%& or &%leaky%& update modes. This is independent of the other
33321 counter-measures (such as rejecting the message) that may be specified by the
33322 rest of the ACL.
33323
33324 The &%leaky%& (default) option means that the client's recorded rate is not
33325 updated if it is above the limit. The effect of this is that Exim measures the
33326 client's average rate of successfully sent email,
33327 up to the given limit.
33328 This is appropriate if the countermeasure when the condition is true
33329 consists of refusing the message, and
33330 is generally the better choice if you have clients that retry automatically.
33331 If the action when true is anything more complex then this option is
33332 likely not what is wanted.
33333
33334 The &%strict%& option means that the client's recorded rate is always
33335 updated. The effect of this is that Exim measures the client's average rate
33336 of attempts to send email, which can be much higher than the maximum it is
33337 actually allowed. If the client is over the limit it may be subjected to
33338 counter-measures by the ACL. It must slow down and allow sufficient time to
33339 pass that its computed rate falls below the maximum before it can send email
33340 again. The time (the number of smoothing periods) it must wait and not
33341 attempt to send mail can be calculated with this formula:
33342 .code
33343         ln(peakrate/maxrate)
33344 .endd
33345
33346
33347 .subsection "Limiting the rate of different events" ratoptuniq
33348 .cindex "rate limiting" "counting unique events"
33349 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33350 rate of different events. For example, the &%per_addr%& option uses this
33351 mechanism to count the number of different recipients that the client has
33352 sent messages to in the last time period; it is equivalent to
33353 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33354 measure the rate that a client uses different sender addresses with the
33355 options &`per_mail/unique=$sender_address`&.
33356
33357 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33358 has seen for that key. The whole set is thrown away when it is older than the
33359 rate smoothing period &'p'&, so each different event is counted at most once
33360 per period. In the &%leaky%& update mode, an event that causes the client to
33361 go over the limit is not added to the set, in the same way that the client's
33362 recorded rate is not updated in the same situation.
33363
33364 When you combine the &%unique=%& and &%readonly%& options, the specific
33365 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33366 rate.
33367
33368 The &%unique=%& mechanism needs more space in the ratelimit database than the
33369 other &%ratelimit%& options in order to store the event set. The number of
33370 unique values is potentially as large as the rate limit, so the extra space
33371 required increases with larger limits.
33372
33373 The uniqueification is not perfect: there is a small probability that Exim
33374 will think a new event has happened before. If the sender's rate is less than
33375 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33376 the measured rate can go above the limit, in which case Exim may under-count
33377 events by a significant margin. Fortunately, if the rate is high enough (2.7
33378 times the limit) that the false positive rate goes above 9%, then Exim will
33379 throw away the over-full event set before the measured rate falls below the
33380 limit. Therefore the only harm should be that exceptionally high sending rates
33381 are logged incorrectly; any countermeasures you configure will be as effective
33382 as intended.
33383
33384
33385 .subsection "Using rate limiting" useratlim
33386 Exim's other ACL facilities are used to define what counter-measures are taken
33387 when the rate limit is exceeded. This might be anything from logging a warning
33388 (for example, while measuring existing sending rates in order to define
33389 policy), through time delays to slow down fast senders, up to rejecting the
33390 message. For example:
33391 .code
33392 # Log all senders' rates
33393 warn ratelimit = 0 / 1h / strict
33394      log_message = Sender rate $sender_rate / $sender_rate_period
33395
33396 # Slow down fast senders; note the need to truncate $sender_rate
33397 # at the decimal point.
33398 warn ratelimit = 100 / 1h / per_rcpt / strict
33399      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33400                    $sender_rate_limit }s
33401
33402 # Keep authenticated users under control
33403 deny authenticated = *
33404      ratelimit = 100 / 1d / strict / $authenticated_id
33405
33406 # System-wide rate limit
33407 defer ratelimit = 10 / 1s / $primary_hostname
33408       message = Sorry, too busy. Try again later.
33409
33410 # Restrict incoming rate from each host, with a default
33411 # set using a macro and special cases looked up in a table.
33412 defer ratelimit = ${lookup {$sender_host_address} \
33413                    cdb {DB/ratelimits.cdb} \
33414                    {$value} {RATELIMIT} }
33415       message = Sender rate exceeds $sender_rate_limit \
33416                messages per $sender_rate_period
33417 .endd
33418 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33419 especially with the &%per_rcpt%& option, you may suffer from a performance
33420 bottleneck caused by locking on the ratelimit hints database. Apart from
33421 making your ACLs less complicated, you can reduce the problem by using a
33422 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33423 this means that Exim will lose its hints data after a reboot (including retry
33424 hints, the callout cache, and ratelimit data).
33425
33426
33427
33428 .section "Address verification" "SECTaddressverification"
33429 .cindex "verifying address" "options for"
33430 .cindex "policy control" "address verification"
33431 Several of the &%verify%& conditions described in section
33432 &<<SECTaclconditions>>& cause addresses to be verified. Section
33433 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33434 The verification conditions can be followed by options that modify the
33435 verification process. The options are separated from the keyword and from each
33436 other by slashes, and some of them contain parameters. For example:
33437 .code
33438 verify = sender/callout
33439 verify = recipient/defer_ok/callout=10s,defer_ok
33440 .endd
33441 The first stage of address verification, which always happens, is to run the
33442 address through the routers, in &"verify mode"&. Routers can detect the
33443 difference between verification and routing for delivery, and their actions can
33444 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33445 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33446 The available options are as follows:
33447
33448 .ilist
33449 If the &%callout%& option is specified, successful routing to one or more
33450 remote hosts is followed by a &"callout"& to those hosts as an additional
33451 check. Callouts and their sub-options are discussed in the next section.
33452 .next
33453 If there is a defer error while doing verification routing, the ACL
33454 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33455 options, the condition is forced to be true instead. Note that this is a main
33456 verification option as well as a suboption for callouts.
33457 .next
33458 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33459 discusses the reporting of sender address verification failures.
33460 .next
33461 The &%success_on_redirect%& option causes verification always to succeed
33462 immediately after a successful redirection. By default, if a redirection
33463 generates just one address, that address is also verified. See further
33464 discussion in section &<<SECTredirwhilveri>>&.
33465 .next
33466 If the &%quota%& option is specified for recipient verify,
33467 successful routing to an appendfile transport is followed by a call into
33468 the transport to evaluate the quota status for the recipient.
33469 No actual delivery is done, but verification will succeed if the quota
33470 is sufficient for the message (if the sender gave a message size) or
33471 not already exceeded (otherwise).
33472 .endlist
33473
33474 .cindex "verifying address" "differentiating failures"
33475 .vindex "&$recipient_verify_failure$&"
33476 .vindex "&$sender_verify_failure$&"
33477 .vindex "&$acl_verify_message$&"
33478 After an address verification failure, &$acl_verify_message$& contains the
33479 error message that is associated with the failure. It can be preserved by
33480 coding like this:
33481 .code
33482 warn  !verify = sender
33483        set acl_m0 = $acl_verify_message
33484 .endd
33485 If you are writing your own custom rejection message or log message when
33486 denying access, you can use this variable to include information about the
33487 verification failure.
33488 This variable is cleared at the end of processing the ACL verb.
33489
33490 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33491 appropriate) contains one of the following words:
33492
33493 .ilist
33494 &%qualify%&: The address was unqualified (no domain), and the message
33495 was neither local nor came from an exempted host.
33496 .next
33497 &%route%&: Routing failed.
33498 .next
33499 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33500 occurred at or before the MAIL command (that is, on initial
33501 connection, HELO, or MAIL).
33502 .next
33503 &%recipient%&: The RCPT command in a callout was rejected.
33504 .next
33505 &%postmaster%&: The postmaster check in a callout was rejected.
33506 .next
33507 &%quota%&: The quota check for a local recipient did non pass.
33508 .endlist
33509
33510 The main use of these variables is expected to be to distinguish between
33511 rejections of MAIL and rejections of RCPT in callouts.
33512
33513 The above variables may also be set after a &*successful*&
33514 address verification to:
33515
33516 .ilist
33517 &%random%&: A random local-part callout succeeded
33518 .endlist
33519
33520
33521
33522
33523 .section "Callout verification" "SECTcallver"
33524 .cindex "verifying address" "by callout"
33525 .cindex "callout" "verification"
33526 .cindex "SMTP" "callout verification"
33527 For non-local addresses, routing verifies the domain, but is unable to do any
33528 checking of the local part. There are situations where some means of verifying
33529 the local part is desirable. One way this can be done is to make an SMTP
33530 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33531 a subsequent host for a recipient address, to see if the host accepts the
33532 address. We use the term &'callout'& to cover both cases. Note that for a
33533 sender address, the callback is not to the client host that is trying to
33534 deliver the message, but to one of the hosts that accepts incoming mail for the
33535 sender's domain.
33536
33537 Exim does not do callouts by default. If you want them to happen, you must
33538 request them by setting appropriate options on the &%verify%& condition, as
33539 described below. This facility should be used with care, because it can add a
33540 lot of resource usage to the cost of verifying an address. However, Exim does
33541 cache the results of callouts, which helps to reduce the cost. Details of
33542 caching are in section &<<SECTcallvercache>>&.
33543
33544 Recipient callouts are usually used only between hosts that are controlled by
33545 the same administration. For example, a corporate gateway host could use
33546 callouts to check for valid recipients on an internal mailserver. A successful
33547 callout does not guarantee that a real delivery to the address would succeed;
33548 on the other hand, a failing callout does guarantee that a delivery would fail.
33549
33550 If the &%callout%& option is present on a condition that verifies an address, a
33551 second stage of verification occurs if the address is successfully routed to
33552 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33553 &(manualroute)& router, where the router specifies the hosts. However, if a
33554 router that does not set up hosts routes to an &(smtp)& transport with a
33555 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33556 &%hosts_override%& set, its hosts are always used, whether or not the router
33557 supplies a host list.
33558 Callouts are only supported on &(smtp)& transports.
33559
33560 The port that is used is taken from the transport, if it is specified and is a
33561 remote transport. (For routers that do verification only, no transport need be
33562 specified.) Otherwise, the default SMTP port is used. If a remote transport
33563 specifies an outgoing interface, this is used; otherwise the interface is not
33564 specified. Likewise, the text that is used for the HELO command is taken from
33565 the transport's &%helo_data%& option; if there is no transport, the value of
33566 &$smtp_active_hostname$& is used.
33567
33568 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33569 test whether a bounce message could be delivered to the sender address. The
33570 following SMTP commands are sent:
33571 .display
33572 &`HELO `&<&'local host name'&>
33573 &`MAIL FROM:<>`&
33574 &`RCPT TO:`&<&'the address to be tested'&>
33575 &`QUIT`&
33576 .endd
33577 LHLO is used instead of HELO if the transport's &%protocol%& option is
33578 set to &"lmtp"&.
33579
33580 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33581 settings.
33582
33583 A recipient callout check is similar. By default, it also uses an empty address
33584 for the sender. This default is chosen because most hosts do not make use of
33585 the sender address when verifying a recipient. Using the same address means
33586 that a single cache entry can be used for each recipient. Some sites, however,
33587 do make use of the sender address when verifying. These are catered for by the
33588 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33589
33590 If the response to the RCPT command is a 2&'xx'& code, the verification
33591 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33592 Exim tries the next host, if any. If there is a problem with all the remote
33593 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33594 &%callout%& option is given, in which case the condition is forced to succeed.
33595
33596 .cindex "SMTP" "output flushing, disabling for callout"
33597 A callout may take a little time. For this reason, Exim normally flushes SMTP
33598 output before performing a callout in an ACL, to avoid unexpected timeouts in
33599 clients when the SMTP PIPELINING extension is in use. The flushing can be
33600 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33601
33602 .cindex "tainted data" "de-tainting"
33603 .cindex "de-tainting" "using recipient verify"
33604 A recipient callout which gets a 2&'xx'& code
33605 will assign untainted values to the
33606 &$domain_data$& and &$local_part_data$& variables,
33607 corresponding to the domain and local parts of the recipient address.
33608
33609
33610
33611
33612 .subsection "Additional parameters for callouts" CALLaddparcall
33613 .cindex "callout" "additional parameters for"
33614 The &%callout%& option can be followed by an equals sign and a number of
33615 optional parameters, separated by commas. For example:
33616 .code
33617 verify = recipient/callout=10s,defer_ok
33618 .endd
33619 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33620 separate verify options, is retained for backwards compatibility, but is now
33621 deprecated. The additional parameters for &%callout%& are as follows:
33622
33623
33624 .vlist
33625 .vitem <&'a&~time&~interval'&>
33626 .cindex "callout" "timeout, specifying"
33627 This specifies the timeout that applies for the callout attempt to each host.
33628 For example:
33629 .code
33630 verify = sender/callout=5s
33631 .endd
33632 The default is 30 seconds. The timeout is used for each response from the
33633 remote host. It is also used for the initial connection, unless overridden by
33634 the &%connect%& parameter.
33635
33636
33637 .vitem &*connect&~=&~*&<&'time&~interval'&>
33638 .cindex "callout" "connection timeout, specifying"
33639 This parameter makes it possible to set a different (usually smaller) timeout
33640 for making the SMTP connection. For example:
33641 .code
33642 verify = sender/callout=5s,connect=1s
33643 .endd
33644 If not specified, this timeout defaults to the general timeout value.
33645
33646 .vitem &*defer_ok*&
33647 .cindex "callout" "defer, action on"
33648 When this parameter is present, failure to contact any host, or any other kind
33649 of temporary error, is treated as success by the ACL. However, the cache is not
33650 updated in this circumstance.
33651
33652 .vitem &*fullpostmaster*&
33653 .cindex "callout" "full postmaster check"
33654 This operates like the &%postmaster%& option (see below), but if the check for
33655 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33656 accordance with the specification in RFC 2821. The RFC states that the
33657 unqualified address &'postmaster'& should be accepted.
33658
33659
33660 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33661 .cindex "callout" "sender when verifying header"
33662 When verifying addresses in header lines using the &%header_sender%&
33663 verification option, Exim behaves by default as if the addresses are envelope
33664 sender addresses from a message. Callout verification therefore tests to see
33665 whether a bounce message could be delivered, by using an empty address in the
33666 MAIL command. However, it is arguable that these addresses might never be used
33667 as envelope senders, and could therefore justifiably reject bounce messages
33668 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33669 address to use in the MAIL command. For example:
33670 .code
33671 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33672 .endd
33673 This parameter is available only for the &%header_sender%& verification option.
33674
33675
33676 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33677 .cindex "callout" "overall timeout, specifying"
33678 This parameter sets an overall timeout for performing a callout verification.
33679 For example:
33680 .code
33681 verify = sender/callout=5s,maxwait=30s
33682 .endd
33683 This timeout defaults to four times the callout timeout for individual SMTP
33684 commands. The overall timeout applies when there is more than one host that can
33685 be tried. The timeout is checked before trying the next host. This prevents
33686 very long delays if there are a large number of hosts and all are timing out
33687 (for example, when network connections are timing out).
33688
33689
33690 .vitem &*no_cache*&
33691 .cindex "callout" "cache, suppressing"
33692 .cindex "caching callout, suppressing"
33693 When this parameter is given, the callout cache is neither read nor updated.
33694
33695 .vitem &*postmaster*&
33696 .cindex "callout" "postmaster; checking"
33697 When this parameter is set, a successful callout check is followed by a similar
33698 check for the local part &'postmaster'& at the same domain. If this address is
33699 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33700 the postmaster check is recorded in a cache record; if it is a failure, this is
33701 used to fail subsequent callouts for the domain without a connection being
33702 made, until the cache record expires.
33703
33704 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33705 The postmaster check uses an empty sender in the MAIL command by default.
33706 You can use this parameter to do a postmaster check using a different address.
33707 For example:
33708 .code
33709 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33710 .endd
33711 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33712 one overrides. The &%postmaster%& parameter is equivalent to this example:
33713 .code
33714 require  verify = sender/callout=postmaster_mailfrom=
33715 .endd
33716 &*Warning*&: The caching arrangements for postmaster checking do not take
33717 account of the sender address. It is assumed that either the empty address or
33718 a fixed non-empty address will be used. All that Exim remembers is that the
33719 postmaster check for the domain succeeded or failed.
33720
33721
33722 .vitem &*random*&
33723 .cindex "callout" "&""random""& check"
33724 When this parameter is set, before doing the normal callout check, Exim does a
33725 check for a &"random"& local part at the same domain. The local part is not
33726 really random &-- it is defined by the expansion of the option
33727 &%callout_random_local_part%&, which defaults to
33728 .code
33729 $primary_hostname-$tod_epoch-testing
33730 .endd
33731 The idea here is to try to determine whether the remote host accepts all local
33732 parts without checking. If it does, there is no point in doing callouts for
33733 specific local parts. If the &"random"& check succeeds, the result is saved in
33734 a cache record, and used to force the current and subsequent callout checks to
33735 succeed without a connection being made, until the cache record expires.
33736
33737 .vitem &*use_postmaster*&
33738 .cindex "callout" "sender for recipient check"
33739 This parameter applies to recipient callouts only. For example:
33740 .code
33741 deny  !verify = recipient/callout=use_postmaster
33742 .endd
33743 .vindex "&$qualify_domain$&"
33744 It causes a non-empty postmaster address to be used in the MAIL command when
33745 performing the callout for the recipient, and also for a &"random"& check if
33746 that is configured. The local part of the address is &`postmaster`& and the
33747 domain is the contents of &$qualify_domain$&.
33748
33749 .vitem &*use_sender*&
33750 This option applies to recipient callouts only. For example:
33751 .code
33752 require  verify = recipient/callout=use_sender
33753 .endd
33754 It causes the message's actual sender address to be used in the MAIL
33755 command when performing the callout, instead of an empty address. There is no
33756 need to use this option unless you know that the called hosts make use of the
33757 sender when checking recipients. If used indiscriminately, it reduces the
33758 usefulness of callout caching.
33759
33760 .vitem &*hold*&
33761 This option applies to recipient callouts only. For example:
33762 .code
33763 require  verify = recipient/callout=use_sender,hold
33764 .endd
33765 It causes the connection to be held open and used for any further recipients
33766 and for eventual delivery (should that be done quickly).
33767 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33768 when that is used for the connections.
33769 The advantage is only gained if there are no callout cache hits
33770 (which could be enforced by the no_cache option),
33771 if the use_sender option is used,
33772 if neither the random nor the use_postmaster option is used,
33773 and if no other callouts intervene.
33774 .endlist
33775
33776 If you use any of the parameters that set a non-empty sender for the MAIL
33777 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33778 &%use_sender%&), you should think about possible loops. Recipient checking is
33779 usually done between two hosts that are under the same management, and the host
33780 that receives the callouts is not normally configured to do callouts itself.
33781 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33782 these circumstances.
33783
33784 However, if you use a non-empty sender address for a callout to an arbitrary
33785 host, there is the likelihood that the remote host will itself initiate a
33786 callout check back to your host. As it is checking what appears to be a message
33787 sender, it is likely to use an empty address in MAIL, thus avoiding a
33788 callout loop. However, to be on the safe side it would be best to set up your
33789 own ACLs so that they do not do sender verification checks when the recipient
33790 is the address you use for header sender or postmaster callout checking.
33791
33792 Another issue to think about when using non-empty senders for callouts is
33793 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33794 by the sender/recipient combination; thus, for any given recipient, many more
33795 actual callouts are performed than when an empty sender or postmaster is used.
33796
33797
33798
33799
33800 .subsection "Callout caching" SECTcallvercache
33801 .cindex "hints database" "callout cache"
33802 .cindex "callout" "cache, description of"
33803 .cindex "caching" "callout"
33804 Exim caches the results of callouts in order to reduce the amount of resources
33805 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33806 option. A hints database called &"callout"& is used for the cache. Two
33807 different record types are used: one records the result of a callout check for
33808 a specific address, and the other records information that applies to the
33809 entire domain (for example, that it accepts the local part &'postmaster'&).
33810
33811 When an original callout fails, a detailed SMTP error message is given about
33812 the failure. However, for subsequent failures that use the cache data, this message
33813 is not available.
33814
33815 The expiry times for negative and positive address cache records are
33816 independent, and can be set by the global options &%callout_negative_expire%&
33817 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33818
33819 If a host gives a negative response to an SMTP connection, or rejects any
33820 commands up to and including
33821 .code
33822 MAIL FROM:<>
33823 .endd
33824 (but not including the MAIL command with a non-empty address),
33825 any callout attempt is bound to fail. Exim remembers such failures in a
33826 domain cache record, which it uses to fail callouts for the domain without
33827 making new connections, until the domain record times out. There are two
33828 separate expiry times for domain cache records:
33829 &%callout_domain_negative_expire%& (default 3h) and
33830 &%callout_domain_positive_expire%& (default 7d).
33831
33832 Domain records expire when the negative expiry time is reached if callouts
33833 cannot be made for the domain, or if the postmaster check failed.
33834 Otherwise, they expire when the positive expiry time is reached. This
33835 ensures that, for example, a host that stops accepting &"random"& local parts
33836 will eventually be noticed.
33837
33838 The callout caching mechanism is based on the domain of the address that is
33839 being tested. If the domain routes to several hosts, it is assumed that their
33840 behaviour will be the same.
33841
33842
33843
33844 .section "Quota caching" "SECTquotacache"
33845 .cindex "hints database" "quota cache"
33846 .cindex "quota" "cache, description of"
33847 .cindex "caching" "quota"
33848 Exim caches the results of quota verification
33849 in order to reduce the amount of resources used.
33850 The &"callout"& hints database is used.
33851
33852 The default cache periods are five minutes for a positive (good) result
33853 and one hour for a negative result.
33854 To change the periods the &%quota%& option can be followed by an equals sign
33855 and a number of optional paramemters, separated by commas.
33856 For example:
33857 .code
33858 verify = recipient/quota=cachepos=1h,cacheneg=1d
33859 .endd
33860 Possible parameters are:
33861 .vlist
33862 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33863 .cindex "quota cache" "positive entry expiry, specifying"
33864 Set the lifetime for a positive cache entry.
33865 A value of zero seconds is legitimate.
33866
33867 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33868 .cindex "quota cache" "negative entry expiry, specifying"
33869 As above, for a negative entry.
33870
33871 .vitem &*no_cache*&
33872 Set both positive and negative lifetimes to zero.
33873
33874 .section "Sender address verification reporting" "SECTsenaddver"
33875 .cindex "verifying" "suppressing error details"
33876 See section &<<SECTaddressverification>>& for a general discussion of
33877 verification. When sender verification fails in an ACL, the details of the
33878 failure are given as additional output lines before the 550 response to the
33879 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33880 you might see:
33881 .code
33882 MAIL FROM:<xyz@abc.example>
33883 250 OK
33884 RCPT TO:<pqr@def.example>
33885 550-Verification failed for <xyz@abc.example>
33886 550-Called:   192.168.34.43
33887 550-Sent:     RCPT TO:<xyz@abc.example>
33888 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33889 550 Sender verification failed
33890 .endd
33891 If more than one RCPT command fails in the same way, the details are given
33892 only for the first of them. However, some administrators do not want to send
33893 out this much information. You can suppress the details by adding
33894 &`/no_details`& to the ACL statement that requests sender verification. For
33895 example:
33896 .code
33897 verify = sender/no_details
33898 .endd
33899
33900 .section "Redirection while verifying" "SECTredirwhilveri"
33901 .cindex "verifying" "redirection while"
33902 .cindex "address redirection" "while verifying"
33903 A dilemma arises when a local address is redirected by aliasing or forwarding
33904 during verification: should the generated addresses themselves be verified,
33905 or should the successful expansion of the original address be enough to verify
33906 it? By default, Exim takes the following pragmatic approach:
33907
33908 .ilist
33909 When an incoming address is redirected to just one child address, verification
33910 continues with the child address, and if that fails to verify, the original
33911 verification also fails.
33912 .next
33913 When an incoming address is redirected to more than one child address,
33914 verification does not continue. A success result is returned.
33915 .endlist
33916
33917 This seems the most reasonable behaviour for the common use of aliasing as a
33918 way of redirecting different local parts to the same mailbox. It means, for
33919 example, that a pair of alias entries of the form
33920 .code
33921 A.Wol:   aw123
33922 aw123:   :fail: Gone away, no forwarding address
33923 .endd
33924 work as expected, with both local parts causing verification failure. When a
33925 redirection generates more than one address, the behaviour is more like a
33926 mailing list, where the existence of the alias itself is sufficient for
33927 verification to succeed.
33928
33929 It is possible, however, to change the default behaviour so that all successful
33930 redirections count as successful verifications, however many new addresses are
33931 generated. This is specified by the &%success_on_redirect%& verification
33932 option. For example:
33933 .code
33934 require verify = recipient/success_on_redirect/callout=10s
33935 .endd
33936 In this example, verification succeeds if a router generates a new address, and
33937 the callout does not occur, because no address was routed to a remote host.
33938
33939 When verification is being tested via the &%-bv%& option, the treatment of
33940 redirections is as just described, unless the &%-v%& or any debugging option is
33941 also specified. In that case, full verification is done for every generated
33942 address and a report is output for each of them.
33943
33944
33945
33946 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33947 .cindex "CSA" "verifying"
33948 Client SMTP Authorization is a system that allows a site to advertise
33949 which machines are and are not permitted to send email. This is done by placing
33950 special SRV records in the DNS; these are looked up using the client's HELO
33951 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33952 Authorization checks in Exim are performed by the ACL condition:
33953 .code
33954 verify = csa
33955 .endd
33956 This fails if the client is not authorized. If there is a DNS problem, or if no
33957 valid CSA SRV record is found, or if the client is authorized, the condition
33958 succeeds. These three cases can be distinguished using the expansion variable
33959 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33960 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33961 be likely to cause problems for legitimate email.
33962
33963 The error messages produced by the CSA code include slightly more
33964 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33965 looking up the CSA SRV record, or problems looking up the CSA target
33966 address record. There are four reasons for &$csa_status$& being &"fail"&:
33967
33968 .ilist
33969 The client's host name is explicitly not authorized.
33970 .next
33971 The client's IP address does not match any of the CSA target IP addresses.
33972 .next
33973 The client's host name is authorized but it has no valid target IP addresses
33974 (for example, the target's addresses are IPv6 and the client is using IPv4).
33975 .next
33976 The client's host name has no CSA SRV record but a parent domain has asserted
33977 that all subdomains must be explicitly authorized.
33978 .endlist
33979
33980 The &%csa%& verification condition can take an argument which is the domain to
33981 use for the DNS query. The default is:
33982 .code
33983 verify = csa/$sender_helo_name
33984 .endd
33985 This implementation includes an extension to CSA. If the query domain
33986 is an address literal such as [192.0.2.95], or if it is a bare IP
33987 address, Exim searches for CSA SRV records in the reverse DNS as if
33988 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33989 meaningful to say:
33990 .code
33991 verify = csa/$sender_host_address
33992 .endd
33993 In fact, this is the check that Exim performs if the client does not say HELO.
33994 This extension can be turned off by setting the main configuration option
33995 &%dns_csa_use_reverse%& to be false.
33996
33997 If a CSA SRV record is not found for the domain itself, a search
33998 is performed through its parent domains for a record which might be
33999 making assertions about subdomains. The maximum depth of this search is limited
34000 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34001 default. Exim does not look for CSA SRV records in a top level domain, so the
34002 default settings handle HELO domains as long as seven
34003 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34004 of legitimate HELO domains.
34005
34006 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34007 direct SRV lookups, this is not sufficient because of the extra parent domain
34008 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34009 addresses into lookups in the reverse DNS space. The result of a successful
34010 lookup such as:
34011 .code
34012 ${lookup dnsdb {csa=$sender_helo_name}}
34013 .endd
34014 has two space-separated fields: an authorization code and a target host name.
34015 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34016 authorization required but absent, or &"?"& for unknown.
34017
34018
34019
34020
34021 .section "Bounce address tag validation" "SECTverifyPRVS"
34022 .cindex "BATV, verifying"
34023 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34024 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34025 Genuine incoming bounce messages should therefore always be addressed to
34026 recipients that have a valid tag. This scheme is a way of detecting unwanted
34027 bounce messages caused by sender address forgeries (often called &"collateral
34028 spam"&), because the recipients of such messages do not include valid tags.
34029
34030 There are two expansion items to help with the implementation of the BATV
34031 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34032 the original envelope sender address by using a simple key to add a hash of the
34033 address and some time-based randomizing information. The &%prvs%& expansion
34034 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34035 The syntax of these expansion items is described in section
34036 &<<SECTexpansionitems>>&.
34037 The validity period on signed addresses is seven days.
34038
34039 As an example, suppose the secret per-address keys are stored in an MySQL
34040 database. A query to look up the key for an address could be defined as a macro
34041 like this:
34042 .code
34043 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34044                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34045                 }{$value}}
34046 .endd
34047 Suppose also that the senders who make use of BATV are defined by an address
34048 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34049 use this:
34050 .code
34051 # Bounces: drop unsigned addresses for BATV senders
34052 deny senders = :
34053      recipients = +batv_senders
34054      message = This address does not send an unsigned reverse path
34055
34056 # Bounces: In case of prvs-signed address, check signature.
34057 deny senders = :
34058      condition  = ${prvscheck {$local_part@$domain}\
34059                   {PRVSCHECK_SQL}{1}}
34060      !condition = $prvscheck_result
34061      message = Invalid reverse path signature.
34062 .endd
34063 The first statement rejects recipients for bounce messages that are addressed
34064 to plain BATV sender addresses, because it is known that BATV senders do not
34065 send out messages with plain sender addresses. The second statement rejects
34066 recipients that are prvs-signed, but with invalid signatures (either because
34067 the key is wrong, or the signature has timed out).
34068
34069 A non-prvs-signed address is not rejected by the second statement, because the
34070 &%prvscheck%& expansion yields an empty string if its first argument is not a
34071 prvs-signed address, thus causing the &%condition%& condition to be false. If
34072 the first argument is a syntactically valid prvs-signed address, the yield is
34073 the third string (in this case &"1"&), whether or not the cryptographic and
34074 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34075 of the checks (empty for failure, &"1"& for success).
34076
34077 There is one more issue you must consider when implementing prvs-signing:
34078 you have to ensure that the routers accept prvs-signed addresses and
34079 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34080 router to remove the signature with a configuration along these lines:
34081 .code
34082 batv_redirect:
34083   driver = redirect
34084   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34085 .endd
34086 This works because, if the third argument of &%prvscheck%& is empty, the result
34087 of the expansion of a prvs-signed address is the decoded value of the original
34088 address. This router should probably be the first of your routers that handles
34089 local addresses.
34090
34091 To create BATV-signed addresses in the first place, a transport of this form
34092 can be used:
34093 .code
34094 external_smtp_batv:
34095   driver = smtp
34096   return_path = ${prvs {$return_path} \
34097                        {${lookup mysql{SELECT \
34098                        secret FROM batv_prvs WHERE \
34099                        sender='${quote_mysql:$sender_address}'} \
34100                        {$value}fail}}}
34101 .endd
34102 If no key can be found for the existing return path, no signing takes place.
34103
34104
34105
34106 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34107 .cindex "&ACL;" "relay control"
34108 .cindex "relaying" "control by ACL"
34109 .cindex "policy control" "relay control"
34110 An MTA is said to &'relay'& a message if it receives it from some host and
34111 delivers it directly to another host as a result of a remote address contained
34112 within it. Redirecting a local address via an alias or forward file and then
34113 passing the message on to another host is not relaying,
34114 .cindex "&""percent hack""&"
34115 but a redirection as a result of the &"percent hack"& is.
34116
34117 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34118 A host which is acting as a gateway or an MX backup is concerned with incoming
34119 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34120 a host which is acting as a smart host for a number of clients is concerned
34121 with outgoing relaying from those clients to the Internet at large. Often the
34122 same host is fulfilling both functions,
34123 . ///
34124 . as illustrated in the diagram below,
34125 . ///
34126 but in principle these two kinds of relaying are entirely independent. What is
34127 not wanted is the transmission of mail from arbitrary remote hosts through your
34128 system to arbitrary domains.
34129
34130
34131 You can implement relay control by means of suitable statements in the ACL that
34132 runs for each RCPT command. For convenience, it is often easiest to use
34133 Exim's named list facility to define the domains and hosts involved. For
34134 example, suppose you want to do the following:
34135
34136 .ilist
34137 Deliver a number of domains to mailboxes on the local host (or process them
34138 locally in some other way). Let's say these are &'my.dom1.example'& and
34139 &'my.dom2.example'&.
34140 .next
34141 Relay mail for a number of other domains for which you are the secondary MX.
34142 These might be &'friend1.example'& and &'friend2.example'&.
34143 .next
34144 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34145 Suppose your LAN is 192.168.45.0/24.
34146 .endlist
34147
34148
34149 In the main part of the configuration, you put the following definitions:
34150 .code
34151 domainlist local_domains    = my.dom1.example : my.dom2.example
34152 domainlist relay_to_domains = friend1.example : friend2.example
34153 hostlist   relay_from_hosts = 192.168.45.0/24
34154 .endd
34155 Now you can use these definitions in the ACL that is run for every RCPT
34156 command:
34157 .code
34158 acl_check_rcpt:
34159   accept domains = +local_domains : +relay_to_domains
34160   accept hosts   = +relay_from_hosts
34161 .endd
34162 The first statement accepts any RCPT command that contains an address in
34163 the local or relay domains. For any other domain, control passes to the second
34164 statement, which accepts the command only if it comes from one of the relay
34165 hosts. In practice, you will probably want to make your ACL more sophisticated
34166 than this, for example, by including sender and recipient verification. The
34167 default configuration includes a more comprehensive example, which is described
34168 in chapter &<<CHAPdefconfil>>&.
34169
34170
34171
34172 .section "Checking a relay configuration" "SECTcheralcon"
34173 .cindex "relaying" "checking control of"
34174 You can check the relay characteristics of your configuration in the same way
34175 that you can test any ACL behaviour for an incoming SMTP connection, by using
34176 the &%-bh%& option to run a fake SMTP session with which you interact.
34177 .ecindex IIDacl
34178
34179
34180
34181 . ////////////////////////////////////////////////////////////////////////////
34182 . ////////////////////////////////////////////////////////////////////////////
34183
34184 .chapter "Content scanning at ACL time" "CHAPexiscan"
34185 .scindex IIDcosca "content scanning" "at ACL time"
34186 The extension of Exim to include content scanning at ACL time, formerly known
34187 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34188 was integrated into the main source for Exim release 4.50, and Tom continues to
34189 maintain it. Most of the wording of this chapter is taken from Tom's
34190 specification.
34191
34192 It is also possible to scan the content of messages at other times. The
34193 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34194 scanning after all the ACLs have run. A transport filter can be used to scan
34195 messages at delivery time (see the &%transport_filter%& option, described in
34196 chapter &<<CHAPtransportgeneric>>&).
34197
34198 If you want to include the ACL-time content-scanning features when you compile
34199 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34200 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34201
34202 .ilist
34203 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34204 for all MIME parts for SMTP and non-SMTP messages, respectively.
34205 .next
34206 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34207 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34208 run at the end of message reception (the &%acl_smtp_data%& ACL).
34209 .next
34210 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34211 of messages, or parts of messages, for debugging purposes.
34212 .next
34213 Additional expansion variables that are set in the new ACL and by the new
34214 conditions.
34215 .next
34216 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34217 .endlist
34218
34219 Content-scanning is continually evolving, and new features are still being
34220 added. While such features are still unstable and liable to incompatible
34221 changes, they are made available in Exim by setting options whose names begin
34222 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34223 this manual. You can find out about them by reading the file called
34224 &_doc/experimental.txt_&.
34225
34226 All the content-scanning facilities work on a MBOX copy of the message that is
34227 temporarily created in a file called:
34228 .display
34229 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34230 .endd
34231 The &_.eml_& extension is a friendly hint to virus scanners that they can
34232 expect an MBOX-like structure inside that file. The file is created when the
34233 first content scanning facility is called. Subsequent calls to content
34234 scanning conditions open the same file again. The directory is recursively
34235 removed when the &%acl_smtp_data%& ACL has finished running, unless
34236 .code
34237 control = no_mbox_unspool
34238 .endd
34239 has been encountered. When the MIME ACL decodes files, they are put into the
34240 same directory by default.
34241
34242
34243
34244 .section "Scanning for viruses" "SECTscanvirus"
34245 .cindex "virus scanning"
34246 .cindex "content scanning" "for viruses"
34247 .cindex "content scanning" "the &%malware%& condition"
34248 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34249 It supports a &"generic"& interface to scanners called via the shell, and
34250 specialized interfaces for &"daemon"& type virus scanners, which are resident
34251 in memory and thus are much faster.
34252
34253 Since message data needs to have arrived,
34254 the condition may be only called in ACL defined by
34255 &%acl_smtp_data%&,
34256 &%acl_smtp_data_prdr%&,
34257 &%acl_smtp_mime%& or
34258 &%acl_smtp_dkim%&
34259
34260 A timeout of 2 minutes is applied to a scanner call (by default);
34261 if it expires then a defer action is taken.
34262
34263 .oindex "&%av_scanner%&"
34264 You can set the &%av_scanner%& option in the main part of the configuration
34265 to specify which scanner to use, together with any additional options that
34266 are needed. The basic syntax is as follows:
34267 .display
34268 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34269 .endd
34270 If you do not set &%av_scanner%&, it defaults to
34271 .code
34272 av_scanner = sophie:/var/run/sophie
34273 .endd
34274 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34275 before use.
34276 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34277 The following scanner types are supported in this release,
34278 though individual ones can be included or not at build time:
34279
34280 .vlist
34281 .vitem &%avast%&
34282 .cindex "virus scanners" "avast"
34283 This is the scanner daemon of Avast. It has been tested with Avast Core
34284 Security (currently at version 2.2.0).
34285 You can get a trial version at &url(https://www.avast.com) or for Linux
34286 at &url(https://www.avast.com/linux-server-antivirus).
34287 This scanner type takes one option,
34288 which can be either a full path to a UNIX socket,
34289 or host and port specifiers separated by white space.
34290 The host may be a name or an IP address; the port is either a
34291 single number or a pair of numbers with a dash between.
34292 A list of options may follow. These options are interpreted on the
34293 Exim's side of the malware scanner, or are given on separate lines to
34294 the daemon as options before the main scan command.
34295
34296 .cindex &`pass_unscanned`& "avast"
34297 If &`pass_unscanned`&
34298 is set, any files the Avast scanner can't scan (e.g.
34299 decompression bombs, or invalid archives) are considered clean. Use with
34300 care.
34301
34302 For example:
34303 .code
34304 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34305 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34306 av_scanner = avast:192.168.2.22 5036
34307 .endd
34308 If you omit the argument, the default path
34309 &_/var/run/avast/scan.sock_&
34310 is used.
34311 If you use a remote host,
34312 you need to make Exim's spool directory available to it,
34313 as the scanner is passed a file path, not file contents.
34314 For information about available commands and their options you may use
34315 .code
34316 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34317     FLAGS
34318     SENSITIVITY
34319     PACK
34320 .endd
34321
34322 If the scanner returns a temporary failure (e.g. license issues, or
34323 permission problems), the message is deferred and a paniclog entry is
34324 written.  The usual &`defer_ok`& option is available.
34325
34326 .vitem &%aveserver%&
34327 .cindex "virus scanners" "Kaspersky"
34328 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34329 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34330 which is the path to the daemon's UNIX socket. The default is shown in this
34331 example:
34332 .code
34333 av_scanner = aveserver:/var/run/aveserver
34334 .endd
34335
34336
34337 .vitem &%clamd%&
34338 .cindex "virus scanners" "clamd"
34339 This daemon-type scanner is GPL and free. You can get it at
34340 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34341 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34342 in the MIME ACL. This is no longer believed to be necessary.
34343
34344 The options are a list of server specifiers, which may be
34345 a UNIX socket specification,
34346 a TCP socket specification,
34347 or a (global) option.
34348
34349 A socket specification consists of a space-separated list.
34350 For a Unix socket the first element is a full path for the socket,
34351 for a TCP socket the first element is the IP address
34352 and the second a port number,
34353 Any further elements are per-server (non-global) options.
34354 These per-server options are supported:
34355 .code
34356 retry=<timespec>        Retry on connect fail
34357 .endd
34358
34359 The &`retry`& option specifies a time after which a single retry for
34360 a failed connect is made.  The default is to not retry.
34361
34362 If a Unix socket file is specified, only one server is supported.
34363
34364 Examples:
34365 .code
34366 av_scanner = clamd:/opt/clamd/socket
34367 av_scanner = clamd:192.0.2.3 1234
34368 av_scanner = clamd:192.0.2.3 1234:local
34369 av_scanner = clamd:192.0.2.3 1234 retry=10s
34370 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34371 .endd
34372 If the value of av_scanner points to a UNIX socket file or contains the
34373 &`local`&
34374 option, then the ClamAV interface will pass a filename containing the data
34375 to be scanned, which should normally result in less I/O happening and be
34376 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34377 Exim does not assume that there is a common filesystem with the remote host.
34378
34379 The final example shows that multiple TCP targets can be specified.  Exim will
34380 randomly use one for each incoming email (i.e. it load balances them).  Note
34381 that only TCP targets may be used if specifying a list of scanners; a UNIX
34382 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34383 unavailable, Exim will try the remaining one(s) until it finds one that works.
34384 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34385 not keep track of scanner state between multiple messages, and the scanner
34386 selection is random, so the message will get logged in the mainlog for each
34387 email that the down scanner gets chosen first (message wrapped to be readable):
34388 .code
34389 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34390    clamd: connection to localhost, port 3310 failed
34391    (Connection refused)
34392 .endd
34393
34394 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34395 contributing the code for this scanner.
34396
34397 .vitem &%cmdline%&
34398 .cindex "virus scanners" "command line interface"
34399 This is the keyword for the generic command line scanner interface. It can be
34400 used to attach virus scanners that are invoked from the shell. This scanner
34401 type takes 3 mandatory options:
34402
34403 .olist
34404 The full path and name of the scanner binary, with all command line options,
34405 and a placeholder (&`%s`&) for the directory to scan.
34406
34407 .next
34408 A regular expression to match against the STDOUT and STDERR output of the
34409 virus scanner. If the expression matches, a virus was found. You must make
34410 absolutely sure that this expression matches on &"virus found"&. This is called
34411 the &"trigger"& expression.
34412
34413 .next
34414 Another regular expression, containing exactly one pair of parentheses, to
34415 match the name of the virus found in the scanners output. This is called the
34416 &"name"& expression.
34417 .endlist olist
34418
34419 For example, Sophos Sweep reports a virus on a line like this:
34420 .code
34421 Virus 'W32/Magistr-B' found in file ./those.bat
34422 .endd
34423 For the trigger expression, we can match the phrase &"found in file"&. For the
34424 name expression, we want to extract the W32/Magistr-B string, so we can match
34425 for the single quotes left and right of it. Altogether, this makes the
34426 configuration setting:
34427 .code
34428 av_scanner = cmdline:\
34429              /path/to/sweep -ss -all -rec -archive %s:\
34430              found in file:'(.+)'
34431 .endd
34432 .vitem &%drweb%&
34433 .cindex "virus scanners" "DrWeb"
34434 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34435 takes one option,
34436 either a full path to a UNIX socket,
34437 or host and port specifiers separated by white space.
34438 The host may be a name or an IP address; the port is either a
34439 single number or a pair of numbers with a dash between.
34440 For example:
34441 .code
34442 av_scanner = drweb:/var/run/drwebd.sock
34443 av_scanner = drweb:192.168.2.20 31337
34444 .endd
34445 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34446 is used. Thanks to Alex Miller for contributing the code for this scanner.
34447
34448 .vitem &%f-protd%&
34449 .cindex "virus scanners" "f-protd"
34450 The f-protd scanner is accessed via HTTP over TCP.
34451 One argument is taken, being a space-separated hostname and port number
34452 (or port-range).
34453 For example:
34454 .code
34455 av_scanner = f-protd:localhost 10200-10204
34456 .endd
34457 If you omit the argument, the default values shown above are used.
34458
34459 .vitem &%f-prot6d%&
34460 .cindex "virus scanners" "f-prot6d"
34461 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34462 One argument is taken, being a space-separated hostname and port number.
34463 For example:
34464 .code
34465 av_scanner = f-prot6d:localhost 10200
34466 .endd
34467 If you omit the argument, the default values show above are used.
34468
34469 .vitem &%fsecure%&
34470 .cindex "virus scanners" "F-Secure"
34471 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34472 argument which is the path to a UNIX socket. For example:
34473 .code
34474 av_scanner = fsecure:/path/to/.fsav
34475 .endd
34476 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34477 Thelmen for contributing the code for this scanner.
34478
34479 .vitem &%kavdaemon%&
34480 .cindex "virus scanners" "Kaspersky"
34481 This is the scanner daemon of Kaspersky Version 4. This version of the
34482 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34483 scanner type takes one option, which is the path to the daemon's UNIX socket.
34484 For example:
34485 .code
34486 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34487 .endd
34488 The default path is &_/var/run/AvpCtl_&.
34489
34490 .vitem &%mksd%&
34491 .cindex "virus scanners" "mksd"
34492 This was a daemon type scanner that is aimed mainly at Polish users,
34493 though some documentation was available in English.
34494 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34495 and this appears to be a candidate for removal from Exim, unless
34496 we are informed of other virus scanners which use the same protocol
34497 to integrate.
34498 The only option for this scanner type is
34499 the maximum number of processes used simultaneously to scan the attachments,
34500 provided that mksd has
34501 been run with at least the same number of child processes. For example:
34502 .code
34503 av_scanner = mksd:2
34504 .endd
34505 You can safely omit this option (the default value is 1).
34506
34507 .vitem &%sock%&
34508 .cindex "virus scanners" "simple socket-connected"
34509 This is a general-purpose way of talking to simple scanner daemons
34510 running on the local machine.
34511 There are four options:
34512 an address (which may be an IP address and port, or the path of a Unix socket),
34513 a commandline to send (may include a single %s which will be replaced with
34514 the path to the mail file to be scanned),
34515 an RE to trigger on from the returned data,
34516 and an RE to extract malware_name from the returned data.
34517 For example:
34518 .code
34519 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34520 .endd
34521 Note that surrounding whitespace is stripped from each option, meaning
34522 there is no way to specify a trailing newline.
34523 The socket specifier and both regular-expressions are required.
34524 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34525 specify an empty element to get this.
34526
34527 .vitem &%sophie%&
34528 .cindex "virus scanners" "Sophos and Sophie"
34529 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34530 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34531 for this scanner type is the path to the UNIX socket that Sophie uses for
34532 client communication. For example:
34533 .code
34534 av_scanner = sophie:/tmp/sophie
34535 .endd
34536 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34537 the option.
34538 .endlist
34539
34540 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34541 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34542 ACL.
34543
34544 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34545 makes it possible to use different scanners. See further below for an example.
34546 The &%malware%& condition caches its results, so when you use it multiple times
34547 for the same message, the actual scanning process is only carried out once.
34548 However, using expandable items in &%av_scanner%& disables this caching, in
34549 which case each use of the &%malware%& condition causes a new scan of the
34550 message.
34551
34552 The &%malware%& condition takes a right-hand argument that is expanded before
34553 use and taken as a list, slash-separated by default.
34554 The first element can then be one of
34555
34556 .ilist
34557 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34558 The condition succeeds if a virus was found, and fail otherwise. This is the
34559 recommended usage.
34560 .next
34561 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34562 the condition fails immediately.
34563 .next
34564 A regular expression, in which case the message is scanned for viruses. The
34565 condition succeeds if a virus is found and its name matches the regular
34566 expression. This allows you to take special actions on certain types of virus.
34567 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34568 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34569 .endlist
34570
34571 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34572 messages even if there is a problem with the virus scanner.
34573 Otherwise, such a problem causes the ACL to defer.
34574
34575 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34576 specify a non-default timeout.  The default is two minutes.
34577 For example:
34578 .code
34579 malware = * / defer_ok / tmo=10s
34580 .endd
34581 A timeout causes the ACL to defer.
34582
34583 .vindex "&$callout_address$&"
34584 When a connection is made to the scanner the expansion variable &$callout_address$&
34585 is set to record the actual address used.
34586
34587 .vindex "&$malware_name$&"
34588 When a virus is found, the condition sets up an expansion variable called
34589 &$malware_name$& that contains the name of the virus. You can use it in a
34590 &%message%& modifier that specifies the error returned to the sender, and/or in
34591 logging data.
34592
34593 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34594 imposed by your anti-virus scanner.
34595
34596 Here is a very simple scanning example:
34597 .code
34598 deny malware = *
34599      message = This message contains malware ($malware_name)
34600 .endd
34601 The next example accepts messages when there is a problem with the scanner:
34602 .code
34603 deny malware = */defer_ok
34604      message = This message contains malware ($malware_name)
34605 .endd
34606 The next example shows how to use an ACL variable to scan with both sophie and
34607 aveserver. It assumes you have set:
34608 .code
34609 av_scanner = $acl_m0
34610 .endd
34611 in the main Exim configuration.
34612 .code
34613 deny set acl_m0 = sophie
34614      malware = *
34615      message = This message contains malware ($malware_name)
34616
34617 deny set acl_m0 = aveserver
34618      malware = *
34619      message = This message contains malware ($malware_name)
34620 .endd
34621
34622
34623 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34624 .cindex "content scanning" "for spam"
34625 .cindex "spam scanning"
34626 .cindex "SpamAssassin"
34627 .cindex "Rspamd"
34628 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34629 score and a report for the message.
34630 Support is also provided for Rspamd.
34631
34632 For more information about installation and configuration of SpamAssassin or
34633 Rspamd refer to their respective websites at
34634 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34635
34636 SpamAssassin can be installed with CPAN by running:
34637 .code
34638 perl -MCPAN -e 'install Mail::SpamAssassin'
34639 .endd
34640 SpamAssassin has its own set of configuration files. Please review its
34641 documentation to see how you can tweak it. The default installation should work
34642 nicely, however.
34643
34644 .oindex "&%spamd_address%&"
34645 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34646 intend to use an instance running on the local host you do not need to set
34647 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34648 you must set the &%spamd_address%& option in the global part of the Exim
34649 configuration as follows (example):
34650 .code
34651 spamd_address = 192.168.99.45 783
34652 .endd
34653 The SpamAssassin protocol relies on a TCP half-close from the client.
34654 If your SpamAssassin client side is running a Linux system with an
34655 iptables firewall, consider setting
34656 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34657 timeout, Exim uses when waiting for a response from the SpamAssassin
34658 server (currently defaulting to 120s).  With a lower value the Linux
34659 connection tracking may consider your half-closed connection as dead too
34660 soon.
34661
34662
34663 To use Rspamd (which by default listens on all local addresses
34664 on TCP port 11333)
34665 you should add &%variant=rspamd%& after the address/port pair, for example:
34666 .code
34667 spamd_address = 127.0.0.1 11333 variant=rspamd
34668 .endd
34669
34670 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34671 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34672 filename instead of an address/port pair:
34673 .code
34674 spamd_address = /var/run/spamd_socket
34675 .endd
34676 You can have multiple &%spamd%& servers to improve scalability. These can
34677 reside on other hardware reachable over the network. To specify multiple
34678 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34679 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34680 .code
34681 spamd_address = 192.168.2.10 783 : \
34682                 192.168.2.11 783 : \
34683                 192.168.2.12 783
34684 .endd
34685 Up to 32 &%spamd%& servers are supported.
34686 When a server fails to respond to the connection attempt, all other
34687 servers are tried until one succeeds. If no server responds, the &%spam%&
34688 condition defers.
34689
34690 Unix and TCP socket specifications may be mixed in any order.
34691 Each element of the list is a list itself, space-separated by default
34692 and changeable in the usual way (&<<SECTlistsepchange>>&);
34693 take care to not double the separator.
34694
34695 For TCP socket specifications a host name or IP (v4 or v6, but
34696 subject to list-separator quoting rules) address can be used,
34697 and the port can be one or a dash-separated pair.
34698 In the latter case, the range is tried in strict order.
34699
34700 Elements after the first for Unix sockets, or second for TCP socket,
34701 are options.
34702 The supported options are:
34703 .code
34704 pri=<priority>      Selection priority
34705 weight=<value>      Selection bias
34706 time=<start>-<end>  Use only between these times of day
34707 retry=<timespec>    Retry on connect fail
34708 tmo=<timespec>      Connection time limit
34709 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34710 .endd
34711
34712 The &`pri`& option specifies a priority for the server within the list,
34713 higher values being tried first.
34714 The default priority is 1.
34715
34716 The &`weight`& option specifies a selection bias.
34717 Within a priority set
34718 servers are queried in a random fashion, weighted by this value.
34719 The default value for selection bias is 1.
34720
34721 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34722 in the local time zone; each element being one or more digits.
34723 Either the seconds or both minutes and seconds, plus the leading &`.`&
34724 characters, may be omitted and will be taken as zero.
34725
34726 Timeout specifications for the &`retry`& and &`tmo`& options
34727 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34728
34729 The &`tmo`& option specifies an overall timeout for communication.
34730 The default value is two minutes.
34731
34732 The &`retry`& option specifies a time after which a single retry for
34733 a failed connect is made.
34734 The default is to not retry.
34735
34736 The &%spamd_address%& variable is expanded before use if it starts with
34737 a dollar sign. In this case, the expansion may return a string that is
34738 used as the list so that multiple spamd servers can be the result of an
34739 expansion.
34740
34741 .vindex "&$callout_address$&"
34742 When a connection is made to the server the expansion variable &$callout_address$&
34743 is set to record the actual address used.
34744
34745 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34746 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34747 .code
34748 deny spam = joe
34749      message = This message was classified as SPAM
34750 .endd
34751 The right-hand side of the &%spam%& condition specifies a name. This is
34752 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34753 to scan using a specific profile, but rather use the SpamAssassin system-wide
34754 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34755 Rspamd does not use this setting. However, you must put something on the
34756 right-hand side.
34757
34758 The name allows you to use per-domain or per-user antispam profiles in
34759 principle, but this is not straightforward in practice, because a message may
34760 have multiple recipients, not necessarily all in the same domain. Because the
34761 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34762 read the contents of the message, the variables &$local_part$& and &$domain$&
34763 are not set.
34764 Careful enforcement of single-recipient messages
34765 (e.g. by responding with defer in the recipient ACL for all recipients
34766 after the first),
34767 or the use of PRDR,
34768 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34769 are needed to use this feature.
34770
34771 The right-hand side of the &%spam%& condition is expanded before being used, so
34772 you can put lookups or conditions there. When the right-hand side evaluates to
34773 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34774
34775
34776 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34777 large ones may cause significant performance degradation. As most spam messages
34778 are quite small, it is recommended that you do not scan the big ones. For
34779 example:
34780 .code
34781 deny condition = ${if < {$message_size}{10K}}
34782      spam = nobody
34783      message = This message was classified as SPAM
34784 .endd
34785
34786 The &%spam%& condition returns true if the threshold specified in the user's
34787 SpamAssassin profile has been matched or exceeded. If you want to use the
34788 &%spam%& condition for its side effects (see the variables below), you can make
34789 it always return &"true"& by appending &`:true`& to the username.
34790
34791 .cindex "spam scanning" "returned variables"
34792 When the &%spam%& condition is run, it sets up a number of expansion
34793 variables.
34794 Except for &$spam_report$&,
34795 these variables are saved with the received message so are
34796 available for use at delivery time.
34797
34798 .vlist
34799 .vitem &$spam_score$&
34800 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34801 for inclusion in log or reject messages.
34802
34803 .vitem &$spam_score_int$&
34804 The spam score of the message, multiplied by ten, as an integer value. For
34805 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34806 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34807 The integer value is useful for numeric comparisons in conditions.
34808
34809 .vitem &$spam_bar$&
34810 A string consisting of a number of &"+"& or &"-"& characters, representing the
34811 integer part of the spam score value. A spam score of 4.4 would have a
34812 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34813 headers, since MUAs can match on such strings. The maximum length of the
34814 spam bar is 50 characters.
34815
34816 .vitem &$spam_report$&
34817 A multiline text table, containing the full SpamAssassin report for the
34818 message. Useful for inclusion in headers or reject messages.
34819 This variable is only usable in a DATA-time ACL.
34820 Beware that SpamAssassin may return non-ASCII characters, especially
34821 when running in country-specific locales, which are not legal
34822 unencoded in headers.
34823
34824 .vitem &$spam_action$&
34825 For SpamAssassin either 'reject' or 'no action' depending on the
34826 spam score versus threshold.
34827 For Rspamd, the recommended action.
34828
34829 .endlist
34830
34831 The &%spam%& condition caches its results unless expansion in
34832 spamd_address was used. If you call it again with the same user name, it
34833 does not scan again, but rather returns the same values as before.
34834
34835 The &%spam%& condition returns DEFER if there is any error while running
34836 the message through SpamAssassin or if the expansion of spamd_address
34837 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34838 statement block), append &`/defer_ok`& to the right-hand side of the
34839 spam condition, like this:
34840 .code
34841 deny spam    = joe/defer_ok
34842      message = This message was classified as SPAM
34843 .endd
34844 This causes messages to be accepted even if there is a problem with &%spamd%&.
34845
34846 Here is a longer, commented example of the use of the &%spam%&
34847 condition:
34848 .code
34849 # put headers in all messages (no matter if spam or not)
34850 warn  spam = nobody:true
34851       add_header = X-Spam-Score: $spam_score ($spam_bar)
34852       add_header = X-Spam-Report: $spam_report
34853
34854 # add second subject line with *SPAM* marker when message
34855 # is over threshold
34856 warn  spam = nobody
34857       add_header = Subject: *SPAM* $h_Subject:
34858
34859 # reject spam at high scores (> 12)
34860 deny  spam = nobody:true
34861       condition = ${if >{$spam_score_int}{120}{1}{0}}
34862       message = This message scored $spam_score spam points.
34863 .endd
34864
34865
34866
34867 .section "Scanning MIME parts" "SECTscanmimepart"
34868 .cindex "content scanning" "MIME parts"
34869 .cindex "MIME content scanning"
34870 .oindex "&%acl_smtp_mime%&"
34871 .oindex "&%acl_not_smtp_mime%&"
34872 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34873 each MIME part of an SMTP message, including multipart types, in the sequence
34874 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34875 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34876 options may both refer to the same ACL if you want the same processing in both
34877 cases.
34878
34879 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34880 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34881 the case of a non-SMTP message. However, a MIME ACL is called only if the
34882 message contains a &'Content-Type:'& header line. When a call to a MIME
34883 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34884 result code is sent to the client. In the case of an SMTP message, the
34885 &%acl_smtp_data%& ACL is not called when this happens.
34886
34887 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34888 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34889 condition to match against the raw MIME part. You can also use the
34890 &%mime_regex%& condition to match against the decoded MIME part (see section
34891 &<<SECTscanregex>>&).
34892
34893 At the start of a MIME ACL, a number of variables are set from the header
34894 information for the relevant MIME part. These are described below. The contents
34895 of the MIME part are not by default decoded into a disk file except for MIME
34896 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34897 part into a disk file, you can use the &%decode%& condition. The general
34898 syntax is:
34899 .display
34900 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34901 .endd
34902 The right hand side is expanded before use. After expansion,
34903 the value can be:
34904
34905 .olist
34906 &"0"& or &"false"&, in which case no decoding is done.
34907 .next
34908 The string &"default"&. In that case, the file is put in the temporary
34909 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34910 a sequential filename consisting of the message id and a sequence number. The
34911 full path and name is available in &$mime_decoded_filename$& after decoding.
34912 .next
34913 A full path name starting with a slash. If the full name is an existing
34914 directory, it is used as a replacement for the default directory. The filename
34915 is then sequentially assigned. If the path does not exist, it is used as
34916 the full path and filename.
34917 .next
34918 If the string does not start with a slash, it is used as the
34919 filename, and the default path is then used.
34920 .endlist
34921 The &%decode%& condition normally succeeds. It is only false for syntax
34922 errors or unusual circumstances such as memory shortages. You can easily decode
34923 a file with its original, proposed filename using
34924 .code
34925 decode = $mime_filename
34926 .endd
34927 However, you should keep in mind that &$mime_filename$& might contain
34928 anything. If you place files outside of the default path, they are not
34929 automatically unlinked.
34930
34931 For RFC822 attachments (these are messages attached to messages, with a
34932 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34933 as for the primary message, only that the &$mime_is_rfc822$& expansion
34934 variable is set (see below). Attached messages are always decoded to disk
34935 before being checked, and the files are unlinked once the check is done.
34936
34937 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34938 used to match regular expressions against raw and decoded MIME parts,
34939 respectively. They are described in section &<<SECTscanregex>>&.
34940
34941 .cindex "MIME content scanning" "returned variables"
34942 The following list describes all expansion variables that are
34943 available in the MIME ACL:
34944
34945 .vlist
34946 .vitem &$mime_anomaly_level$& &&&
34947        &$mime_anomaly_text$&
34948 .vindex &$mime_anomaly_level$&
34949 .vindex &$mime_anomaly_text$&
34950 If there are problems decoding, these variables contain information on
34951 the detected issue.
34952
34953 .vitem &$mime_boundary$&
34954 .vindex &$mime_boundary$&
34955 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34956 have a boundary string, which is stored in this variable. If the current part
34957 has no boundary parameter in the &'Content-Type:'& header, this variable
34958 contains the empty string.
34959
34960 .vitem &$mime_charset$&
34961 .vindex &$mime_charset$&
34962 This variable contains the character set identifier, if one was found in the
34963 &'Content-Type:'& header. Examples for charset identifiers are:
34964 .code
34965 us-ascii
34966 gb2312 (Chinese)
34967 iso-8859-1
34968 .endd
34969 Please note that this value is not normalized, so you should do matches
34970 case-insensitively.
34971
34972 .vitem &$mime_content_description$&
34973 .vindex &$mime_content_description$&
34974 This variable contains the normalized content of the &'Content-Description:'&
34975 header. It can contain a human-readable description of the parts content. Some
34976 implementations repeat the filename for attachments here, but they are usually
34977 only used for display purposes.
34978
34979 .vitem &$mime_content_disposition$&
34980 .vindex &$mime_content_disposition$&
34981 This variable contains the normalized content of the &'Content-Disposition:'&
34982 header. You can expect strings like &"attachment"& or &"inline"& here.
34983
34984 .vitem &$mime_content_id$&
34985 .vindex &$mime_content_id$&
34986 This variable contains the normalized content of the &'Content-ID:'& header.
34987 This is a unique ID that can be used to reference a part from another part.
34988
34989 .vitem &$mime_content_size$&
34990 .vindex &$mime_content_size$&
34991 This variable is set only after the &%decode%& modifier (see above) has been
34992 successfully run. It contains the size of the decoded part in kilobytes. The
34993 size is always rounded up to full kilobytes, so only a completely empty part
34994 has a &$mime_content_size$& of zero.
34995
34996 .vitem &$mime_content_transfer_encoding$&
34997 .vindex &$mime_content_transfer_encoding$&
34998 This variable contains the normalized content of the
34999 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35000 type. Typical values are &"base64"& and &"quoted-printable"&.
35001
35002 .vitem &$mime_content_type$&
35003 .vindex &$mime_content_type$&
35004 If the MIME part has a &'Content-Type:'& header, this variable contains its
35005 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35006 are some examples of popular MIME types, as they may appear in this variable:
35007 .code
35008 text/plain
35009 text/html
35010 application/octet-stream
35011 image/jpeg
35012 audio/midi
35013 .endd
35014 If the MIME part has no &'Content-Type:'& header, this variable contains the
35015 empty string.
35016
35017 .vitem &$mime_decoded_filename$&
35018 .vindex &$mime_decoded_filename$&
35019 This variable is set only after the &%decode%& modifier (see above) has been
35020 successfully run. It contains the full path and filename of the file
35021 containing the decoded data.
35022 .endlist
35023
35024 .cindex "RFC 2047"
35025 .vlist
35026 .vitem &$mime_filename$&
35027 .vindex &$mime_filename$&
35028 This is perhaps the most important of the MIME variables. It contains a
35029 proposed filename for an attachment, if one was found in either the
35030 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35031 RFC2047
35032 or RFC2231
35033 decoded, but no additional sanity checks are done.
35034  If no filename was
35035 found, this variable contains the empty string.
35036
35037 .vitem &$mime_is_coverletter$&
35038 .vindex &$mime_is_coverletter$&
35039 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35040 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35041 content in the cover letter, while not restricting attachments at all.
35042
35043 The variable contains 1 (true) for a MIME part believed to be part of the
35044 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35045 follows:
35046
35047 .olist
35048 The outermost MIME part of a message is always a cover letter.
35049
35050 .next
35051 If a multipart/alternative or multipart/related MIME part is a cover letter,
35052 so are all MIME subparts within that multipart.
35053
35054 .next
35055 If any other multipart is a cover letter, the first subpart is a cover letter,
35056 and the rest are attachments.
35057
35058 .next
35059 All parts contained within an attachment multipart are attachments.
35060 .endlist olist
35061
35062 As an example, the following will ban &"HTML mail"& (including that sent with
35063 alternative plain text), while allowing HTML files to be attached. HTML
35064 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35065 .code
35066 deny !condition = $mime_is_rfc822
35067      condition = $mime_is_coverletter
35068      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35069      message = HTML mail is not accepted here
35070 .endd
35071
35072 .vitem &$mime_is_multipart$&
35073 .vindex &$mime_is_multipart$&
35074 This variable has the value 1 (true) when the current part has the main type
35075 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35076 Since multipart entities only serve as containers for other parts, you may not
35077 want to carry out specific actions on them.
35078
35079 .vitem &$mime_is_rfc822$&
35080 .vindex &$mime_is_rfc822$&
35081 This variable has the value 1 (true) if the current part is not a part of the
35082 checked message itself, but part of an attached message. Attached message
35083 decoding is fully recursive.
35084
35085 .vitem &$mime_part_count$&
35086 .vindex &$mime_part_count$&
35087 This variable is a counter that is raised for each processed MIME part. It
35088 starts at zero for the very first part (which is usually a multipart). The
35089 counter is per-message, so it is reset when processing RFC822 attachments (see
35090 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35091 complete, so you can use it in the DATA ACL to determine the number of MIME
35092 parts of a message. For non-MIME messages, this variable contains the value -1.
35093 .endlist
35094
35095
35096
35097 .section "Scanning with regular expressions" "SECTscanregex"
35098 .cindex "content scanning" "with regular expressions"
35099 .cindex "regular expressions" "content scanning with"
35100 You can specify your own custom regular expression matches on the full body of
35101 the message, or on individual MIME parts.
35102
35103 The &%regex%& condition takes one or more regular expressions as arguments and
35104 matches them against the full message (when called in the DATA ACL) or a raw
35105 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35106 linewise, with a maximum line length of 32K characters. That means you cannot
35107 have multiline matches with the &%regex%& condition.
35108
35109 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35110 to 32K of decoded content (the whole content at once, not linewise). If the
35111 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35112 is decoded automatically when &%mime_regex%& is executed (using default path
35113 and filename values). If the decoded data is larger than  32K, only the first
35114 32K characters are checked.
35115
35116 The regular expressions are passed as a colon-separated list. To include a
35117 literal colon, you must double it. Since the whole right-hand side string is
35118 expanded before being used, you must also escape dollar signs and backslashes
35119 with more backslashes, or use the &`\N`& facility to disable expansion.
35120 Here is a simple example that contains two regular expressions:
35121 .code
35122 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35123      message = contains blacklisted regex ($regex_match_string)
35124 .endd
35125 The conditions returns true if any one of the regular expressions matches. The
35126 &$regex_match_string$& expansion variable is then set up and contains the
35127 matching regular expression.
35128 The expansion variables &$regex1$& &$regex2$& etc
35129 are set to any substrings captured by the regular expression.
35130
35131 &*Warning*&: With large messages, these conditions can be fairly
35132 CPU-intensive.
35133
35134 .ecindex IIDcosca
35135
35136
35137
35138
35139 . ////////////////////////////////////////////////////////////////////////////
35140 . ////////////////////////////////////////////////////////////////////////////
35141
35142 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35143          "Local scan function"
35144 .scindex IIDlosca "&[local_scan()]& function" "description of"
35145 .cindex "customizing" "input scan using C function"
35146 .cindex "policy control" "by local scan function"
35147 In these days of email worms, viruses, and ever-increasing spam, some sites
35148 want to apply a lot of checking to messages before accepting them.
35149
35150 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35151 passing messages to external virus and spam scanning software. You can also do
35152 a certain amount in Exim itself through string expansions and the &%condition%&
35153 condition in the ACL that runs after the SMTP DATA command or the ACL for
35154 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35155
35156 To allow for further customization to a site's own requirements, there is the
35157 possibility of linking Exim with a private message scanning function, written
35158 in C. If you want to run code that is written in something other than C, you
35159 can of course use a little C stub to call it.
35160
35161 The local scan function is run once for every incoming message, at the point
35162 when Exim is just about to accept the message.
35163 It can therefore be used to control non-SMTP messages from local processes as
35164 well as messages arriving via SMTP.
35165
35166 Exim applies a timeout to calls of the local scan function, and there is an
35167 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35168 Zero means &"no timeout"&.
35169 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35170 before calling the local scan function, so that the most common types of crash
35171 are caught. If the timeout is exceeded or one of those signals is caught, the
35172 incoming message is rejected with a temporary error if it is an SMTP message.
35173 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35174 code. The incident is logged on the main and reject logs.
35175
35176
35177
35178 .section "Building Exim to use a local scan function" "SECID207"
35179 .cindex "&[local_scan()]& function" "building Exim to use"
35180 To make use of the local scan function feature, you must tell Exim where your
35181 function is before building Exim, by setting
35182 both HAVE_LOCAL_SCAN and
35183 LOCAL_SCAN_SOURCE in your
35184 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35185 directory, so you might set
35186 .code
35187 HAVE_LOCAL_SCAN=yes
35188 LOCAL_SCAN_SOURCE=Local/local_scan.c
35189 .endd
35190 for example. The function must be called &[local_scan()]&;
35191 the source file(s) for it should first #define LOCAL_SCAN
35192 and then #include "local_scan.h".
35193 It is called by
35194 Exim after it has received a message, when the success return code is about to
35195 be sent. This is after all the ACLs have been run. The return code from your
35196 function controls whether the message is actually accepted or not. There is a
35197 commented template function (that just accepts the message) in the file
35198 _src/local_scan.c_.
35199
35200 If you want to make use of Exim's runtime configuration file to set options
35201 for your &[local_scan()]& function, you must also set
35202 .code
35203 LOCAL_SCAN_HAS_OPTIONS=yes
35204 .endd
35205 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35206
35207
35208
35209
35210 .section "API for local_scan()" "SECTapiforloc"
35211 .cindex "&[local_scan()]& function" "API description"
35212 .cindex &%dlfunc%& "API description"
35213 You must include this line near the start of your code:
35214 .code
35215 #define LOCAL_SCAN
35216 #include "local_scan.h"
35217 .endd
35218 This header file defines a number of variables and other values, and the
35219 prototype for the function itself. Exim is coded to use unsigned char values
35220 almost exclusively, and one of the things this header defines is a shorthand
35221 for &`unsigned char`& called &`uschar`&.
35222 It also makes available the following macro definitions, to simplify casting character
35223 strings and pointers to character strings:
35224 .code
35225 #define CS   (char *)
35226 #define CCS  (const char *)
35227 #define CSS  (char **)
35228 #define US   (unsigned char *)
35229 #define CUS  (const unsigned char *)
35230 #define USS  (unsigned char **)
35231 .endd
35232 The function prototype for &[local_scan()]& is:
35233 .code
35234 extern int local_scan(int fd, uschar **return_text);
35235 .endd
35236 The arguments are as follows:
35237
35238 .ilist
35239 &%fd%& is a file descriptor for the file that contains the body of the message
35240 (the -D file). The file is open for reading and writing, but updating it is not
35241 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35242
35243 The descriptor is positioned at character 19 of the file, which is the first
35244 character of the body itself, because the first 19 characters are the message
35245 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35246 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35247 case this changes in some future version.
35248 .next
35249 &%return_text%& is an address which you can use to return a pointer to a text
35250 string at the end of the function. The value it points to on entry is NULL.
35251 .endlist
35252
35253 The function must return an &%int%& value which is one of the following macros:
35254
35255 .vlist
35256 .vitem &`LOCAL_SCAN_ACCEPT`&
35257 .vindex "&$local_scan_data$&"
35258 The message is accepted. If you pass back a string of text, it is saved with
35259 the message, and made available in the variable &$local_scan_data$&. No
35260 newlines are permitted (if there are any, they are turned into spaces) and the
35261 maximum length of text is 1000 characters.
35262
35263 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35264 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35265 queued without immediate delivery, and is frozen.
35266
35267 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35268 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35269 queued without immediate delivery.
35270
35271 .vitem &`LOCAL_SCAN_REJECT`&
35272 The message is rejected; the returned text is used as an error message which is
35273 passed back to the sender and which is also logged. Newlines are permitted &--
35274 they cause a multiline response for SMTP rejections, but are converted to
35275 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35276 used.
35277
35278 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35279 The message is temporarily rejected; the returned text is used as an error
35280 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35281 problem"& is used.
35282
35283 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35284 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35285 message is not written to the reject log. It has the effect of unsetting the
35286 &%rejected_header%& log selector for just this rejection. If
35287 &%rejected_header%& is already unset (see the discussion of the
35288 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35289 same as LOCAL_SCAN_REJECT.
35290
35291 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35292 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35293 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35294 .endlist
35295
35296 If the message is not being received by interactive SMTP, rejections are
35297 reported by writing to &%stderr%& or by sending an email, as configured by the
35298 &%-oe%& command line options.
35299
35300
35301
35302 .section "Configuration options for local_scan()" "SECTconoptloc"
35303 .cindex "&[local_scan()]& function" "configuration options"
35304 It is possible to have option settings in the main configuration file
35305 that set values in static variables in the &[local_scan()]& module. If you
35306 want to do this, you must have the line
35307 .code
35308 LOCAL_SCAN_HAS_OPTIONS=yes
35309 .endd
35310 in your &_Local/Makefile_& when you build Exim. (This line is in
35311 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35312 file, you must define static variables to hold the option values, and a table
35313 to define them.
35314
35315 The table must be a vector called &%local_scan_options%&, of type
35316 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35317 and a pointer to the variable that holds the value. The entries must appear in
35318 alphabetical order. Following &%local_scan_options%& you must also define a
35319 variable called &%local_scan_options_count%& that contains the number of
35320 entries in the table. Here is a short example, showing two kinds of option:
35321 .code
35322 static int my_integer_option = 42;
35323 static uschar *my_string_option = US"a default string";
35324
35325 optionlist local_scan_options[] = {
35326   { "my_integer", opt_int,       &my_integer_option },
35327   { "my_string",  opt_stringptr, &my_string_option }
35328 };
35329
35330 int local_scan_options_count =
35331   sizeof(local_scan_options)/sizeof(optionlist);
35332 .endd
35333 The values of the variables can now be changed from Exim's runtime
35334 configuration file by including a local scan section as in this example:
35335 .code
35336 begin local_scan
35337 my_integer = 99
35338 my_string = some string of text...
35339 .endd
35340 The available types of option data are as follows:
35341
35342 .vlist
35343 .vitem &*opt_bool*&
35344 This specifies a boolean (true/false) option. The address should point to a
35345 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35346 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35347 whether such a variable has been set at all, you can initialize it to
35348 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35349 values.)
35350
35351 .vitem &*opt_fixed*&
35352 This specifies a fixed point number, such as is used for load averages.
35353 The address should point to a variable of type &`int`&. The value is stored
35354 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35355
35356 .vitem &*opt_int*&
35357 This specifies an integer; the address should point to a variable of type
35358 &`int`&. The value may be specified in any of the integer formats accepted by
35359 Exim.
35360
35361 .vitem &*opt_mkint*&
35362 This is the same as &%opt_int%&, except that when such a value is output in a
35363 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35364 printed with the suffix K or M.
35365
35366 .vitem &*opt_octint*&
35367 This also specifies an integer, but the value is always interpreted as an
35368 octal integer, whether or not it starts with the digit zero, and it is
35369 always output in octal.
35370
35371 .vitem &*opt_stringptr*&
35372 This specifies a string value; the address must be a pointer to a
35373 variable that points to a string (for example, of type &`uschar *`&).
35374
35375 .vitem &*opt_time*&
35376 This specifies a time interval value. The address must point to a variable of
35377 type &`int`&. The value that is placed there is a number of seconds.
35378 .endlist
35379
35380 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35381 out the values of all the &[local_scan()]& options.
35382
35383
35384
35385 .section "Available Exim variables" "SECID208"
35386 .cindex "&[local_scan()]& function" "available Exim variables"
35387 The header &_local_scan.h_& gives you access to a number of C variables. These
35388 are the only ones that are guaranteed to be maintained from release to release.
35389 Note, however, that you can obtain the value of any Exim expansion variable,
35390 including &$recipients$&, by calling &'expand_string()'&. The exported
35391 C variables are as follows:
35392
35393 .vlist
35394 .vitem &*int&~body_linecount*&
35395 This variable contains the number of lines in the message's body.
35396 It is not valid if the &%spool_wireformat%& option is used.
35397
35398 .vitem &*int&~body_zerocount*&
35399 This variable contains the number of binary zero bytes in the message's body.
35400 It is not valid if the &%spool_wireformat%& option is used.
35401
35402 .vitem &*unsigned&~int&~debug_selector*&
35403 This variable is set to zero when no debugging is taking place. Otherwise, it
35404 is a bitmap of debugging selectors. Two bits are identified for use in
35405 &[local_scan()]&; they are defined as macros:
35406
35407 .ilist
35408 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35409 testing option that is not privileged &-- any caller may set it. All the
35410 other selector bits can be set only by admin users.
35411
35412 .next
35413 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35414 by the &`+local_scan`& debug selector. It is not included in the default set
35415 of debugging bits.
35416 .endlist ilist
35417
35418 Thus, to write to the debugging output only when &`+local_scan`& has been
35419 selected, you should use code like this:
35420 .code
35421 if ((debug_selector & D_local_scan) != 0)
35422   debug_printf("xxx", ...);
35423 .endd
35424 .vitem &*uschar&~*expand_string_message*&
35425 After a failing call to &'expand_string()'& (returned value NULL), the
35426 variable &%expand_string_message%& contains the error message, zero-terminated.
35427
35428 .vitem &*header_line&~*header_list*&
35429 A pointer to a chain of header lines. The &%header_line%& structure is
35430 discussed below.
35431
35432 .vitem &*header_line&~*header_last*&
35433 A pointer to the last of the header lines.
35434
35435 .vitem &*const&~uschar&~*headers_charset*&
35436 The value of the &%headers_charset%& configuration option.
35437
35438 .vitem &*BOOL&~host_checking*&
35439 This variable is TRUE during a host checking session that is initiated by the
35440 &%-bh%& command line option.
35441
35442 .vitem &*uschar&~*interface_address*&
35443 The IP address of the interface that received the message, as a string. This
35444 is NULL for locally submitted messages.
35445
35446 .vitem &*int&~interface_port*&
35447 The port on which this message was received. When testing with the &%-bh%&
35448 command line option, the value of this variable is -1 unless a port has been
35449 specified via the &%-oMi%& option.
35450
35451 .vitem &*uschar&~*message_id*&
35452 This variable contains Exim's message id for the incoming message (the value of
35453 &$message_exim_id$&) as a zero-terminated string.
35454
35455 .vitem &*uschar&~*received_protocol*&
35456 The name of the protocol by which the message was received.
35457
35458 .vitem &*int&~recipients_count*&
35459 The number of accepted recipients.
35460
35461 .vitem &*recipient_item&~*recipients_list*&
35462 .cindex "recipient" "adding in local scan"
35463 .cindex "recipient" "removing in local scan"
35464 The list of accepted recipients, held in a vector of length
35465 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35466 can add additional recipients by calling &'receive_add_recipient()'& (see
35467 below). You can delete recipients by removing them from the vector and
35468 adjusting the value in &%recipients_count%&. In particular, by setting
35469 &%recipients_count%& to zero you remove all recipients. If you then return the
35470 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35471 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35472 and then call &'receive_add_recipient()'& as often as needed.
35473
35474 .vitem &*uschar&~*sender_address*&
35475 The envelope sender address. For bounce messages this is the empty string.
35476
35477 .vitem &*uschar&~*sender_host_address*&
35478 The IP address of the sending host, as a string. This is NULL for
35479 locally-submitted messages.
35480
35481 .vitem &*uschar&~*sender_host_authenticated*&
35482 The name of the authentication mechanism that was used, or NULL if the message
35483 was not received over an authenticated SMTP connection.
35484
35485 .vitem &*uschar&~*sender_host_name*&
35486 The name of the sending host, if known.
35487
35488 .vitem &*int&~sender_host_port*&
35489 The port on the sending host.
35490
35491 .vitem &*BOOL&~smtp_input*&
35492 This variable is TRUE for all SMTP input, including BSMTP.
35493
35494 .vitem &*BOOL&~smtp_batched_input*&
35495 This variable is TRUE for BSMTP input.
35496
35497 .vitem &*int&~store_pool*&
35498 The contents of this variable control which pool of memory is used for new
35499 requests. See section &<<SECTmemhanloc>>& for details.
35500 .endlist
35501
35502
35503 .section "Structure of header lines" "SECID209"
35504 The &%header_line%& structure contains the members listed below.
35505 You can add additional header lines by calling the &'header_add()'& function
35506 (see below). You can cause header lines to be ignored (deleted) by setting
35507 their type to *.
35508
35509
35510 .vlist
35511 .vitem &*struct&~header_line&~*next*&
35512 A pointer to the next header line, or NULL for the last line.
35513
35514 .vitem &*int&~type*&
35515 A code identifying certain headers that Exim recognizes. The codes are printing
35516 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35517 Notice in particular that any header line whose type is * is not transmitted
35518 with the message. This flagging is used for header lines that have been
35519 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35520 lines.) Effectively, * means &"deleted"&.
35521
35522 .vitem &*int&~slen*&
35523 The number of characters in the header line, including the terminating and any
35524 internal newlines.
35525
35526 .vitem &*uschar&~*text*&
35527 A pointer to the text of the header. It always ends with a newline, followed by
35528 a zero byte. Internal newlines are preserved.
35529 .endlist
35530
35531
35532
35533 .section "Structure of recipient items" "SECID210"
35534 The &%recipient_item%& structure contains these members:
35535
35536 .vlist
35537 .vitem &*uschar&~*address*&
35538 This is a pointer to the recipient address as it was received.
35539
35540 .vitem &*int&~pno*&
35541 This is used in later Exim processing when top level addresses are created by
35542 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35543 and must always contain -1 at this stage.
35544
35545 .vitem &*uschar&~*errors_to*&
35546 If this value is not NULL, bounce messages caused by failing to deliver to the
35547 recipient are sent to the address it contains. In other words, it overrides the
35548 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35549 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35550 an unqualified address, Exim qualifies it using the domain from
35551 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35552 is NULL for all recipients.
35553 .endlist
35554
35555
35556
35557 .section "Available Exim functions" "SECID211"
35558 .cindex "&[local_scan()]& function" "available Exim functions"
35559 The header &_local_scan.h_& gives you access to a number of Exim functions.
35560 These are the only ones that are guaranteed to be maintained from release to
35561 release:
35562
35563 .vlist
35564 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35565        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35566
35567 This function creates a child process that runs the command specified by
35568 &%argv%&. The environment for the process is specified by &%envp%&, which can
35569 be NULL if no environment variables are to be passed. A new umask is supplied
35570 for the process in &%newumask%&.
35571
35572 Pipes to the standard input and output of the new process are set up
35573 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35574 standard error is cloned to the standard output. If there are any file
35575 descriptors &"in the way"& in the new process, they are closed. If the final
35576 argument is TRUE, the new process is made into a process group leader.
35577
35578 The function returns the pid of the new process, or -1 if things go wrong.
35579
35580 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35581 This function waits for a child process to terminate, or for a timeout (in
35582 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35583 return value is as follows:
35584
35585 .ilist
35586 >= 0
35587
35588 The process terminated by a normal exit and the value is the process
35589 ending status.
35590
35591 .next
35592 < 0 and > &--256
35593
35594 The process was terminated by a signal and the value is the negation of the
35595 signal number.
35596
35597 .next
35598 &--256
35599
35600 The process timed out.
35601 .next
35602 &--257
35603
35604 The was some other error in wait(); &%errno%& is still set.
35605 .endlist
35606
35607 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35608 This function provide you with a means of submitting a new message to
35609 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35610 want, but this packages it all up for you.) The function creates a pipe,
35611 forks a subprocess that is running
35612 .code
35613 exim -t -oem -oi -f <>
35614 .endd
35615 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35616 that is connected to the standard input. The yield of the function is the PID
35617 of the subprocess. You can then write a message to the file descriptor, with
35618 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35619
35620 When you have finished, call &'child_close()'& to wait for the process to
35621 finish and to collect its ending status. A timeout value of zero is usually
35622 fine in this circumstance. Unless you have made a mistake with the recipient
35623 addresses, you should get a return code of zero.
35624
35625
35626 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35627        *sender_authentication)*&
35628 This function is a more sophisticated version of &'child_open()'&. The command
35629 that it runs is:
35630 .display
35631 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35632 .endd
35633 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35634
35635
35636 .vitem &*void&~debug_printf(char&~*,&~...)*&
35637 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35638 output is written to the standard error stream. If no debugging is selected,
35639 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35640 conditional on the &`local_scan`& debug selector by coding like this:
35641 .code
35642 if ((debug_selector & D_local_scan) != 0)
35643   debug_printf("xxx", ...);
35644 .endd
35645
35646 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35647 This is an interface to Exim's string expansion code. The return value is the
35648 expanded string, or NULL if there was an expansion failure.
35649 The C variable &%expand_string_message%& contains an error message after an
35650 expansion failure. If expansion does not change the string, the return value is
35651 the pointer to the input string. Otherwise, the return value points to a new
35652 block of memory that was obtained by a call to &'store_get()'&. See section
35653 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35654
35655 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35656 This function allows you to an add additional header line at the end of the
35657 existing ones. The first argument is the type, and should normally be a space
35658 character. The second argument is a format string and any number of
35659 substitution arguments as for &[sprintf()]&. You may include internal newlines
35660 if you want, and you must ensure that the string ends with a newline.
35661
35662 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35663         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35664 This function adds a new header line at a specified point in the header
35665 chain. The header itself is specified as for &'header_add()'&.
35666
35667 If &%name%& is NULL, the new header is added at the end of the chain if
35668 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35669 NULL, the header lines are searched for the first non-deleted header that
35670 matches the name. If one is found, the new header is added before it if
35671 &%after%& is false. If &%after%& is true, the new header is added after the
35672 found header and any adjacent subsequent ones with the same name (even if
35673 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35674 option controls where the header is added. If it is true, addition is at the
35675 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35676 headers, or at the top if there are no &'Received:'& headers, you could use
35677 .code
35678 header_add_at_position(TRUE, US"Received", TRUE,
35679   ' ', "X-xxx: ...");
35680 .endd
35681 Normally, there is always at least one non-deleted &'Received:'& header, but
35682 there may not be if &%received_header_text%& expands to an empty string.
35683
35684
35685 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35686 This function removes header lines. If &%occurrence%& is zero or negative, all
35687 occurrences of the header are removed. If occurrence is greater than zero, that
35688 particular instance of the header is removed. If no header(s) can be found that
35689 match the specification, the function does nothing.
35690
35691
35692 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35693         int&~length,&~BOOL&~notdel)*&"
35694 This function tests whether the given header has the given name. It is not just
35695 a string comparison, because white space is permitted between the name and the
35696 colon. If the &%notdel%& argument is true, a false return is forced for all
35697 &"deleted"& headers; otherwise they are not treated specially. For example:
35698 .code
35699 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35700 .endd
35701 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35702 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35703 This function base64-encodes a string, which is passed by address and length.
35704 The text may contain bytes of any value, including zero. The result is passed
35705 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35706 zero-terminated.
35707
35708 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35709 This function decodes a base64-encoded string. Its arguments are a
35710 zero-terminated base64-encoded string and the address of a variable that is set
35711 to point to the result, which is in dynamic memory. The length of the decoded
35712 string is the yield of the function. If the input is invalid base64 data, the
35713 yield is -1. A zero byte is added to the end of the output string to make it
35714 easy to interpret as a C string (assuming it contains no zeros of its own). The
35715 added zero byte is not included in the returned count.
35716
35717 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35718 This function checks for a match in a domain list. Domains are always
35719 matched caselessly. The return value is one of the following:
35720 .itable none 0 0 2 15* left 85* left
35721 .irow &`OK`&    "match succeeded"
35722 .irow &`FAIL`&  "match failed"
35723 .irow &`DEFER`& "match deferred"
35724 .endtable
35725 DEFER is usually caused by some kind of lookup defer, such as the
35726 inability to contact a database.
35727
35728 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35729         BOOL&~caseless)*&"
35730 This function checks for a match in a local part list. The third argument
35731 controls case-sensitivity. The return values are as for
35732 &'lss_match_domain()'&.
35733
35734 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35735         BOOL&~caseless)*&"
35736 This function checks for a match in an address list. The third argument
35737 controls the case-sensitivity of the local part match. The domain is always
35738 matched caselessly. The return values are as for &'lss_match_domain()'&.
35739
35740 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35741         uschar&~*list)*&"
35742 This function checks for a match in a host list. The most common usage is
35743 expected to be
35744 .code
35745 lss_match_host(sender_host_name, sender_host_address, ...)
35746 .endd
35747 .vindex "&$sender_host_address$&"
35748 An empty address field matches an empty item in the host list. If the host name
35749 is NULL, the name corresponding to &$sender_host_address$& is automatically
35750 looked up if a host name is required to match an item in the list. The return
35751 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35752 returns ERROR in the case when it had to look up a host name, but the lookup
35753 failed.
35754
35755 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35756         *format,&~...)*&"
35757 This function writes to Exim's log files. The first argument should be zero (it
35758 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35759 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35760 them. It specifies to which log or logs the message is written. The remaining
35761 arguments are a format and relevant insertion arguments. The string should not
35762 contain any newlines, not even at the end.
35763
35764
35765 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35766 This function adds an additional recipient to the message. The first argument
35767 is the recipient address. If it is unqualified (has no domain), it is qualified
35768 with the &%qualify_recipient%& domain. The second argument must always be -1.
35769
35770 This function does not allow you to specify a private &%errors_to%& address (as
35771 described with the structure of &%recipient_item%& above), because it pre-dates
35772 the addition of that field to the structure. However, it is easy to add such a
35773 value afterwards. For example:
35774 .code
35775  receive_add_recipient(US"monitor@mydom.example", -1);
35776  recipients_list[recipients_count-1].errors_to =
35777    US"postmaster@mydom.example";
35778 .endd
35779
35780 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35781 This is a convenience function to remove a named recipient from the list of
35782 recipients. It returns true if a recipient was removed, and false if no
35783 matching recipient could be found. The argument must be a complete email
35784 address.
35785 .endlist
35786
35787
35788 .cindex "RFC 2047"
35789 .vlist
35790 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35791   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35792 This function decodes strings that are encoded according to RFC 2047. Typically
35793 these are the contents of header lines. First, each &"encoded word"& is decoded
35794 from the Q or B encoding into a byte-string. Then, if provided with the name of
35795 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35796 made  to translate the result to the named character set. If this fails, the
35797 binary string is returned with an error message.
35798
35799 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35800 maximum MIME word length is enforced. The third argument is the target
35801 encoding, or NULL if no translation is wanted.
35802
35803 .cindex "binary zero" "in RFC 2047 decoding"
35804 .cindex "RFC 2047" "binary zero in"
35805 If a binary zero is encountered in the decoded string, it is replaced by the
35806 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35807 not be 0 because header lines are handled as zero-terminated strings.
35808
35809 The function returns the result of processing the string, zero-terminated; if
35810 &%lenptr%& is not NULL, the length of the result is set in the variable to
35811 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35812
35813 If an error is encountered, the function returns NULL and uses the &%error%&
35814 argument to return an error message. The variable pointed to by &%error%& is
35815 set to NULL if there is no error; it may be set non-NULL even when the function
35816 returns a non-NULL value if decoding was successful, but there was a problem
35817 with translation.
35818
35819
35820 .vitem &*int&~smtp_fflush(void)*&
35821 This function is used in conjunction with &'smtp_printf()'&, as described
35822 below.
35823
35824 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35825 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35826 output stream. You should use this function only when there is an SMTP output
35827 stream, that is, when the incoming message is being received via interactive
35828 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35829 is FALSE. If you want to test for an incoming message from another host (as
35830 opposed to a local process that used the &%-bs%& command line option), you can
35831 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35832 is involved.
35833
35834 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35835 output function, so it can be used for all forms of SMTP connection.
35836
35837 The second argument is used to request that the data be buffered
35838 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35839 This is advisory only, but likely to save on system-calls and packets
35840 sent when a sequence of calls to the function are made.
35841
35842 The argument was added in Exim version 4.90 - changing the API/ABI.
35843 Nobody noticed until 4.93 was imminent, at which point the
35844 ABI version number was incremented.
35845
35846 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35847 must start with an appropriate response code: 550 if you are going to return
35848 LOCAL_SCAN_REJECT, 451 if you are going to return
35849 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35850 initial lines of a multi-line response, the code must be followed by a hyphen
35851 to indicate that the line is not the final response line. You must also ensure
35852 that the lines you write terminate with CRLF. For example:
35853 .code
35854 smtp_printf("550-this is some extra info\r\n");
35855 return LOCAL_SCAN_REJECT;
35856 .endd
35857 Note that you can also create multi-line responses by including newlines in
35858 the data returned via the &%return_text%& argument. The added value of using
35859 &'smtp_printf()'& is that, for instance, you could introduce delays between
35860 multiple output lines.
35861
35862 The &'smtp_printf()'& function does not return any error indication, because it
35863 does not
35864 guarantee a flush of
35865 pending output, and therefore does not test
35866 the state of the stream. (In the main code of Exim, flushing and error
35867 detection is done when Exim is ready for the next SMTP input command.) If
35868 you want to flush the output and check for an error (for example, the
35869 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35870 arguments. It flushes the output stream, and returns a non-zero value if there
35871 is an error.
35872
35873 .vitem &*void&~*store_get(int,BOOL)*&
35874 This function accesses Exim's internal store (memory) manager. It gets a new
35875 chunk of memory whose size is given by the first argument.
35876 The second argument should be given as TRUE if the memory will be used for
35877 data possibly coming from an attacker (eg. the message content),
35878 FALSE if it is locally-sourced.
35879 Exim bombs out if it ever
35880 runs out of memory. See the next section for a discussion of memory handling.
35881
35882 .vitem &*void&~*store_get_perm(int,BOOL)*&
35883 This function is like &'store_get()'&, but it always gets memory from the
35884 permanent pool. See the next section for a discussion of memory handling.
35885
35886 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35887 See below.
35888
35889 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35890 See below.
35891
35892 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35893 These three functions create strings using Exim's dynamic memory facilities.
35894 The first makes a copy of an entire string. The second copies up to a maximum
35895 number of characters, indicated by the second argument. The third uses a format
35896 and insertion arguments to create a new string. In each case, the result is a
35897 pointer to a new string in the current memory pool. See the next section for
35898 more discussion.
35899 .endlist
35900
35901
35902
35903 .section "More about Exim's memory handling" "SECTmemhanloc"
35904 .cindex "&[local_scan()]& function" "memory handling"
35905 No function is provided for freeing memory, because that is never needed.
35906 The dynamic memory that Exim uses when receiving a message is automatically
35907 recycled if another message is received by the same process (this applies only
35908 to incoming SMTP connections &-- other input methods can supply only one
35909 message at a time). After receiving the last message, a reception process
35910 terminates.
35911
35912 Because it is recycled, the normal dynamic memory cannot be used for holding
35913 data that must be preserved over a number of incoming messages on the same SMTP
35914 connection. However, Exim in fact uses two pools of dynamic memory; the second
35915 one is not recycled, and can be used for this purpose.
35916
35917 If you want to allocate memory that remains available for subsequent messages
35918 in the same SMTP connection, you should set
35919 .code
35920 store_pool = POOL_PERM
35921 .endd
35922 before calling the function that does the allocation. There is no need to
35923 restore the value if you do not need to; however, if you do want to revert to
35924 the normal pool, you can either restore the previous value of &%store_pool%& or
35925 set it explicitly to POOL_MAIN.
35926
35927 The pool setting applies to all functions that get dynamic memory, including
35928 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35929 There is also a convenience function called &'store_get_perm()'& that gets a
35930 block of memory from the permanent pool while preserving the value of
35931 &%store_pool%&.
35932 .ecindex IIDlosca
35933
35934
35935
35936
35937 . ////////////////////////////////////////////////////////////////////////////
35938 . ////////////////////////////////////////////////////////////////////////////
35939
35940 .chapter "System-wide message filtering" "CHAPsystemfilter"
35941 .scindex IIDsysfil1 "filter" "system filter"
35942 .scindex IIDsysfil2 "filtering all mail"
35943 .scindex IIDsysfil3 "system filter"
35944 The previous chapters (on ACLs and the local scan function) describe checks
35945 that can be applied to messages before they are accepted by a host. There is
35946 also a mechanism for checking messages once they have been received, but before
35947 they are delivered. This is called the &'system filter'&.
35948
35949 The system filter operates in a similar manner to users' filter files, but it
35950 is run just once per message (however many recipients the message has).
35951 It should not normally be used as a substitute for routing, because &%deliver%&
35952 commands in a system router provide new envelope recipient addresses.
35953 The system filter must be an Exim filter. It cannot be a Sieve filter.
35954
35955 The system filter is run at the start of a delivery attempt, before any routing
35956 is done. If a message fails to be completely delivered at the first attempt,
35957 the system filter is run again at the start of every retry.
35958 If you want your filter to do something only once per message, you can make use
35959 .cindex retry condition
35960 of the &%first_delivery%& condition in an &%if%& command in the filter to
35961 prevent it happening on retries.
35962
35963 .vindex "&$domain$&"
35964 .vindex "&$local_part$&"
35965 &*Warning*&: Because the system filter runs just once, variables that are
35966 specific to individual recipient addresses, such as &$local_part$& and
35967 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35968 you want to run a centrally-specified filter for each recipient address
35969 independently, you can do so by setting up a suitable &(redirect)& router, as
35970 described in section &<<SECTperaddfil>>& below.
35971
35972
35973 .section "Specifying a system filter" "SECID212"
35974 .cindex "uid (user id)" "system filter"
35975 .cindex "gid (group id)" "system filter"
35976 The name of the file that contains the system filter must be specified by
35977 setting &%system_filter%&. If you want the filter to run under a uid and gid
35978 other than root, you must also set &%system_filter_user%& and
35979 &%system_filter_group%& as appropriate. For example:
35980 .code
35981 system_filter = /etc/mail/exim.filter
35982 system_filter_user = exim
35983 .endd
35984 If a system filter generates any deliveries directly to files or pipes (via the
35985 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35986 specified by setting &%system_filter_file_transport%& and
35987 &%system_filter_pipe_transport%&, respectively. Similarly,
35988 &%system_filter_reply_transport%& must be set to handle any messages generated
35989 by the &%reply%& command.
35990
35991
35992 .section "Testing a system filter" "SECID213"
35993 You can run simple tests of a system filter in the same way as for a user
35994 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35995 are permitted only in system filters are recognized.
35996
35997 If you want to test the combined effect of a system filter and a user filter,
35998 you can use both &%-bF%& and &%-bf%& on the same command line.
35999
36000
36001
36002 .section "Contents of a system filter" "SECID214"
36003 The language used to specify system filters is the same as for users' filter
36004 files. It is described in the separate end-user document &'Exim's interface to
36005 mail filtering'&. However, there are some additional features that are
36006 available only in system filters; these are described in subsequent sections.
36007 If they are encountered in a user's filter file or when testing with &%-bf%&,
36008 they cause errors.
36009
36010 .cindex "frozen messages" "manual thaw; testing in filter"
36011 There are two special conditions which, though available in users' filter
36012 files, are designed for use in system filters. The condition &%first_delivery%&
36013 is true only for the first attempt at delivering a message, and
36014 &%manually_thawed%& is true only if the message has been frozen, and
36015 subsequently thawed by an admin user. An explicit forced delivery counts as a
36016 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36017
36018 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36019 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36020 succeed, it will not be tried again.
36021 If you want Exim to retry an unseen delivery until it succeeds, you should
36022 arrange to set it up every time the filter runs.
36023
36024 When a system filter finishes running, the values of the variables &$n0$& &--
36025 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36026 users' filter files. Thus a system filter can, for example, set up &"scores"&
36027 to which users' filter files can refer.
36028
36029
36030
36031 .section "Additional variable for system filters" "SECID215"
36032 .vindex "&$recipients$&"
36033 The expansion variable &$recipients$&, containing a list of all the recipients
36034 of the message (separated by commas and white space), is available in system
36035 filters. It is not available in users' filters for privacy reasons.
36036
36037
36038
36039 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36040 .cindex "freezing messages"
36041 .cindex "message" "freezing"
36042 .cindex "message" "forced failure"
36043 .cindex "&%fail%&" "in system filter"
36044 .cindex "&%freeze%& in system filter"
36045 .cindex "&%defer%& in system filter"
36046 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36047 always available in system filters, but are not normally enabled in users'
36048 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36049 for the &(redirect)& router.) These commands can optionally be followed by the
36050 word &%text%& and a string containing an error message, for example:
36051 .code
36052 fail text "this message looks like spam to me"
36053 .endd
36054 The keyword &%text%& is optional if the next character is a double quote.
36055
36056 The &%defer%& command defers delivery of the original recipients of the
36057 message. The &%fail%& command causes all the original recipients to be failed,
36058 and a bounce message to be created. The &%freeze%& command suspends all
36059 delivery attempts for the original recipients. In all cases, any new deliveries
36060 that are specified by the filter are attempted as normal after the filter has
36061 run.
36062
36063 The &%freeze%& command is ignored if the message has been manually unfrozen and
36064 not manually frozen since. This means that automatic freezing by a system
36065 filter can be used as a way of checking out suspicious messages. If a message
36066 is found to be all right, manually unfreezing it allows it to be delivered.
36067
36068 .cindex "log" "&%fail%& command log line"
36069 .cindex "&%fail%&" "log line; reducing"
36070 The text given with a fail command is used as part of the bounce message as
36071 well as being written to the log. If the message is quite long, this can fill
36072 up a lot of log space when such failures are common. To reduce the size of the
36073 log message, Exim interprets the text in a special way if it starts with the
36074 two characters &`<<`& and contains &`>>`& later. The text between these two
36075 strings is written to the log, and the rest of the text is used in the bounce
36076 message. For example:
36077 .code
36078 fail "<<filter test 1>>Your message is rejected \
36079      because it contains attachments that we are \
36080      not prepared to receive."
36081 .endd
36082
36083 .cindex "loop" "caused by &%fail%&"
36084 Take great care with the &%fail%& command when basing the decision to fail on
36085 the contents of the message, because the bounce message will of course include
36086 the contents of the original message and will therefore trigger the &%fail%&
36087 command again (causing a mail loop) unless steps are taken to prevent this.
36088 Testing the &%error_message%& condition is one way to prevent this. You could
36089 use, for example
36090 .code
36091 if $message_body contains "this is spam" and not error_message
36092 then fail text "spam is not wanted here" endif
36093 .endd
36094 though of course that might let through unwanted bounce messages. The
36095 alternative is clever checking of the body and/or headers to detect bounces
36096 generated by the filter.
36097
36098 The interpretation of a system filter file ceases after a
36099 &%defer%&,
36100 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36101 set up earlier in the filter file are honoured, so you can use a sequence such
36102 as
36103 .code
36104 mail ...
36105 freeze
36106 .endd
36107 to send a specified message when the system filter is freezing (or deferring or
36108 failing) a message. The normal deliveries for the message do not, of course,
36109 take place.
36110
36111
36112
36113 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36114 .cindex "header lines" "adding; in system filter"
36115 .cindex "header lines" "removing; in system filter"
36116 .cindex "filter" "header lines; adding/removing"
36117 Two filter commands that are available only in system filters are:
36118 .code
36119 headers add <string>
36120 headers remove <string>
36121 .endd
36122 The argument for the &%headers add%& is a string that is expanded and then
36123 added to the end of the message's headers. It is the responsibility of the
36124 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36125 space is ignored, and if the string is otherwise empty, or if the expansion is
36126 forced to fail, the command has no effect.
36127
36128 You can use &"\n"& within the string, followed by white space, to specify
36129 continued header lines. More than one header may be added in one command by
36130 including &"\n"& within the string without any following white space. For
36131 example:
36132 .code
36133 headers add "X-header-1: ....\n  \
36134              continuation of X-header-1 ...\n\
36135              X-header-2: ...."
36136 .endd
36137 Note that the header line continuation white space after the first newline must
36138 be placed before the backslash that continues the input string, because white
36139 space after input continuations is ignored.
36140
36141 The argument for &%headers remove%& is a colon-separated list of header names.
36142 This command applies only to those headers that are stored with the message;
36143 those that are added at delivery time (such as &'Envelope-To:'& and
36144 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36145 header with the same name, they are all removed.
36146
36147 The &%headers%& command in a system filter makes an immediate change to the set
36148 of header lines that was received with the message (with possible additions
36149 from ACL processing). Subsequent commands in the system filter operate on the
36150 modified set, which also forms the basis for subsequent message delivery.
36151 Unless further modified during routing or transporting, this set of headers is
36152 used for all recipients of the message.
36153
36154 During routing and transporting, the variables that refer to the contents of
36155 header lines refer only to those lines that are in this set. Thus, header lines
36156 that are added by a system filter are visible to users' filter files and to all
36157 routers and transports. This contrasts with the manipulation of header lines by
36158 routers and transports, which is not immediate, but which instead is saved up
36159 until the message is actually being written (see section
36160 &<<SECTheadersaddrem>>&).
36161
36162 If the message is not delivered at the first attempt, header lines that were
36163 added by the system filter are stored with the message, and so are still
36164 present at the next delivery attempt. Header lines that were removed are still
36165 present, but marked &"deleted"& so that they are not transported with the
36166 message. For this reason, it is usual to make the &%headers%& command
36167 conditional on &%first_delivery%& so that the set of header lines is not
36168 modified more than once.
36169
36170 Because header modification in a system filter acts immediately, you have to
36171 use an indirect approach if you want to modify the contents of a header line.
36172 For example:
36173 .code
36174 headers add "Old-Subject: $h_subject:"
36175 headers remove "Subject"
36176 headers add "Subject: new subject (was: $h_old-subject:)"
36177 headers remove "Old-Subject"
36178 .endd
36179
36180
36181
36182 .section "Setting an errors address in a system filter" "SECID217"
36183 .cindex "envelope from"
36184 .cindex "envelope sender"
36185 In a system filter, if a &%deliver%& command is followed by
36186 .code
36187 errors_to <some address>
36188 .endd
36189 in order to change the envelope sender (and hence the error reporting) for that
36190 delivery, any address may be specified. (In a user filter, only the current
36191 user's address can be set.) For example, if some mail is being monitored, you
36192 might use
36193 .code
36194 unseen deliver monitor@spying.example errors_to root@local.example
36195 .endd
36196 to take a copy which would not be sent back to the normal error reporting
36197 address if its delivery failed.
36198
36199
36200
36201 .section "Per-address filtering" "SECTperaddfil"
36202 .vindex "&$domain_data$&"
36203 .vindex "&$local_part_data$&"
36204 In contrast to the system filter, which is run just once per message for each
36205 delivery attempt, it is also possible to set up a system-wide filtering
36206 operation that runs once for each recipient address. In this case, variables
36207 such as &$local_part_data$& and &$domain_data$& can be used,
36208 and indeed, the choice of filter file could be made dependent on them.
36209 This is an example of a router which implements such a filter:
36210 .code
36211 central_filter:
36212   check_local_user
36213   driver = redirect
36214   domains = +local_domains
36215   file = /central/filters/$local_part_data
36216   no_verify
36217   allow_filter
36218   allow_freeze
36219 .endd
36220 The filter is run in a separate process under its own uid. Therefore, either
36221 &%check_local_user%& must be set (as above), in which case the filter is run as
36222 the local user, or the &%user%& option must be used to specify which user to
36223 use. If both are set, &%user%& overrides.
36224
36225 Care should be taken to ensure that none of the commands in the filter file
36226 specify a significant delivery if the message is to go on to be delivered to
36227 its intended recipient. The router will not then claim to have dealt with the
36228 address, so it will be passed on to subsequent routers to be delivered in the
36229 normal way.
36230 .ecindex IIDsysfil1
36231 .ecindex IIDsysfil2
36232 .ecindex IIDsysfil3
36233
36234
36235
36236
36237
36238
36239 . ////////////////////////////////////////////////////////////////////////////
36240 . ////////////////////////////////////////////////////////////////////////////
36241
36242 .chapter "Message processing" "CHAPmsgproc"
36243 .scindex IIDmesproc "message" "general processing"
36244 Exim performs various transformations on the sender and recipient addresses of
36245 all messages that it handles, and also on the messages' header lines. Some of
36246 these are optional and configurable, while others always take place. All of
36247 this processing, except rewriting as a result of routing, and the addition or
36248 removal of header lines while delivering, happens when a message is received,
36249 before it is placed on Exim's queue.
36250
36251 Some of the automatic processing takes place by default only for
36252 &"locally-originated"& messages. This adjective is used to describe messages
36253 that are not received over TCP/IP, but instead are passed to an Exim process on
36254 its standard input. This includes the interactive &"local SMTP"& case that is
36255 set up by the &%-bs%& command line option.
36256
36257 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36258 or ::1) are not considered to be locally-originated. Exim does not treat the
36259 loopback interface specially in any way.
36260
36261 If you want the loopback interface to be treated specially, you must ensure
36262 that there are appropriate entries in your ACLs.
36263
36264
36265
36266
36267 .section "Submission mode for non-local messages" "SECTsubmodnon"
36268 .cindex "message" "submission"
36269 .cindex "submission mode"
36270 Processing that happens automatically for locally-originated messages (unless
36271 &%suppress_local_fixups%& is set) can also be requested for messages that are
36272 received over TCP/IP. The term &"submission mode"& is used to describe this
36273 state. Submission mode is set by the modifier
36274 .code
36275 control = submission
36276 .endd
36277 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36278 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36279 a local submission, and is normally used when the source of the message is
36280 known to be an MUA running on a client host (as opposed to an MTA). For
36281 example, to set submission mode for messages originating on the IPv4 loopback
36282 interface, you could include the following in the MAIL ACL:
36283 .code
36284 warn  hosts = 127.0.0.1
36285       control = submission
36286 .endd
36287 .cindex "&%sender_retain%& submission option"
36288 There are some options that can be used when setting submission mode. A slash
36289 is used to separate options. For example:
36290 .code
36291 control = submission/sender_retain
36292 .endd
36293 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36294 true and &%local_from_check%& false for the current incoming message. The first
36295 of these allows an existing &'Sender:'& header in the message to remain, and
36296 the second suppresses the check to ensure that &'From:'& matches the
36297 authenticated sender. With this setting, Exim still fixes up messages by adding
36298 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36299 attempt to check sender authenticity in header lines.
36300
36301 When &%sender_retain%& is not set, a submission mode setting may specify a
36302 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36303 example:
36304 .code
36305 control = submission/domain=some.domain
36306 .endd
36307 The domain may be empty. How this value is used is described in sections
36308 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36309 that allows you to specify the user's full name for inclusion in a created
36310 &'Sender:'& or &'From:'& header line. For example:
36311 .code
36312 accept authenticated = *
36313        control = submission/domain=wonderland.example/\
36314                             name=${lookup {$authenticated_id} \
36315                                    lsearch {/etc/exim/namelist}}
36316 .endd
36317 Because the name may contain any characters, including slashes, the &%name%&
36318 option must be given last. The remainder of the string is used as the name. For
36319 the example above, if &_/etc/exim/namelist_& contains:
36320 .code
36321 bigegg:  Humpty Dumpty
36322 .endd
36323 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36324 line would be:
36325 .code
36326 Sender: Humpty Dumpty <bigegg@wonderland.example>
36327 .endd
36328 .cindex "return path" "in submission mode"
36329 By default, submission mode forces the return path to the same address as is
36330 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36331 specified, the return path is also left unchanged.
36332
36333 &*Note*&: The changes caused by submission mode take effect after the predata
36334 ACL. This means that any sender checks performed before the fix-ups use the
36335 untrusted sender address specified by the user, not the trusted sender address
36336 specified by submission mode. Although this might be slightly unexpected, it
36337 does mean that you can configure ACL checks to spot that a user is trying to
36338 spoof another's address.
36339
36340 .section "Line endings" "SECTlineendings"
36341 .cindex "line endings"
36342 .cindex "carriage return"
36343 .cindex "linefeed"
36344 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36345 linefeed) is the line ending for messages transmitted over the Internet using
36346 SMTP over TCP/IP. However, within individual operating systems, different
36347 conventions are used. For example, Unix-like systems use just LF, but others
36348 use CRLF or just CR.
36349
36350 Exim was designed for Unix-like systems, and internally, it stores messages
36351 using the system's convention of a single LF as a line terminator. When
36352 receiving a message, all line endings are translated to this standard format.
36353 Originally, it was thought that programs that passed messages directly to an
36354 MTA within an operating system would use that system's convention. Experience
36355 has shown that this is not the case; for example, there are Unix applications
36356 that use CRLF in this circumstance. For this reason, and for compatibility with
36357 other MTAs, the way Exim handles line endings for all messages is now as
36358 follows:
36359
36360 .ilist
36361 LF not preceded by CR is treated as a line ending.
36362 .next
36363 CR is treated as a line ending; if it is immediately followed by LF, the LF
36364 is ignored.
36365 .next
36366 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36367 nor a local message in the state where a line containing only a dot is a
36368 terminator.
36369 .next
36370 If a bare CR is encountered within a header line, an extra space is added after
36371 the line terminator so as not to end the header line. The reasoning behind this
36372 is that bare CRs in header lines are most likely either to be mistakes, or
36373 people trying to play silly games.
36374 .next
36375 If the first header line received in a message ends with CRLF, a subsequent
36376 bare LF in a header line is treated in the same way as a bare CR in a header
36377 line.
36378 .endlist
36379
36380
36381
36382
36383
36384 .section "Unqualified addresses" "SECID218"
36385 .cindex "unqualified addresses"
36386 .cindex "address" "qualification"
36387 By default, Exim expects every envelope address it receives from an external
36388 host to be fully qualified. Unqualified addresses cause negative responses to
36389 SMTP commands. However, because SMTP is used as a means of transporting
36390 messages from MUAs running on personal workstations, there is sometimes a
36391 requirement to accept unqualified addresses from specific hosts or IP networks.
36392
36393 Exim has two options that separately control which hosts may send unqualified
36394 sender or recipient addresses in SMTP commands, namely
36395 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36396 cases, if an unqualified address is accepted, it is qualified by adding the
36397 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36398
36399 .oindex "&%qualify_domain%&"
36400 .oindex "&%qualify_recipient%&"
36401 Unqualified addresses in header lines are automatically qualified for messages
36402 that are locally originated, unless the &%-bnq%& option is given on the command
36403 line. For messages received over SMTP, unqualified addresses in header lines
36404 are qualified only if unqualified addresses are permitted in SMTP commands. In
36405 other words, such qualification is also controlled by
36406 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36407
36408
36409
36410
36411 .section "The UUCP From line" "SECID219"
36412 .cindex "&""From""& line"
36413 .cindex "UUCP" "&""From""& line"
36414 .cindex "sender" "address"
36415 .oindex "&%uucp_from_pattern%&"
36416 .oindex "&%uucp_from_sender%&"
36417 .cindex "envelope from"
36418 .cindex "envelope sender"
36419 .cindex "Sendmail compatibility" "&""From""& line"
36420 Messages that have come from UUCP (and some other applications) often begin
36421 with a line containing the envelope sender and a timestamp, following the word
36422 &"From"&. Examples of two common formats are:
36423 .code
36424 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36425 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36426 .endd
36427 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36428 Exim recognizes such lines at the start of messages that are submitted to it
36429 via the command line (that is, on the standard input). It does not recognize
36430 such lines in incoming SMTP messages, unless the sending host matches
36431 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36432 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36433 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36434 default value matches the two common cases shown above and puts the address
36435 that follows &"From"& into &$1$&.
36436
36437 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36438 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36439 a trusted user, the message's sender address is constructed by expanding the
36440 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36441 then parsed as an RFC 2822 address. If there is no domain, the local part is
36442 qualified with &%qualify_domain%& unless it is the empty string. However, if
36443 the command line &%-f%& option is used, it overrides the &"From"& line.
36444
36445 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36446 sender address is not changed. This is also the case for incoming SMTP messages
36447 that are permitted to contain &"From"& lines.
36448
36449 Only one &"From"& line is recognized. If there is more than one, the second is
36450 treated as a data line that starts the body of the message, as it is not valid
36451 as a header line. This also happens if a &"From"& line is present in an
36452 incoming SMTP message from a source that is not permitted to send them.
36453
36454
36455
36456 .section "Header lines"
36457 .subsection "Resent- header lines" SECID220
36458 .chindex Resent-
36459 RFC 2822 makes provision for sets of header lines starting with the string
36460 &`Resent-`& to be added to a message when it is resent by the original
36461 recipient to somebody else. These headers are &'Resent-Date:'&,
36462 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36463 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36464
36465 .blockquote
36466 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36467 processing of replies or other such automatic actions on messages.'&
36468 .endblockquote
36469
36470 This leaves things a bit vague as far as other processing actions such as
36471 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36472 follows:
36473
36474 .ilist
36475 A &'Resent-From:'& line that just contains the login id of the submitting user
36476 is automatically rewritten in the same way as &'From:'& (see below).
36477 .next
36478 If there's a rewriting rule for a particular header line, it is also applied to
36479 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36480 &'From:'& also rewrites &'Resent-From:'&.
36481 .next
36482 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36483 also removed.
36484 .next
36485 For a locally-submitted message,
36486 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36487 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36488 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36489 included in log lines in this case.
36490 .next
36491 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36492 &%Resent-%& header lines are present.
36493 .endlist
36494
36495
36496
36497
36498 .subsection Auto-Submitted: SECID221
36499 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36500 includes the header line:
36501 .code
36502 Auto-Submitted: auto-replied
36503 .endd
36504
36505 .subsection Bcc: SECID222
36506 .cindex "&'Bcc:'& header line"
36507 If Exim is called with the &%-t%& option, to take recipient addresses from a
36508 message's header, it removes any &'Bcc:'& header line that may exist (after
36509 extracting its addresses). If &%-t%& is not present on the command line, any
36510 existing &'Bcc:'& is not removed.
36511
36512
36513 .subsection Date: SECID223
36514 .cindex Date:
36515 If a locally-generated or submission-mode message has no &'Date:'& header line,
36516 Exim adds one, using the current date and time, unless the
36517 &%suppress_local_fixups%& control has been specified.
36518
36519 .subsection Delivery-date: SECID224
36520 .cindex "&'Delivery-date:'& header line"
36521 .oindex "&%delivery_date_remove%&"
36522 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36523 set. Exim can be configured to add them to the final delivery of messages. (See
36524 the generic &%delivery_date_add%& transport option.) They should not be present
36525 in messages in transit. If the &%delivery_date_remove%& configuration option is
36526 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36527 messages.
36528
36529
36530 .subsection Envelope-to: SECID225
36531 .chindex Envelope-to:
36532 .oindex "&%envelope_to_remove%&"
36533 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36534 Exim can be configured to add them to the final delivery of messages. (See the
36535 generic &%envelope_to_add%& transport option.) They should not be present in
36536 messages in transit. If the &%envelope_to_remove%& configuration option is set
36537 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36538 messages.
36539
36540
36541 .subsection From: SECTthefrohea
36542 .chindex From:
36543 .cindex "Sendmail compatibility" "&""From""& line"
36544 .cindex "message" "submission"
36545 .cindex "submission mode"
36546 If a submission-mode message does not contain a &'From:'& header line, Exim
36547 adds one if either of the following conditions is true:
36548
36549 .ilist
36550 The envelope sender address is not empty (that is, this is not a bounce
36551 message). The added header line copies the envelope sender address.
36552 .next
36553 .vindex "&$authenticated_id$&"
36554 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36555 .olist
36556 .vindex "&$qualify_domain$&"
36557 If no domain is specified by the submission control, the local part is
36558 &$authenticated_id$& and the domain is &$qualify_domain$&.
36559 .next
36560 If a non-empty domain is specified by the submission control, the local
36561 part is &$authenticated_id$&, and the domain is the specified domain.
36562 .next
36563 If an empty domain is specified by the submission control,
36564 &$authenticated_id$& is assumed to be the complete address.
36565 .endlist
36566 .endlist
36567
36568 A non-empty envelope sender takes precedence.
36569
36570 If a locally-generated incoming message does not contain a &'From:'& header
36571 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36572 containing the sender's address. The calling user's login name and full name
36573 are used to construct the address, as described in section &<<SECTconstr>>&.
36574 They are obtained from the password data by calling &[getpwuid()]& (but see the
36575 &%unknown_login%& configuration option). The address is qualified with
36576 &%qualify_domain%&.
36577
36578 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36579 &'From:'& header line containing just the unqualified login name of the calling
36580 user, this is replaced by an address containing the user's login name and full
36581 name as described in section &<<SECTconstr>>&.
36582
36583
36584 .subsection Message-ID: SECID226
36585 .chindex Message-ID:
36586 .cindex "message" "submission"
36587 .oindex "&%message_id_header_text%&"
36588 If a locally-generated or submission-mode incoming message does not contain a
36589 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36590 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36591 to the message. If there are any &'Resent-:'& headers in the message, it
36592 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36593 message id, preceded by the letter E to ensure it starts with a letter, and
36594 followed by @ and the primary host name. Additional information can be included
36595 in this header line by setting the &%message_id_header_text%& and/or
36596 &%message_id_header_domain%& options.
36597
36598
36599 .subsection Received: SECID227
36600 .chindex Received:
36601 A &'Received:'& header line is added at the start of every message. The
36602 contents are defined by the &%received_header_text%& configuration option, and
36603 Exim automatically adds a semicolon and a timestamp to the configured string.
36604
36605 The &'Received:'& header is generated as soon as the message's header lines
36606 have been received. At this stage, the timestamp in the &'Received:'& header
36607 line is the time that the message started to be received. This is the value
36608 that is seen by the DATA ACL and by the &[local_scan()]& function.
36609
36610 Once a message is accepted, the timestamp in the &'Received:'& header line is
36611 changed to the time of acceptance, which is (apart from a small delay while the
36612 -H spool file is written) the earliest time at which delivery could start.
36613
36614
36615 .subsection References: SECID228
36616 .chindex References:
36617 Messages created by the &(autoreply)& transport include a &'References:'&
36618 header line. This is constructed according to the rules that are described in
36619 section 3.64 of RFC 2822 (which states that replies should contain such a
36620 header line), and section 3.14 of RFC 3834 (which states that automatic
36621 responses are not different in this respect). However, because some mail
36622 processing software does not cope well with very long header lines, no more
36623 than 12 message IDs are copied from the &'References:'& header line in the
36624 incoming message. If there are more than 12, the first one and then the final
36625 11 are copied, before adding the message ID of the incoming message.
36626
36627
36628
36629 .subsection Return-path: SECID229
36630 .chindex Return-path:
36631 .oindex "&%return_path_remove%&"
36632 &'Return-path:'& header lines are defined as something an MTA may insert when
36633 it does the final delivery of messages. (See the generic &%return_path_add%&
36634 transport option.) Therefore, they should not be present in messages in
36635 transit. If the &%return_path_remove%& configuration option is set (the
36636 default), Exim removes &'Return-path:'& header lines from incoming messages.
36637
36638
36639
36640 .subsection Sender: SECTthesenhea
36641 .cindex "&'Sender:'& header line"
36642 .cindex "message" "submission"
36643 .chindex Sender:
36644 For a locally-originated message from an untrusted user, Exim may remove an
36645 existing &'Sender:'& header line, and it may add a new one. You can modify
36646 these actions by setting the &%local_sender_retain%& option true, the
36647 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36648 control setting.
36649
36650 When a local message is received from an untrusted user and
36651 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36652 control has not been set, a check is made to see if the address given in the
36653 &'From:'& header line is the correct (local) sender of the message. The address
36654 that is expected has the login name as the local part and the value of
36655 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36656 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36657 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36658 line is added to the message.
36659
36660 If you set &%local_from_check%& false, this checking does not occur. However,
36661 the removal of an existing &'Sender:'& line still happens, unless you also set
36662 &%local_sender_retain%& to be true. It is not possible to set both of these
36663 options true at the same time.
36664
36665 .cindex "submission mode"
36666 By default, no processing of &'Sender:'& header lines is done for messages
36667 received over TCP/IP or for messages submitted by trusted users. However, when
36668 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36669 not specified on the submission control, the following processing takes place:
36670
36671 .vindex "&$authenticated_id$&"
36672 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36673 authenticated, and &$authenticated_id$& is not empty, a sender address is
36674 created as follows:
36675
36676 .ilist
36677 .vindex "&$qualify_domain$&"
36678 If no domain is specified by the submission control, the local part is
36679 &$authenticated_id$& and the domain is &$qualify_domain$&.
36680 .next
36681 If a non-empty domain is specified by the submission control, the local part
36682 is &$authenticated_id$&, and the domain is the specified domain.
36683 .next
36684 If an empty domain is specified by the submission control,
36685 &$authenticated_id$& is assumed to be the complete address.
36686 .endlist
36687
36688 This address is compared with the address in the &'From:'& header line. If they
36689 are different, a &'Sender:'& header line containing the created address is
36690 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36691 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36692
36693 .cindex "return path" "created from &'Sender:'&"
36694 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36695 the message (the envelope sender address) is changed to be the same address,
36696 except in the case of submission mode when &%sender_retain%& is specified.
36697
36698
36699
36700 .section "Adding and removing header lines in routers and transports" &&&
36701          "SECTheadersaddrem"
36702 .cindex "header lines" "adding; in router or transport"
36703 .cindex "header lines" "removing; in router or transport"
36704 When a message is delivered, the addition and removal of header lines can be
36705 specified in a system filter, or on any of the routers and transports that
36706 process the message. Section &<<SECTaddremheasys>>& contains details about
36707 modifying headers in a system filter. Header lines can also be added in an ACL
36708 as a message is received (see section &<<SECTaddheadacl>>&).
36709
36710 In contrast to what happens in a system filter, header modifications that are
36711 specified on routers and transports apply only to the particular recipient
36712 addresses that are being processed by those routers and transports. These
36713 changes do not actually take place until a copy of the message is being
36714 transported. Therefore, they do not affect the basic set of header lines, and
36715 they do not affect the values of the variables that refer to header lines.
36716
36717 &*Note*&: In particular, this means that any expansions in the configuration of
36718 the transport cannot refer to the modified header lines, because such
36719 expansions all occur before the message is actually transported.
36720
36721 For both routers and transports, the argument of a &%headers_add%&
36722 option must be in the form of one or more RFC 2822 header lines, separated by
36723 newlines (coded as &"\n"&). For example:
36724 .code
36725 headers_add = X-added-header: added by $primary_hostname\n\
36726               X-added-second: another added header line
36727 .endd
36728 Exim does not check the syntax of these added header lines.
36729
36730 Multiple &%headers_add%& options for a single router or transport can be
36731 specified; the values will append to a single list of header lines.
36732 Each header-line is separately expanded.
36733
36734 The argument of a &%headers_remove%& option must consist of a colon-separated
36735 list of header names. This is confusing, because header names themselves are
36736 often terminated by colons. In this case, the colons are the list separators,
36737 not part of the names. For example:
36738 .code
36739 headers_remove = return-receipt-to:acknowledge-to
36740 .endd
36741
36742 Multiple &%headers_remove%& options for a single router or transport can be
36743 specified; the arguments will append to a single header-names list.
36744 Each item is separately expanded.
36745 Note that colons in complex expansions which are used to
36746 form all or part of a &%headers_remove%& list
36747 will act as list separators.
36748
36749 When &%headers_add%& or &%headers_remove%& is specified on a router,
36750 items are expanded at routing time,
36751 and then associated with all addresses that are
36752 accepted by that router, and also with any new addresses that it generates. If
36753 an address passes through several routers as a result of aliasing or
36754 forwarding, the changes are cumulative.
36755
36756 .oindex "&%unseen%&"
36757 However, this does not apply to multiple routers that result from the use of
36758 the &%unseen%& option. Any header modifications that were specified by the
36759 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36760
36761 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36762 settings cannot be delivered together in a batch, so a transport is always
36763 dealing with a set of addresses that have the same header-processing
36764 requirements.
36765
36766 The transport starts by writing the original set of header lines that arrived
36767 with the message, possibly modified by the system filter. As it writes out
36768 these lines, it consults the list of header names that were attached to the
36769 recipient address(es) by &%headers_remove%& options in routers, and it also
36770 consults the transport's own &%headers_remove%& option. Header lines whose
36771 names are on either of these lists are not written out. If there are multiple
36772 instances of any listed header, they are all skipped.
36773
36774 After the remaining original header lines have been written, new header
36775 lines that were specified by routers' &%headers_add%& options are written, in
36776 the order in which they were attached to the address. These are followed by any
36777 header lines specified by the transport's &%headers_add%& option.
36778
36779 This way of handling header line modifications in routers and transports has
36780 the following consequences:
36781
36782 .ilist
36783 The original set of header lines, possibly modified by the system filter,
36784 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36785 to it, at all times.
36786 .next
36787 Header lines that are added by a router's
36788 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36789 expansion syntax in subsequent routers or the transport.
36790 .next
36791 Conversely, header lines that are specified for removal by &%headers_remove%&
36792 in a router remain visible to subsequent routers and the transport.
36793 .next
36794 Headers added to an address by &%headers_add%& in a router cannot be removed by
36795 a later router or by a transport.
36796 .next
36797 An added header can refer to the contents of an original header that is to be
36798 removed, even it has the same name as the added header. For example:
36799 .code
36800 headers_remove = subject
36801 headers_add = Subject: new subject (was: $h_subject:)
36802 .endd
36803 .endlist
36804
36805 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36806 for a &(redirect)& router that has the &%one_time%& option set.
36807
36808
36809
36810
36811
36812 .section "Constructed addresses" "SECTconstr"
36813 .cindex "address" "constructed"
36814 .cindex "constructed address"
36815 When Exim constructs a sender address for a locally-generated message, it uses
36816 the form
36817 .display
36818 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36819 .endd
36820 For example:
36821 .code
36822 Zaphod Beeblebrox <zaphod@end.univ.example>
36823 .endd
36824 The user name is obtained from the &%-F%& command line option if set, or
36825 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36826 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36827 ampersand character, this is replaced by the login name with the first letter
36828 upper cased, as is conventional in a number of operating systems. See the
36829 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36830 The &%unknown_username%& option can be used to specify user names in cases when
36831 there is no password file entry.
36832
36833 .cindex "RFC 2047"
36834 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36835 parts of it if necessary. In addition, if it contains any non-printing
36836 characters, it is encoded as described in RFC 2047, which defines a way of
36837 including non-ASCII characters in header lines. The value of the
36838 &%headers_charset%& option specifies the name of the encoding that is used (the
36839 characters are assumed to be in this encoding). The setting of
36840 &%print_topbitchars%& controls whether characters with the top bit set (that
36841 is, with codes greater than 127) count as printing characters or not.
36842
36843
36844
36845 .section "Case of local parts" "SECID230"
36846 .cindex "case of local parts"
36847 .cindex "local part" "case of"
36848 RFC 2822 states that the case of letters in the local parts of addresses cannot
36849 be assumed to be non-significant. Exim preserves the case of local parts of
36850 addresses, but by default it uses a lower-cased form when it is routing,
36851 because on most Unix systems, usernames are in lower case and case-insensitive
36852 routing is required. However, any particular router can be made to use the
36853 original case for local parts by setting the &%caseful_local_part%& generic
36854 router option.
36855
36856 .cindex "mixed-case login names"
36857 If you must have mixed-case user names on your system, the best way to proceed,
36858 assuming you want case-independent handling of incoming email, is to set up
36859 your first router to convert incoming local parts in your domains to the
36860 correct case by means of a file lookup. For example:
36861 .code
36862 correct_case:
36863   driver = redirect
36864   domains = +local_domains
36865   data = ${lookup{$local_part}cdb\
36866               {/etc/usercased.cdb}{$value}fail}\
36867               @$domain
36868 .endd
36869 For this router, the local part is forced to lower case by the default action
36870 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36871 up a new local part in the correct case. If you then set &%caseful_local_part%&
36872 on any subsequent routers which process your domains, they will operate on
36873 local parts with the correct case in a case-sensitive manner.
36874
36875
36876
36877 .section "Dots in local parts" "SECID231"
36878 .cindex "dot" "in local part"
36879 .cindex "local part" "dots in"
36880 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36881 part may not begin or end with a dot, nor have two consecutive dots in the
36882 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36883 empty components for compatibility.
36884
36885
36886
36887 .section "Rewriting addresses" "SECID232"
36888 .cindex "rewriting" "addresses"
36889 Rewriting of sender and recipient addresses, and addresses in headers, can
36890 happen automatically, or as the result of configuration options, as described
36891 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36892 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36893
36894 Automatic rewriting includes qualification, as mentioned above. The other case
36895 in which it can happen is when an incomplete non-local domain is given. The
36896 routing process may cause this to be expanded into the full domain name. For
36897 example, a header such as
36898 .code
36899 To: hare@teaparty
36900 .endd
36901 might get rewritten as
36902 .code
36903 To: hare@teaparty.wonderland.fict.example
36904 .endd
36905 Rewriting as a result of routing is the one kind of message processing that
36906 does not happen at input time, as it cannot be done until the address has
36907 been routed.
36908
36909 Strictly, one should not do &'any'& deliveries of a message until all its
36910 addresses have been routed, in case any of the headers get changed as a
36911 result of routing. However, doing this in practice would hold up many
36912 deliveries for unreasonable amounts of time, just because one address could not
36913 immediately be routed. Exim therefore does not delay other deliveries when
36914 routing of one or more addresses is deferred.
36915 .ecindex IIDmesproc
36916
36917
36918
36919 . ////////////////////////////////////////////////////////////////////////////
36920 . ////////////////////////////////////////////////////////////////////////////
36921
36922 .chapter "SMTP processing" "CHAPSMTP"
36923 .scindex IIDsmtpproc1 "SMTP" "processing details"
36924 .scindex IIDsmtpproc2 "LMTP" "processing details"
36925 Exim supports a number of different ways of using the SMTP protocol, and its
36926 LMTP variant, which is an interactive protocol for transferring messages into a
36927 closed mail store application. This chapter contains details of how SMTP is
36928 processed. For incoming mail, the following are available:
36929
36930 .ilist
36931 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36932 .next
36933 SMTP over the standard input and output (the &%-bs%& option);
36934 .next
36935 Batched SMTP on the standard input (the &%-bS%& option).
36936 .endlist
36937
36938 For mail delivery, the following are available:
36939
36940 .ilist
36941 SMTP over TCP/IP (the &(smtp)& transport);
36942 .next
36943 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36944 &"lmtp"&);
36945 .next
36946 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36947 transport);
36948 .next
36949 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36950 the &%use_bsmtp%& option set).
36951 .endlist
36952
36953 &'Batched SMTP'& is the name for a process in which batches of messages are
36954 stored in or read from files (or pipes), in a format in which SMTP commands are
36955 used to contain the envelope information.
36956
36957
36958
36959 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36960 .cindex "SMTP" "outgoing over TCP/IP"
36961 .cindex "outgoing SMTP over TCP/IP"
36962 .cindex "LMTP" "over TCP/IP"
36963 .cindex "outgoing LMTP over TCP/IP"
36964 .cindex "EHLO"
36965 .cindex "HELO"
36966 .cindex "SIZE" "option on MAIL command"
36967 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36968 The &%protocol%& option selects which protocol is to be used, but the actual
36969 processing is the same in both cases.
36970
36971 .cindex "ESMTP extensions" SIZE
36972 If, in response to its EHLO command, Exim is told that the SIZE
36973 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36974 command. The value of <&'n'&> is the message size plus the value of the
36975 &%size_addition%& option (default 1024) to allow for additions to the message
36976 such as per-transport header lines, or changes made in a
36977 .cindex "transport" "filter"
36978 .cindex "filter" "transport filter"
36979 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36980 suppressed.
36981
36982 If the remote server advertises support for PIPELINING, Exim uses the
36983 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36984 required for the transaction.
36985
36986 If the remote server advertises support for the STARTTLS command, and Exim
36987 was built to support TLS encryption, it tries to start a TLS session unless the
36988 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36989 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36990 is called for verification.
36991
36992 If the remote server advertises support for the AUTH command, Exim scans
36993 the authenticators configuration for any suitable client settings, as described
36994 in chapter &<<CHAPSMTPAUTH>>&.
36995
36996 .cindex "carriage return"
36997 .cindex "linefeed"
36998 Responses from the remote host are supposed to be terminated by CR followed by
36999 LF. However, there are known to be hosts that do not send CR characters, so in
37000 order to be able to interwork with such hosts, Exim treats LF on its own as a
37001 line terminator.
37002
37003 If a message contains a number of different addresses, all those with the same
37004 characteristics (for example, the same envelope sender) that resolve to the
37005 same set of hosts, in the same order, are sent in a single SMTP transaction,
37006 even if they are for different domains, unless there are more than the setting
37007 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37008 they are split into groups containing no more than &%max_rcpt%&s addresses
37009 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37010 in parallel sessions. The order of hosts with identical MX values is not
37011 significant when checking whether addresses can be batched in this way.
37012
37013 When the &(smtp)& transport suffers a temporary failure that is not
37014 message-related, Exim updates its transport-specific database, which contains
37015 records indexed by host name that remember which messages are waiting for each
37016 particular host. It also updates the retry database with new retry times.
37017
37018 .cindex "hints database" "retry keys"
37019 Exim's retry hints are based on host name plus IP address, so if one address of
37020 a multi-homed host is broken, it will soon be skipped most of the time.
37021 See the next section for more detail about error handling.
37022
37023 .cindex "SMTP" "passed connection"
37024 .cindex "SMTP" "batching over TCP/IP"
37025 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37026 looks in the hints database for the transport to see if there are any queued
37027 messages waiting for the host to which it is connected. If it finds one, it
37028 creates a new Exim process using the &%-MC%& option (which can only be used by
37029 a process running as root or the Exim user) and passes the TCP/IP socket to it
37030 so that it can deliver another message using the same socket. The new process
37031 does only those deliveries that are routed to the connected host, and may in
37032 turn pass the socket on to a third process, and so on.
37033
37034 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37035 limit the number of messages sent down a single TCP/IP connection.
37036
37037 .cindex "asterisk" "after IP address"
37038 The second and subsequent messages delivered down an existing connection are
37039 identified in the main log by the addition of an asterisk after the closing
37040 square bracket of the IP address.
37041
37042
37043
37044
37045 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37046 .cindex "error" "in outgoing SMTP"
37047 .cindex "SMTP" "errors in outgoing"
37048 .cindex "host" "error"
37049 Three different kinds of error are recognized for outgoing SMTP: host errors,
37050 message errors, and recipient errors.
37051
37052 .vlist
37053 .vitem "&*Host errors*&"
37054 A host error is not associated with a particular message or with a
37055 particular recipient of a message. The host errors are:
37056
37057 .ilist
37058 Connection refused or timed out,
37059 .next
37060 Any error response code on connection,
37061 .next
37062 Any error response code to EHLO or HELO,
37063 .next
37064 Loss of connection at any time, except after &"."&,
37065 .next
37066 I/O errors at any time,
37067 .next
37068 Timeouts during the session, other than in response to MAIL, RCPT or
37069 the &"."& at the end of the data.
37070 .endlist ilist
37071
37072 For a host error, a permanent error response on connection, or in response to
37073 EHLO, causes all addresses routed to the host to be failed. Any other host
37074 error causes all addresses to be deferred, and retry data to be created for the
37075 host. It is not tried again, for any message, until its retry time arrives. If
37076 the current set of addresses are not all delivered in this run (to some
37077 alternative host), the message is added to the list of those waiting for this
37078 host, so if it is still undelivered when a subsequent successful delivery is
37079 made to the host, it will be sent down the same SMTP connection.
37080
37081 .vitem "&*Message errors*&"
37082 .cindex "message" "error"
37083 A message error is associated with a particular message when sent to a
37084 particular host, but not with a particular recipient of the message. The
37085 message errors are:
37086
37087 .ilist
37088 Any error response code to MAIL, DATA, or the &"."& that terminates
37089 the data,
37090 .next
37091 Timeout after MAIL,
37092 .next
37093 Timeout or loss of connection after the &"."& that terminates the data. A
37094 timeout after the DATA command itself is treated as a host error, as is loss of
37095 connection at any other time.
37096 .endlist ilist
37097
37098 For a message error, a permanent error response (5&'xx'&) causes all addresses
37099 to be failed, and a delivery error report to be returned to the sender. A
37100 temporary error response (4&'xx'&), or one of the timeouts, causes all
37101 addresses to be deferred. Retry data is not created for the host, but instead,
37102 a retry record for the combination of host plus message id is created. The
37103 message is not added to the list of those waiting for this host. This ensures
37104 that the failing message will not be sent to this host again until the retry
37105 time arrives. However, other messages that are routed to the host are not
37106 affected, so if it is some property of the message that is causing the error,
37107 it will not stop the delivery of other mail.
37108
37109 If the remote host specified support for the SIZE parameter in its response
37110 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37111 over-large message will cause a message error because the error arrives as a
37112 response to MAIL.
37113
37114 .vitem "&*Recipient errors*&"
37115 .cindex "recipient" "error"
37116 A recipient error is associated with a particular recipient of a message. The
37117 recipient errors are:
37118
37119 .ilist
37120 Any error response to RCPT,
37121 .next
37122 Timeout after RCPT.
37123 .endlist
37124
37125 For a recipient error, a permanent error response (5&'xx'&) causes the
37126 recipient address to be failed, and a bounce message to be returned to the
37127 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37128 address to be deferred, and routing retry data to be created for it. This is
37129 used to delay processing of the address in subsequent queue runs, until its
37130 routing retry time arrives. This applies to all messages, but because it
37131 operates only in queue runs, one attempt will be made to deliver a new message
37132 to the failing address before the delay starts to operate. This ensures that,
37133 if the failure is really related to the message rather than the recipient
37134 (&"message too big for this recipient"& is a possible example), other messages
37135 have a chance of getting delivered. If a delivery to the address does succeed,
37136 the retry information gets cleared, so all stuck messages get tried again, and
37137 the retry clock is reset.
37138
37139 The message is not added to the list of those waiting for this host. Use of the
37140 host for other messages is unaffected, and except in the case of a timeout,
37141 other recipients are processed independently, and may be successfully delivered
37142 in the current SMTP session. After a timeout it is of course impossible to
37143 proceed with the session, so all addresses get deferred. However, those other
37144 than the one that failed do not suffer any subsequent retry delays. Therefore,
37145 if one recipient is causing trouble, the others have a chance of getting
37146 through when a subsequent delivery attempt occurs before the failing
37147 recipient's retry time.
37148 .endlist
37149
37150 In all cases, if there are other hosts (or IP addresses) available for the
37151 current set of addresses (for example, from multiple MX records), they are
37152 tried in this run for any undelivered addresses, subject of course to their
37153 own retry data. In other words, recipient error retry data does not take effect
37154 until the next delivery attempt.
37155
37156 Some hosts have been observed to give temporary error responses to every
37157 MAIL command at certain times (&"insufficient space"& has been seen). It
37158 would be nice if such circumstances could be recognized, and defer data for the
37159 host itself created, but this is not possible within the current Exim design.
37160 What actually happens is that retry data for every (host, message) combination
37161 is created.
37162
37163 The reason that timeouts after MAIL and RCPT are treated specially is that
37164 these can sometimes arise as a result of the remote host's verification
37165 procedures. Exim makes this assumption, and treats them as if a temporary error
37166 response had been received. A timeout after &"."& is treated specially because
37167 it is known that some broken implementations fail to recognize the end of the
37168 message if the last character of the last line is a binary zero. Thus, it is
37169 helpful to treat this case as a message error.
37170
37171 Timeouts at other times are treated as host errors, assuming a problem with the
37172 host, or the connection to it. If a timeout after MAIL, RCPT,
37173 or &"."& is really a connection problem, the assumption is that at the next try
37174 the timeout is likely to occur at some other point in the dialogue, causing it
37175 then to be treated as a host error.
37176
37177 There is experimental evidence that some MTAs drop the connection after the
37178 terminating &"."& if they do not like the contents of the message for some
37179 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37180 should be given. That is why Exim treats this case as a message rather than a
37181 host error, in order not to delay other messages to the same host.
37182
37183
37184
37185
37186 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37187 .cindex "SMTP" "incoming over TCP/IP"
37188 .cindex "incoming SMTP over TCP/IP"
37189 .cindex "inetd"
37190 .cindex "daemon"
37191 Incoming SMTP messages can be accepted in one of two ways: by running a
37192 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37193 &_/etc/inetd.conf_& should be like this:
37194 .code
37195 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37196 .endd
37197 Exim distinguishes between this case and the case of a locally running user
37198 agent using the &%-bs%& option by checking whether or not the standard input is
37199 a socket. When it is, either the port must be privileged (less than 1024), or
37200 the caller must be root or the Exim user. If any other user passes a socket
37201 with an unprivileged port number, Exim prints a message on the standard error
37202 stream and exits with an error code.
37203
37204 By default, Exim does not make a log entry when a remote host connects or
37205 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37206 unexpected. It can be made to write such log entries by setting the
37207 &%smtp_connection%& log selector.
37208
37209 .cindex "carriage return"
37210 .cindex "linefeed"
37211 Commands from the remote host are supposed to be terminated by CR followed by
37212 LF. However, there are known to be hosts that do not send CR characters. In
37213 order to be able to interwork with such hosts, Exim treats LF on its own as a
37214 line terminator.
37215 Furthermore, because common code is used for receiving messages from all
37216 sources, a CR on its own is also interpreted as a line terminator. However, the
37217 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37218
37219 .cindex "EHLO" "invalid data"
37220 .cindex "HELO" "invalid data"
37221 One area that sometimes gives rise to problems concerns the EHLO or
37222 HELO commands. Some clients send syntactically invalid versions of these
37223 commands, which Exim rejects by default. (This is nothing to do with verifying
37224 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37225 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37226 match the broken hosts that send invalid commands.
37227
37228 .cindex "SIZE option on MAIL command"
37229 .cindex "MAIL" "SIZE option"
37230 The amount of disk space available is checked whenever SIZE is received on
37231 a MAIL command, independently of whether &%message_size_limit%& or
37232 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37233 false. A temporary error is given if there is not enough space. If
37234 &%check_spool_space%& is set, the check is for that amount of space plus the
37235 value given with SIZE, that is, it checks that the addition of the incoming
37236 message will not reduce the space below the threshold.
37237
37238 When a message is successfully received, Exim includes the local message id in
37239 its response to the final &"."& that terminates the data. If the remote host
37240 logs this text it can help with tracing what has happened to a message.
37241
37242 The Exim daemon can limit the number of simultaneous incoming connections it is
37243 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37244 number of simultaneous incoming connections from a single remote host (see the
37245 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37246 rejected using the SMTP temporary error code 421.
37247
37248 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37249 subprocess has finished, as this can get lost at busy times. Instead, it looks
37250 for completed subprocesses every time it wakes up. Provided there are other
37251 things happening (new incoming calls, starts of queue runs), completed
37252 processes will be noticed and tidied away. On very quiet systems you may
37253 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37254 it will be noticed when the daemon next wakes up.
37255
37256 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37257 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37258 high system load &-- for details see the &%smtp_accept_reserve%&,
37259 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37260 applies in both the daemon and &'inetd'& cases.
37261
37262 Exim normally starts a delivery process for each message received, though this
37263 can be varied by means of the &%-odq%& command line option and the
37264 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37265 number of simultaneously running delivery processes started in this way from
37266 SMTP input can be limited by the &%smtp_accept_queue%& and
37267 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37268 subsequently received messages are just put on the input queue without starting
37269 a delivery process.
37270
37271 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37272 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37273 started up from the &'inetd'& daemon, because in that case each connection is
37274 handled by an entirely independent Exim process. Control by load average is,
37275 however, available with &'inetd'&.
37276
37277 Exim can be configured to verify addresses in incoming SMTP commands as they
37278 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37279 to rewrite addresses at this time &-- before any syntax checking is done. See
37280 section &<<SSECTrewriteS>>&.
37281
37282 Exim can also be configured to limit the rate at which a client host submits
37283 MAIL and RCPT commands in a single SMTP session. See the
37284 &%smtp_ratelimit_hosts%& option.
37285
37286
37287
37288 .subsection "Unrecognized SMTP commands" SECID234
37289 .cindex "SMTP" "unrecognized commands"
37290 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37291 commands during a single SMTP connection, it drops the connection after sending
37292 the error response to the last command. The default value for
37293 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37294 abuse that subvert web servers into making connections to SMTP ports; in these
37295 circumstances, a number of non-SMTP lines are sent first.
37296
37297
37298 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37299 .cindex "SMTP" "syntax errors"
37300 .cindex "SMTP" "protocol errors"
37301 A syntax error is detected if an SMTP command is recognized, but there is
37302 something syntactically wrong with its data, for example, a malformed email
37303 address in a RCPT command. Protocol errors include invalid command
37304 sequencing such as RCPT before MAIL. If Exim receives more than
37305 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37306 drops the connection after sending the error response to the last command. The
37307 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37308 broken clients that loop sending bad commands (yes, it has been seen).
37309
37310
37311
37312 .subsection "Use of non-mail SMTP commands" SECID236
37313 .cindex "SMTP" "non-mail commands"
37314 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37315 DATA. Exim counts such commands, and drops the connection if there are too
37316 many of them in a single SMTP session. This action catches some
37317 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37318 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37319 defines what &"too many"& means. Its default value is 10.
37320
37321 When a new message is expected, one occurrence of RSET is not counted. This
37322 allows a client to send one RSET between messages (this is not necessary,
37323 but some clients do it). Exim also allows one uncounted occurrence of HELO
37324 or EHLO, and one occurrence of STARTTLS between messages. After
37325 starting up a TLS session, another EHLO is expected, and so it too is not
37326 counted.
37327
37328 The first occurrence of AUTH in a connection, or immediately following
37329 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37330 RCPT, DATA, and QUIT are counted.
37331
37332 You can control which hosts are subject to the limit set by
37333 &%smtp_accept_max_nonmail%& by setting
37334 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37335 the limit apply to all hosts. This option means that you can exclude any
37336 specific badly-behaved hosts that you have to live with.
37337
37338
37339
37340
37341 .subsection "The VRFY and EXPN commands" SECID237
37342 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37343 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37344 appropriate) in order to decide whether the command should be accepted or not.
37345
37346 .cindex "VRFY" "processing"
37347 When no ACL is defined for VRFY, or if it rejects without
37348 setting an explicit response code, the command is accepted
37349 (with a 252 SMTP response code)
37350 in order to support awkward clients that do a VRFY before every RCPT.
37351 When VRFY is accepted, it runs exactly the same code as when Exim is
37352 called with the &%-bv%& option, and returns 250/451/550
37353 SMTP response codes.
37354
37355 .cindex "EXPN" "processing"
37356 If no ACL for EXPN is defined, the command is rejected.
37357 When EXPN is accepted, a single-level expansion of the address is done.
37358 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37359 than a verification (the &%-bv%& option). If an unqualified local part is given
37360 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37361 of VRFY and EXPN commands are logged on the main and reject logs, and
37362 VRFY verification failures are logged in the main log for consistency with
37363 RCPT failures.
37364
37365
37366
37367 .subsection "The ETRN command" SECTETRN
37368 .cindex "ETRN" "processing"
37369 .cindex "ESMTP extensions" ETRN
37370 RFC 1985 describes an ESMTP command called ETRN that is designed to
37371 overcome the security problems of the TURN command (which has fallen into
37372 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37373 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37374 should be accepted or not. If no ACL is defined, the command is rejected.
37375
37376 The ETRN command is concerned with &"releasing"& messages that are awaiting
37377 delivery to certain hosts. As Exim does not organize its message queue by host,
37378 the only form of ETRN that is supported by default is the one where the
37379 text starts with the &"#"& prefix, in which case the remainder of the text is
37380 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37381 the &%-R%& option to happen, with the remainder of the ETRN text as its
37382 argument. For example,
37383 .code
37384 ETRN #brigadoon
37385 .endd
37386 runs the command
37387 .code
37388 exim -R brigadoon
37389 .endd
37390 which causes a delivery attempt on all messages with undelivered addresses
37391 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37392 default), Exim prevents the simultaneous execution of more than one queue run
37393 for the same argument string as a result of an ETRN command. This stops
37394 a misbehaving client from starting more than one queue runner at once.
37395
37396 .cindex "hints database" "ETRN serialization"
37397 Exim implements the serialization by means of a hints database in which a
37398 record is written whenever a process is started by ETRN, and deleted when
37399 the process completes. However, Exim does not keep the SMTP session waiting for
37400 the ETRN process to complete. Once ETRN is accepted, the client is sent
37401 a &"success"& return code. Obviously there is scope for hints records to get
37402 left lying around if there is a system or program crash. To guard against this,
37403 Exim ignores any records that are more than six hours old.
37404
37405 .oindex "&%smtp_etrn_command%&"
37406 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37407 used. This specifies a command that is run whenever ETRN is received,
37408 whatever the form of its argument. For
37409 example:
37410 .code
37411 smtp_etrn_command = /etc/etrn_command $domain \
37412                     $sender_host_address
37413 .endd
37414 .vindex "&$domain$&"
37415 The string is split up into arguments which are independently expanded. The
37416 expansion variable &$domain$& is set to the argument of the ETRN command,
37417 and no syntax checking is done on the contents of this argument. Exim does not
37418 wait for the command to complete, so its status code is not checked. Exim runs
37419 under its own uid and gid when receiving incoming SMTP, so it is not possible
37420 for it to change them before running the command.
37421
37422
37423
37424 .section "Incoming local SMTP" "SECID238"
37425 .cindex "SMTP" "local incoming"
37426 Some user agents use SMTP to pass messages to their local MTA using the
37427 standard input and output, as opposed to passing the envelope on the command
37428 line and writing the message to the standard input. This is supported by the
37429 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37430 messages over TCP/IP (including the use of ACLs), except that the envelope
37431 sender given in a MAIL command is ignored unless the caller is trusted. In
37432 an ACL you can detect this form of SMTP input by testing for an empty host
37433 identification. It is common to have this as the first line in the ACL that
37434 runs for RCPT commands:
37435 .code
37436 accept hosts = :
37437 .endd
37438 This accepts SMTP messages from local processes without doing any other tests.
37439
37440
37441
37442 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37443 .cindex "SMTP" "batched outgoing"
37444 .cindex "batched SMTP output"
37445 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37446 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37447 be output in BSMTP format. No SMTP responses are possible for this form of
37448 delivery. All it is doing is using SMTP commands as a way of transmitting the
37449 envelope along with the message.
37450
37451 The message is written to the file or pipe preceded by the SMTP commands
37452 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37453 the message that start with a dot have an extra dot added. The SMTP command
37454 HELO is not normally used. If it is required, the &%message_prefix%& option
37455 can be used to specify it.
37456
37457 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37458 one recipient address at a time by default. However, you can arrange for them
37459 to handle several addresses at once by setting the &%batch_max%& option. When
37460 this is done for BSMTP, messages may contain multiple RCPT commands. See
37461 chapter &<<CHAPbatching>>& for more details.
37462
37463 .vindex "&$host$&"
37464 When one or more addresses are routed to a BSMTP transport by a router that
37465 sets up a host list, the name of the first host on the list is available to the
37466 transport in the variable &$host$&. Here is an example of such a transport and
37467 router:
37468 .code
37469 begin routers
37470 route_append:
37471   driver = manualroute
37472   transport = smtp_appendfile
37473   route_list = domain.example  batch.host.example
37474
37475 begin transports
37476 smtp_appendfile:
37477   driver = appendfile
37478   directory = /var/bsmtp/$host
37479   batch_max = 1000
37480   use_bsmtp
37481   user = exim
37482 .endd
37483 This causes messages addressed to &'domain.example'& to be written in BSMTP
37484 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37485 message (unless there are more than 1000 recipients).
37486
37487
37488
37489 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37490 .cindex "SMTP" "batched incoming"
37491 .cindex "batched SMTP input"
37492 The &%-bS%& command line option causes Exim to accept one or more messages by
37493 reading SMTP on the standard input, but to generate no responses. If the caller
37494 is trusted, the senders in the MAIL commands are believed; otherwise the
37495 sender is always the caller of Exim. Unqualified senders and receivers are not
37496 rejected (there seems little point) but instead just get qualified. HELO
37497 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37498 as NOOP; QUIT quits.
37499
37500 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37501 ACL is run in the same way as for non-SMTP local input.
37502
37503 If an error is detected while reading a message, including a missing &"."& at
37504 the end, Exim gives up immediately. It writes details of the error to the
37505 standard output in a stylized way that the calling program should be able to
37506 make some use of automatically, for example:
37507 .code
37508 554 Unexpected end of file
37509 Transaction started in line 10
37510 Error detected in line 14
37511 .endd
37512 It writes a more verbose version, for human consumption, to the standard error
37513 file, for example:
37514 .code
37515 An error was detected while processing a file of BSMTP input.
37516 The error message was:
37517
37518 501 '>' missing at end of address
37519
37520 The SMTP transaction started in line 10.
37521 The error was detected in line 12.
37522 The SMTP command at fault was:
37523
37524 rcpt to:<malformed@in.com.plete
37525
37526 1 previous message was successfully processed.
37527 The rest of the batch was abandoned.
37528 .endd
37529 The return code from Exim is zero only if there were no errors. It is 1 if some
37530 messages were accepted before an error was detected, and 2 if no messages were
37531 accepted.
37532 .ecindex IIDsmtpproc1
37533 .ecindex IIDsmtpproc2
37534
37535
37536
37537 . ////////////////////////////////////////////////////////////////////////////
37538 . ////////////////////////////////////////////////////////////////////////////
37539
37540 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37541          "Customizing messages"
37542 When a message fails to be delivered, or remains in the queue for more than a
37543 configured amount of time, Exim sends a message to the original sender, or
37544 to an alternative configured address. The text of these messages is built into
37545 the code of Exim, but it is possible to change it, either by adding a single
37546 string, or by replacing each of the paragraphs by text supplied in a file.
37547
37548 The &'From:'& and &'To:'& header lines are automatically generated; you can
37549 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37550 option. Exim also adds the line
37551 .code
37552 Auto-Submitted: auto-generated
37553 .endd
37554 to all warning and bounce messages,
37555
37556
37557 .section "Customizing bounce messages" "SECID239"
37558 .cindex "customizing" "bounce message"
37559 .cindex "bounce message" "customizing"
37560 If &%bounce_message_text%& is set, its contents are included in the default
37561 message immediately after &"This message was created automatically by mail
37562 delivery software."& The string is not expanded. It is not used if
37563 &%bounce_message_file%& is set.
37564
37565 When &%bounce_message_file%& is set, it must point to a template file for
37566 constructing error messages. The file consists of a series of text items,
37567 separated by lines consisting of exactly four asterisks. If the file cannot be
37568 opened, default text is used and a message is written to the main and panic
37569 logs. If any text item in the file is empty, default text is used for that
37570 item.
37571
37572 .vindex "&$bounce_recipient$&"
37573 .vindex "&$bounce_return_size_limit$&"
37574 Each item of text that is read from the file is expanded, and there are two
37575 expansion variables which can be of use here: &$bounce_recipient$& is set to
37576 the recipient of an error message while it is being created, and
37577 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37578 option, rounded to a whole number.
37579
37580 The items must appear in the file in the following order:
37581
37582 .ilist
37583 The first item is included in the headers, and should include at least a
37584 &'Subject:'& header. Exim does not check the syntax of these headers.
37585 .next
37586 The second item forms the start of the error message. After it, Exim lists the
37587 failing addresses with their error messages.
37588 .next
37589 The third item is used to introduce any text from pipe transports that is to be
37590 returned to the sender. It is omitted if there is no such text.
37591 .next
37592 The fourth, fifth and sixth items will be ignored and may be empty.
37593 The fields exist for back-compatibility
37594 .endlist
37595
37596 The default state (&%bounce_message_file%& unset) is equivalent to the
37597 following file, in which the sixth item is empty. The &'Subject:'& and some
37598 other lines have been split in order to fit them on the page:
37599 .code
37600 Subject: Mail delivery failed
37601   ${if eq{$sender_address}{$bounce_recipient}
37602   {: returning message to sender}}
37603 ****
37604 This message was created automatically by mail delivery software.
37605
37606 A message ${if eq{$sender_address}{$bounce_recipient}
37607   {that you sent }{sent by
37608
37609 <$sender_address>
37610
37611 }}could not be delivered to all of its recipients.
37612 This is a permanent error. The following address(es) failed:
37613 ****
37614 The following text was generated during the delivery attempt(s):
37615 ****
37616 ------ This is a copy of the message, including all the headers.
37617   ------
37618 ****
37619 ------ The body of the message is $message_size characters long;
37620   only the first
37621 ------ $bounce_return_size_limit or so are included here.
37622 ****
37623 .endd
37624 .section "Customizing warning messages" "SECTcustwarn"
37625 .cindex "customizing" "warning message"
37626 .cindex "warning of delay" "customizing the message"
37627 The option &%warn_message_file%& can be pointed at a template file for use when
37628 warnings about message delays are created. In this case there are only three
37629 text sections:
37630
37631 .ilist
37632 The first item is included in the headers, and should include at least a
37633 &'Subject:'& header. Exim does not check the syntax of these headers.
37634 .next
37635 The second item forms the start of the warning message. After it, Exim lists
37636 the delayed addresses.
37637 .next
37638 The third item then ends the message.
37639 .endlist
37640
37641 The default state is equivalent to the following file, except that some lines
37642 have been split here, in order to fit them on the page:
37643 .code
37644 Subject: Warning: message $message_exim_id delayed
37645   $warn_message_delay
37646 ****
37647 This message was created automatically by mail delivery software.
37648
37649 A message ${if eq{$sender_address}{$warn_message_recipients}
37650 {that you sent }{sent by
37651
37652 <$sender_address>
37653
37654 }}has not been delivered to all of its recipients after
37655 more than $warn_message_delay in the queue on $primary_hostname.
37656
37657 The message identifier is:     $message_exim_id
37658 The subject of the message is: $h_subject
37659 The date of the message is:    $h_date
37660
37661 The following address(es) have not yet been delivered:
37662 ****
37663 No action is required on your part. Delivery attempts will
37664 continue for some time, and this warning may be repeated at
37665 intervals if the message remains undelivered. Eventually the
37666 mail delivery software will give up, and when that happens,
37667 the message will be returned to you.
37668 .endd
37669 .vindex "&$warn_message_delay$&"
37670 .vindex "&$warn_message_recipients$&"
37671 However, in the default state the subject and date lines are omitted if no
37672 appropriate headers exist. During the expansion of this file,
37673 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37674 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37675 of recipients for the warning message. There may be more than one if there are
37676 multiple addresses with different &%errors_to%& settings on the routers that
37677 handled them.
37678
37679
37680
37681
37682 . ////////////////////////////////////////////////////////////////////////////
37683 . ////////////////////////////////////////////////////////////////////////////
37684
37685 .chapter "Some common configuration settings" "CHAPcomconreq"
37686 This chapter discusses some configuration settings that seem to be fairly
37687 common. More examples and discussion can be found in the Exim book.
37688
37689
37690
37691 .section "Sending mail to a smart host" "SECID240"
37692 .cindex "smart host" "example router"
37693 If you want to send all mail for non-local domains to a &"smart host"&, you
37694 should replace the default &(dnslookup)& router with a router which does the
37695 routing explicitly:
37696 .code
37697 send_to_smart_host:
37698   driver = manualroute
37699   route_list = !+local_domains smart.host.name
37700   transport = remote_smtp
37701 .endd
37702 You can use the smart host's IP address instead of the name if you wish.
37703 If you are using Exim only to submit messages to a smart host, and not for
37704 receiving incoming messages, you can arrange for it to do the submission
37705 synchronously by setting the &%mua_wrapper%& option (see chapter
37706 &<<CHAPnonqueueing>>&).
37707
37708
37709
37710
37711 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37712 .cindex "mailing lists"
37713 Exim can be used to run simple mailing lists, but for large and/or complicated
37714 requirements, the use of additional specialized mailing list software such as
37715 Majordomo or Mailman is recommended.
37716
37717 The &(redirect)& router can be used to handle mailing lists where each list
37718 is maintained in a separate file, which can therefore be managed by an
37719 independent manager. The &%domains%& router option can be used to run these
37720 lists in a separate domain from normal mail. For example:
37721 .code
37722 lists:
37723   driver = redirect
37724   domains = lists.example
37725   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37726   forbid_pipe
37727   forbid_file
37728   errors_to = ${quote_local_part:$local_part-request}@lists.example
37729   no_more
37730 .endd
37731 This router is skipped for domains other than &'lists.example'&. For addresses
37732 in that domain, it looks for a file that matches the local part. If there is no
37733 such file, the router declines, but because &%no_more%& is set, no subsequent
37734 routers are tried, and so the whole delivery fails.
37735
37736 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37737 expanded into a filename or a pipe delivery, which is usually inappropriate in
37738 a mailing list.
37739
37740 .oindex "&%errors_to%&"
37741 The &%errors_to%& option specifies that any delivery errors caused by addresses
37742 taken from a mailing list are to be sent to the given address rather than the
37743 original sender of the message. However, before acting on this, Exim verifies
37744 the error address, and ignores it if verification fails.
37745
37746 For example, using the configuration above, mail sent to
37747 &'dicts@lists.example'& is passed on to those addresses contained in
37748 &_/usr/lists/dicts_&, with error reports directed to
37749 &'dicts-request@lists.example'&, provided that this address can be verified.
37750 There could be a file called &_/usr/lists/dicts-request_& containing
37751 the address(es) of this particular list's manager(s), but other approaches,
37752 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37753 or &%local_part_suffix%& options) to handle addresses of the form
37754 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37755
37756
37757
37758 .section "Syntax errors in mailing lists" "SECID241"
37759 .cindex "mailing lists" "syntax errors in"
37760 If an entry in redirection data contains a syntax error, Exim normally defers
37761 delivery of the original address. That means that a syntax error in a mailing
37762 list holds up all deliveries to the list. This may not be appropriate when a
37763 list is being maintained automatically from data supplied by users, and the
37764 addresses are not rigorously checked.
37765
37766 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37767 entries that fail to parse, noting the incident in the log. If in addition
37768 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37769 whenever a broken address is skipped. It is usually appropriate to set
37770 &%syntax_errors_to%& to the same address as &%errors_to%&.
37771
37772
37773
37774 .section "Re-expansion of mailing lists" "SECID242"
37775 .cindex "mailing lists" "re-expansion of"
37776 Exim remembers every individual address to which a message has been delivered,
37777 in order to avoid duplication, but it normally stores only the original
37778 recipient addresses with a message. If all the deliveries to a mailing list
37779 cannot be done at the first attempt, the mailing list is re-expanded when the
37780 delivery is next tried. This means that alterations to the list are taken into
37781 account at each delivery attempt, so addresses that have been added to
37782 the list since the message arrived will therefore receive a copy of the
37783 message, even though it pre-dates their subscription.
37784
37785 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37786 on the &(redirect)& router. If this is done, any addresses generated by the
37787 router that fail to deliver at the first attempt are added to the message as
37788 &"top level"& addresses, and the parent address that generated them is marked
37789 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37790 subsequent delivery attempts. The disadvantage of this is that if any of the
37791 failing addresses are incorrect, correcting them in the file has no effect on
37792 pre-existing messages.
37793
37794 The original top-level address is remembered with each of the generated
37795 addresses, and is output in any log messages. However, any intermediate parent
37796 addresses are not recorded. This makes a difference to the log only if the
37797 &%all_parents%& selector is set, but for mailing lists there is normally only
37798 one level of expansion anyway.
37799
37800
37801
37802 .section "Closed mailing lists" "SECID243"
37803 .cindex "mailing lists" "closed"
37804 The examples so far have assumed open mailing lists, to which anybody may
37805 send mail. It is also possible to set up closed lists, where mail is accepted
37806 from specified senders only. This is done by making use of the generic
37807 &%senders%& option to restrict the router that handles the list.
37808
37809 The following example uses the same file as a list of recipients and as a list
37810 of permitted senders. It requires three routers:
37811 .code
37812 lists_request:
37813   driver = redirect
37814   domains = lists.example
37815   local_part_suffix = -request
37816   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37817   file = /usr/lists/${local_part_data}-request
37818   no_more
37819
37820 lists_post:
37821   driver = redirect
37822   domains = lists.example
37823   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37824   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37825   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37826   forbid_pipe
37827   forbid_file
37828   errors_to = ${quote_local_part:$local_part-request}@lists.example
37829   no_more
37830
37831 lists_closed:
37832   driver = redirect
37833   domains = lists.example
37834   allow_fail
37835   data = :fail: $local_part@lists.example is a closed mailing list
37836 .endd
37837 All three routers have the same &%domains%& setting, so for any other domains,
37838 they are all skipped. The first router runs only if the local part ends in
37839 &%-request%&. It handles messages to the list manager(s) by means of an open
37840 mailing list.
37841
37842 The second router runs only if the &%senders%& precondition is satisfied. It
37843 checks for the existence of a list that corresponds to the local part, and then
37844 checks that the sender is on the list by means of a linear search. It is
37845 necessary to check for the existence of the file before trying to search it,
37846 because otherwise Exim thinks there is a configuration error. If the file does
37847 not exist, the expansion of &%senders%& is *, which matches all senders. This
37848 means that the router runs, but because there is no list, declines, and
37849 &%no_more%& ensures that no further routers are run. The address fails with an
37850 &"unrouteable address"& error.
37851
37852 The third router runs only if the second router is skipped, which happens when
37853 a mailing list exists, but the sender is not on it. This router forcibly fails
37854 the address, giving a suitable error message.
37855
37856
37857
37858
37859 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37860 .cindex "VERP"
37861 .cindex "Variable Envelope Return Paths"
37862 .cindex "envelope from"
37863 .cindex "envelope sender"
37864 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37865 are a way of helping mailing list administrators discover which subscription
37866 address is the cause of a particular delivery failure. The idea is to encode
37867 the original recipient address in the outgoing envelope sender address, so that
37868 if the message is forwarded by another host and then subsequently bounces, the
37869 original recipient can be extracted from the recipient address of the bounce.
37870
37871 .oindex &%errors_to%&
37872 .oindex &%return_path%&
37873 Envelope sender addresses can be modified by Exim using two different
37874 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37875 list examples), or the &%return_path%& option on a transport. The second of
37876 these is effective only if the message is successfully delivered to another
37877 host; it is not used for errors detected on the local host (see the description
37878 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37879 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37880 .code
37881 verp_smtp:
37882   driver = smtp
37883   max_rcpt = 1
37884   return_path = \
37885     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37886       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37887 .endd
37888 This has the effect of rewriting the return path (envelope sender) on outgoing
37889 SMTP messages, if the local part of the original return path ends in
37890 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37891 local part and domain of the recipient into the return path. Suppose, for
37892 example, that a message whose return path has been set to
37893 &'somelist-request@your.dom.example'& is sent to
37894 &'subscriber@other.dom.example'&. In the transport, the return path is
37895 rewritten as
37896 .code
37897 somelist-request+subscriber=other.dom.example@your.dom.example
37898 .endd
37899 .vindex "&$local_part$&"
37900 For this to work, you must tell Exim to send multiple copies of messages that
37901 have more than one recipient, so that each copy has just one recipient. This is
37902 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37903 might be sent to several different recipients in the same domain, in which case
37904 &$local_part$& is not available in the transport, because it is not unique.
37905
37906 Unless your host is doing nothing but mailing list deliveries, you should
37907 probably use a separate transport for the VERP deliveries, so as not to use
37908 extra resources in making one-per-recipient copies for other deliveries. This
37909 can easily be done by expanding the &%transport%& option in the router:
37910 .code
37911 dnslookup:
37912   driver = dnslookup
37913   domains = ! +local_domains
37914   transport = \
37915     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37916       {verp_smtp}{remote_smtp}}
37917   no_more
37918 .endd
37919 If you want to change the return path using &%errors_to%& in a router instead
37920 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37921 routers that handle mailing list addresses. This will ensure that all delivery
37922 errors, including those detected on the local host, are sent to the VERP
37923 address.
37924
37925 On a host that does no local deliveries and has no manual routing, only the
37926 &(dnslookup)& router needs to be changed. A special transport is not needed for
37927 SMTP deliveries. Every mailing list recipient has its own return path value,
37928 and so Exim must hand them to the transport one at a time. Here is an example
37929 of a &(dnslookup)& router that implements VERP:
37930 .code
37931 verp_dnslookup:
37932   driver = dnslookup
37933   domains = ! +local_domains
37934   transport = remote_smtp
37935   errors_to = \
37936     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37937      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37938   no_more
37939 .endd
37940 Before you start sending out messages with VERPed return paths, you must also
37941 configure Exim to accept the bounce messages that come back to those paths.
37942 Typically this is done by setting a &%local_part_suffix%& option for a
37943 router, and using this to route the messages to wherever you want to handle
37944 them.
37945
37946 The overhead incurred in using VERP depends very much on the size of the
37947 message, the number of recipient addresses that resolve to the same remote
37948 host, and the speed of the connection over which the message is being sent. If
37949 a lot of addresses resolve to the same host and the connection is slow, sending
37950 a separate copy of the message for each address may take substantially longer
37951 than sending a single copy with many recipients (for which VERP cannot be
37952 used).
37953
37954
37955
37956
37957
37958
37959 .section "Virtual domains" "SECTvirtualdomains"
37960 .cindex "virtual domains"
37961 .cindex "domain" "virtual"
37962 The phrase &'virtual domain'& is unfortunately used with two rather different
37963 meanings:
37964
37965 .ilist
37966 A domain for which there are no real mailboxes; all valid local parts are
37967 aliases for other email addresses. Common examples are organizational
37968 top-level domains and &"vanity"& domains.
37969 .next
37970 One of a number of independent domains that are all handled by the same host,
37971 with mailboxes on that host, but where the mailbox owners do not necessarily
37972 have login accounts on that host.
37973 .endlist
37974
37975 The first usage is probably more common, and does seem more &"virtual"& than
37976 the second. This kind of domain can be handled in Exim with a straightforward
37977 aliasing router. One approach is to create a separate alias file for each
37978 virtual domain. Exim can test for the existence of the alias file to determine
37979 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37980 to a router of this form:
37981 .code
37982 virtual:
37983   driver = redirect
37984   domains = dsearch;/etc/mail/virtual
37985   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37986   no_more
37987 .endd
37988 The &%domains%& option specifies that the router is to be skipped, unless there
37989 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37990 domain that is being processed.
37991 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37992 being placed into the &$domain_data$& variable.
37993
37994 When the router runs, it looks up the local
37995 part in the file to find a new address (or list of addresses). The &%no_more%&
37996 setting ensures that if the lookup fails (leading to &%data%& being an empty
37997 string), Exim gives up on the address without trying any subsequent routers.
37998
37999 This one router can handle all the virtual domains because the alias filenames
38000 follow a fixed pattern. Permissions can be arranged so that appropriate people
38001 can edit the different alias files. A successful aliasing operation results in
38002 a new envelope recipient address, which is then routed from scratch.
38003
38004 The other kind of &"virtual"& domain can also be handled in a straightforward
38005 way. One approach is to create a file for each domain containing a list of
38006 valid local parts, and use it in a router like this:
38007 .code
38008 my_domains:
38009   driver = accept
38010   domains = dsearch;/etc/mail/domains
38011   local_parts = lsearch;/etc/mail/domains/$domain
38012   transport = my_mailboxes
38013 .endd
38014 The address is accepted if there is a file for the domain, and the local part
38015 can be found in the file. The &%domains%& option is used to check for the
38016 file's existence because &%domains%& is tested before the &%local_parts%&
38017 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38018 because that option is tested after &%local_parts%&. The transport is as
38019 follows:
38020 .code
38021 my_mailboxes:
38022   driver = appendfile
38023   file = /var/mail/$domain_data/$local_part_data
38024   user = mail
38025 .endd
38026 This uses a directory of mailboxes for each domain. The &%user%& setting is
38027 required, to specify which uid is to be used for writing to the mailboxes.
38028
38029 The configuration shown here is just one example of how you might support this
38030 requirement. There are many other ways this kind of configuration can be set
38031 up, for example, by using a database instead of separate files to hold all the
38032 information about the domains.
38033
38034
38035
38036 .section "Multiple user mailboxes" "SECTmulbox"
38037 .cindex "multiple mailboxes"
38038 .cindex "mailbox" "multiple"
38039 .cindex "local part" "prefix"
38040 .cindex "local part" "suffix"
38041 Heavy email users often want to operate with multiple mailboxes, into which
38042 incoming mail is automatically sorted. A popular way of handling this is to
38043 allow users to use multiple sender addresses, so that replies can easily be
38044 identified. Users are permitted to add prefixes or suffixes to their local
38045 parts for this purpose. The wildcard facility of the generic router options
38046 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38047 example, consider this router:
38048 .code
38049 userforward:
38050   driver = redirect
38051   check_local_user
38052   file = $home/.forward
38053   local_part_suffix = -*
38054   local_part_suffix_optional
38055   allow_filter
38056 .endd
38057 .vindex "&$local_part_suffix$&"
38058 It runs a user's &_.forward_& file for all local parts of the form
38059 &'username-*'&. Within the filter file the user can distinguish different
38060 cases by testing the variable &$local_part_suffix$&. For example:
38061 .code
38062 if $local_part_suffix contains -special then
38063 save /home/$local_part_data/Mail/special
38064 endif
38065 .endd
38066 If the filter file does not exist, or does not deal with such addresses, they
38067 fall through to subsequent routers, and, assuming no subsequent use of the
38068 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38069 control over which suffixes are valid.
38070
38071 Alternatively, a suffix can be used to trigger the use of a different
38072 &_.forward_& file &-- which is the way a similar facility is implemented in
38073 another MTA:
38074 .code
38075 userforward:
38076   driver = redirect
38077   check_local_user
38078   local_part_suffix = -*
38079   local_part_suffix_optional
38080   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38081   allow_filter
38082 .endd
38083 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38084 example, &_.forward-special_& is used. Once again, if the appropriate file
38085 does not exist, or does not deal with the address, it is passed on to
38086 subsequent routers, which could, if required, look for an unqualified
38087 &_.forward_& file to use as a default.
38088
38089
38090
38091 .section "Simplified vacation processing" "SECID244"
38092 .cindex "vacation processing"
38093 The traditional way of running the &'vacation'& program is for a user to set up
38094 a pipe command in a &_.forward_& file
38095 (see section &<<SECTspecitredli>>& for syntax details).
38096 This is prone to error by inexperienced users. There are two features of Exim
38097 that can be used to make this process simpler for users:
38098
38099 .ilist
38100 A local part prefix such as &"vacation-"& can be specified on a router which
38101 can cause the message to be delivered directly to the &'vacation'& program, or
38102 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38103 &_.forward_& file are then much simpler. For example:
38104 .code
38105 spqr, vacation-spqr
38106 .endd
38107 .next
38108 The &%require_files%& generic router option can be used to trigger a
38109 vacation delivery by checking for the existence of a certain file in the
38110 user's home directory. The &%unseen%& generic option should also be used, to
38111 ensure that the original delivery also proceeds. In this case, all the user has
38112 to do is to create a file called, say, &_.vacation_&, containing a vacation
38113 message.
38114 .endlist
38115
38116 Another advantage of both these methods is that they both work even when the
38117 use of arbitrary pipes by users is locked out.
38118
38119
38120
38121 .section "Taking copies of mail" "SECID245"
38122 .cindex "message" "copying every"
38123 Some installations have policies that require archive copies of all messages to
38124 be made. A single copy of each message can easily be taken by an appropriate
38125 command in a system filter, which could, for example, use a different file for
38126 each day's messages.
38127
38128 There is also a shadow transport mechanism that can be used to take copies of
38129 messages that are successfully delivered by local transports, one copy per
38130 delivery. This could be used, &'inter alia'&, to implement automatic
38131 notification of delivery by sites that insist on doing such things.
38132
38133
38134
38135 .section "Intermittently connected hosts" "SECID246"
38136 .cindex "intermittently connected hosts"
38137 It has become quite common (because it is cheaper) for hosts to connect to the
38138 Internet periodically rather than remain connected all the time. The normal
38139 arrangement is that mail for such hosts accumulates on a system that is
38140 permanently connected.
38141
38142 Exim was designed for use on permanently connected hosts, and so it is not
38143 particularly well-suited to use in an intermittently connected environment.
38144 Nevertheless there are some features that can be used.
38145
38146
38147 .section "Exim on the upstream server host" "SECID247"
38148 It is tempting to arrange for incoming mail for the intermittently connected
38149 host to remain in Exim's queue until the client connects. However, this
38150 approach does not scale very well. Two different kinds of waiting message are
38151 being mixed up in the same queue &-- those that cannot be delivered because of
38152 some temporary problem, and those that are waiting for their destination host
38153 to connect. This makes it hard to manage the queue, as well as wasting
38154 resources, because each queue runner scans the entire queue.
38155
38156 A better approach is to separate off those messages that are waiting for an
38157 intermittently connected host. This can be done by delivering these messages
38158 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38159 format, from where they are transmitted by other software when their
38160 destination connects. This makes it easy to collect all the mail for one host
38161 in a single directory, and to apply local timeout rules on a per-message basis
38162 if required.
38163
38164 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38165 you are doing this, you should configure Exim with a long retry period for the
38166 intermittent host. For example:
38167 .code
38168 cheshire.wonderland.fict.example    *   F,5d,24h
38169 .endd
38170 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38171 which messages it has queued up for that host. Once the intermittent host comes
38172 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38173 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38174 causes all the queued up messages to be delivered, often down a single SMTP
38175 connection. While the host remains connected, any new messages get delivered
38176 immediately.
38177
38178 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38179 issued with a different IP address each time it connects, Exim's retry
38180 mechanisms on the holding host get confused, because the IP address is normally
38181 used as part of the key string for holding retry information. This can be
38182 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38183 Since this has disadvantages for permanently connected hosts, it is best to
38184 arrange a separate transport for the intermittently connected ones.
38185
38186
38187
38188 .section "Exim on the intermittently connected client host" "SECID248"
38189 The value of &%smtp_accept_queue_per_connection%& should probably be
38190 increased, or even set to zero (that is, disabled) on the intermittently
38191 connected host, so that all incoming messages down a single connection get
38192 delivered immediately.
38193
38194 .cindex "SMTP" "passed connection"
38195 .cindex "SMTP" "multiple deliveries"
38196 .cindex "multiple SMTP deliveries"
38197 .cindex "first pass routing"
38198 Mail waiting to be sent from an intermittently connected host will probably
38199 not have been routed, because without a connection DNS lookups are not
38200 possible. This means that if a normal queue run is done at connection time,
38201 each message is likely to be sent in a separate SMTP session. This can be
38202 avoided by starting the queue run with a command line option beginning with
38203 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38204 first pass, routing is done but no deliveries take place. The second pass is a
38205 normal queue run; since all the messages have been previously routed, those
38206 destined for the same host are likely to get sent as multiple deliveries in a
38207 single SMTP connection.
38208
38209
38210
38211 . ////////////////////////////////////////////////////////////////////////////
38212 . ////////////////////////////////////////////////////////////////////////////
38213
38214 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38215          "Exim as a non-queueing client"
38216 .cindex "client, non-queueing"
38217 .cindex "smart host" "suppressing queueing"
38218 On a personal computer, it is a common requirement for all
38219 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38220 configured to operate that way, for all the popular operating systems.
38221 However, there are some MUAs for Unix-like systems that cannot be so
38222 configured: they submit messages using the command line interface of
38223 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38224 messages this way.
38225
38226 If the personal computer runs continuously, there is no problem, because it can
38227 run a conventional MTA that handles delivery to the smart host, and deal with
38228 any delays via its queueing mechanism. However, if the computer does not run
38229 continuously or runs different operating systems at different times, queueing
38230 email is not desirable.
38231
38232 There is therefore a requirement for something that can provide the
38233 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38234 any queueing or retrying facilities. Furthermore, the delivery to the smart
38235 host should be synchronous, so that if it fails, the sending MUA is immediately
38236 informed. In other words, we want something that extends an MUA that submits
38237 to a local MTA via the command line so that it behaves like one that submits
38238 to a remote smart host using TCP/SMTP.
38239
38240 There are a number of applications (for example, there is one called &'ssmtp'&)
38241 that do this job. However, people have found them to be lacking in various
38242 ways. For instance, you might want to allow aliasing and forwarding to be done
38243 before sending a message to the smart host.
38244
38245 Exim already had the necessary infrastructure for doing this job. Just a few
38246 tweaks were needed to make it behave as required, though it is somewhat of an
38247 overkill to use a fully-featured MTA for this purpose.
38248
38249 .oindex "&%mua_wrapper%&"
38250 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38251 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38252 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38253 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38254 compatible router and transport configuration. Typically there will be just one
38255 router and one transport, sending everything to a smart host.
38256
38257 When run in MUA wrapping mode, the behaviour of Exim changes in the
38258 following ways:
38259
38260 .ilist
38261 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38262 In other words, the only way to submit messages is via the command line.
38263 .next
38264 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38265 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38266 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38267 does not finish until the delivery attempt is complete. If the delivery is
38268 successful, a zero return code is given.
38269 .next
38270 Address redirection is permitted, but the final routing for all addresses must
38271 be to the same remote transport, and to the same list of hosts. Furthermore,
38272 the return address (envelope sender) must be the same for all recipients, as
38273 must any added or deleted header lines. In other words, it must be possible to
38274 deliver the message in a single SMTP transaction, however many recipients there
38275 are.
38276 .next
38277 If these conditions are not met, or if routing any address results in a
38278 failure or defer status, or if Exim is unable to deliver all the recipients
38279 successfully to one of the smart hosts, delivery of the entire message fails.
38280 .next
38281 Because no queueing is allowed, all failures are treated as permanent; there
38282 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38283 smart host. Furthermore, because only a single yes/no response can be given to
38284 the caller, it is not possible to deliver to some recipients and not others. If
38285 there is an error (temporary or permanent) for any recipient, all are failed.
38286 .next
38287 If more than one smart host is listed, Exim will try another host after a
38288 connection failure or a timeout, in the normal way. However, if this kind of
38289 failure happens for all the hosts, the delivery fails.
38290 .next
38291 When delivery fails, an error message is written to the standard error stream
38292 (as well as to Exim's log), and Exim exits to the caller with a return code
38293 value 1. The message is expunged from Exim's spool files. No bounce messages
38294 are ever generated.
38295 .next
38296 No retry data is maintained, and any retry rules are ignored.
38297 .next
38298 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38299 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38300 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38301 .endlist
38302
38303 The overall effect is that Exim makes a single synchronous attempt to deliver
38304 the message, failing if there is any kind of problem. Because no local
38305 deliveries are done and no daemon can be run, Exim does not need root
38306 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38307 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38308 the advantages and disadvantages of running without root privilege.
38309
38310
38311
38312
38313 . ////////////////////////////////////////////////////////////////////////////
38314 . ////////////////////////////////////////////////////////////////////////////
38315
38316 .chapter "Log files" "CHAPlog"
38317 .scindex IIDloggen "log" "general description"
38318 .cindex "log" "types of"
38319 Exim writes three different logs, referred to as the main log, the reject log,
38320 and the panic log:
38321
38322 .ilist
38323 .cindex "main log"
38324 The main log records the arrival of each message and each delivery in a single
38325 line in each case. The format is as compact as possible, in an attempt to keep
38326 down the size of log files. Two-character flag sequences make it easy to pick
38327 out these lines. A number of other events are recorded in the main log. Some of
38328 them are optional, in which case the &%log_selector%& option controls whether
38329 they are included or not. A Perl script called &'eximstats'&, which does simple
38330 analysis of main log files, is provided in the Exim distribution (see section
38331 &<<SECTmailstat>>&).
38332 .next
38333 .cindex "reject log"
38334 The reject log records information from messages that are rejected as a result
38335 of a configuration option (that is, for policy reasons).
38336 The first line of each rejection is a copy of the line that is also written to
38337 the main log. Then, if the message's header has been read at the time the log
38338 is written, its contents are written to this log. Only the original header
38339 lines are available; header lines added by ACLs are not logged. You can use the
38340 reject log to check that your policy controls are working correctly; on a busy
38341 host this may be easier than scanning the main log for rejection messages. You
38342 can suppress the writing of the reject log by setting &%write_rejectlog%&
38343 false.
38344 .next
38345 .cindex "panic log"
38346 .cindex "system log"
38347 When certain serious errors occur, Exim writes entries to its panic log. If the
38348 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38349 are usually written to the main log as well, but can get lost amid the mass of
38350 other entries. The panic log should be empty under normal circumstances. It is
38351 therefore a good idea to check it (or to have a &'cron'& script check it)
38352 regularly, in order to become aware of any problems. When Exim cannot open its
38353 panic log, it tries as a last resort to write to the system log (syslog). This
38354 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38355 message itself is written at priority LOG_CRIT.
38356 .endlist
38357
38358 Every log line starts with a timestamp, in the format shown in the following
38359 example. Note that many of the examples shown in this chapter are line-wrapped.
38360 In the log file, this would be all on one line:
38361 .code
38362 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38363   by QUIT
38364 .endd
38365 By default, the timestamps are in the local timezone. There are two
38366 ways of changing this:
38367
38368 .ilist
38369 You can set the &%timezone%& option to a different time zone; in particular, if
38370 you set
38371 .code
38372 timezone = UTC
38373 .endd
38374 the timestamps will be in UTC (aka GMT).
38375 .next
38376 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38377 example:
38378 .code
38379 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38380 .endd
38381 .endlist
38382
38383 .cindex "log" "process ids in"
38384 .cindex "pid (process id)" "in log lines"
38385 Exim does not include its process id in log lines by default, but you can
38386 request that it does so by specifying the &`pid`& log selector (see section
38387 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38388 brackets, immediately after the time and date.
38389
38390
38391
38392
38393 .section "Where the logs are written" "SECTwhelogwri"
38394 .cindex "log" "destination"
38395 .cindex "log" "to file"
38396 .cindex "log" "to syslog"
38397 .cindex "syslog"
38398 The logs may be written to local files, or to syslog, or both. However, it
38399 should be noted that many syslog implementations use UDP as a transport, and
38400 are therefore unreliable in the sense that messages are not guaranteed to
38401 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38402 It has also been reported that on large log files (tens of megabytes) you may
38403 need to tweak syslog to prevent it syncing the file with each write &-- on
38404 Linux this has been seen to make syslog take 90% plus of CPU time.
38405
38406 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38407 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38408 configuration. This latter string is expanded, so it can contain, for example,
38409 references to the host name:
38410 .code
38411 log_file_path = /var/log/$primary_hostname/exim_%slog
38412 .endd
38413 It is generally advisable, however, to set the string in &_Local/Makefile_&
38414 rather than at runtime, because then the setting is available right from the
38415 start of Exim's execution. Otherwise, if there's something it wants to log
38416 before it has read the configuration file (for example, an error in the
38417 configuration file) it will not use the path you want, and may not be able to
38418 log at all.
38419
38420 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38421 list, currently limited to at most two items. This is one option where the
38422 facility for changing a list separator may not be used. The list must always be
38423 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38424 otherwise the item must either be an absolute path, containing &`%s`& at the
38425 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38426 implying the use of a default path.
38427
38428 When Exim encounters an empty item in the list, it searches the list defined by
38429 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38430 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38431 mean &"use the path specified at build time"&. If no such item exists, log
38432 files are written in the &_log_& subdirectory of the spool directory. This is
38433 equivalent to the configuration file setting:
38434 .code
38435 log_file_path = $spool_directory/log/%slog
38436 .endd
38437 If you do not specify anything at build time or runtime,
38438 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38439 that is where the logs are written.
38440
38441 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38442 are in use &-- see section &<<SECTdatlogfil>>& below.
38443
38444 Here are some examples of possible Makefile settings:
38445 .display
38446 &`LOG_FILE_PATH=syslog                    `& syslog only
38447 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38448 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38449 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38450 .endd
38451 If there are more than two paths in the list, the first is used and a panic
38452 error is logged.
38453
38454
38455
38456 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38457 .cindex "log" "cycling local files"
38458 .cindex "cycling logs"
38459 .cindex "&'exicyclog'&"
38460 .cindex "log" "local files; writing to"
38461 Some operating systems provide centralized and standardized methods for cycling
38462 log files. For those that do not, a utility script called &'exicyclog'& is
38463 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38464 main and reject logs each time it is called. The maximum number of old logs to
38465 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38466
38467 An Exim delivery process opens the main log when it first needs to write to it,
38468 and it keeps the file open in case subsequent entries are required &-- for
38469 example, if a number of different deliveries are being done for the same
38470 message. However, remote SMTP deliveries can take a long time, and this means
38471 that the file may be kept open long after it is renamed if &'exicyclog'& or
38472 something similar is being used to rename log files on a regular basis. To
38473 ensure that a switch of log files is noticed as soon as possible, Exim calls
38474 &[stat()]& on the main log's name before reusing an open file, and if the file
38475 does not exist, or its inode has changed, the old file is closed and Exim
38476 tries to open the main log from scratch. Thus, an old log file may remain open
38477 for quite some time, but no Exim processes should write to it once it has been
38478 renamed.
38479
38480
38481
38482 .section "Datestamped log files" "SECTdatlogfil"
38483 .cindex "log" "datestamped files"
38484 Instead of cycling the main and reject log files by renaming them
38485 periodically, some sites like to use files whose names contain a datestamp,
38486 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38487 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38488 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38489 point where the datestamp is required. For example:
38490 .code
38491 log_file_path = /var/spool/exim/log/%slog-%D
38492 log_file_path = /var/log/exim-%s-%D.log
38493 log_file_path = /var/spool/exim/log/%D-%slog
38494 log_file_path = /var/log/exim/%s.%M
38495 .endd
38496 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38497 examples of names generated by the above examples:
38498 .code
38499 /var/spool/exim/log/mainlog-20021225
38500 /var/log/exim-reject-20021225.log
38501 /var/spool/exim/log/20021225-mainlog
38502 /var/log/exim/main.200212
38503 .endd
38504 When this form of log file is specified, Exim automatically switches to new
38505 files at midnight. It does not make any attempt to compress old logs; you
38506 will need to write your own script if you require this. You should not
38507 run &'exicyclog'& with this form of logging.
38508
38509 The location of the panic log is also determined by &%log_file_path%&, but it
38510 is not datestamped, because rotation of the panic log does not make sense.
38511 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38512 the string. In addition, if it immediately follows a slash, a following
38513 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38514 character is removed. Thus, the four examples above would give these panic
38515 log names:
38516 .code
38517 /var/spool/exim/log/paniclog
38518 /var/log/exim-panic.log
38519 /var/spool/exim/log/paniclog
38520 /var/log/exim/panic
38521 .endd
38522
38523
38524 .section "Logging to syslog" "SECID249"
38525 .cindex "log" "syslog; writing to"
38526 The use of syslog does not change what Exim logs or the format of its messages,
38527 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38528 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38529 that, the same strings are written to syslog as to log files. The syslog
38530 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38531 by default, but you can change these by setting the &%syslog_facility%& and
38532 &%syslog_processname%& options, respectively. If Exim was compiled with
38533 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38534 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38535 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38536 the time and host name to each line.
38537 The three log streams are mapped onto syslog priorities as follows:
38538
38539 .ilist
38540 &'mainlog'& is mapped to LOG_INFO
38541 .next
38542 &'rejectlog'& is mapped to LOG_NOTICE
38543 .next
38544 &'paniclog'& is mapped to LOG_ALERT
38545 .endlist
38546
38547 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38548 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38549 these are routed by syslog to the same place. You can suppress this duplication
38550 by setting &%syslog_duplication%& false.
38551
38552 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38553 entries contain multiple lines when headers are included. To cope with both
38554 these cases, entries written to syslog are split into separate &[syslog()]&
38555 calls at each internal newline, and also after a maximum of
38556 870 data characters. (This allows for a total syslog line length of 1024, when
38557 additions such as timestamps are added.) If you are running a syslog
38558 replacement that can handle lines longer than the 1024 characters allowed by
38559 RFC 3164, you should set
38560 .code
38561 SYSLOG_LONG_LINES=yes
38562 .endd
38563 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38564 lines, but it still splits at internal newlines in &'reject'& log entries.
38565
38566 To make it easy to re-assemble split lines later, each component of a split
38567 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38568 where <&'n'&> is the component number and <&'m'&> is the total number of
38569 components in the entry. The / delimiter is used when the line was split
38570 because it was too long; if it was split because of an internal newline, the \
38571 delimiter is used. For example, supposing the length limit to be 50 instead of
38572 870, the following would be the result of a typical rejection message to
38573 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38574 name, and pid as added by syslog:
38575 .code
38576 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38577 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38578 [3/5]  when scanning for sender: missing or malformed lo
38579 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38580 [5/5] mple>)
38581 .endd
38582 The same error might cause the following lines to be written to &"rejectlog"&
38583 (LOG_NOTICE):
38584 .code
38585 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38586 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38587 [3/18] er when scanning for sender: missing or malformed
38588 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38589 [5\18] .example>)
38590 [6\18] Recipients: ph10@some.domain.cam.example
38591 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38592 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38593 [9\18]        id 16RdAL-0006pc-00
38594 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38595 [11\18] 09:43 +0100
38596 [12\18] F From: <>
38597 [13\18]   Subject: this is a test header
38598 [18\18]   X-something: this is another header
38599 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38600 [16\18] le>
38601 [17\18] B Bcc:
38602 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38603 .endd
38604 Log lines that are neither too long nor contain newlines are written to syslog
38605 without modification.
38606
38607 If only syslog is being used, the Exim monitor is unable to provide a log tail
38608 display, unless syslog is routing &'mainlog'& to a file on the local host and
38609 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38610 where it is.
38611
38612
38613
38614 .section "Log line flags" "SECID250"
38615 One line is written to the main log for each message received, and for each
38616 successful, unsuccessful, and delayed delivery. These lines can readily be
38617 picked out by the distinctive two-character flags that immediately follow the
38618 timestamp. The flags are:
38619 .itable none 0 0 2 10* left 90* left
38620 .irow &%<=%&     "message arrival"
38621 .irow &%(=%&     "message fakereject"
38622 .irow &%=>%&     "normal message delivery"
38623 .irow &%->%&     "additional address in same delivery"
38624 .irow &%>>%&     "cutthrough message delivery"
38625 .irow &%*>%&     "delivery suppressed by &%-N%&"
38626 .irow &%**%&     "delivery failed; address bounced"
38627 .irow &%==%&     "delivery deferred; temporary problem"
38628 .endtable
38629
38630
38631 .section "Logging message reception" "SECID251"
38632 .cindex "log" "reception line"
38633 The format of the single-line entry in the main log that is written for every
38634 message received is shown in the basic example below, which is split over
38635 several lines in order to fit it on the page:
38636 .code
38637 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38638   H=mailer.fict.example [192.168.123.123] U=exim
38639   P=smtp S=5678 id=<incoming message id>
38640 .endd
38641 The address immediately following &"<="& is the envelope sender address. A
38642 bounce message is shown with the sender address &"<>"&, and if it is locally
38643 generated, this is followed by an item of the form
38644 .code
38645 R=<message id>
38646 .endd
38647 which is a reference to the message that caused the bounce to be sent.
38648
38649 .cindex "HELO"
38650 .cindex "EHLO"
38651 For messages from other hosts, the H and U fields identify the remote host and
38652 record the RFC 1413 identity of the user that sent the message, if one was
38653 received. The number given in square brackets is the IP address of the sending
38654 host. If there is a single, unparenthesized  host name in the H field, as
38655 above, it has been verified to correspond to the IP address (see the
38656 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38657 by the remote host in the SMTP HELO or EHLO command, and has not been
38658 verified. If verification yields a different name to that given for HELO or
38659 EHLO, the verified name appears first, followed by the HELO or EHLO
38660 name in parentheses.
38661
38662 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38663 without brackets, in the HELO or EHLO command, leading to entries in
38664 the log containing text like these examples:
38665 .code
38666 H=(10.21.32.43) [192.168.8.34]
38667 H=([10.21.32.43]) [192.168.8.34]
38668 .endd
38669 This can be confusing. Only the final address in square brackets can be relied
38670 on.
38671
38672 For locally generated messages (that is, messages not received over TCP/IP),
38673 the H field is omitted, and the U field contains the login name of the caller
38674 of Exim.
38675
38676 .cindex "authentication" "logging"
38677 .cindex "AUTH" "logging"
38678 For all messages, the P field specifies the protocol used to receive the
38679 message. This is the value that is stored in &$received_protocol$&. In the case
38680 of incoming SMTP messages, the value indicates whether or not any SMTP
38681 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38682 session was encrypted, there is an additional X field that records the cipher
38683 suite that was used.
38684
38685 .cindex log protocol
38686 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38687 hosts that have authenticated themselves using the SMTP AUTH command. The first
38688 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38689 there is an additional item A= followed by the name of the authenticator that
38690 was used. If an authenticated identification was set up by the authenticator's
38691 &%server_set_id%& option, this is logged too, separated by a colon from the
38692 authenticator name.
38693
38694 .cindex "size" "of message"
38695 The id field records the existing message id, if present. The size of the
38696 received message is given by the S field. When the message is delivered,
38697 headers may be removed or added, so that the size of delivered copies of the
38698 message may not correspond with this value (and indeed may be different to each
38699 other).
38700
38701 The &%log_selector%& option can be used to request the logging of additional
38702 data when a message is received. See section &<<SECTlogselector>>& below.
38703
38704
38705
38706 .section "Logging deliveries" "SECID252"
38707 .cindex "log" "delivery line"
38708 The format of the single-line entry in the main log that is written for every
38709 delivery is shown in one of the examples below, for local and remote
38710 deliveries, respectively. Each example has been split into multiple lines in order
38711 to fit it on the page:
38712 .code
38713 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38714   <marv@hitch.fict.example> R=localuser T=local_delivery
38715 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38716   monk@holistic.fict.example R=dnslookup T=remote_smtp
38717   H=holistic.fict.example [192.168.234.234]
38718 .endd
38719 For ordinary local deliveries, the original address is given in angle brackets
38720 after the final delivery address, which might be a pipe or a file. If
38721 intermediate address(es) exist between the original and the final address, the
38722 last of these is given in parentheses after the final address. The R and T
38723 fields record the router and transport that were used to process the address.
38724
38725 If SMTP AUTH was used for the delivery there is an additional item A=
38726 followed by the name of the authenticator that was used.
38727 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38728 option, this is logged too, as a second colon-separated list item.
38729 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38730
38731 If a shadow transport was run after a successful local delivery, the log line
38732 for the successful delivery has an item added on the end, of the form
38733 .display
38734 &`ST=<`&&'shadow transport name'&&`>`&
38735 .endd
38736 If the shadow transport did not succeed, the error message is put in
38737 parentheses afterwards.
38738
38739 .cindex "asterisk" "after IP address"
38740 When more than one address is included in a single delivery (for example, two
38741 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38742 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38743 down a single SMTP connection, an asterisk follows the
38744 remote IP address (and port if enabled)
38745 in the log lines for the second and subsequent messages.
38746 When two or more messages are delivered down a single TLS connection, the
38747 DNS and some TLS-related information logged for the first message delivered
38748 will not be present in the log lines for the second and subsequent messages.
38749 TLS cipher information is still available.
38750
38751 .cindex "delivery" "cutthrough; logging"
38752 .cindex "cutthrough" "logging"
38753 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38754 line precedes the reception line, since cutthrough waits for a possible
38755 rejection from the destination in case it can reject the sourced item.
38756
38757 The generation of a reply message by a filter file gets logged as a
38758 &"delivery"& to the addressee, preceded by &">"&.
38759
38760 The &%log_selector%& option can be used to request the logging of additional
38761 data when a message is delivered. See section &<<SECTlogselector>>& below.
38762
38763
38764 .section "Discarded deliveries" "SECID253"
38765 .cindex "discarded messages"
38766 .cindex "message" "discarded"
38767 .cindex "delivery" "discarded; logging"
38768 When a message is discarded as a result of the command &"seen finish"& being
38769 obeyed in a filter file which generates no deliveries, a log entry of the form
38770 .code
38771 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38772   <low.club@bridge.example> R=userforward
38773 .endd
38774 is written, to record why no deliveries are logged. When a message is discarded
38775 because it is aliased to &":blackhole:"& the log line is like this:
38776 .code
38777 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38778   <hole@nowhere.example> R=blackhole_router
38779 .endd
38780
38781
38782 .section "Deferred deliveries" "SECID254"
38783 When a delivery is deferred, a line of the following form is logged:
38784 .code
38785 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38786   R=dnslookup T=smtp defer (146): Connection refused
38787 .endd
38788 In the case of remote deliveries, the error is the one that was given for the
38789 last IP address that was tried. Details of individual SMTP failures are also
38790 written to the log, so the above line would be preceded by something like
38791 .code
38792 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38793   mail1.endrest.example [192.168.239.239]: Connection refused
38794 .endd
38795 When a deferred address is skipped because its retry time has not been reached,
38796 a message is written to the log, but this can be suppressed by setting an
38797 appropriate value in &%log_selector%&.
38798
38799
38800
38801 .section "Delivery failures" "SECID255"
38802 .cindex "delivery" "failure; logging"
38803 If a delivery fails because an address cannot be routed, a line of the
38804 following form is logged:
38805 .code
38806 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38807   <jim@trek99.example>: unknown mail domain
38808 .endd
38809 If a delivery fails at transport time, the router and transport are shown, and
38810 the response from the remote host is included, as in this example:
38811 .code
38812 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38813   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38814   after pipelined RCPT TO:<ace400@pb.example>: host
38815   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38816   <ace400@pb.example>...Addressee unknown
38817 .endd
38818 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38819 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38820 disabling PIPELINING. The log lines for all forms of delivery failure are
38821 flagged with &`**`&.
38822
38823
38824
38825 .section "Fake deliveries" "SECID256"
38826 .cindex "delivery" "fake; logging"
38827 If a delivery does not actually take place because the &%-N%& option has been
38828 used to suppress it, a normal delivery line is written to the log, except that
38829 &"=>"& is replaced by &"*>"&.
38830
38831
38832
38833 .section "Completion" "SECID257"
38834 A line of the form
38835 .code
38836 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38837 .endd
38838 is written to the main log when a message is about to be removed from the spool
38839 at the end of its processing.
38840
38841
38842
38843
38844 .section "Summary of Fields in Log Lines" "SECID258"
38845 .cindex "log" "summary of fields"
38846 A summary of the field identifiers that are used in log lines is shown in
38847 the following table:
38848 .display
38849 &`A   `&        authenticator name (and optional id and sender)
38850 &`C   `&        SMTP confirmation on delivery
38851 &`    `&        command list for &"no mail in SMTP session"&
38852 &`CV  `&        certificate verification status
38853 &`D   `&        duration of &"no mail in SMTP session"&
38854 &`DKIM`&        domain verified in incoming message
38855 &`DN  `&        distinguished name from peer certificate
38856 &`DS  `&        DNSSEC secured lookups
38857 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38858 &`F   `&        sender address (on delivery lines)
38859 &`H   `&        host name and IP address
38860 &`I   `&        local interface used
38861 &`id  `&        message id (from header) for incoming message
38862 &`K   `&        CHUNKING extension used
38863 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38864 &`M8S `&        8BITMIME status for incoming message
38865 &`P   `&        on &`<=`& lines: protocol used
38866 &`    `&        on &`=>`& and &`**`& lines: return path
38867 &`PRDR`&        PRDR extension used
38868 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38869 &`Q   `&        alternate queue name
38870 &`QT  `&        on &`=>`& lines: time spent on queue so far
38871 &`    `&        on &"Completed"& lines: time spent on queue
38872 &`R   `&        on &`<=`& lines: reference for local bounce
38873 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38874 &`RT  `&        on &`<=`& lines: time taken for reception
38875 &`S   `&        size of message in bytes
38876 &`SNI `&        server name indication from TLS client hello
38877 &`ST  `&        shadow transport name
38878 &`T   `&        on &`<=`& lines: message subject (topic)
38879 &`TFO `&        connection took advantage of TCP Fast Open
38880 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38881 &`U   `&        local user or RFC 1413 identity
38882 &`X   `&        TLS cipher suite
38883 .endd
38884
38885
38886 .section "Other log entries" "SECID259"
38887 Various other types of log entry are written from time to time. Most should be
38888 self-explanatory. Among the more common are:
38889
38890 .ilist
38891 .cindex "retry" "time not reached"
38892 &'retry time not reached'&&~&~An address previously suffered a temporary error
38893 during routing or local delivery, and the time to retry has not yet arrived.
38894 This message is not written to an individual message log file unless it happens
38895 during the first delivery attempt.
38896 .next
38897 &'retry time not reached for any host'&&~&~An address previously suffered
38898 temporary errors during remote delivery, and the retry time has not yet arrived
38899 for any of the hosts to which it is routed.
38900 .next
38901 .cindex "spool directory" "file locked"
38902 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38903 some other Exim process is already working on the message. This can be quite
38904 common if queue running processes are started at frequent intervals. The
38905 &'exiwhat'& utility script can be used to find out what Exim processes are
38906 doing.
38907 .next
38908 .cindex "error" "ignored"
38909 &'error ignored'&&~&~There are several circumstances that give rise to this
38910 message:
38911 .olist
38912 Exim failed to deliver a bounce message whose age was greater than
38913 &%ignore_bounce_errors_after%&. The bounce was discarded.
38914 .next
38915 A filter file set up a delivery using the &"noerror"& option, and the delivery
38916 failed. The delivery was discarded.
38917 .next
38918 A delivery set up by a router configured with
38919 . ==== As this is a nested list, any displays it contains must be indented
38920 . ==== as otherwise they are too far to the left.
38921 .code
38922     errors_to = <>
38923 .endd
38924 failed. The delivery was discarded.
38925 .endlist olist
38926 .next
38927 .cindex DKIM "log line"
38928 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38929 logging and the message has a DKIM signature header.
38930 .endlist ilist
38931
38932
38933
38934
38935
38936 .section "Reducing or increasing what is logged" "SECTlogselector"
38937 .cindex "log" "selectors"
38938 By setting the &%log_selector%& global option, you can disable some of Exim's
38939 default logging, or you can request additional logging. The value of
38940 &%log_selector%& is made up of names preceded by plus or minus characters. For
38941 example:
38942 .code
38943 log_selector = +arguments -retry_defer
38944 .endd
38945 The list of optional log items is in the following table, with the default
38946 selection marked by asterisks:
38947 .itable none 0 0 3 2.8in left 10pt center 3in left
38948 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
38949 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
38950 .irow &`address_rewrite`&               &nbsp; "address rewriting"
38951 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
38952 .irow &`arguments`&                     &nbsp; "command line arguments"
38953 .irow &`connection_reject`&             *       "connection rejections"
38954 .irow &`delay_delivery`&                *       "immediate delivery delayed"
38955 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
38956 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
38957 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
38958 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
38959 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
38960 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
38961 .irow &`etrn`&                          *       "ETRN commands"
38962 .irow &`host_lookup_failed`&            *       "as it says"
38963 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
38964 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
38965 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
38966 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
38967 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
38968 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
38969 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
38970 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
38971 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
38972 .irow &`queue_run`&                     *       "start and end queue runs"
38973 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
38974 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
38975 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
38976 .irow &`pid`&                           &nbsp; "Exim process id"
38977 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
38978 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
38979 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
38980 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
38981 .irow &`received_sender`&               &nbsp; "sender on <= lines"
38982 .irow &`rejected_header`&               *       "header contents on reject log"
38983 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
38984 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
38985 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
38986 .irow &`sender_verify_fail`&            *       "sender verification failures"
38987 .irow &`size_reject`&                   *       "rejection because too big"
38988 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
38989 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
38990 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
38991 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
38992 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
38993 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
38994 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
38995 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
38996 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
38997 .irow &`tls_certificate_verified`&      *       "certificate verification status"
38998 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
38999 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39000 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39001 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39002 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39003 .irow &`all`&                           &nbsp; "&*all of the above*&"
39004 .endtable
39005 See also the &%slow_lookup_log%& main configuration option,
39006 section &<<SECID99>>&
39007
39008 More details on each of these items follows:
39009
39010 .ilist
39011 .cindex "8BITMIME"
39012 .cindex "log" "8BITMIME"
39013 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39014 which may help in tracking down interoperability issues with ancient MTAs
39015 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39016 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39017 &`7BIT`& and &`8BITMIME`& respectively.
39018 .next
39019 .cindex "&%warn%& ACL verb" "log when skipping"
39020 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39021 its conditions cannot be evaluated, a log line to this effect is written if
39022 this log selector is set.
39023 .next
39024 .cindex "log" "rewriting"
39025 .cindex "rewriting" "logging"
39026 &%address_rewrite%&: This applies both to global rewrites and per-transport
39027 rewrites, but not to rewrites in filters run as an unprivileged user (because
39028 such users cannot access the log).
39029 .next
39030 .cindex "log" "full parentage"
39031 &%all_parents%&: Normally only the original and final addresses are logged on
39032 delivery lines; with this selector, intermediate parents are given in
39033 parentheses between them.
39034 .next
39035 .cindex "log" "Exim arguments"
39036 .cindex "Exim arguments, logging"
39037 &%arguments%&: This causes Exim to write the arguments with which it was called
39038 to the main log, preceded by the current working directory. This is a debugging
39039 feature, added to make it easier to find out how certain MUAs call
39040 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39041 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39042 that are empty or that contain white space are quoted. Non-printing characters
39043 are shown as escape sequences. This facility cannot log unrecognized arguments,
39044 because the arguments are checked before the configuration file is read. The
39045 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39046 between the caller and Exim.
39047 .next
39048 .cindex "log" "connection rejections"
39049 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39050 connection is rejected, for whatever reason.
39051 .next
39052 .cindex "log" "delayed delivery"
39053 .cindex "delayed delivery, logging"
39054 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39055 started for an incoming message because the load is too high or too many
39056 messages were received on one connection. Logging does not occur if no delivery
39057 process is started because &%queue_only%& is set or &%-odq%& was used.
39058 .next
39059 .cindex "log" "delivery duration"
39060 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39061 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39062 If millisecond logging is enabled, short times will be shown with greater
39063 precision, eg. &`DT=0.304s`&.
39064 .next
39065 .cindex "log" "message size on delivery"
39066 .cindex "size" "of message"
39067 &%delivery_size%&: For each delivery, the size of message delivered is added to
39068 the &"=>"& line, tagged with S=.
39069 .next
39070 .cindex log "DKIM verification"
39071 .cindex DKIM "verification logging"
39072 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39073 verifies successfully a tag of DKIM is added, with one of the verified domains.
39074 .next
39075 .cindex log "DKIM verification"
39076 .cindex DKIM "verification logging"
39077 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39078 .next
39079 .cindex "log" "dnslist defer"
39080 .cindex "DNS list" "logging defer"
39081 .cindex "black list (DNS)"
39082 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39083 DNS black list suffers a temporary error.
39084 .next
39085 .cindex log dnssec
39086 .cindex dnssec logging
39087 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39088 dns lookups gave secure results a tag of DS is added.
39089 For acceptance this covers the reverse and forward lookups for host name verification.
39090 It does not cover helo-name verification.
39091 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39092 .next
39093 .cindex "log" "ETRN commands"
39094 .cindex "ETRN" "logging"
39095 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39096 is run to determine whether or not it is actually accepted. An invalid ETRN
39097 command, or one received within a message transaction is not logged by this
39098 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39099 .next
39100 .cindex "log" "host lookup failure"
39101 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39102 any addresses, or when a lookup of an IP address fails to find a host name, a
39103 log line is written. This logging does not apply to direct DNS lookups when
39104 routing email addresses, but it does apply to &"byname"& lookups.
39105 .next
39106 .cindex "log" "ident timeout"
39107 .cindex "RFC 1413" "logging timeout"
39108 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39109 client's ident port times out.
39110 .next
39111 .cindex "log" "incoming interface"
39112 .cindex "log" "outgoing interface"
39113 .cindex "log" "local interface"
39114 .cindex "log" "local address and port"
39115 .cindex "TCP/IP" "logging local address and port"
39116 .cindex "interface" "logging"
39117 &%incoming_interface%&: The interface on which a message was received is added
39118 to the &"<="& line as an IP address in square brackets, tagged by I= and
39119 followed by a colon and the port number. The local interface and port are also
39120 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39121 rejection lines, and (despite the name) to outgoing
39122 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39123 The latter can be disabled by turning off the &%outgoing_interface%& option.
39124 .next
39125 .cindex log "incoming proxy address"
39126 .cindex proxy "logging proxy address"
39127 .cindex "TCP/IP" "logging proxy address"
39128 &%proxy%&: The internal (closest to the system running Exim) IP address
39129 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39130 on a proxied connection
39131 or the &"=>"& line for a message delivered on a proxied connection.
39132 See &<<SECTproxyInbound>>& for more information.
39133 .next
39134 .cindex "log" "incoming remote port"
39135 .cindex "port" "logging remote"
39136 .cindex "TCP/IP" "logging incoming remote port"
39137 .vindex "&$sender_fullhost$&"
39138 .vindex "&$sender_rcvhost$&"
39139 &%incoming_port%&: The remote port number from which a message was received is
39140 added to log entries and &'Received:'& header lines, following the IP address
39141 in square brackets, and separated from it by a colon. This is implemented by
39142 changing the value that is put in the &$sender_fullhost$& and
39143 &$sender_rcvhost$& variables. Recording the remote port number has become more
39144 important with the widening use of NAT (see RFC 2505).
39145 .next
39146 .cindex "log" "dropped connection"
39147 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39148 connection is unexpectedly dropped.
39149 .next
39150 .cindex "log" "millisecond timestamps"
39151 .cindex millisecond logging
39152 .cindex timestamps "millisecond, in logs"
39153 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39154 appended to the seconds value.
39155 .next
39156 .cindex "log" "message id"
39157 &%msg_id%&: The value of the Message-ID: header.
39158 .next
39159 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39160 This will be either because the message is a bounce, or was submitted locally
39161 (submission mode) without one.
39162 The field identifier will have an asterix appended: &"id*="&.
39163 .next
39164 .cindex "log" "outgoing interface"
39165 .cindex "log" "local interface"
39166 .cindex "log" "local address and port"
39167 .cindex "TCP/IP" "logging local address and port"
39168 .cindex "interface" "logging"
39169 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39170 interface on which a message was sent is added to delivery lines as an I= tag
39171 followed by IP address in square brackets. You can disable this by turning
39172 off the &%outgoing_interface%& option.
39173 .next
39174 .cindex "log" "outgoing remote port"
39175 .cindex "port" "logging outgoing remote"
39176 .cindex "TCP/IP" "logging outgoing remote port"
39177 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39178 containing => tags) following the IP address.
39179 The local port is also added if &%incoming_interface%& and
39180 &%outgoing_interface%& are both enabled.
39181 This option is not included in the default setting, because for most ordinary
39182 configurations, the remote port number is always 25 (the SMTP port), and the
39183 local port is a random ephemeral port.
39184 .next
39185 .cindex "log" "process ids in"
39186 .cindex "pid (process id)" "in log lines"
39187 &%pid%&: The current process id is added to every log line, in square brackets,
39188 immediately after the time and date.
39189 .next
39190 .cindex log pipelining
39191 .cindex pipelining "logging outgoing"
39192 &%pipelining%&: A field is added to delivery and accept
39193 log lines when the ESMTP PIPELINING extension was used.
39194 The field is a single "L".
39195
39196 On accept lines, where PIPELINING was offered but not used by the client,
39197 the field has a minus appended.
39198
39199 .cindex "pipelining" "early connection"
39200 If Exim is built without the DISABLE_PIPE_CONNECT build option
39201 accept "L" fields have a period appended if the feature was
39202 offered but not used, or an asterisk appended if used.
39203 Delivery "L" fields have an asterisk appended if used.
39204
39205 .next
39206 .cindex "log" "queue run"
39207 .cindex "queue runner" "logging"
39208 &%queue_run%&: The start and end of every queue run are logged.
39209 .next
39210 .cindex "log" "queue time"
39211 &%queue_time%&: The amount of time the message has been in the queue on the
39212 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39213 &`QT=3m45s`&.
39214 If millisecond logging is enabled, short times will be shown with greater
39215 precision, eg. &`QT=1.578s`&.
39216 .next
39217 &%queue_time_overall%&: The amount of time the message has been in the queue on
39218 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39219 example, &`QT=3m45s`&.
39220 .next
39221 .cindex "log" "receive duration"
39222 &%receive_time%&: For each message, the amount of real time it has taken to
39223 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39224 If millisecond logging is enabled, short times will be shown with greater
39225 precision, eg. &`RT=0.204s`&.
39226 .next
39227 .cindex "log" "recipients"
39228 &%received_recipients%&: The recipients of a message are listed in the main log
39229 as soon as the message is received. The list appears at the end of the log line
39230 that is written when a message is received, preceded by the word &"for"&. The
39231 addresses are listed after they have been qualified, but before any rewriting
39232 has taken place.
39233 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39234 in the list.
39235 .next
39236 .cindex "log" "sender reception"
39237 &%received_sender%&: The unrewritten original sender of a message is added to
39238 the end of the log line that records the message's arrival, after the word
39239 &"from"& (before the recipients if &%received_recipients%& is also set).
39240 .next
39241 .cindex "log" "header lines for rejection"
39242 &%rejected_header%&: If a message's header has been received at the time a
39243 rejection is written to the reject log, the complete header is added to the
39244 log. Header logging can be turned off individually for messages that are
39245 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39246 .next
39247 .cindex "log" "retry defer"
39248 &%retry_defer%&: A log line is written if a delivery is deferred because a
39249 retry time has not yet been reached. However, this &"retry time not reached"&
39250 message is always omitted from individual message logs after the first delivery
39251 attempt.
39252 .next
39253 .cindex "log" "return path"
39254 &%return_path_on_delivery%&: The return path that is being transmitted with
39255 the message is included in delivery and bounce lines, using the tag P=.
39256 This is omitted if no delivery actually happens, for example, if routing fails,
39257 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39258 .next
39259 .cindex "log" "sender on delivery"
39260 &%sender_on_delivery%&: The message's sender address is added to every delivery
39261 and bounce line, tagged by F= (for &"from"&).
39262 This is the original sender that was received with the message; it is not
39263 necessarily the same as the outgoing return path.
39264 .next
39265 .cindex "log" "sender verify failure"
39266 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39267 gives details of a sender verification failure is not written. Log lines for
39268 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39269 detail is lost.
39270 .next
39271 .cindex "log" "size rejection"
39272 &%size_reject%&: A log line is written whenever a message is rejected because
39273 it is too big.
39274 .next
39275 .cindex "log" "frozen messages; skipped"
39276 .cindex "frozen messages" "logging skipping"
39277 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39278 queue run because it another process is already delivering it or because
39279 it is frozen.
39280 .cindex "&""spool file is locked""&"
39281 .cindex "&""message is frozen""&"
39282 The message that is written is either &"spool file is locked"& or
39283 &"message is frozen"&.
39284 .next
39285 .cindex "log" "smtp confirmation"
39286 .cindex "SMTP" "logging confirmation"
39287 .cindex "LMTP" "logging confirmation"
39288 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39289 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39290 A number of MTAs (including Exim) return an identifying string in this
39291 response.
39292 .next
39293 .cindex "log" "SMTP connections"
39294 .cindex "SMTP" "logging connections"
39295 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39296 established or closed, unless the connection is from a host that matches
39297 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39298 only when the closure is unexpected.) This applies to connections from local
39299 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39300 dropped in the middle of a message, a log line is always written, whether or
39301 not this selector is set, but otherwise nothing is written at the start and end
39302 of connections unless this selector is enabled.
39303
39304 For TCP/IP connections to an Exim daemon, the current number of connections is
39305 included in the log message for each new connection, but note that the count is
39306 reset if the daemon is restarted.
39307 Also, because connections are closed (and the closure is logged) in
39308 subprocesses, the count may not include connections that have been closed but
39309 whose termination the daemon has not yet noticed. Thus, while it is possible to
39310 match up the opening and closing of connections in the log, the value of the
39311 logged counts may not be entirely accurate.
39312 .next
39313 .cindex "log" "SMTP transaction; incomplete"
39314 .cindex "SMTP" "logging incomplete transactions"
39315 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39316 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39317 and the message sender plus any accepted recipients are included in the log
39318 line. This can provide evidence of dictionary attacks.
39319 .next
39320 .cindex "log" "non-MAIL SMTP sessions"
39321 .cindex "MAIL" "logging session without"
39322 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39323 connection terminates without having issued a MAIL command. This includes both
39324 the case when the connection is dropped, and the case when QUIT is used. It
39325 does not include cases where the connection is rejected right at the start (by
39326 an ACL, or because there are too many connections, or whatever). These cases
39327 already have their own log lines.
39328
39329 The log line that is written contains the identity of the client in the usual
39330 way, followed by D= and a time, which records the duration of the connection.
39331 If the connection was authenticated, this fact is logged exactly as it is for
39332 an incoming message, with an A= item. If the connection was encrypted, CV=,
39333 DN=, and X= items may appear as they do for an incoming message, controlled by
39334 the same logging options.
39335
39336 Finally, if any SMTP commands were issued during the connection, a C= item
39337 is added to the line, listing the commands that were used. For example,
39338 .code
39339 C=EHLO,QUIT
39340 .endd
39341 shows that the client issued QUIT straight after EHLO. If there were fewer
39342 than 20 commands, they are all listed. If there were more than 20 commands,
39343 the last 20 are listed, preceded by &"..."&. However, with the default
39344 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39345 have been aborted before 20 non-mail commands are processed.
39346 .next
39347 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39348 colon-separated, is appended to the A= item for a message arrival or delivery
39349 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39350 was accepted or used.
39351 .next
39352 .cindex "log" "SMTP protocol error"
39353 .cindex "SMTP" "logging protocol error"
39354 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39355 encountered. Exim does not have perfect detection of all protocol errors
39356 because of transmission delays and the use of pipelining. If PIPELINING has
39357 been advertised to a client, an Exim server assumes that the client will use
39358 it, and therefore it does not count &"expected"& errors (for example, RCPT
39359 received after rejecting MAIL) as protocol errors.
39360 .next
39361 .cindex "SMTP" "logging syntax errors"
39362 .cindex "SMTP" "syntax errors; logging"
39363 .cindex "SMTP" "unknown command; logging"
39364 .cindex "log" "unknown SMTP command"
39365 .cindex "log" "SMTP syntax error"
39366 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39367 encountered. An unrecognized command is treated as a syntax error. For an
39368 external connection, the host identity is given; for an internal connection
39369 using &%-bs%& the sender identification (normally the calling user) is given.
39370 .next
39371 .cindex "log" "subject"
39372 .cindex "subject, logging"
39373 &%subject%&: The subject of the message is added to the arrival log line,
39374 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39375 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39376 specifies whether characters with values greater than 127 should be logged
39377 unchanged, or whether they should be rendered as escape sequences.
39378 .next
39379 .cindex "log" "certificate verification"
39380 .cindex log DANE
39381 .cindex DANE logging
39382 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39383 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39384 verified
39385 using a CA trust anchor,
39386 &`CV=dane`& if using a DNS trust anchor,
39387 and &`CV=no`& if not.
39388 .next
39389 .cindex "log" "TLS cipher"
39390 .cindex "TLS" "logging cipher"
39391 &%tls_cipher%&: When a message is sent or received over an encrypted
39392 connection, the cipher suite used is added to the log line, preceded by X=.
39393 .next
39394 .cindex "log" "TLS peer DN"
39395 .cindex "TLS" "logging peer DN"
39396 &%tls_peerdn%&: When a message is sent or received over an encrypted
39397 connection, and a certificate is supplied by the remote host, the peer DN is
39398 added to the log line, preceded by DN=.
39399 .next
39400 .cindex "log" "TLS resumption"
39401 .cindex "TLS" "logging session resumption"
39402 &%tls_resumption%&: When a message is sent or received over an encrypted
39403 connection and the TLS session resumed one used on a previous TCP connection,
39404 an asterisk is appended to the X= cipher field in the log line.
39405 .next
39406 .cindex "log" "TLS SNI"
39407 .cindex "TLS" "logging SNI"
39408 .cindex SNI logging
39409 &%tls_sni%&: When a message is received over an encrypted connection, and
39410 the remote host provided the Server Name Indication extension, the SNI is
39411 added to the log line, preceded by SNI=.
39412 .next
39413 .cindex "log" "DNS failure in list"
39414 &%unknown_in_list%&: This setting causes a log entry to be written when the
39415 result of a list match is failure because a DNS lookup failed.
39416 .endlist
39417
39418
39419 .section "Message log" "SECID260"
39420 .cindex "message" "log file for"
39421 .cindex "log" "message log; description of"
39422 .cindex "&_msglog_& directory"
39423 .oindex "&%preserve_message_logs%&"
39424 In addition to the general log files, Exim writes a log file for each message
39425 that it handles. The names of these per-message logs are the message ids, and
39426 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39427 message log contains copies of the log lines that apply to the message. This
39428 makes it easier to inspect the status of an individual message without having
39429 to search the main log. A message log is deleted when processing of the message
39430 is complete, unless &%preserve_message_logs%& is set, but this should be used
39431 only with great care because they can fill up your disk very quickly.
39432
39433 On a heavily loaded system, it may be desirable to disable the use of
39434 per-message logs, in order to reduce disk I/O. This can be done by setting the
39435 &%message_logs%& option false.
39436 .ecindex IIDloggen
39437
39438
39439
39440
39441 . ////////////////////////////////////////////////////////////////////////////
39442 . ////////////////////////////////////////////////////////////////////////////
39443
39444 .chapter "Exim utilities" "CHAPutils"
39445 .scindex IIDutils "utilities"
39446 A number of utility scripts and programs are supplied with Exim and are
39447 described in this chapter. There is also the Exim Monitor, which is covered in
39448 the next chapter. The utilities described here are:
39449
39450 .itable none 0 0 3  7* left  15* left  40* left
39451 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39452   "list what Exim processes are doing"
39453 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39454 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39455 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39456 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39457                                                 various criteria"
39458 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39459 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39460   "extract statistics from the log"
39461 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39462   "check address acceptance from given IP"
39463 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39464 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39465 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39466 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39467 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39468 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39469 .endtable
39470
39471 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39472 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39473 &url(https://duncanthrax.net/exilog/) for details.
39474
39475
39476
39477
39478 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39479 .cindex "&'exiwhat'&"
39480 .cindex "process, querying"
39481 .cindex "SIGUSR1"
39482 On operating systems that can restart a system call after receiving a signal
39483 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39484 a line describing what it is doing to the file &_exim-process.info_& in the
39485 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39486 processes it can find, having first emptied the file. It then waits for one
39487 second to allow the Exim processes to react before displaying the results. In
39488 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39489 send the signal to the Exim processes, so it is normally run as root.
39490
39491 &*Warning*&: This is not an efficient process. It is intended for occasional
39492 use by system administrators. It is not sensible, for example, to set up a
39493 script that sends SIGUSR1 signals to Exim processes at short intervals.
39494
39495
39496 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39497 varies in different operating systems. Not only are different options used,
39498 but the format of the output is different. For this reason, there are some
39499 system configuration options that configure exactly how &'exiwhat'& works. If
39500 it doesn't seem to be working for you, check the following compile-time
39501 options:
39502 .itable none 0 0 2 30* left 70* left
39503 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39504 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39505 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39506 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39507 .endtable
39508 An example of typical output from &'exiwhat'& is
39509 .code
39510 164 daemon: -q1h, listening on port 25
39511 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39512 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39513   [10.19.42.42] (editor@ref.example)
39514 10592 handling incoming call from [192.168.243.242]
39515 10628 accepting a local non-SMTP message
39516 .endd
39517 The first number in the output line is the process number. The third line has
39518 been split here, in order to fit it on the page.
39519
39520
39521
39522 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39523 .cindex "&'exiqgrep'&"
39524 .cindex "queue" "grepping"
39525 This utility is a Perl script contributed by Matt Hubbard. It runs
39526 .code
39527 exim -bpu
39528 .endd
39529 or (in case &*-a*& switch is specified)
39530 .code
39531 exim -bp
39532 .endd
39533 to obtain a queue listing, and then greps the output to select messages
39534 that match given criteria. The following selection options are available:
39535
39536 .vlist
39537 .vitem &*-f*&&~<&'regex'&>
39538 Match the sender address using a case-insensitive search. The field that is
39539 tested is enclosed in angle brackets, so you can test for bounce messages with
39540 .code
39541 exiqgrep -f '^<>$'
39542 .endd
39543 .vitem &*-r*&&~<&'regex'&>
39544 Match a recipient address using a case-insensitive search. The field that is
39545 tested is not enclosed in angle brackets.
39546
39547 .vitem &*-s*&&~<&'regex'&>
39548 Match against the size field.
39549
39550 .vitem &*-y*&&~<&'seconds'&>
39551 Match messages that are younger than the given time.
39552
39553 .vitem &*-o*&&~<&'seconds'&>
39554 Match messages that are older than the given time.
39555
39556 .vitem &*-z*&
39557 Match only frozen messages.
39558
39559 .vitem &*-x*&
39560 Match only non-frozen messages.
39561
39562 .vitem &*-G*&&~<&'queuename'&>
39563 Match only messages in the given queue.  Without this, the default queue is searched.
39564 .endlist
39565
39566 The following options control the format of the output:
39567
39568 .vlist
39569 .vitem &*-c*&
39570 Display only the count of matching messages.
39571
39572 .vitem &*-l*&
39573 Long format &-- display the full message information as output by Exim. This is
39574 the default.
39575
39576 .vitem &*-i*&
39577 Display message ids only.
39578
39579 .vitem &*-b*&
39580 Brief format &-- one line per message.
39581
39582 .vitem &*-R*&
39583 Display messages in reverse order.
39584
39585 .vitem &*-a*&
39586 Include delivered recipients in queue listing.
39587 .endlist
39588
39589 The following options give alternates for configuration:
39590
39591 .vlist
39592 .vitem &*-C*&&~<&'config&~file'&>
39593 is used to specify an alternate &_exim.conf_& which might
39594 contain alternate exim configuration the queue management might be using.
39595
39596 .vitem &*-E*&&~<&'path'&>
39597 can be used to specify a path for the exim binary,
39598 overriding the built-in one.
39599 .endlist
39600
39601 There is one more option, &%-h%&, which outputs a list of options.
39602 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39603
39604
39605
39606 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39607 .cindex "&'exiqsumm'&"
39608 .cindex "queue" "summary"
39609 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39610 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39611 running a command such as
39612 .code
39613 exim -bp | exiqsumm
39614 .endd
39615 The output consists of one line for each domain that has messages waiting for
39616 it, as in the following example:
39617 .code
39618 3   2322   74m   66m  msn.com.example
39619 .endd
39620 Each line lists the number of pending deliveries for a domain, their total
39621 volume, and the length of time that the oldest and the newest messages have
39622 been waiting. Note that the number of pending deliveries is greater than the
39623 number of messages when messages have more than one recipient.
39624
39625 A summary line is output at the end. By default the output is sorted on the
39626 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39627 the output to be sorted by oldest message and by count of messages,
39628 respectively. There are also three options that split the messages for each
39629 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39630 separates frozen messages, and &%-s%& separates messages according to their
39631 sender.
39632
39633 The output of &'exim -bp'& contains the original addresses in the message, so
39634 this also applies to the output from &'exiqsumm'&. No domains from addresses
39635 generated by aliasing or forwarding are included (unless the &%one_time%&
39636 option of the &(redirect)& router has been used to convert them into &"top
39637 level"& addresses).
39638
39639
39640
39641
39642 .section "Extracting specific information from the log (exigrep)" &&&
39643          "SECTextspeinf"
39644 .cindex "&'exigrep'&"
39645 .cindex "log" "extracts; grepping for"
39646 The &'exigrep'& utility is a Perl script that searches one or more main log
39647 files for entries that match a given pattern. When it finds a match, it
39648 extracts all the log entries for the relevant message, not just those that
39649 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39650 given message, or all mail for a given user, or for a given host, for example.
39651 The input files can be in Exim log format or syslog format.
39652 If a matching log line is not associated with a specific message, it is
39653 included in &'exigrep'&'s output without any additional lines. The usage is:
39654 .display
39655 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39656 .endd
39657 If no log filenames are given on the command line, the standard input is read.
39658
39659 The &%-t%& argument specifies a number of seconds. It adds an additional
39660 condition for message selection. Messages that are complete are shown only if
39661 they spent more than <&'n'&> seconds in the queue.
39662
39663 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39664 makes it case-sensitive. This may give a performance improvement when searching
39665 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39666 option; with &%-I%& they do not. In both cases it is possible to change the
39667 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39668
39669 The &%-l%& option means &"literal"&, that is, treat all characters in the
39670 pattern as standing for themselves. Otherwise the pattern must be a Perl
39671 regular expression.
39672
39673 The &%-v%& option inverts the matching condition. That is, a line is selected
39674 if it does &'not'& match the pattern.
39675
39676 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39677 that are generated as a result/response to a message that &'exigrep'& matched
39678 normally.
39679
39680 Example of &%-M%&:
39681 user_a sends a message to user_b, which generates a bounce back to user_b. If
39682 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39683 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39684 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39685 when searching for &"user_a"& will show both messages since the bounce is
39686 &"related"& to or a &"result"& of the first message that was found by the
39687 search term.
39688
39689 If the location of a &'zcat'& command is known from the definition of
39690 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39691 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39692 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39693 autodetection of some well known compression extensions.
39694
39695
39696 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39697 .cindex "&'exipick'&"
39698 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39699 lists messages from the queue according to a variety of criteria. For details
39700 of &'exipick'&'s facilities, run &'exipick'& with
39701 the &%--help%& option.
39702
39703
39704 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39705 .cindex "log" "cycling local files"
39706 .cindex "cycling logs"
39707 .cindex "&'exicyclog'&"
39708 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39709 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39710 you are using log files with datestamps in their names (see section
39711 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39712 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39713 There are two command line options for &'exicyclog'&:
39714 .ilist
39715 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39716 default that is set when Exim is built. The default default is 10.
39717 .next
39718 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39719 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39720 overriding the script's default, which is to find the setting from Exim's
39721 configuration.
39722 .endlist
39723
39724 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39725 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39726 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39727 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39728 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39729 logs are handled similarly.
39730
39731 If the limit is greater than 99, the script uses 3-digit numbers such as
39732 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39733 to one that is greater, or &'vice versa'&, you will have to fix the names of
39734 any existing log files.
39735
39736 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39737 the end are deleted. All files with numbers greater than 01 are compressed,
39738 using a compression command which is configured by the COMPRESS_COMMAND
39739 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39740 root &%crontab%& entry of the form
39741 .code
39742 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39743 .endd
39744 assuming you have used the name &"exim"& for the Exim user. You can run
39745 &'exicyclog'& as root if you wish, but there is no need.
39746
39747
39748
39749 .section "Mail statistics (eximstats)" "SECTmailstat"
39750 .cindex "statistics"
39751 .cindex "&'eximstats'&"
39752 A Perl script called &'eximstats'& is provided for extracting statistical
39753 information from log files. The output is either plain text, or HTML.
39754 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39755 . --- 404 error and everything else points to that.
39756
39757 The &'eximstats'& script has been hacked about quite a bit over time. The
39758 latest version is the result of some extensive revision by Steve Campbell. A
39759 lot of information is given by default, but there are options for suppressing
39760 various parts of it. Following any options, the arguments to the script are a
39761 list of files, which should be main log files. For example:
39762 .code
39763 eximstats -nr /var/spool/exim/log/mainlog.01
39764 .endd
39765 By default, &'eximstats'& extracts information about the number and volume of
39766 messages received from or delivered to various hosts. The information is sorted
39767 both by message count and by volume, and the top fifty hosts in each category
39768 are listed on the standard output. Similar information, based on email
39769 addresses or domains instead of hosts can be requested by means of various
39770 options. For messages delivered and received locally, similar statistics are
39771 also produced per user.
39772
39773 The output also includes total counts and statistics about delivery errors, and
39774 histograms showing the number of messages received and deliveries made in each
39775 hour of the day. A delivery with more than one address in its envelope (for
39776 example, an SMTP transaction with more than one RCPT command) is counted
39777 as a single delivery by &'eximstats'&.
39778
39779 Though normally more deliveries than receipts are reported (as messages may
39780 have multiple recipients), it is possible for &'eximstats'& to report more
39781 messages received than delivered, even though the queue is empty at the start
39782 and end of the period in question. If an incoming message contains no valid
39783 recipients, no deliveries are recorded for it. A bounce message is handled as
39784 an entirely separate message.
39785
39786 &'eximstats'& always outputs a grand total summary giving the volume and number
39787 of messages received and deliveries made, and the number of hosts involved in
39788 each case. It also outputs the number of messages that were delayed (that is,
39789 not completely delivered at the first attempt), and the number that had at
39790 least one address that failed.
39791
39792 The remainder of the output is in sections that can be independently disabled
39793 or modified by various options. It consists of a summary of deliveries by
39794 transport, histograms of messages received and delivered per time interval
39795 (default per hour), information about the time messages spent in the queue,
39796 a list of relayed messages, lists of the top fifty sending hosts, local
39797 senders, destination hosts, and destination local users by count and by volume,
39798 and a list of delivery errors that occurred.
39799
39800 The relay information lists messages that were actually relayed, that is, they
39801 came from a remote host and were directly delivered to some other remote host,
39802 without being processed (for example, for aliasing or forwarding) locally.
39803
39804 There are quite a few options for &'eximstats'& to control exactly what it
39805 outputs. These are documented in the Perl script itself, and can be extracted
39806 by running the command &(perldoc)& on the script. For example:
39807 .code
39808 perldoc /usr/exim/bin/eximstats
39809 .endd
39810
39811 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39812 .cindex "&'exim_checkaccess'&"
39813 .cindex "policy control" "checking access"
39814 .cindex "checking access"
39815 The &%-bh%& command line argument allows you to run a fake SMTP session with
39816 debugging output, in order to check what Exim is doing when it is applying
39817 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39818 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39819 sometimes you just want to answer the question &"Does this address have
39820 access?"& without bothering with any further details.
39821
39822 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39823 two arguments, an IP address and an email address:
39824 .code
39825 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39826 .endd
39827 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39828 given email address would be accepted in a RCPT command in a TCP/IP
39829 connection from the host with the given IP address. The output of the utility
39830 is either the word &"accepted"&, or the SMTP error response, for example:
39831 .code
39832 Rejected:
39833 550 Relay not permitted
39834 .endd
39835 When running this test, the utility uses &`<>`& as the envelope sender address
39836 for the MAIL command, but you can change this by providing additional
39837 options. These are passed directly to the Exim command. For example, to specify
39838 that the test is to be run with the sender address &'himself@there.example'&
39839 you can use:
39840 .code
39841 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39842                  -f himself@there.example
39843 .endd
39844 Note that these additional Exim command line items must be given after the two
39845 mandatory arguments.
39846
39847 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39848 while running its checks. You can run checks that include callouts by using
39849 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39850
39851
39852
39853 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39854 .cindex "DBM" "building dbm files"
39855 .cindex "building DBM files"
39856 .cindex "&'exim_dbmbuild'&"
39857 .cindex "lower casing"
39858 .cindex "binary zero" "in lookup key"
39859 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39860 the format used by the &(lsearch)& lookup (see section
39861 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39862 names as keys and the remainder of the information as data. The lower-casing
39863 can be prevented by calling the program with the &%-nolc%& option.
39864
39865 A terminating zero is included as part of the key string. This is expected by
39866 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39867 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39868 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39869 files.
39870
39871 The program requires two arguments: the name of the input file (which can be a
39872 single hyphen to indicate the standard input), and the name of the output file.
39873 It creates the output under a temporary name, and then renames it if all went
39874 well.
39875
39876 .cindex "USE_DB"
39877 If the native DB interface is in use (USE_DB is set in a compile-time
39878 configuration file &-- this is common in free versions of Unix) the two
39879 filenames must be different, because in this mode the Berkeley DB functions
39880 create a single output file using exactly the name given. For example,
39881 .code
39882 exim_dbmbuild /etc/aliases /etc/aliases.db
39883 .endd
39884 reads the system alias file and creates a DBM version of it in
39885 &_/etc/aliases.db_&.
39886
39887 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39888 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39889 environment, the suffixes are added to the second argument of
39890 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39891 when the Berkeley functions are used in compatibility mode (though this is not
39892 recommended), because in that case it adds a &_.db_& suffix to the filename.
39893
39894 If a duplicate key is encountered, the program outputs a warning, and when it
39895 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39896 option is used. By default, only the first of a set of duplicates is used &--
39897 this makes it compatible with &(lsearch)& lookups. There is an option
39898 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39899 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39900 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39901 return code is 2.
39902
39903
39904
39905
39906 .section "Finding individual retry times (exinext)" "SECTfinindret"
39907 .cindex "retry" "times"
39908 .cindex "&'exinext'&"
39909 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39910 fish specific information out of the retry database. Given a mail domain (or a
39911 complete address), it looks up the hosts for that domain, and outputs any retry
39912 information for the hosts or for the domain. At present, the retry information
39913 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39914 output. For example:
39915 .code
39916 $ exinext piglet@milne.fict.example
39917 kanga.milne.example:192.168.8.1 error 146: Connection refused
39918   first failed: 21-Feb-1996 14:57:34
39919   last tried:   21-Feb-1996 14:57:34
39920   next try at:  21-Feb-1996 15:02:34
39921 roo.milne.example:192.168.8.3 error 146: Connection refused
39922   first failed: 20-Jan-1996 13:12:08
39923   last tried:   21-Feb-1996 11:42:03
39924   next try at:  21-Feb-1996 19:42:03
39925   past final cutoff time
39926 .endd
39927 You can also give &'exinext'& a local part, without a domain, and it
39928 will give any retry information for that local part in your default domain.
39929 A message id can be used to obtain retry information pertaining to a specific
39930 message. This exists only when an attempt to deliver a message to a remote host
39931 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39932 &'exinext'& is not particularly efficient, but then it is not expected to be
39933 run very often.
39934
39935 The &'exinext'& utility calls Exim to find out information such as the location
39936 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39937 passed on to the &'exim'& commands. The first specifies an alternate Exim
39938 configuration file, and the second sets macros for use within the configuration
39939 file. These features are mainly to help in testing, but might also be useful in
39940 environments where more than one configuration file is in use.
39941
39942
39943
39944 .section "Hints database maintenance" "SECThindatmai"
39945 .cindex "hints database" "maintenance"
39946 .cindex "maintaining Exim's hints database"
39947 Three utility programs are provided for maintaining the DBM files that Exim
39948 uses to contain its delivery hint information. Each program requires two
39949 arguments. The first specifies the name of Exim's spool directory, and the
39950 second is the name of the database it is to operate on. These are as follows:
39951
39952 .ilist
39953 &'retry'&: the database of retry information
39954 .next
39955 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39956 for remote hosts
39957 .next
39958 &'callout'&: the callout cache
39959 .next
39960 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39961 .next
39962 &'tls'&: TLS session resumption data
39963 .next
39964 &'misc'&: other hints data
39965 .endlist
39966
39967 The &'misc'& database is used for
39968
39969 .ilist
39970 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39971 .next
39972 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39973 &(smtp)& transport)
39974 .next
39975 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39976 in a transport)
39977 .endlist
39978
39979
39980
39981 .section "exim_dumpdb" "SECTdumpdb"
39982 .cindex "&'exim_dumpdb'&"
39983 The entire contents of a database are written to the standard output by the
39984 &'exim_dumpdb'& program,
39985 taking as arguments the spool and database names.
39986 An option &'-z'& may be given to request times in UTC;
39987 otherwise times are in the local timezone.
39988 An option &'-k'& may be given to dump only the record keys.
39989 For example, to dump the retry database:
39990 .code
39991 exim_dumpdb /var/spool/exim retry
39992 .endd
39993 For the retry database
39994 two lines of output are produced for each entry:
39995 .code
39996 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39997 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39998 .endd
39999 The first item on the first line is the key of the record. It starts with one
40000 of the letters R, or T, depending on whether it refers to a routing or
40001 transport retry. For a local delivery, the next part is the local address; for
40002 a remote delivery it is the name of the remote host, followed by its failing IP
40003 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40004 transport). If the remote port is not the standard one (port 25), it is added
40005 to the IP address. Then there follows an error code, an additional error code,
40006 and a textual description of the error.
40007
40008 The three times on the second line are the time of first failure, the time of
40009 the last delivery attempt, and the computed time for the next attempt. The line
40010 ends with an asterisk if the cutoff time for the last retry rule has been
40011 exceeded.
40012
40013 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40014 consists of a host name followed by a list of ids for messages that are or were
40015 waiting to be delivered to that host. If there are a very large number for any
40016 one host, continuation records, with a sequence number added to the host name,
40017 may be seen. The data in these records is often out of date, because a message
40018 may be routed to several alternative hosts, and Exim makes no effort to keep
40019 cross-references.
40020
40021
40022
40023 .section "exim_tidydb" "SECTtidydb"
40024 .cindex "&'exim_tidydb'&"
40025 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40026 database. If run with no options, it removes all records that are more than 30
40027 days old. The age is calculated from the date and time that the record was last
40028 updated. Note that, in the case of the retry database, it is &'not'& the time
40029 since the first delivery failure. Information about a host that has been down
40030 for more than 30 days will remain in the database, provided that the record is
40031 updated sufficiently often.
40032
40033 The cutoff date can be altered by means of the &%-t%& option, which must be
40034 followed by a time. For example, to remove all records older than a week from
40035 the retry database:
40036 .code
40037 exim_tidydb -t 7d /var/spool/exim retry
40038 .endd
40039 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40040 message ids. In the former these appear as data in records keyed by host &--
40041 they were messages that were waiting for that host &-- and in the latter they
40042 are the keys for retry information for messages that have suffered certain
40043 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40044 message ids in database records are those of messages that are still on the
40045 queue. Message ids for messages that no longer exist are removed from
40046 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40047 For the &'retry'& database, records whose keys are non-existent message ids are
40048 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40049 whenever it removes information from the database.
40050
40051 Certain records are automatically removed by Exim when they are no longer
40052 needed, but others are not. For example, if all the MX hosts for a domain are
40053 down, a retry record is created for each one. If the primary MX host comes back
40054 first, its record is removed when Exim successfully delivers to it, but the
40055 records for the others remain because Exim has not tried to use those hosts.
40056
40057 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40058 hints databases. You should do this at a quiet time of day, because it requires
40059 a database to be locked (and therefore inaccessible to Exim) while it does its
40060 work. Removing records from a DBM file does not normally make the file smaller,
40061 but all the common DBM libraries are able to re-use the space that is released.
40062 After an initial phase of increasing in size, the databases normally reach a
40063 point at which they no longer get any bigger, as long as they are regularly
40064 tidied.
40065
40066 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40067 databases is likely to keep on increasing.
40068
40069
40070
40071
40072 .section "exim_fixdb" "SECTfixdb"
40073 .cindex "&'exim_fixdb'&"
40074 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40075 Its main use is for testing Exim, but it might also be occasionally useful for
40076 getting round problems in a live system. Its interface
40077 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40078 key of a database record can then be entered, and the data for that record is
40079 displayed.
40080
40081 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40082 except the &'retry'& database, that is the only operation that can be carried
40083 out. For the &'retry'& database, each field is output preceded by a number, and
40084 data for individual fields can be changed by typing the field number followed
40085 by new data, for example:
40086 .code
40087 > 4 951102:1000
40088 .endd
40089 resets the time of the next delivery attempt. Time values are given as a
40090 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40091 used as optional separators.
40092
40093 Both displayed and input times are in the local timezone by default.
40094 If an option &'-z'& is used on the command line, displayed times
40095 are in UTC.
40096
40097
40098
40099
40100 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40101 .cindex "mailbox" "maintenance"
40102 .cindex "&'exim_lock'&"
40103 .cindex "locking mailboxes"
40104 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40105 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40106 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40107 a user agent while investigating a problem. The utility requires the name of
40108 the file as its first argument. If the locking is successful, the second
40109 argument is run as a command (using C's &[system()]& function); if there is no
40110 second argument, the value of the SHELL environment variable is used; if this
40111 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40112 is unlocked and the utility ends. The following options are available:
40113
40114 .vlist
40115 .vitem &%-fcntl%&
40116 Use &[fcntl()]& locking on the open mailbox.
40117
40118 .vitem &%-flock%&
40119 Use &[flock()]& locking on the open mailbox, provided the operating system
40120 supports it.
40121
40122 .vitem &%-interval%&
40123 This must be followed by a number, which is a number of seconds; it sets the
40124 interval to sleep between retries (default 3).
40125
40126 .vitem &%-lockfile%&
40127 Create a lock file before opening the mailbox.
40128
40129 .vitem &%-mbx%&
40130 Lock the mailbox using MBX rules.
40131
40132 .vitem &%-q%&
40133 Suppress verification output.
40134
40135 .vitem &%-retries%&
40136 This must be followed by a number; it sets the number of times to try to get
40137 the lock (default 10).
40138
40139 .vitem &%-restore_time%&
40140 This option causes &%exim_lock%& to restore the modified and read times to the
40141 locked file before exiting. This allows you to access a locked mailbox (for
40142 example, to take a backup copy) without disturbing the times that the user
40143 subsequently sees.
40144
40145 .vitem &%-timeout%&
40146 This must be followed by a number, which is a number of seconds; it sets a
40147 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40148 default), a non-blocking call is used.
40149
40150 .vitem &%-v%&
40151 Generate verbose output.
40152 .endlist
40153
40154 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40155 default is to create a lock file and also to use &[fcntl()]& locking on the
40156 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40157 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40158 requires that the directory containing the file be writeable. Locking by lock
40159 file does not last forever; Exim assumes that a lock file is expired if it is
40160 more than 30 minutes old.
40161
40162 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40163 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40164 to be taken out on the open mailbox, and an exclusive lock on the file
40165 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40166 number of the mailbox file. When the locking is released, if an exclusive lock
40167 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40168
40169 The default output contains verification of the locking that takes place. The
40170 &%-v%& option causes some additional information to be given. The &%-q%& option
40171 suppresses all output except error messages.
40172
40173 A command such as
40174 .code
40175 exim_lock /var/spool/mail/spqr
40176 .endd
40177 runs an interactive shell while the file is locked, whereas
40178 .display
40179 &`exim_lock -q /var/spool/mail/spqr <<End`&
40180 <&'some commands'&>
40181 &`End`&
40182 .endd
40183 runs a specific non-interactive sequence of commands while the file is locked,
40184 suppressing all verification output. A single command can be run by a command
40185 such as
40186 .code
40187 exim_lock -q /var/spool/mail/spqr \
40188   "cp /var/spool/mail/spqr /some/where"
40189 .endd
40190 Note that if a command is supplied, it must be entirely contained within the
40191 second argument &-- hence the quotes.
40192 .ecindex IIDutils
40193
40194
40195 . ////////////////////////////////////////////////////////////////////////////
40196 . ////////////////////////////////////////////////////////////////////////////
40197
40198 .chapter "The Exim monitor" "CHAPeximon"
40199 .scindex IIDeximon "Exim monitor" "description"
40200 .cindex "X-windows"
40201 .cindex "&'eximon'&"
40202 .cindex "Local/eximon.conf"
40203 .cindex "&_exim_monitor/EDITME_&"
40204 The Exim monitor is an application which displays in an X window information
40205 about the state of Exim's queue and what Exim is doing. An admin user can
40206 perform certain operations on messages from this GUI interface; however all
40207 such facilities are also available from the command line, and indeed, the
40208 monitor itself makes use of the command line to perform any actions requested.
40209
40210
40211
40212 .section "Running the monitor" "SECID264"
40213 The monitor is started by running the script called &'eximon'&. This is a shell
40214 script that sets up a number of environment variables, and then runs the
40215 binary called &_eximon.bin_&. The default appearance of the monitor window can
40216 be changed by editing the &_Local/eximon.conf_& file created by editing
40217 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40218 parameters are for.
40219
40220 The parameters that get built into the &'eximon'& script can be overridden for
40221 a particular invocation by setting up environment variables of the same names,
40222 preceded by &`EXIMON_`&. For example, a shell command such as
40223 .code
40224 EXIMON_LOG_DEPTH=400 eximon
40225 .endd
40226 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40227 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40228 overrides the Exim log file configuration. This makes it possible to have
40229 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40230 syslog messages are routed to a file on the local host.
40231
40232 X resources can be used to change the appearance of the window in the normal
40233 way. For example, a resource setting of the form
40234 .code
40235 Eximon*background: gray94
40236 .endd
40237 changes the colour of the background to light grey rather than white. The
40238 stripcharts are drawn with both the data lines and the reference lines in
40239 black. This means that the reference lines are not visible when on top of the
40240 data. However, their colour can be changed by setting a resource called
40241 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40242 For example, if your X server is running Unix, you could set up lighter
40243 reference lines in the stripcharts by obeying
40244 .code
40245 xrdb -merge <<End
40246 Eximon*highlight: gray
40247 End
40248 .endd
40249 .cindex "admin user"
40250 In order to see the contents of messages in the queue, and to operate on them,
40251 &'eximon'& must either be run as root or by an admin user.
40252
40253 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40254 contain X11 resource parameters interpreted by the X11 library.  In addition,
40255 if the first parameter starts with the string "gdb" then it is removed and the
40256 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40257 versioned variants of gdb can be invoked).
40258
40259 The monitor's window is divided into three parts. The first contains one or
40260 more stripcharts and two action buttons, the second contains a &"tail"& of the
40261 main log file, and the third is a display of the queue of messages awaiting
40262 delivery, with two more action buttons. The following sections describe these
40263 different parts of the display.
40264
40265
40266
40267
40268 .section "The stripcharts" "SECID265"
40269 .cindex "stripchart"
40270 The first stripchart is always a count of messages in the queue. Its name can
40271 be configured by setting QUEUE_STRIPCHART_NAME in the
40272 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40273 configuration script by regular expression matches on log file entries, making
40274 it possible to display, for example, counts of messages delivered to certain
40275 hosts or using certain transports. The supplied defaults display counts of
40276 received and delivered messages, and of local and SMTP deliveries. The default
40277 period between stripchart updates is one minute; this can be adjusted by a
40278 parameter in the &_Local/eximon.conf_& file.
40279
40280 The stripchart displays rescale themselves automatically as the value they are
40281 displaying changes. There are always 10 horizontal lines in each chart; the
40282 title string indicates the value of each division when it is greater than one.
40283 For example, &"x2"& means that each division represents a value of 2.
40284
40285 It is also possible to have a stripchart which shows the percentage fullness of
40286 a particular disk partition, which is useful when local deliveries are confined
40287 to a single partition.
40288
40289 .cindex "&%statvfs%& function"
40290 This relies on the availability of the &[statvfs()]& function or equivalent in
40291 the operating system. Most, but not all versions of Unix that support Exim have
40292 this. For this particular stripchart, the top of the chart always represents
40293 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40294 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40295 &_Local/eximon.conf_& file.
40296
40297
40298
40299
40300 .section "Main action buttons" "SECID266"
40301 .cindex "size" "of monitor window"
40302 .cindex "Exim monitor" "window size"
40303 .cindex "window size"
40304 Below the stripcharts there is an action button for quitting the monitor. Next
40305 to this is another button marked &"Size"&. They are placed here so that
40306 shrinking the window to its default minimum size leaves just the queue count
40307 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40308 the window to expand to its maximum size, unless it is already at the maximum,
40309 in which case it is reduced to its minimum.
40310
40311 When expanding to the maximum, if the window cannot be fully seen where it
40312 currently is, it is moved back to where it was the last time it was at full
40313 size. When it is expanding from its minimum size, the old position is
40314 remembered, and next time it is reduced to the minimum it is moved back there.
40315
40316 The idea is that you can keep a reduced window just showing one or two
40317 stripcharts at a convenient place on your screen, easily expand it to show
40318 the full window when required, and just as easily put it back to what it was.
40319 The idea is copied from what the &'twm'& window manager does for its
40320 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40321 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40322
40323 Normally, the monitor starts up with the window at its full size, but it can be
40324 built so that it starts up with the window at its smallest size, by setting
40325 START_SMALL=yes in &_Local/eximon.conf_&.
40326
40327
40328
40329 .section "The log display" "SECID267"
40330 .cindex "log" "tail of; in monitor"
40331 The second section of the window is an area in which a display of the tail of
40332 the main log is maintained.
40333 To save space on the screen, the timestamp on each log line is shortened by
40334 removing the date and, if &%log_timezone%& is set, the timezone.
40335 The log tail is not available when the only destination for logging data is
40336 syslog, unless the syslog lines are routed to a local file whose name is passed
40337 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40338
40339 The log sub-window has a scroll bar at its lefthand side which can be used to
40340 move back to look at earlier text, and the up and down arrow keys also have a
40341 scrolling effect. The amount of log that is kept depends on the setting of
40342 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40343 to use. When this is full, the earlier 50% of data is discarded &-- this is
40344 much more efficient than throwing it away line by line. The sub-window also has
40345 a horizontal scroll bar for accessing the ends of long log lines. This is the
40346 only means of horizontal scrolling; the right and left arrow keys are not
40347 available. Text can be cut from this part of the window using the mouse in the
40348 normal way. The size of this subwindow is controlled by parameters in the
40349 configuration file &_Local/eximon.conf_&.
40350
40351 Searches of the text in the log window can be carried out by means of the ^R
40352 and ^S keystrokes, which default to a reverse and a forward search,
40353 respectively. The search covers only the text that is displayed in the window.
40354 It cannot go further back up the log.
40355
40356 The point from which the search starts is indicated by a caret marker. This is
40357 normally at the end of the text in the window, but can be positioned explicitly
40358 by pointing and clicking with the left mouse button, and is moved automatically
40359 by a successful search. If new text arrives in the window when it is scrolled
40360 back, the caret remains where it is, but if the window is not scrolled back,
40361 the caret is moved to the end of the new text.
40362
40363 Pressing ^R or ^S pops up a window into which the search text can be typed.
40364 There are buttons for selecting forward or reverse searching, for carrying out
40365 the search, and for cancelling. If the &"Search"& button is pressed, the search
40366 happens and the window remains so that further searches can be done. If the
40367 &"Return"& key is pressed, a single search is done and the window is closed. If
40368 ^C is typed the search is cancelled.
40369
40370 The searching facility is implemented using the facilities of the Athena text
40371 widget. By default this pops up a window containing both &"search"& and
40372 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40373 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40374 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40375 provided version of &%TextPop%& when the remaining parts of the text widget
40376 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40377 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40378 on these systems, at the expense of having unwanted items in the search popup
40379 window.
40380
40381
40382
40383 .section "The queue display" "SECID268"
40384 .cindex "queue" "display in monitor"
40385 The bottom section of the monitor window contains a list of all messages that
40386 are in the queue, which includes those currently being received or delivered,
40387 as well as those awaiting delivery. The size of this subwindow is controlled by
40388 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40389 at which it is updated is controlled by another parameter in the same file &--
40390 the default is 5 minutes, since queue scans can be quite expensive. However,
40391 there is an &"Update"& action button just above the display which can be used
40392 to force an update of the queue display at any time.
40393
40394 When a host is down for some time, a lot of pending mail can build up for it,
40395 and this can make it hard to deal with other messages in the queue. To help
40396 with this situation there is a button next to &"Update"& called &"Hide"&. If
40397 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40398 type anything in here and press &"Return"&, the text is added to a chain of
40399 such texts, and if every undelivered address in a message matches at least one
40400 of the texts, the message is not displayed.
40401
40402 If there is an address that does not match any of the texts, all the addresses
40403 are displayed as normal. The matching happens on the ends of addresses so, for
40404 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40405 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40406 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40407 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40408 a hide request is automatically cancelled after one hour.
40409
40410 While the dialogue box is displayed, you can't press any buttons or do anything
40411 else to the monitor window. For this reason, if you want to cut text from the
40412 queue display to use in the dialogue box, you have to do the cutting before
40413 pressing the &"Hide"& button.
40414
40415 The queue display contains, for each unhidden queued message, the length of
40416 time it has been in the queue, the size of the message, the message id, the
40417 message sender, and the first undelivered recipient, all on one line. If it is
40418 a bounce message, the sender is shown as &"<>"&. If there is more than one
40419 recipient to which the message has not yet been delivered, subsequent ones are
40420 listed on additional lines, up to a maximum configured number, following which
40421 an ellipsis is displayed. Recipients that have already received the message are
40422 not shown.
40423
40424 .cindex "frozen messages" "display"
40425 If a message is frozen, an asterisk is displayed at the left-hand side.
40426
40427 The queue display has a vertical scroll bar, and can also be scrolled by means
40428 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40429 The text searching facilities, as described above for the log window, are also
40430 available, but the caret is always moved to the end of the text when the queue
40431 display is updated.
40432
40433
40434
40435 .section "The queue menu" "SECID269"
40436 .cindex "queue" "menu in monitor"
40437 If the &%shift%& key is held down and the left button is clicked when the mouse
40438 pointer is over the text for any message, an action menu pops up, and the first
40439 line of the queue display for the message is highlighted. This does not affect
40440 any selected text.
40441
40442 If you want to use some other event for popping up the menu, you can set the
40443 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40444 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40445 value set in this parameter is a standard X event description. For example, to
40446 run eximon using &%ctrl%& rather than &%shift%& you could use
40447 .code
40448 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40449 .endd
40450 The title of the menu is the message id, and it contains entries which act as
40451 follows:
40452
40453 .ilist
40454 &'message log'&: The contents of the message log for the message are displayed
40455 in a new text window.
40456 .next
40457 &'headers'&: Information from the spool file that contains the envelope
40458 information and headers is displayed in a new text window. See chapter
40459 &<<CHAPspool>>& for a description of the format of spool files.
40460 .next
40461 &'body'&: The contents of the spool file containing the body of the message are
40462 displayed in a new text window. There is a default limit of 20,000 bytes to the
40463 amount of data displayed. This can be changed by setting the BODY_MAX
40464 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40465 .next
40466 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40467 delivery of the message. This causes an automatic thaw if the message is
40468 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40469 a new text window. The delivery is run in a separate process, to avoid holding
40470 up the monitor while the delivery proceeds.
40471 .next
40472 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40473 that the message be frozen.
40474 .next
40475 .cindex "thawing messages"
40476 .cindex "unfreezing messages"
40477 .cindex "frozen messages" "thawing"
40478 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40479 that the message be thawed.
40480 .next
40481 .cindex "delivery" "forcing failure"
40482 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40483 that Exim gives up trying to deliver the message. A bounce message is generated
40484 for any remaining undelivered addresses.
40485 .next
40486 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40487 that the message be deleted from the system without generating a bounce
40488 message.
40489 .next
40490 &'add recipient'&: A dialog box is displayed into which a recipient address can
40491 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40492 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40493 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40494 causes a call to Exim to be made using the &%-Mar%& option to request that an
40495 additional recipient be added to the message, unless the entry box is empty, in
40496 which case no action is taken.
40497 .next
40498 &'mark delivered'&: A dialog box is displayed into which a recipient address
40499 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40500 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40501 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40502 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40503 recipient address as already delivered, unless the entry box is empty, in which
40504 case no action is taken.
40505 .next
40506 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40507 mark all recipient addresses as already delivered.
40508 .next
40509 &'edit sender'&: A dialog box is displayed initialized with the current
40510 sender's address. Pressing RETURN causes a call to Exim to be made using the
40511 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40512 in which case no action is taken. If you want to set an empty sender (as in
40513 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40514 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40515 the address is qualified with that domain.
40516 .endlist
40517
40518 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40519 other cases when a call to Exim is made, if there is any output from Exim (in
40520 particular, if the command fails) a window containing the command and the
40521 output is displayed. Otherwise, the results of the action are normally apparent
40522 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40523 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40524 if no output is generated.
40525
40526 The queue display is automatically updated for actions such as freezing and
40527 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40528 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40529 force an update of the display after one of these actions.
40530
40531 In any text window that is displayed as result of a menu action, the normal
40532 cut-and-paste facility is available, and searching can be carried out using ^R
40533 and ^S, as described above for the log tail window.
40534 .ecindex IIDeximon
40535
40536
40537
40538
40539
40540 . ////////////////////////////////////////////////////////////////////////////
40541 . ////////////////////////////////////////////////////////////////////////////
40542
40543 .chapter "Security considerations" "CHAPsecurity"
40544 .scindex IIDsecurcon "security" "discussion of"
40545 This chapter discusses a number of issues concerned with security, some of
40546 which are also covered in other parts of this manual.
40547
40548 For reasons that this author does not understand, some people have promoted
40549 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40550 existence of this chapter in the documentation. However, the intent of the
40551 chapter is simply to describe the way Exim works in relation to certain
40552 security concerns, not to make any specific claims about the effectiveness of
40553 its security as compared with other MTAs.
40554
40555 What follows is a description of the way Exim is supposed to be. Best efforts
40556 have been made to try to ensure that the code agrees with the theory, but an
40557 absence of bugs can never be guaranteed. Any that are reported will get fixed
40558 as soon as possible.
40559
40560
40561 .section "Building a more &""hardened""& Exim" "SECID286"
40562 .cindex "security" "build-time features"
40563 There are a number of build-time options that can be set in &_Local/Makefile_&
40564 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40565 Exim administrator who does not have the root password, or by someone who has
40566 penetrated the Exim (but not the root) account. These options are as follows:
40567
40568 .ilist
40569 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40570 start of any filenames used with the &%-C%& option. When it is set, these
40571 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40572 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40573 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40574 default setting for &%ALT_CONFIG_PREFIX%&.
40575
40576 If the permitted configuration files are confined to a directory to
40577 which only root has access, this guards against someone who has broken
40578 into the Exim account from running a privileged Exim with an arbitrary
40579 configuration file, and using it to break into other accounts.
40580 .next
40581
40582 If a non-trusted configuration file (i.e. not the default configuration file
40583 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40584 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40585 the next item), then root privilege is retained only if the caller of Exim is
40586 root. This locks out the possibility of testing a configuration using &%-C%&
40587 right through message reception and delivery, even if the caller is root. The
40588 reception works, but by that time, Exim is running as the Exim user, so when
40589 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40590 privilege to be lost. However, root can test reception and delivery using two
40591 separate commands.
40592
40593 .next
40594 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40595 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40596 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40597 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40598 the restrictive side.  Requiring build-time selection of safe macros is onerous
40599 but this option is intended solely as a transition mechanism to permit
40600 previously-working configurations to continue to work after release 4.73.
40601 .next
40602 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40603 is disabled.
40604 .next
40605 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40606 never to be used for any deliveries. This is like the &%never_users%& runtime
40607 option, but it cannot be overridden; the runtime option adds additional users
40608 to the list. The default setting is &"root"&; this prevents a non-root user who
40609 is permitted to modify the runtime file from using Exim as a way to get root.
40610 .endlist
40611
40612
40613
40614 .section "Root privilege" "SECID270"
40615 .cindex "setuid"
40616 .cindex "root privilege"
40617 The Exim binary is normally setuid to root, which means that it gains root
40618 privilege (runs as root) when it starts execution. In some special cases (for
40619 example, when the daemon is not in use and there are no local deliveries), it
40620 may be possible to run Exim setuid to some user other than root. This is
40621 discussed in the next section. However, in most installations, root privilege
40622 is required for two things:
40623
40624 .ilist
40625 To set up a socket connected to the standard SMTP port (25) when initialising
40626 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40627 not required.
40628 .next
40629 To be able to change uid and gid in order to read users' &_.forward_& files and
40630 perform local deliveries as the receiving user or as specified in the
40631 configuration.
40632 .endlist
40633
40634 It is not necessary to be root to do any of the other things Exim does, such as
40635 receiving messages and delivering them externally over SMTP, and it is
40636 obviously more secure if Exim does not run as root except when necessary.
40637 For this reason, a user and group for Exim to use must be defined in
40638 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40639 group"&. Their values can be changed by the runtime configuration, though this
40640 is not recommended. Often a user called &'exim'& is used, but some sites use
40641 &'mail'& or another user name altogether.
40642
40643 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40644 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40645 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40646
40647 After a new Exim process has interpreted its command line options, it changes
40648 uid and gid in the following cases:
40649
40650 .ilist
40651 .oindex "&%-C%&"
40652 .oindex "&%-D%&"
40653 If the &%-C%& option is used to specify an alternate configuration file, or if
40654 the &%-D%& option is used to define macro values for the configuration, and the
40655 calling process is not running as root, the uid and gid are changed to those of
40656 the calling process.
40657 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40658 option may not be used at all.
40659 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40660 can be supplied if the calling process is running as root, the Exim run-time
40661 user or CONFIGURE_OWNER, if defined.
40662 .next
40663 .oindex "&%-be%&"
40664 .oindex "&%-bf%&"
40665 .oindex "&%-bF%&"
40666 If the expansion test option (&%-be%&) or one of the filter testing options
40667 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40668 calling process.
40669 .next
40670 If the process is not a daemon process or a queue runner process or a delivery
40671 process or a process for testing address routing (started with &%-bt%&), the
40672 uid and gid are changed to the Exim user and group. This means that Exim always
40673 runs under its own uid and gid when receiving messages. This also applies when
40674 testing address verification
40675 .oindex "&%-bv%&"
40676 .oindex "&%-bh%&"
40677 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40678 option).
40679 .next
40680 For a daemon, queue runner, delivery, or address testing process, the uid
40681 remains as root at this stage, but the gid is changed to the Exim group.
40682 .endlist
40683
40684 The processes that initially retain root privilege behave as follows:
40685
40686 .ilist
40687 A daemon process changes the gid to the Exim group and the uid to the Exim
40688 user after setting up one or more listening sockets. The &[initgroups()]&
40689 function is called, so that if the Exim user is in any additional groups, they
40690 will be used during message reception.
40691 .next
40692 A queue runner process retains root privilege throughout its execution. Its
40693 job is to fork a controlled sequence of delivery processes.
40694 .next
40695 A delivery process retains root privilege throughout most of its execution,
40696 but any actual deliveries (that is, the transports themselves) are run in
40697 subprocesses which always change to a non-root uid and gid. For local
40698 deliveries this is typically the uid and gid of the owner of the mailbox; for
40699 remote deliveries, the Exim uid and gid are used. Once all the delivery
40700 subprocesses have been run, a delivery process changes to the Exim uid and gid
40701 while doing post-delivery tidying up such as updating the retry database and
40702 generating bounce and warning messages.
40703
40704 While the recipient addresses in a message are being routed, the delivery
40705 process runs as root. However, if a user's filter file has to be processed,
40706 this is done in a subprocess that runs under the individual user's uid and
40707 gid. A system filter is run as root unless &%system_filter_user%& is set.
40708 .next
40709 A process that is testing addresses (the &%-bt%& option) runs as root so that
40710 the routing is done in the same environment as a message delivery.
40711 .endlist
40712
40713
40714
40715
40716 .section "Running Exim without privilege" "SECTrunexiwitpri"
40717 .cindex "privilege, running without"
40718 .cindex "unprivileged running"
40719 .cindex "root privilege" "running without"
40720 Some installations like to run Exim in an unprivileged state for more of its
40721 operation, for added security. Support for this mode of operation is provided
40722 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40723 gid are changed to the Exim user and group at the start of a delivery process
40724 (and also queue runner and address testing processes). This means that address
40725 routing is no longer run as root, and the deliveries themselves cannot change
40726 to any other uid.
40727
40728 .cindex SIGHUP
40729 .cindex "daemon" "restarting"
40730 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40731 that the daemon can still be started in the usual way, and it can respond
40732 correctly to SIGHUP because the re-invocation regains root privilege.
40733
40734 An alternative approach is to make Exim setuid to the Exim user and also setgid
40735 to the Exim group. If you do this, the daemon must be started from a root
40736 process. (Calling Exim from a root process makes it behave in the way it does
40737 when it is setuid root.) However, the daemon cannot restart itself after a
40738 SIGHUP signal because it cannot regain privilege.
40739
40740 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40741 stops Exim from trying to re-invoke itself to do a delivery after a message has
40742 been received. Such a re-invocation is a waste of resources because it has no
40743 effect.
40744
40745 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40746 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40747 to the Exim user seems a clean approach, but there is one complication:
40748
40749 In this style of operation, Exim is running with the real uid and gid set to
40750 those of the calling process, and the effective uid/gid set to Exim's values.
40751 Ideally, any association with the calling process' uid/gid should be dropped,
40752 that is, the real uid/gid should be reset to the effective values so as to
40753 discard any privileges that the caller may have. While some operating systems
40754 have a function that permits this action for a non-root effective uid, quite a
40755 number of them do not. Because of this lack of standardization, Exim does not
40756 address this problem at this time.
40757
40758 For this reason, the recommended approach for &"mostly unprivileged"& running
40759 is to keep the Exim binary setuid to root, and to set
40760 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40761 be used in the most straightforward way.
40762
40763 If you configure Exim not to run delivery processes as root, there are a
40764 number of restrictions on what you can do:
40765
40766 .ilist
40767 You can deliver only as the Exim user/group. You should  explicitly use the
40768 &%user%& and &%group%& options to override routers or local transports that
40769 normally deliver as the recipient. This makes sure that configurations that
40770 work in this mode function the same way in normal mode. Any implicit or
40771 explicit specification of another user causes an error.
40772 .next
40773 Use of &_.forward_& files is severely restricted, such that it is usually
40774 not worthwhile to include them in the configuration.
40775 .next
40776 Users who wish to use &_.forward_& would have to make their home directory and
40777 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40778 and their equivalents in Exim filters, cannot be used. While they could be
40779 enabled in the Exim user's name, that would be insecure and not very useful.
40780 .next
40781 Unless the local user mailboxes are all owned by the Exim user (possible in
40782 some POP3 or IMAP-only environments):
40783
40784 .olist
40785 They must be owned by the Exim group and be writeable by that group. This
40786 implies you must set &%mode%& in the appendfile configuration, as well as the
40787 mode of the mailbox files themselves.
40788 .next
40789 You must set &%no_check_owner%&, since most or all of the files will not be
40790 owned by the Exim user.
40791 .next
40792 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40793 on a newly created mailbox when unprivileged. This also implies that new
40794 mailboxes need to be created manually.
40795 .endlist olist
40796 .endlist ilist
40797
40798
40799 These restrictions severely restrict what can be done in local deliveries.
40800 However, there are no restrictions on remote deliveries. If you are running a
40801 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40802 gives more security at essentially no cost.
40803
40804 If you are using the &%mua_wrapper%& facility (see chapter
40805 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40806
40807
40808
40809
40810 .section "Delivering to local files" "SECID271"
40811 Full details of the checks applied by &(appendfile)& before it writes to a file
40812 are given in chapter &<<CHAPappendfile>>&.
40813
40814
40815
40816 .section "Running local commands" "SECTsecconslocalcmds"
40817 .cindex "security" "local commands"
40818 .cindex "security" "command injection attacks"
40819 There are a number of ways in which an administrator can configure Exim to run
40820 commands based upon received, untrustworthy, data. Further, in some
40821 configurations a user who can control a &_.forward_& file can also arrange to
40822 run commands. Configuration to check includes, but is not limited to:
40823
40824 .ilist
40825 Use of &%use_shell%& in the pipe transport: various forms of shell command
40826 injection may be possible with this option present. It is dangerous and should
40827 be used only with considerable caution. Consider constraints which whitelist
40828 allowed characters in a variable which is to be used in a pipe transport that
40829 has &%use_shell%& enabled.
40830 .next
40831 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40832 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40833 &_.forward_& files in a redirect router. If Exim is running on a central mail
40834 hub to which ordinary users do not have shell access, but home directories are
40835 NFS mounted (for instance) then administrators should review the list of these
40836 forbid options available, and should bear in mind that the options that may
40837 need forbidding can change as new features are added between releases.
40838 .next
40839 The &%${run...}%& expansion item does not use a shell by default, but
40840 administrators can configure use of &_/bin/sh_& as part of the command.
40841 Such invocations should be viewed with prejudicial suspicion.
40842 .next
40843 Administrators who use embedded Perl are advised to explore how Perl's
40844 taint checking might apply to their usage.
40845 .next
40846 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40847 administrators are well advised to view its use with suspicion, in case (for
40848 instance) it allows a local-part to contain embedded Exim directives.
40849 .next
40850 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40851 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40852 each can reference arbitrary lists and files, rather than just being a list
40853 of opaque strings.
40854 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40855 real-world security vulnerabilities caused by its use with untrustworthy data
40856 injected in, for SQL injection attacks.
40857 Consider the use of the &%inlisti%& expansion condition instead.
40858 .endlist
40859
40860
40861
40862
40863 .section "Trust in configuration data" "SECTsecconfdata"
40864 .cindex "security" "data sources"
40865 .cindex "security" "regular expressions"
40866 .cindex "regular expressions" "security"
40867 .cindex "PCRE2" "security"
40868 If configuration data for Exim can come from untrustworthy sources, there
40869 are some issues to be aware of:
40870
40871 .ilist
40872 Use of &%${expand...}%& may provide a path for shell injection attacks.
40873 .next
40874 Letting untrusted data provide a regular expression is unwise.
40875 .next
40876 Using &%${match...}%& to apply a fixed regular expression against untrusted
40877 data may result in pathological behaviour within PCRE2.  Be aware of what
40878 "backtracking" means and consider options for being more strict with a regular
40879 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40880 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40881 possessive quantifiers or just not using regular expressions against untrusted
40882 data.
40883 .next
40884 It can be important to correctly use &%${quote:...}%&,
40885 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40886 items to ensure that data is correctly constructed.
40887 .next
40888 Some lookups might return multiple results, even though normal usage is only
40889 expected to yield one result.
40890 .endlist
40891
40892
40893
40894
40895 .section "IPv4 source routing" "SECID272"
40896 .cindex "source routing" "in IP packets"
40897 .cindex "IP source routing"
40898 Many operating systems suppress IP source-routed packets in the kernel, but
40899 some cannot be made to do this, so Exim does its own check. It logs incoming
40900 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40901 IPv6. No special checking is currently done.
40902
40903
40904
40905 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40906 Support for these SMTP commands is disabled by default. If required, they can
40907 be enabled by defining suitable ACLs.
40908
40909
40910
40911
40912 .section "Privileged users" "SECID274"
40913 .cindex "trusted users"
40914 .cindex "admin user"
40915 .cindex "privileged user"
40916 .cindex "user" "trusted"
40917 .cindex "user" "admin"
40918 Exim recognizes two sets of users with special privileges. Trusted users are
40919 able to submit new messages to Exim locally, but supply their own sender
40920 addresses and information about a sending host. For other users submitting
40921 local messages, Exim sets up the sender address from the uid, and doesn't
40922 permit a remote host to be specified.
40923
40924 .oindex "&%-f%&"
40925 However, an untrusted user is permitted to use the &%-f%& command line option
40926 in the special form &%-f <>%& to indicate that a delivery failure for the
40927 message should not cause an error report. This affects the message's envelope,
40928 but it does not affect the &'Sender:'& header. Untrusted users may also be
40929 permitted to use specific forms of address with the &%-f%& option by setting
40930 the &%untrusted_set_sender%& option.
40931
40932 Trusted users are used to run processes that receive mail messages from some
40933 other mail domain and pass them on to Exim for delivery either locally, or over
40934 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40935 as any user listed in the &%trusted_users%& configuration option, or under any
40936 group listed in the &%trusted_groups%& option.
40937
40938 Admin users are permitted to do things to the messages on Exim's queue. They
40939 can freeze or thaw messages, cause them to be returned to their senders, remove
40940 them entirely, or modify them in various ways. In addition, admin users can run
40941 the Exim monitor and see all the information it is capable of providing, which
40942 includes the contents of files on the spool.
40943
40944 .oindex "&%-M%&"
40945 .oindex "&%-q%&"
40946 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40947 delivery of messages on its queue is restricted to admin users. This
40948 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40949 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40950 queue is also restricted to admin users. This restriction can be relaxed by
40951 setting &%no_queue_list_requires_admin%&.
40952
40953 Exim recognizes an admin user if the calling process is running as root or as
40954 the Exim user or if any of the groups associated with the calling process is
40955 the Exim group. It is not necessary actually to be running under the Exim
40956 group. However, if admin users who are not root or the Exim user are to access
40957 the contents of files on the spool via the Exim monitor (which runs
40958 unprivileged), Exim must be built to allow group read access to its spool
40959 files.
40960
40961 By default, regular users are trusted to perform basic testing and
40962 introspection commands, as themselves.  This setting can be tightened by
40963 setting the &%commandline_checks_require_admin%& option.
40964 This affects most of the checking options,
40965 such as &%-be%& and anything else &%-b*%&.
40966
40967
40968 .section "Spool files" "SECID275"
40969 .cindex "spool directory" "files"
40970 Exim's spool directory and everything it contains is owned by the Exim user and
40971 set to the Exim group. The mode for spool files is defined in the
40972 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40973 any user who is a member of the Exim group can access these files.
40974
40975
40976
40977 .section "Use of argv[0]" "SECID276"
40978 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40979 of specific strings, Exim assumes certain options. For example, calling Exim
40980 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40981 to calling it with the option &%-bS%&. There are no security implications in
40982 this.
40983
40984
40985
40986 .section "Use of %f formatting" "SECID277"
40987 The only use made of &"%f"& by Exim is in formatting load average values. These
40988 are actually stored in integer variables as 1000 times the load average.
40989 Consequently, their range is limited and so therefore is the length of the
40990 converted output.
40991
40992
40993
40994 .section "Embedded Exim path" "SECID278"
40995 Exim uses its own path name, which is embedded in the code, only when it needs
40996 to re-exec in order to regain root privilege. Therefore, it is not root when it
40997 does so. If some bug allowed the path to get overwritten, it would lead to an
40998 arbitrary program's being run as exim, not as root.
40999
41000
41001
41002 .section "Dynamic module directory" "SECTdynmoddir"
41003 Any dynamically loadable modules must be installed into the directory
41004 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41005 loading it.
41006
41007
41008 .section "Use of sprintf()" "SECID279"
41009 .cindex "&[sprintf()]&"
41010 A large number of occurrences of &"sprintf"& in the code are actually calls to
41011 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41012 The intermediate formatting is done into a large fixed buffer by a function
41013 that runs through the format string itself, and checks the length of each
41014 conversion before performing it, thus preventing buffer overruns.
41015
41016 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41017 the output buffer is known to be sufficiently long to contain the converted
41018 string.
41019
41020
41021
41022 .section "Use of debug_printf() and log_write()" "SECID280"
41023 Arbitrary strings are passed to both these functions, but they do their
41024 formatting by calling the function &'string_vformat()'&, which runs through
41025 the format string itself, and checks the length of each conversion.
41026
41027
41028
41029 .section "Use of strcat() and strcpy()" "SECID281"
41030 These are used only in cases where the output buffer is known to be large
41031 enough to hold the result.
41032 .ecindex IIDsecurcon
41033
41034
41035
41036
41037 . ////////////////////////////////////////////////////////////////////////////
41038 . ////////////////////////////////////////////////////////////////////////////
41039
41040 .chapter "Format of spool files" "CHAPspool"
41041 .scindex IIDforspo1 "format" "spool files"
41042 .scindex IIDforspo2 "spool directory" "format of files"
41043 .scindex IIDforspo3 "spool files" "format of"
41044 .cindex "spool files" "editing"
41045 A message on Exim's queue consists of two files, whose names are the message id
41046 followed by -D and -H, respectively. The data portion of the message is kept in
41047 the -D file on its own. The message's envelope, status, and headers are all
41048 kept in the -H file, whose format is described in this chapter. Each of these
41049 two files contains the final component of its own name as its first line. This
41050 is insurance against disk crashes where the directory is lost but the files
41051 themselves are recoverable.
41052
41053 The file formats may be changed, or new formats added, at any release.
41054 Spool files are not intended as an interface to other programs
41055 and should not be used as such.
41056
41057 Some people are tempted into editing -D files in order to modify messages. You
41058 need to be extremely careful if you do this; it is not recommended and you are
41059 on your own if you do it. Here are some of the pitfalls:
41060
41061 .ilist
41062 You must ensure that Exim does not try to deliver the message while you are
41063 fiddling with it. The safest way is to take out a write lock on the -D file,
41064 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41065 place, the lock will be retained. If you write a new file and rename it, the
41066 lock will be lost at the instant of rename.
41067 .next
41068 .vindex "&$body_linecount$&"
41069 If you change the number of lines in the file, the value of
41070 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41071 cause incomplete transmission of messages or undeliverable messages.
41072 .next
41073 If the message is in MIME format, you must take care not to break it.
41074 .next
41075 If the message is cryptographically signed, any change will invalidate the
41076 signature.
41077 .endlist
41078 All in all, modifying -D files is fraught with danger.
41079
41080 Files whose names end with -J may also be seen in the &_input_& directory (or
41081 its subdirectories when &%split_spool_directory%& is set). These are journal
41082 files, used to record addresses to which the message has been delivered during
41083 the course of a delivery attempt. If there are still undelivered recipients at
41084 the end, the -H file is updated, and the -J file is deleted. If, however, there
41085 is some kind of crash (for example, a power outage) before this happens, the -J
41086 file remains in existence. When Exim next processes the message, it notices the
41087 -J file and uses it to update the -H file before starting the next delivery
41088 attempt.
41089
41090 Files whose names end with -K or .eml may also be seen in the spool.
41091 These are temporaries used for DKIM or malware processing, when that is used.
41092 They should be tidied up by normal operations; any old ones are probably
41093 relics of crashes and can be removed.
41094
41095 .section "Format of the -H file" "SECID282"
41096 .cindex "uid (user id)" "in spool file"
41097 .cindex "gid (group id)" "in spool file"
41098 The second line of the -H file contains the login name for the uid of the
41099 process that called Exim to read the message, followed by the numerical uid and
41100 gid. For a locally generated message, this is normally the user who sent the
41101 message. For a message received over TCP/IP via the daemon, it is
41102 normally the Exim user.
41103
41104 The third line of the file contains the address of the message's sender as
41105 transmitted in the envelope, contained in angle brackets. The sender address is
41106 empty for bounce messages. For incoming SMTP mail, the sender address is given
41107 in the MAIL command. For locally generated mail, the sender address is
41108 created by Exim from the login name of the current user and the configured
41109 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41110 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41111 &"<>"& or an address that matches &%untrusted_set_senders%&.
41112
41113 The fourth line contains two numbers. The first is the time that the message
41114 was received, in the conventional Unix form &-- the number of seconds since the
41115 start of the epoch. The second number is a count of the number of messages
41116 warning of delayed delivery that have been sent to the sender.
41117
41118 There follow a number of lines starting with a hyphen.
41119 These contain variables, can appear in any
41120 order, and are omitted when not relevant.
41121
41122 If there is a second hyphen after the first,
41123 the corresponding data is tainted.
41124 If there is a value in parentheses, the data is quoted for a lookup.
41125
41126 The following word specifies a variable,
41127 and the remainder of the item depends on the variable.
41128
41129 .vlist
41130 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41131 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41132 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41133 recognized, to provide backward compatibility. In the old format, a line of
41134 this form is present for every ACL variable that is not empty. The number
41135 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41136 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41137 the data string for the variable. The string itself starts at the beginning of
41138 the next line, and is followed by a newline character. It may contain internal
41139 newlines.
41140
41141 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41142 A line of this form is present for every ACL connection variable that is
41143 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41144 The length is the length of the data string for the variable. The string itself
41145 starts at the beginning of the next line, and is followed by a newline
41146 character. It may contain internal newlines.
41147
41148 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41149 A line of this form is present for every ACL message variable that is defined.
41150 Note that there is a space between &%-aclm%& and the rest of the name. The
41151 length is the length of the data string for the variable. The string itself
41152 starts at the beginning of the next line, and is followed by a newline
41153 character. It may contain internal newlines.
41154
41155 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41156 This is present if, when the message was received over SMTP, the value of
41157 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41158
41159 .vitem &%-allow_unqualified_recipient%&
41160 This is present if unqualified recipient addresses are permitted in header
41161 lines (to stop such addresses from being qualified if rewriting occurs at
41162 transport time). Local messages that were input using &%-bnq%& and remote
41163 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41164
41165 .vitem &%-allow_unqualified_sender%&
41166 This is present if unqualified sender addresses are permitted in header lines
41167 (to stop such addresses from being qualified if rewriting occurs at transport
41168 time). Local messages that were input using &%-bnq%& and remote messages from
41169 hosts that match &%sender_unqualified_hosts%& set this flag.
41170
41171 .vitem "&%-auth_id%&&~<&'text'&>"
41172 The id information for a message received on an authenticated SMTP connection
41173 &-- the value of the &$authenticated_id$& variable.
41174
41175 .vitem "&%-auth_sender%&&~<&'address'&>"
41176 The address of an authenticated sender &-- the value of the
41177 &$authenticated_sender$& variable.
41178
41179 .vitem "&%-body_linecount%&&~<&'number'&>"
41180 This records the number of lines in the body of the message, and is
41181 present unless &%-spool_file_wireformat%& is.
41182
41183 .vitem "&%-body_zerocount%&&~<&'number'&>"
41184 This records the number of binary zero bytes in the body of the message, and is
41185 present if the number is greater than zero.
41186
41187 .vitem &%-deliver_firsttime%&
41188 This is written when a new message is first added to the spool. When the spool
41189 file is updated after a deferral, it is omitted.
41190
41191 .vitem "&%-frozen%&&~<&'time'&>"
41192 .cindex "frozen messages" "spool data"
41193 The message is frozen, and the freezing happened at <&'time'&>.
41194
41195 .vitem "&%-helo_name%&&~<&'text'&>"
41196 This records the host name as specified by a remote host in a HELO or EHLO
41197 command.
41198
41199 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41200 This records the IP address of the host from which the message was received and
41201 the remote port number that was used. It is omitted for locally generated
41202 messages.
41203
41204 .vitem "&%-host_auth%&&~<&'text'&>"
41205 If the message was received on an authenticated SMTP connection, this records
41206 the name of the authenticator &-- the value of the
41207 &$sender_host_authenticated$& variable.
41208
41209 .vitem &%-host_lookup_failed%&
41210 This is present if an attempt to look up the sending host's name from its IP
41211 address failed. It corresponds to the &$host_lookup_failed$& variable.
41212
41213 .vitem "&%-host_name%&&~<&'text'&>"
41214 .cindex "reverse DNS lookup"
41215 .cindex "DNS" "reverse lookup"
41216 This records the name of the remote host from which the message was received,
41217 if the host name was looked up from the IP address when the message was being
41218 received. It is not present if no reverse lookup was done.
41219
41220 .vitem "&%-ident%&&~<&'text'&>"
41221 For locally submitted messages, this records the login of the originating user,
41222 unless it was a trusted user and the &%-oMt%& option was used to specify an
41223 ident value. For messages received over TCP/IP, this records the ident string
41224 supplied by the remote host, if any.
41225
41226 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41227 This records the IP address of the local interface and the port number through
41228 which a message was received from a remote host. It is omitted for locally
41229 generated messages.
41230
41231 .vitem &%-local%&
41232 The message is from a local sender.
41233
41234 .vitem &%-localerror%&
41235 The message is a locally-generated bounce message.
41236
41237 .vitem "&%-local_scan%&&~<&'string'&>"
41238 This records the data string that was returned by the &[local_scan()]& function
41239 when the message was received &-- the value of the &$local_scan_data$&
41240 variable. It is omitted if no data was returned.
41241
41242 .vitem &%-manual_thaw%&
41243 The message was frozen but has been thawed manually, that is, by an explicit
41244 Exim command rather than via the auto-thaw process.
41245
41246 .vitem &%-N%&
41247 A testing delivery process was started using the &%-N%& option to suppress any
41248 actual deliveries, but delivery was deferred. At any further delivery attempts,
41249 &%-N%& is assumed.
41250
41251 .vitem &%-received_protocol%&
41252 This records the value of the &$received_protocol$& variable, which contains
41253 the name of the protocol by which the message was received.
41254
41255 .vitem &%-sender_set_untrusted%&
41256 The envelope sender of this message was set by an untrusted local caller (used
41257 to ensure that the caller is displayed in queue listings).
41258
41259 .vitem "&%-spam_score_int%&&~<&'number'&>"
41260 If a message was scanned by SpamAssassin, this is present. It records the value
41261 of &$spam_score_int$&.
41262
41263 .vitem &%-spool_file_wireformat%&
41264 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41265 rather than Unix-format.
41266 The line-ending is CRLF rather than newline.
41267 There is still, however, no leading-dot-stuffing.
41268
41269 .vitem &%-tls_certificate_verified%&
41270 A TLS certificate was received from the client that sent this message, and the
41271 certificate was verified by the server.
41272
41273 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41274 When the message was received over an encrypted connection, this records the
41275 name of the cipher suite that was used.
41276
41277 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41278 When the message was received over an encrypted connection, and a certificate
41279 was received from the client, this records the Distinguished Name from that
41280 certificate.
41281 .endlist
41282
41283 Following the options there is a list of those addresses to which the message
41284 is not to be delivered. This set of addresses is initialized from the command
41285 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41286 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41287 the address is added to this set. The addresses are kept internally as a
41288 balanced binary tree, and it is a representation of that tree which is written
41289 to the spool file. If an address is expanded via an alias or forward file, the
41290 original address is added to the tree when deliveries to all its child
41291 addresses are complete.
41292
41293 If the tree is empty, there is a single line in the spool file containing just
41294 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41295 Y or N, followed by an address. The address is the value for the node of the
41296 tree, and the letters indicate whether the node has a left branch and/or a
41297 right branch attached to it, respectively. If branches exist, they immediately
41298 follow. Here is an example of a three-node tree:
41299 .code
41300 YY darcy@austen.fict.example
41301 NN alice@wonderland.fict.example
41302 NN editor@thesaurus.ref.example
41303 .endd
41304 After the non-recipients tree, there is a list of the message's recipients.
41305 This is a simple list, preceded by a count. It includes all the original
41306 recipients of the message, including those to whom the message has already been
41307 delivered. In the simplest case, the list contains one address per line. For
41308 example:
41309 .code
41310 4
41311 editor@thesaurus.ref.example
41312 darcy@austen.fict.example
41313 rdo@foundation
41314 alice@wonderland.fict.example
41315 .endd
41316 However, when a child address has been added to the top-level addresses as a
41317 result of the use of the &%one_time%& option on a &(redirect)& router, each
41318 line is of the following form:
41319 .display
41320 <&'top-level address'&> <&'errors_to address'&> &&&
41321   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41322 .endd
41323 The 01 flag bit indicates the presence of the three other fields that follow
41324 the top-level address. Other bits may be used in future to support additional
41325 fields. The <&'parent number'&> is the offset in the recipients list of the
41326 original parent of the &"one time"& address. The first two fields are the
41327 envelope sender that is associated with this address and its length. If the
41328 length is zero, there is no special envelope sender (there are then two space
41329 characters in the line). A non-empty field can arise from a &(redirect)& router
41330 that has an &%errors_to%& setting.
41331
41332
41333 A blank line separates the envelope and status information from the headers
41334 which follow. A header may occupy several lines of the file, and to save effort
41335 when reading it in, each header is preceded by a number and an identifying
41336 character. The number is the number of characters in the header, including any
41337 embedded newlines and the terminating newline. The character is one of the
41338 following:
41339
41340 .table2 50pt
41341 .row <&'blank'&>         "header in which Exim has no special interest"
41342 .row &`B`&               "&'Bcc:'& header"
41343 .row &`C`&               "&'Cc:'& header"
41344 .row &`F`&               "&'From:'& header"
41345 .row &`I`&               "&'Message-id:'& header"
41346 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41347 .row &`R`&               "&'Reply-To:'& header"
41348 .row &`S`&               "&'Sender:'& header"
41349 .row &`T`&               "&'To:'& header"
41350 .row &`*`&               "replaced or deleted header"
41351 .endtable
41352
41353 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41354 purposes. They are not transmitted when the message is delivered. Here is a
41355 typical set of headers:
41356 .code
41357 111P Received: by hobbit.fict.example with local (Exim 4.00)
41358 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41359 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41360 038* X-rewrote-sender: bb@hobbit.fict.example
41361 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41362 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41363 099* To: alice@wonderland.fict.example, rdo@foundation,
41364 darcy@austen.fict.example, editor@thesaurus.ref.example
41365 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41366 darcy@austen.fict.example, editor@thesaurus.ref.example
41367 038  Date: Fri, 11 May 2001 10:28:59 +0100
41368 .endd
41369 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41370 &'To:'& header have been rewritten, the last one because routing expanded the
41371 unqualified domain &'foundation'&.
41372 .ecindex IIDforspo1
41373 .ecindex IIDforspo2
41374 .ecindex IIDforspo3
41375
41376 .section "Format of the -D file" "SECID282a"
41377 The data file is traditionally in Unix-standard format: lines are ended with
41378 an ASCII newline character.
41379 However, when the &%spool_wireformat%& main option is used some -D files
41380 can have an alternate format.
41381 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41382 The -D file lines (not including the first name-component line) are
41383 suitable for direct copying to the wire when transmitting using the
41384 ESMTP CHUNKING option, meaning lower processing overhead.
41385 Lines are terminated with an ASCII CRLF pair.
41386 There is no dot-stuffing (and no dot-termination).
41387
41388 . ////////////////////////////////////////////////////////////////////////////
41389 . ////////////////////////////////////////////////////////////////////////////
41390
41391 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41392          "DKIM, SPF, SRS and DMARC Support"
41393
41394 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41395 .cindex "DKIM"
41396
41397 DKIM is a mechanism by which messages sent by some entity can be provably
41398 linked to a domain which that entity controls.  It permits reputation to
41399 be tracked on a per-domain basis, rather than merely upon source IP address.
41400 DKIM is documented in RFC 6376.
41401
41402 As DKIM relies on the message being unchanged in transit, messages handled
41403 by a mailing-list (which traditionally adds to the message) will not match
41404 any original DKIM signature.
41405
41406 DKIM support is compiled into Exim by default if TLS support is present.
41407 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41408
41409 Exim's DKIM implementation allows for
41410 .olist
41411 Signing outgoing messages: This function is implemented in the SMTP transport.
41412 It can co-exist with all other Exim features
41413 (including transport filters)
41414 except cutthrough delivery.
41415 .next
41416 Verifying signatures in incoming messages: This is implemented by an additional
41417 ACL (acl_smtp_dkim), which can be called several times per message, with
41418 different signature contexts.
41419 .endlist
41420
41421 In typical Exim style, the verification implementation does not include any
41422 default "policy". Instead it enables you to build your own policy using
41423 Exim's standard controls.
41424
41425 Please note that verification of DKIM signatures in incoming mail is turned
41426 on by default for logging (in the <= line) purposes.
41427
41428 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41429 When set, for each signature in incoming email,
41430 exim will log a line displaying the most important signature details, and the
41431 signature status. Here is an example (with line-breaks added for clarity):
41432 .code
41433 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41434     d=facebookmail.com s=q1-2009b
41435     c=relaxed/relaxed a=rsa-sha1
41436     i=@facebookmail.com t=1252484542 [verification succeeded]
41437 .endd
41438
41439 You might want to turn off DKIM verification processing entirely for internal
41440 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41441 control modifier. This should typically be done in the RCPT ACL, at points
41442 where you accept mail from relay sources (internal hosts or authenticated
41443 senders).
41444
41445
41446 .subsection "Signing outgoing messages" SECDKIMSIGN
41447 .cindex DKIM signing
41448
41449 For signing to be usable you must have published a DKIM record in DNS.
41450 Note that RFC 8301 (which does not cover EC keys) says:
41451 .code
41452 rsa-sha1 MUST NOT be used for signing or verifying.
41453
41454 Signers MUST use RSA keys of at least 1024 bits for all keys.
41455 Signers SHOULD use RSA keys of at least 2048 bits.
41456 .endd
41457
41458 Note also that the key content (the 'p=' field)
41459 in the DNS record is different between RSA and EC keys;
41460 for the former it is the base64 of the ASN.1 for the RSA public key
41461 (equivalent to the private-key .pem with the header/trailer stripped)
41462 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41463
41464 Signing is enabled by setting private options on the SMTP transport.
41465 These options take (expandable) strings as arguments.
41466
41467 .option dkim_domain smtp "string list&!!" unset
41468 The domain(s) you want to sign with.
41469 After expansion, this can be a list.
41470 Each element in turn,
41471 lowercased,
41472 .vindex "&$dkim_domain$&"
41473 is put into the &%$dkim_domain%& expansion variable
41474 while expanding the remaining signing options.
41475 If it is empty after expansion, DKIM signing is not done,
41476 and no error will result even if &%dkim_strict%& is set.
41477
41478 .option dkim_selector smtp "string list&!!" unset
41479 This sets the key selector string.
41480 After expansion, which can use &$dkim_domain$&, this can be a list.
41481 Each element in turn is put in the expansion
41482 .vindex "&$dkim_selector$&"
41483 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41484 option along with &%$dkim_domain%&.
41485 If the option is empty after expansion, DKIM signing is not done for this domain,
41486 and no error will result even if &%dkim_strict%& is set.
41487
41488 To do, for example, dual-signing with RSA and EC keys
41489 this could be be used:
41490 .code
41491 dkim_selector = ec_sel : rsa_sel
41492 dkim_private_key = KEYS_DIR/$dkim_selector
41493 .endd
41494
41495 .option dkim_private_key smtp string&!! unset
41496 This sets the private key to use.
41497 You can use the &%$dkim_domain%& and
41498 &%$dkim_selector%& expansion variables to determine the private key to use.
41499 The result can either
41500 .ilist
41501 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41502 .next
41503 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41504 be a valid Ed25519 private key (same format as above)
41505 .next
41506 start with a slash, in which case it is treated as a file that contains
41507 the private key
41508 .next
41509 be "0", "false" or the empty string, in which case the message will not
41510 be signed. This case will not result in an error, even if &%dkim_strict%&
41511 is set.
41512 .endlist
41513
41514 To generate keys under OpenSSL:
41515 .code
41516 openssl genrsa -out dkim_rsa.private 2048
41517 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41518 .endd
41519 The result file from the first command should be retained, and
41520 this option set to use it.
41521 Take the base-64 lines from the output of the second command, concatenated,
41522 for the DNS TXT record.
41523 See section 3.6 of RFC6376 for the record specification.
41524
41525 Under GnuTLS:
41526 .code
41527 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41528 certtool --load-privkey=dkim_rsa.private --pubkey-info
41529 .endd
41530
41531 Note that RFC 8301 says:
41532 .code
41533 Signers MUST use RSA keys of at least 1024 bits for all keys.
41534 Signers SHOULD use RSA keys of at least 2048 bits.
41535 .endd
41536
41537 EC keys for DKIM are defined by RFC 8463.
41538 They are considerably smaller than RSA keys for equivalent protection.
41539 As they are a recent development, users should consider dual-signing
41540 (by setting a list of selectors, and an expansion for this option)
41541 for some transition period.
41542 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41543 for EC keys.
41544
41545 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41546 .code
41547 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41548 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41549 .endd
41550
41551 To produce the required public key value for a DNS record:
41552 .code
41553 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41554 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41555 .endd
41556
41557 Exim also supports an alternate format
41558 of Ed25519 keys in DNS which was a candidate during development
41559 of the standard, but not adopted.
41560 A future release will probably drop that support.
41561
41562 .option dkim_hash smtp string&!! sha256
41563 Can be set to any one of the supported hash methods, which are:
41564 .ilist
41565 &`sha1`& &-- should not be used, is old and insecure
41566 .next
41567 &`sha256`& &-- the default
41568 .next
41569 &`sha512`& &-- possibly more secure but less well supported
41570 .endlist
41571
41572 Note that RFC 8301 says:
41573 .code
41574 rsa-sha1 MUST NOT be used for signing or verifying.
41575 .endd
41576
41577 .option dkim_identity smtp string&!! unset
41578 If set after expansion, the value is used to set an "i=" tag in
41579 the signing header.  The DKIM standards restrict the permissible
41580 syntax of this optional tag to a mail address, with possibly-empty
41581 local part, an @, and a domain identical to or subdomain of the "d="
41582 tag value.  Note that Exim does not check the value.
41583
41584 .option dkim_canon smtp string&!! unset
41585 This option sets the canonicalization method used when signing a message.
41586 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41587 The option defaults to "relaxed" when unset. Note: the current implementation
41588 only supports signing with the same canonicalization method for both headers and body.
41589
41590 .option dkim_strict smtp string&!! unset
41591 This  option  defines  how  Exim  behaves  when  signing a message that
41592 should be signed fails for some reason.  When the expansion evaluates to
41593 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41594 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41595 variables here.
41596
41597 .option dkim_sign_headers smtp string&!! "see below"
41598 If set, this option must expand to a colon-separated
41599 list of header names.
41600 Headers with these names, or the absence or such a header, will be included
41601 in the message signature.
41602 When unspecified, the header names listed in RFC4871 will be used,
41603 whether or not each header is present in the message.
41604 The default list is available for the expansion in the macro
41605 &"_DKIM_SIGN_HEADERS"&
41606 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41607
41608 If a name is repeated, multiple headers by that name (or the absence thereof)
41609 will be signed.  The textually later headers in the headers part of the
41610 message are signed first, if there are multiples.
41611
41612 A name can be prefixed with either an &"="& or a &"+"& character.
41613 If an &"="& prefix is used, all headers that are present with this name
41614 will be signed.
41615 If a &"+"& prefix if used, all headers that are present with this name
41616 will be signed, and one signature added for a missing header with the
41617 name will be appended.
41618
41619 .option dkim_timestamps smtp integer&!! unset
41620 This option controls the inclusion of timestamp information in the signature.
41621 If not set, no such information will be included.
41622 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41623 for the expiry tag
41624 (eg. 1209600 for two weeks);
41625 both creation (t=) and expiry (x=) tags will be included.
41626
41627 RFC 6376 lists these tags as RECOMMENDED.
41628
41629
41630 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41631 .cindex DKIM verification
41632
41633 Verification of DKIM signatures in SMTP incoming email is done for all
41634 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41635 .cindex DKIM "selecting signature algorithms"
41636 Individual classes of signature algorithm can be ignored by changing
41637 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41638 The &%dkim_verify_minimal%& option can be set to cease verification
41639 processing for a message once the first passing signature is found.
41640
41641 .cindex authentication "expansion item"
41642 Performing verification sets up information used by the
41643 &%authresults%& expansion item.
41644
41645 For most purposes the default option settings suffice and the remainder
41646 of this section can be ignored.
41647
41648 The results of verification are made available to the
41649 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41650 A missing ACL definition defaults to accept.
41651 By default, the ACL is called once for each
41652 syntactically(!) correct signature in the incoming message.
41653 If any ACL call does not accept, the message is not accepted.
41654 If a cutthrough delivery was in progress for the message, that is
41655 summarily dropped (having wasted the transmission effort).
41656
41657 To evaluate the verification result in the ACL
41658 a large number of expansion variables
41659 containing the signature status and its details are set up during the
41660 runtime of the ACL.
41661
41662 Calling the ACL only for existing signatures is not sufficient to build
41663 more advanced policies. For that reason, the main option
41664 &%dkim_verify_signers%&, and an expansion variable
41665 &%$dkim_signers%& exist.
41666
41667 The main option &%dkim_verify_signers%& can be set to a colon-separated
41668 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41669 called. It is expanded when the message has been received. At this point,
41670 the expansion variable &%$dkim_signers%& already contains a colon-separated
41671 list of signer domains and identities for the message. When
41672 &%dkim_verify_signers%& is not specified in the main configuration,
41673 it defaults as:
41674 .code
41675 dkim_verify_signers = $dkim_signers
41676 .endd
41677 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41678 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41679 call the ACL for known domains or identities. This would be achieved as follows:
41680 .code
41681 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41682 .endd
41683 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41684 and "ebay.com", plus all domains and identities that have signatures in the message.
41685 You can also be more creative in constructing your policy. For example:
41686 .code
41687 dkim_verify_signers = $sender_address_domain:$dkim_signers
41688 .endd
41689
41690 If a domain or identity is listed several times in the (expanded) value of
41691 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41692
41693 Note that if the option is set using untrustworthy data
41694 (such as the From: header)
41695 care should be taken to force lowercase for domains
41696 and for the domain part if identities.
41697 The default setting can be regarded as trustworthy in this respect.
41698
41699 If multiple signatures match a domain (or identity), the ACL is called once
41700 for each matching signature.
41701
41702
41703 Inside the DKIM ACL, the following expansion variables are
41704 available (from most to least important):
41705
41706
41707 .vlist
41708 .vitem &%$dkim_cur_signer%&
41709 The signer that is being evaluated in this ACL run. This can be a domain or
41710 an identity. This is one of the list items from the expanded main option
41711 &%dkim_verify_signers%& (see above).
41712
41713 .vitem &%$dkim_verify_status%&
41714 Within the DKIM ACL,
41715 a string describing the general status of the signature. One of
41716 .ilist
41717 &%none%&: There is no signature in the message for the current domain or
41718 identity (as reflected by &%$dkim_cur_signer%&).
41719 .next
41720 &%invalid%&: The signature could not be verified due to a processing error.
41721 More detail is available in &%$dkim_verify_reason%&.
41722 .next
41723 &%fail%&: Verification of the signature failed.  More detail is
41724 available in &%$dkim_verify_reason%&.
41725 .next
41726 &%pass%&: The signature passed verification. It is valid.
41727 .endlist
41728
41729 This variable can be overwritten using an ACL 'set' modifier.
41730 This might, for instance, be done to enforce a policy restriction on
41731 hash-method or key-size:
41732 .code
41733   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41734        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41735        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41736                                   {< {$dkim_key_length}{1024}}}}
41737        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41738        set dkim_verify_status = fail
41739        set dkim_verify_reason = hash too weak or key too short
41740 .endd
41741
41742 So long as a DKIM ACL is defined (it need do no more than accept),
41743 after all the DKIM ACL runs have completed, the value becomes a
41744 colon-separated list of the values after each run.
41745 This is maintained for the mime, prdr and data ACLs.
41746
41747 .vitem &%$dkim_verify_reason%&
41748 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41749 "fail" or "invalid". One of
41750 .ilist
41751 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41752 key for the domain could not be retrieved. This may be a temporary problem.
41753 .next
41754 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41755 record for the domain is syntactically invalid.
41756 .next
41757 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41758 body hash does not match the one specified in the signature header. This
41759 means that the message body was modified in transit.
41760 .next
41761 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41762 could not be verified. This may mean that headers were modified,
41763 re-written or otherwise changed in a way which is incompatible with
41764 DKIM verification. It may of course also mean that the signature is forged.
41765 .endlist
41766
41767 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41768
41769 .vitem &%$dkim_domain%&
41770 The signing domain. IMPORTANT: This variable is only populated if there is
41771 an actual signature in the message for the current domain or identity (as
41772 reflected by &%$dkim_cur_signer%&).
41773
41774 .vitem &%$dkim_identity%&
41775 The signing identity, if present. IMPORTANT: This variable is only populated
41776 if there is an actual signature in the message for the current domain or
41777 identity (as reflected by &%$dkim_cur_signer%&).
41778
41779 .vitem &%$dkim_selector%&
41780 The key record selector string.
41781
41782 .vitem &%$dkim_algo%&
41783 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41784 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41785 may also be 'ed25519-sha256'.
41786 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41787 for EC keys.
41788
41789 Note that RFC 8301 says:
41790 .code
41791 rsa-sha1 MUST NOT be used for signing or verifying.
41792
41793 DKIM signatures identified as having been signed with historic
41794 algorithms (currently, rsa-sha1) have permanently failed evaluation
41795 .endd
41796
41797 To enforce this you must either have a DKIM ACL which checks this variable
41798 and overwrites the &$dkim_verify_status$& variable as discussed above,
41799 or have set the main option &%dkim_verify_hashes%& to exclude
41800 processing of such signatures.
41801
41802 .vitem &%$dkim_canon_body%&
41803 The body canonicalization method. One of 'relaxed' or 'simple'.
41804
41805 .vitem &%$dkim_canon_headers%&
41806 The header canonicalization method. One of 'relaxed' or 'simple'.
41807
41808 .vitem &%$dkim_copiedheaders%&
41809 A transcript of headers and their values which are included in the signature
41810 (copied from the 'z=' tag of the signature).
41811 Note that RFC6376 requires that verification fail if the From: header is
41812 not included in the signature.  Exim does not enforce this; sites wishing
41813 strict enforcement should code the check explicitly.
41814
41815 .vitem &%$dkim_bodylength%&
41816 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41817 limit was set by the signer, "9999999999999" is returned. This makes sure
41818 that this variable always expands to an integer value.
41819 &*Note:*& The presence of the signature tag specifying a signing body length
41820 is one possible route to spoofing of valid DKIM signatures.
41821 A paranoid implementation might wish to regard signature where this variable
41822 shows less than the "no limit" return as being invalid.
41823
41824 .vitem &%$dkim_created%&
41825 UNIX timestamp reflecting the date and time when the signature was created.
41826 When this was not specified by the signer, "0" is returned.
41827
41828 .vitem &%$dkim_expires%&
41829 UNIX timestamp reflecting the date and time when the signer wants the
41830 signature to be treated as "expired". When this was not specified by the
41831 signer, "9999999999999" is returned. This makes it possible to do useful
41832 integer size comparisons against this value.
41833 Note that Exim does not check this value.
41834
41835 .vitem &%$dkim_headernames%&
41836 A colon-separated list of names of headers included in the signature.
41837
41838 .vitem &%$dkim_key_testing%&
41839 "1" if the key record has the "testing" flag set, "0" if not.
41840
41841 .vitem &%$dkim_key_nosubdomains%&
41842 "1" if the key record forbids subdomaining, "0" otherwise.
41843
41844 .vitem &%$dkim_key_srvtype%&
41845 Service type (tag s=) from the key record. Defaults to "*" if not specified
41846 in the key record.
41847
41848 .vitem &%$dkim_key_granularity%&
41849 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41850 in the key record.
41851
41852 .vitem &%$dkim_key_notes%&
41853 Notes from the key record (tag n=).
41854
41855 .vitem &%$dkim_key_length%&
41856 Number of bits in the key.
41857 Valid only once the key is loaded, which is at the time the header signature
41858 is verified, which is after the body hash is.
41859
41860 Note that RFC 8301 says:
41861 .code
41862 Verifiers MUST NOT consider signatures using RSA keys of
41863 less than 1024 bits as valid signatures.
41864 .endd
41865
41866 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41867 option.
41868
41869 .endlist
41870
41871 In addition, two ACL conditions are provided:
41872
41873 .vlist
41874 .vitem &%dkim_signers%&
41875 ACL condition that checks a colon-separated list of domains or identities
41876 for a match against the domain or identity that the ACL is currently verifying
41877 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41878 verb to a group of domains or identities. For example:
41879
41880 .code
41881 # Warn when Mail purportedly from GMail has no gmail signature
41882 warn sender_domains = gmail.com
41883      dkim_signers = gmail.com
41884      dkim_status = none
41885      log_message = GMail sender without gmail.com DKIM signature
41886 .endd
41887
41888 Note that the above does not check for a total lack of DKIM signing;
41889 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41890
41891 .vitem &%dkim_status%&
41892 ACL condition that checks a colon-separated list of possible DKIM verification
41893 results against the actual result of verification. This is typically used
41894 to restrict an ACL verb to a list of verification outcomes, for example:
41895
41896 .code
41897 deny sender_domains = paypal.com:paypal.de
41898      dkim_signers = paypal.com:paypal.de
41899      dkim_status = none:invalid:fail
41900      message = Mail from Paypal with invalid/missing signature
41901 .endd
41902
41903 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41904 see the documentation of the &%$dkim_verify_status%& expansion variable above
41905 for more information of what they mean.
41906 .endlist
41907
41908
41909
41910
41911 .section "SPF (Sender Policy Framework)" SECSPF
41912 .cindex SPF verification
41913
41914 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41915 messages with its domain in the envelope from, documented by RFC 7208.
41916 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41917 the &url(http://openspf.org).
41918 . --- 2019-10-28: still not https, open-spf.org is told to be a
41919 . --- web-archive copy of the now dead openspf.org site
41920 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41921 . --- discussion.
41922
41923 Messages sent by a system not authorised will fail checking of such assertions.
41924 This includes retransmissions done by traditional forwarders.
41925
41926 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41927 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41928 &url(https://www.libspf2.org/).
41929 There is no Exim involvement in the transmission of messages;
41930 publishing certain DNS records is all that is required.
41931
41932 For verification, an ACL condition and an expansion lookup are provided.
41933 .cindex authentication "expansion item"
41934 Performing verification sets up information used by the
41935 &%authresults%& expansion item.
41936
41937
41938 .cindex SPF "ACL condition"
41939 .cindex ACL "spf condition"
41940 The ACL condition "spf" can be used at or after the MAIL ACL.
41941 It takes as an argument a list of strings giving the outcome of the SPF check,
41942 and will succeed for any matching outcome.
41943 Valid strings are:
41944 .vlist
41945 .vitem &%pass%&
41946 The SPF check passed, the sending host is positively verified by SPF.
41947
41948 .vitem &%fail%&
41949 The SPF check failed, the sending host is NOT allowed to send mail for the
41950 domain in the envelope-from address.
41951
41952 .vitem &%softfail%&
41953 The SPF check failed, but the queried domain can't absolutely confirm that this
41954 is a forgery.
41955
41956 .vitem &%none%&
41957 The queried domain does not publish SPF records.
41958
41959 .vitem &%neutral%&
41960 The SPF check returned a "neutral" state.  This means the queried domain has
41961 published a SPF record, but wants to allow outside servers to send mail under
41962 its domain as well.  This should be treated like "none".
41963
41964 .vitem &%permerror%&
41965 This indicates a syntax error in the SPF record of the queried domain.
41966 You may deny messages when this occurs.
41967
41968 .vitem &%temperror%&
41969 This indicates a temporary error during all processing, including Exim's
41970 SPF processing.  You may defer messages when this occurs.
41971
41972 .vitem &%invalid%&
41973 There was an error during processing of the SPF lookup
41974 .endlist
41975
41976 You can prefix each string with an exclamation mark to  invert
41977 its meaning,  for example  "!fail" will  match all  results but
41978 "fail".  The  string  list is  evaluated  left-to-right,  in a
41979 short-circuit fashion.
41980
41981 Example:
41982 .code
41983 deny spf = fail
41984      message = $sender_host_address is not allowed to send mail from \
41985                ${if def:sender_address_domain \
41986                     {$sender_address_domain}{$sender_helo_name}}.  \
41987                Please see http://www.open-spf.org/Why;\
41988                identity=${if def:sender_address_domain \
41989                              {$sender_address}{$sender_helo_name}};\
41990                ip=$sender_host_address
41991 .endd
41992
41993 Note: The above mentioned URL may not be as helpful as expected. You are
41994 encouraged to replace the link with a link to a site with more
41995 explanations.
41996
41997 When the spf condition has run, it sets up several expansion
41998 variables:
41999
42000 .cindex SPF "verification variables"
42001 .vlist
42002 .vitem &$spf_header_comment$&
42003 .vindex &$spf_header_comment$&
42004   This contains a human-readable string describing the outcome
42005   of the SPF check. You can add it to a custom header or use
42006   it for logging purposes.
42007
42008 .vitem &$spf_received$&
42009 .vindex &$spf_received$&
42010   This contains a complete Received-SPF: header (name and
42011   content) that can be added to the message. Please note that
42012   according to the SPF draft, this header must be added at the
42013   top of the header list, i.e. with
42014 .code
42015 add_header = :at_start:$spf_received
42016 .endd
42017   See section &<<SECTaddheadacl>>& for further details.
42018
42019   Note: in case of "Best-guess" (see below), the convention is
42020   to put this string in a header called X-SPF-Guess: instead.
42021
42022 .vitem &$spf_result$&
42023 .vindex &$spf_result$&
42024   This contains the outcome of the SPF check in string form,
42025   currently one of pass, fail, softfail, none, neutral, permerror,
42026   temperror, or &"(invalid)"&.
42027
42028 .vitem &$spf_result_guessed$&
42029 .vindex &$spf_result_guessed$&
42030   This boolean is true only if a best-guess operation was used
42031   and required in order to obtain a result.
42032
42033 .vitem &$spf_smtp_comment$&
42034 .vindex &$spf_smtp_comment$&
42035 .vindex &%spf_smtp_comment_template%&
42036   This contains a string that can be used in a SMTP response
42037   to the calling party. Useful for "fail".
42038   The string is generated by the SPF library from the template configured in the main config
42039   option &%spf_smtp_comment_template%&.
42040 .endlist
42041
42042
42043 .cindex SPF "ACL condition"
42044 .cindex ACL "spf_guess condition"
42045 .cindex SPF "best guess"
42046 In addition to SPF, you can also perform checks for so-called
42047 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42048 SPF, but it is supported by the same framework that enables SPF
42049 capability.
42050 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42051 for a description of what it means.
42052 . --- 2019-10-28: still not https:
42053
42054 To access this feature, simply use the spf_guess condition in place
42055 of the spf one.  For example:
42056
42057 .code
42058 deny spf_guess = fail
42059      message = $sender_host_address doesn't look trustworthy to me
42060 .endd
42061
42062 In case you decide to reject messages based on this check, you
42063 should note that although it uses the same framework, "Best-guess"
42064 is not SPF, and therefore you should not mention SPF at all in your
42065 reject message.
42066
42067 When the spf_guess condition has run, it sets up the same expansion
42068 variables as when spf condition is run, described above.
42069
42070 Additionally, since Best-guess is not standardized, you may redefine
42071 what "Best-guess" means to you by redefining the main configuration
42072 &%spf_guess%& option.
42073 For example, the following:
42074
42075 .code
42076 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42077 .endd
42078
42079 would relax host matching rules to a broader network range.
42080
42081
42082 .cindex SPF "lookup expansion"
42083 .cindex lookup spf
42084 A lookup expansion is also available. It takes an email
42085 address as the key and an IP address
42086 (v4 or v6)
42087 as the database:
42088
42089 .code
42090   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42091 .endd
42092
42093 The lookup will return the same result strings as can appear in
42094 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42095
42096
42097
42098
42099
42100 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42101 .cindex SRS "sender rewriting scheme"
42102
42103 SRS can be used to modify sender addresses when forwarding so that
42104 SPF verification does not object to them.
42105 It operates by encoding the original envelope sender in a new
42106 sender local part and using a domain run by the forwarding site
42107 as the new domain for the sender.  Any DSN message should be returned
42108 to this new sender at the forwarding site, which can extract the
42109 original sender from the coded local part and forward the DSN to
42110 the originator.
42111
42112 This is a way of avoiding the breakage that SPF does to forwarding.
42113 The constructed local-part will be longer than the original,
42114 leading to possible problems with very long addresses.
42115 The changing of the sender address also hinders the tracing of mail
42116 problems.
42117
42118 Exim can be built to include native SRS support.  To do this
42119 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42120 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42121 will be defined.
42122 The support is limited to SRS0-encoding; SRS1 is not supported.
42123
42124 .cindex SRS excoding
42125 To encode an address use this expansion item:
42126 .vlist
42127 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42128 .cindex "&%srs_encode%& expansion item"
42129 .cindex SRS "expansion item"
42130 The first argument should be a secret known and used by all systems
42131 handling the recipient domain for the original message.
42132 There is no need to periodically change this key; a timestamp is also
42133 encoded.
42134 The second argument should be given as the envelope sender address before this
42135 encoding operation.
42136 If this value is empty the the expansion result will be empty.
42137 The third argument should be the recipient domain of the message when
42138 it arrived at this system.
42139 .endlist
42140
42141 .cindex SRS decoding
42142 To decode an address use this expansion condition:
42143 .vlist
42144 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42145 The first argument should be the recipient local prt as is was received.
42146 The second argument is the site secret.
42147
42148 If the messages is not for an SRS-encoded recipient the condition will
42149 return false.  If it is, the condition will return true and the variable
42150 &$srs_recipient$& will be set to the decoded (original) value.
42151 .endlist
42152
42153 Example usage:
42154 .code
42155   #macro
42156   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42157
42158   #routers
42159
42160   outbound:
42161     driver =    dnslookup
42162     # if outbound, and forwarding has been done, use an alternate transport
42163     domains =   ! +my_domains
42164     transport = ${if eq {$local_part@$domain} \
42165                         {$original_local_part@$original_domain} \
42166                      {remote_smtp} {remote_forwarded_smtp}}
42167
42168   inbound_srs:
42169     driver =    redirect
42170     senders =   :
42171     domains =   +my_domains
42172     # detect inbound bounces which are SRS'd, and decode them
42173     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42174     data =      $srs_recipient
42175
42176   inbound_srs_failure:
42177     driver =    redirect
42178     senders =   :
42179     domains =   +my_domains
42180     # detect inbound bounces which look SRS'd but are invalid
42181     condition = ${if inbound_srs {$local_part} {}}
42182     allow_fail
42183     data =      :fail: Invalid SRS recipient address
42184
42185   #... further routers here
42186
42187
42188   # transport; should look like the non-forward outbound
42189   # one, plus the max_rcpt and return_path options
42190   remote_forwarded_smtp:
42191     driver =              smtp
42192     # modify the envelope from, for mails that we forward
42193     max_rcpt =            1
42194     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42195 .endd
42196
42197
42198
42199
42200
42201 .section DMARC SECDMARC
42202 .cindex DMARC verification
42203
42204 DMARC combines feedback from SPF, DKIM, and header From: in order
42205 to attempt to provide better indicators of the authenticity of an
42206 email.  This document does not explain the fundamentals; you
42207 should read and understand how it works by visiting the website at
42208 &url(http://www.dmarc.org/).
42209
42210 If Exim is built with DMARC support,
42211 the libopendmarc library is used.
42212
42213 For building Exim yourself, obtain the library from
42214 &url(http://sourceforge.net/projects/opendmarc/)
42215 to obtain a copy, or find it in your favorite package
42216 repository.  You will need to attend to the local/Makefile feature
42217 SUPPORT_DMARC and the associated LDFLAGS addition.
42218 This description assumes
42219 that headers will be in /usr/local/include, and that the libraries
42220 are in /usr/local/lib.
42221
42222 .subsection Configuration SSECDMARCCONFIG
42223 .cindex DMARC configuration
42224
42225 There are three main-configuration options:
42226 .cindex DMARC "configuration options"
42227
42228 The &%dmarc_tld_file%& option
42229 .oindex &%dmarc_tld_file%&
42230 defines the location of a text file of valid
42231 top level domains the opendmarc library uses
42232 during domain parsing. Maintained by Mozilla,
42233 the most current version can be downloaded
42234 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42235 See also the util/renew-opendmarc-tlds.sh script.
42236 The default for the option is unset.
42237 If not set, DMARC processing is disabled.
42238
42239
42240 The &%dmarc_history_file%& option, if set
42241 .oindex &%dmarc_history_file%&
42242 defines the location of a file to log results
42243 of dmarc verification on inbound emails. The
42244 contents are importable by the opendmarc tools
42245 which will manage the data, send out DMARC
42246 reports, and expire the data. Make sure the
42247 directory of this file is writable by the user
42248 exim runs as.
42249 The default is unset.
42250
42251 The &%dmarc_forensic_sender%& option
42252 .oindex &%dmarc_forensic_sender%&
42253 defines an alternate email address to use when sending a
42254 forensic report detailing alignment failures
42255 if a sender domain's dmarc record specifies it
42256 and you have configured Exim to send them.
42257 If set, this is expanded and used for the
42258 From: header line; the address is extracted
42259 from it and used for the envelope from.
42260 If not set (the default), the From: header is expanded from
42261 the dsn_from option, and <> is used for the
42262 envelope from.
42263
42264 .subsection Controls SSECDMARCCONTROLS
42265 .cindex DMARC controls
42266
42267 By default, the DMARC processing will run for any remote,
42268 non-authenticated user.  It makes sense to only verify DMARC
42269 status of messages coming from remote, untrusted sources.  You can
42270 use standard conditions such as hosts, senders, etc, to decide that
42271 DMARC verification should *not* be performed for them and disable
42272 DMARC with an ACL control modifier:
42273 .code
42274   control = dmarc_disable_verify
42275 .endd
42276 A DMARC record can also specify a "forensic address", which gives
42277 exim an email address to submit reports about failed alignment.
42278 Exim does not do this by default because in certain conditions it
42279 results in unintended information leakage (what lists a user might
42280 be subscribed to, etc).  You must configure exim to submit forensic
42281 reports to the owner of the domain.  If the DMARC record contains a
42282 forensic address and you specify the control statement below, then
42283 exim will send these forensic emails.  It is also advised that you
42284 configure a &%dmarc_forensic_sender%& because the default sender address
42285 construction might be inadequate.
42286 .code
42287   control = dmarc_enable_forensic
42288 .endd
42289 (AGAIN: You can choose not to send these forensic reports by simply
42290 not putting the dmarc_enable_forensic control line at any point in
42291 your exim config.  If you don't tell exim to send them, it will not
42292 send them.)
42293
42294 There are no options to either control.  Both must appear before
42295 the DATA acl.
42296
42297 .subsection ACL SSECDMARCACL
42298 .cindex DMARC "ACL condition"
42299
42300 DMARC checks can be run on incoming SMTP  messages by using the
42301 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42302 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42303 condition.  Putting this condition in the ACLs is required in order
42304 for a DMARC check to actually occur.  All of the variables are set
42305 up before the DATA ACL, but there is no actual DMARC check that
42306 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42307
42308 The &"dmarc_status"& condition takes a list of strings on its
42309 right-hand side.  These strings describe recommended action based
42310 on the DMARC check.  To understand what the policy recommendations
42311 mean, refer to the DMARC website above.  Valid strings are:
42312 .itable none 0 0 2 20* left 80* left
42313 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42314 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42315 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42316 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42317 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42318 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42319 .irow &'temperror'&     "Library error or dns error"
42320 .irow &'off'&           "The DMARC check was disabled for this email"
42321 .endtable
42322 You can prefix each string with an exclamation mark to invert its
42323 meaning, for example "!accept" will match all results but
42324 "accept".  The string list is evaluated left-to-right in a
42325 short-circuit fashion.  When a string matches the outcome of the
42326 DMARC check, the condition succeeds.  If none of the listed
42327 strings matches the outcome of the DMARC check, the condition
42328 fails.
42329
42330 Of course, you can also use any other lookup method that Exim
42331 supports, including LDAP, Postgres, MySQL, etc, as long as the
42332 result is a list of colon-separated strings.
42333
42334 Performing the check sets up information used by the
42335 &%authresults%& expansion item.
42336
42337 Several expansion variables are set before the DATA ACL is
42338 processed, and you can use them in this ACL.  The following
42339 expansion variables are available:
42340
42341 .vlist
42342 .vitem &$dmarc_status$&
42343 .vindex &$dmarc_status$&
42344 .cindex DMARC result
42345 A one word status indicating what the DMARC library
42346 thinks of the email.  It is a combination of the results of
42347 DMARC record lookup and the SPF/DKIM/DMARC processing results
42348 (if a DMARC record was found).  The actual policy declared
42349 in the DMARC record is in a separate expansion variable.
42350
42351 .vitem &$dmarc_status_text$&
42352 .vindex &$dmarc_status_text$&
42353 Slightly longer, human readable status.
42354
42355 .vitem &$dmarc_used_domain$&
42356 .vindex &$dmarc_used_domain$&
42357 The domain which DMARC used to look up the DMARC policy record.
42358
42359 .vitem &$dmarc_domain_policy$&
42360 .vindex &$dmarc_domain_policy$&
42361 The policy declared in the DMARC record.  Valid values
42362 are "none", "reject" and "quarantine".  It is blank when there
42363 is any error, including no DMARC record.
42364 .endlist
42365
42366 .subsection Logging SSECDMARCLOGGING
42367 .cindex DMARC logging
42368
42369 By default, Exim's DMARC configuration is intended to be
42370 non-intrusive and conservative.  To facilitate this, Exim will not
42371 create any type of logging files without explicit configuration by
42372 you, the admin.  Nor will Exim send out any emails/reports about
42373 DMARC issues without explicit configuration by you, the admin (other
42374 than typical bounce messages that may come about due to ACL
42375 processing or failure delivery issues).
42376
42377 In order to log statistics suitable to be imported by the opendmarc
42378 tools, you need to:
42379 .ilist
42380 Configure the global option &%dmarc_history_file%&
42381 .next
42382 Configure cron jobs to call the appropriate opendmarc history
42383 import scripts and truncating the dmarc_history_file
42384 .endlist
42385
42386 In order to send forensic reports, you need to:
42387 .ilist
42388 Configure the global option &%dmarc_forensic_sender%&
42389 .next
42390 Configure, somewhere before the DATA ACL, the control option to
42391 enable sending DMARC forensic reports
42392 .endlist
42393
42394 .subsection Example SSECDMARCEXAMPLE
42395 .cindex DMARC example
42396
42397 Example usage:
42398 .code
42399 (RCPT ACL)
42400   warn    domains        = +local_domains
42401           hosts          = +local_hosts
42402           control        = dmarc_disable_verify
42403
42404   warn    !domains       = +screwed_up_dmarc_records
42405           control        = dmarc_enable_forensic
42406
42407   warn    condition      = (lookup if destined to mailing list)
42408           set acl_m_mailing_list = 1
42409
42410 (DATA ACL)
42411   warn    dmarc_status   = accept : none : off
42412           !authenticated = *
42413           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42414
42415   warn    dmarc_status   = !accept
42416           !authenticated = *
42417           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42418
42419   warn    dmarc_status   = quarantine
42420           !authenticated = *
42421           set $acl_m_quarantine = 1
42422           # Do something in a transport with this flag variable
42423
42424   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42425           condition      = ${if eq{$acl_m_mailing_list}{1}}
42426           message        = Messages from $dmarc_used_domain break mailing lists
42427
42428   deny    dmarc_status   = reject
42429           !authenticated = *
42430           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42431
42432   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42433 .endd
42434
42435
42436
42437
42438
42439 . ////////////////////////////////////////////////////////////////////////////
42440 . ////////////////////////////////////////////////////////////////////////////
42441
42442 .chapter "Proxies" "CHAPproxies" &&&
42443          "Proxy support"
42444 .cindex "proxy support"
42445 .cindex "proxy" "access via"
42446
42447 A proxy is an intermediate system through which communication is passed.
42448 Proxies may provide a security, availability or load-distribution function.
42449
42450
42451 .section "Inbound proxies" SECTproxyInbound
42452 .cindex proxy inbound
42453 .cindex proxy "server side"
42454 .cindex proxy "Proxy protocol"
42455 .cindex "Proxy protocol" proxy
42456
42457 Exim has support for receiving inbound SMTP connections via a proxy
42458 that uses &"Proxy Protocol"& to speak to it.
42459 To include this support, include &"SUPPORT_PROXY=yes"&
42460 in Local/Makefile.
42461
42462 It was built on the HAProxy specification, found at
42463 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42464
42465 The purpose of this facility is so that an application load balancer,
42466 such as HAProxy, can sit in front of several Exim servers
42467 to distribute load.
42468 Exim uses the local protocol communication with the proxy to obtain
42469 the remote SMTP system IP address and port information.
42470 There is no logging if a host passes or
42471 fails Proxy Protocol negotiation, but it can easily be determined and
42472 recorded in an ACL (example is below).
42473
42474 Use of a proxy is enabled by setting the &%hosts_proxy%&
42475 main configuration option to a hostlist; connections from these
42476 hosts will use Proxy Protocol.
42477 Exim supports both version 1 and version 2 of the Proxy Protocol and
42478 automatically determines which version is in use.
42479
42480 The Proxy Protocol header is the first data received on a TCP connection
42481 and is inserted before any TLS-on-connect handshake from the client; Exim
42482 negotiates TLS between Exim-as-server and the remote client, not between
42483 Exim and the proxy server. The Proxy Protocol header must be received
42484 within &%proxy_protocol_timeout%&, which defaults to 3s.
42485
42486 The following expansion variables are usable
42487 (&"internal"& and &"external"& here refer to the interfaces
42488 of the proxy):
42489 .itable none 0 0 2 30* left 70* left
42490 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42491 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42492 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42493 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42494 .irow $proxy_session            "boolean: SMTP connection via proxy"
42495 .endtable
42496 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42497 there was a protocol error.
42498 The variables &$sender_host_address$& and &$sender_host_port$&
42499 will have values for the actual client system, not the proxy.
42500
42501 Since the real connections are all coming from the proxy, and the
42502 per host connection tracking is done before Proxy Protocol is
42503 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42504 handle all of the parallel volume you expect per inbound proxy.
42505 With the option set so high, you lose the ability
42506 to protect your server from many connections from one IP.
42507 In order to prevent your server from overload, you
42508 need to add a per connection ratelimit to your connect ACL.
42509 A possible solution is:
42510 .display
42511   # Set max number of connections per host
42512   LIMIT   = 5
42513   # Or do some kind of IP lookup in a flat file or database
42514   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42515
42516   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42517           message        = Too many connections from this IP right now
42518 .endd
42519
42520
42521
42522 .section "Outbound proxies" SECTproxySOCKS
42523 .cindex proxy outbound
42524 .cindex proxy "client side"
42525 .cindex proxy SOCKS
42526 .cindex SOCKS proxy
42527 Exim has support for sending outbound SMTP via a proxy
42528 using a protocol called SOCKS5 (defined by RFC1928).
42529 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42530 Local/Makefile.
42531
42532 Use of a proxy is enabled by setting the &%socks_proxy%& option
42533 on an smtp transport.
42534 The option value is expanded and should then be a list
42535 (colon-separated by default) of proxy specifiers.
42536 Each proxy specifier is a list
42537 (space-separated by default) where the initial element
42538 is an IP address and any subsequent elements are options.
42539
42540 Options are a string <name>=<value>.
42541 The list of options is in the following table:
42542 .itable none 0 0 2 10* left 90* left
42543 .irow &'auth'&  "authentication method"
42544 .irow &'name'&  "authentication username"
42545 .irow &'pass'&  "authentication password"
42546 .irow &'port'&  "tcp port"
42547 .irow &'tmo'&   "connection timeout"
42548 .irow &'pri'&   "priority"
42549 .irow &'weight'& "selection bias"
42550 .endtable
42551
42552 More details on each of these options follows:
42553
42554 .ilist
42555 .cindex authentication "to proxy"
42556 .cindex proxy authentication
42557 &%auth%&: Either &"none"& (default) or &"name"&.
42558 Using &"name"& selects username/password authentication per RFC 1929
42559 for access to the proxy.
42560 Default is &"none"&.
42561 .next
42562 &%name%&: sets the username for the &"name"& authentication method.
42563 Default is empty.
42564 .next
42565 &%pass%&: sets the password for the &"name"& authentication method.
42566 Default is empty.
42567 .next
42568 &%port%&: the TCP port number to use for the connection to the proxy.
42569 Default is 1080.
42570 .next
42571 &%tmo%&: sets a connection timeout in seconds for this proxy.
42572 Default is 5.
42573 .next
42574 &%pri%&: specifies a priority for the proxy within the list,
42575 higher values being tried first.
42576 The default priority is 1.
42577 .next
42578 &%weight%&: specifies a selection bias.
42579 Within a priority set servers are queried in a random fashion,
42580 weighted by this value.
42581 The default value for selection bias is 1.
42582 .endlist
42583
42584 Proxies from the list are tried according to their priority
42585 and weight settings until one responds.  The timeout for the
42586 overall connection applies to the set of proxied attempts.
42587
42588 .section Logging SECTproxyLog
42589 To log the (local) IP of a proxy in the incoming or delivery logline,
42590 add &"+proxy"& to the &%log_selector%& option.
42591 This will add a component tagged with &"PRX="& to the line.
42592
42593 . ////////////////////////////////////////////////////////////////////////////
42594 . ////////////////////////////////////////////////////////////////////////////
42595
42596 .chapter "Internationalisation" "CHAPi18n" &&&
42597          "Internationalisation""
42598 .cindex internationalisation "email address"
42599 .cindex EAI
42600 .cindex i18n
42601 .cindex utf8 "mail name handling"
42602
42603 Exim has support for Internationalised mail names.
42604 To include this it must be built with SUPPORT_I18N and the libidn library.
42605 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42606
42607 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42608 instead of it) then IDNA2008 is supported; this adds an extra library
42609 requirement, upon libidn2.
42610
42611 .section "MTA operations" SECTi18nMTA
42612 .cindex SMTPUTF8 "ESMTP option"
42613 .cindex "ESMTP extensions" SMTPUTF8
42614 The main configuration option &%smtputf8_advertise_hosts%& specifies
42615 a host list.  If this matches the sending host and
42616 accept_8bitmime is true (the default) then the ESMTP option
42617 SMTPUTF8 will be advertised.
42618
42619 If the sender specifies the SMTPUTF8 option on a MAIL command
42620 international handling for the message is enabled and
42621 the expansion variable &$message_smtputf8$& will have value TRUE.
42622
42623 The option &%allow_utf8_domains%& is set to true for this
42624 message. All DNS lookups are converted to a-label form
42625 whatever the setting of &%allow_utf8_domains%&
42626 when Exim is built with SUPPORT_I18N.
42627
42628 Both localparts and domain are maintained as the original
42629 UTF-8 form internally; any comparison or regular-expression use will
42630 require appropriate care.  Filenames created, eg. by
42631 the appendfile transport, will have UTF-8 names.
42632
42633 HELO names sent by the smtp transport will have any UTF-8
42634 components expanded to a-label form,
42635 and any certificate name checks will be done using the a-label
42636 form of the name.
42637
42638 .cindex log protocol
42639 .cindex SMTPUTF8 logging
42640 .cindex i18n logging
42641 Log lines and Received-by: header lines will acquire a "utf8"
42642 prefix on the protocol element, eg. utf8esmtp.
42643
42644 The following expansion operators can be used:
42645 .code
42646 ${utf8_domain_to_alabel:str}
42647 ${utf8_domain_from_alabel:str}
42648 ${utf8_localpart_to_alabel:str}
42649 ${utf8_localpart_from_alabel:str}
42650 .endd
42651
42652 .cindex utf8 "address downconversion"
42653 .cindex i18n "utf8 address downconversion"
42654 The RCPT ACL
42655 may use the following modifier:
42656 .display
42657 control = utf8_downconvert
42658 control = utf8_downconvert/<value>
42659 .endd
42660 This sets a flag requiring that envelope addresses are converted to
42661 a-label form before smtp delivery.
42662 This is usually for use in a Message Submission Agent context,
42663 but could be used for any message.
42664
42665 If a value is appended it may be:
42666 .itable none 0 0 2 5* right 95* left
42667 .irow &`1`&     "mandatory downconversion"
42668 .irow &`0`&     "no downconversion"
42669 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42670 .endtable
42671 If no value is given, 1 is used.
42672
42673 If mua_wrapper is set, the utf8_downconvert control
42674 is initially set to -1.
42675
42676 The smtp transport has an option &%utf8_downconvert%&.
42677 If set it must expand to one of the three values described above,
42678 or an empty string.
42679 If non-empty it overrides value previously set
42680 (due to mua_wrapper or by an ACL control).
42681
42682
42683 There is no explicit support for VRFY and EXPN.
42684 Configurations supporting these should inspect
42685 &$smtp_command_argument$& for an SMTPUTF8 argument.
42686
42687 There is no support for LMTP on Unix sockets.
42688 Using the "lmtp" protocol option on an smtp transport,
42689 for LMTP over TCP, should work as expected.
42690
42691 There is no support for DSN unitext handling,
42692 and no provision for converting logging from or to UTF-8.
42693
42694
42695
42696 .section "MDA operations" SECTi18nMDA
42697 To aid in constructing names suitable for IMAP folders
42698 the following expansion operator can be used:
42699 .code
42700 ${imapfolder {<string>} {<sep>} {<specials>}}
42701 .endd
42702
42703 The string is converted from the charset specified by
42704 the "headers charset" command (in a filter file)
42705 or &%headers_charset%& main configuration option (otherwise),
42706 to the
42707 modified UTF-7 encoding specified by RFC 2060,
42708 with the following exception: All occurrences of <sep>
42709 (which has to be a single character)
42710 are replaced with periods ("."), and all periods and slashes that are not
42711 <sep> and are not in the <specials> string are BASE64 encoded.
42712
42713 The third argument can be omitted, defaulting to an empty string.
42714 The second argument can be omitted, defaulting to "/".
42715
42716 This is the encoding used by Courier for Maildir names on disk, and followed
42717 by many other IMAP servers.
42718
42719 Examples:
42720 .display
42721 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42722 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42723 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42724 .endd
42725
42726 Note that the source charset setting is vital, and also that characters
42727 must be representable in UTF-16.
42728
42729
42730 . ////////////////////////////////////////////////////////////////////////////
42731 . ////////////////////////////////////////////////////////////////////////////
42732
42733 .chapter "Events" "CHAPevents" &&&
42734          "Events"
42735 .cindex events
42736
42737 The events mechanism in Exim can be used to intercept processing at a number
42738 of points.  It was originally invented to give a way to do customised logging
42739 actions (for example, to a database) but can also be used to modify some
42740 processing actions.
42741
42742 Most installations will never need to use Events.
42743 The support can be left out of a build by defining DISABLE_EVENT=yes
42744 in &_Local/Makefile_&.
42745
42746 There are two major classes of events: main and transport.
42747 The main configuration option &%event_action%& controls reception events;
42748 a transport option &%event_action%& controls delivery events.
42749
42750 Both options are a string which is expanded when the event fires.
42751 An example might look like:
42752 .cindex logging custom
42753 .code
42754 event_action = ${if eq {msg:delivery}{$event_name} \
42755 {${lookup pgsql {SELECT * FROM record_Delivery( \
42756     '${quote_pgsql:$sender_address_domain}',\
42757     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42758     '${quote_pgsql:$domain}', \
42759     '${quote_pgsql:${lc:$local_part}}', \
42760     '${quote_pgsql:$host_address}', \
42761     '${quote_pgsql:${lc:$host}}', \
42762     '${quote_pgsql:$message_exim_id}')}} \
42763 } {}}
42764 .endd
42765
42766 Events have names which correspond to the point in process at which they fire.
42767 The name is placed in the variable &$event_name$& and the event action
42768 expansion must check this, as it will be called for every possible event type.
42769
42770 The current list of events is:
42771 .itable all 0 0 4 25* left 10* center 15* center 50* left
42772 .row auth:fail              after    both       "per driver per authentication attempt"
42773 .row dane:fail              after    transport  "per connection"
42774 .row msg:complete           after    main       "per message"
42775 .row msg:defer              after    transport  "per message per delivery try"
42776 .row msg:delivery           after    transport  "per recipient"
42777 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42778 .row msg:rcpt:defer         after    transport  "per recipient"
42779 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42780 .row msg:fail:delivery      after    transport  "per recipient"
42781 .row msg:fail:internal      after    main       "per recipient"
42782 .row tcp:connect            before   transport  "per connection"
42783 .row tcp:close              after    transport  "per connection"
42784 .row tls:cert               before   both       "per certificate in verification chain"
42785 .row tls:fail:connect       after    main       "per connection"
42786 .row smtp:connect           after    transport  "per connection"
42787 .row smtp:ehlo              after    transport  "per connection"
42788 .endtable
42789 New event types may be added in future.
42790
42791 The event name is a colon-separated list, defining the type of
42792 event in a tree of possibilities.  It may be used as a list
42793 or just matched on as a whole.  There will be no spaces in the name.
42794
42795 The second column in the table above describes whether the event fires
42796 before or after the action is associates with.  Those which fire before
42797 can be used to affect that action (more on this below).
42798
42799 The third column in the table above says what section of the configuration
42800 should define the event action.
42801
42802 An additional variable, &$event_data$&, is filled with information varying
42803 with the event type:
42804 .itable all 0 0 2 20* left 80* left
42805 .row auth:fail            "smtp response"
42806 .row dane:fail            "failure reason"
42807 .row msg:defer            "error string"
42808 .row msg:delivery         "smtp confirmation message"
42809 .row msg:fail:internal    "failure reason"
42810 .row msg:fail:delivery    "smtp error message"
42811 .row msg:host:defer       "error string"
42812 .row msg:rcpt:host:defer  "error string"
42813 .row msg:rcpt:defer       "error string"
42814 .row tls:cert             "verification chain depth"
42815 .row tls:fail:connect     "error string"
42816 .row smtp:connect         "smtp banner"
42817 .row smtp:ehlo            "smtp ehlo response"
42818 .endtable
42819
42820 The :defer events populate one extra variable: &$event_defer_errno$&.
42821
42822 For complex operations an ACL expansion can be used in &%event_action%&,
42823 however due to the multiple contexts that Exim operates in during
42824 the course of its processing:
42825 .ilist
42826 variables set in transport events will not be visible outside that
42827 transport call
42828 .next
42829 acl_m variables in a server context are lost on a new connection,
42830 and after smtp helo/ehlo/mail/starttls/rset commands
42831 .endlist
42832 Using an ACL expansion with the logwrite modifier can be
42833 a useful way of writing to the main log.
42834
42835 The expansion of the event_action option should normally
42836 return an empty string.  Should it return anything else the
42837 following will be forced:
42838 .itable all 0 0 2 20* left 80* left
42839 .row auth:fail        "log information to write"
42840 .row tcp:connect      "do not connect"
42841 .row tls:cert         "refuse verification"
42842 .row smtp:connect     "close connection"
42843 .endtable
42844 All other message types ignore the result string, and
42845 no other use is made of it.
42846
42847 For a tcp:connect event, if the connection is being made to a proxy
42848 then the address and port variables will be that of the proxy and not
42849 the target system.
42850
42851 For tls:cert events, if GnuTLS is in use this will trigger only per
42852 chain element received on the connection.
42853 For OpenSSL it will trigger for every chain element including those
42854 loaded locally.
42855
42856 . ////////////////////////////////////////////////////////////////////////////
42857 . ////////////////////////////////////////////////////////////////////////////
42858
42859 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42860          "Adding drivers or lookups"
42861 .cindex "adding drivers"
42862 .cindex "new drivers, adding"
42863 .cindex "drivers" "adding new"
42864 The following actions have to be taken in order to add a new router, transport,
42865 authenticator, or lookup type to Exim:
42866
42867 .olist
42868 Choose a name for the driver or lookup type that does not conflict with any
42869 existing name; I will use &"newdriver"& in what follows.
42870 .next
42871 Add to &_src/EDITME_& the line:
42872 .display
42873 <&'type'&>&`_NEWDRIVER=yes`&
42874 .endd
42875 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42876 code is not to be included in the binary by default, comment this line out. You
42877 should also add any relevant comments about the driver or lookup type.
42878 .next
42879 Add to &_src/config.h.defaults_& the line:
42880 .code
42881 #define <type>_NEWDRIVER
42882 .endd
42883 .next
42884 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42885 and create a table entry as is done for all the other drivers and lookup types.
42886 .next
42887 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42888 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42889 Add your &`NEWDRIVER`& to that list.
42890 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42891 simple form that most lookups have.
42892 .next
42893 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42894 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42895 driver or lookup type and add it to the definition of OBJ.
42896 .next
42897 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42898 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42899 .next
42900 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42901 &_src_&.
42902 .next
42903 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42904 as for other drivers and lookups.
42905 .endlist
42906
42907 Then all you need to do is write the code! A good way to start is to make a
42908 proforma by copying an existing module of the same type, globally changing all
42909 occurrences of the name, and cutting out most of the code. Note that any
42910 options you create must be listed in alphabetical order, because the tables are
42911 searched using a binary chop procedure.
42912
42913 There is a &_README_& file in each of the sub-directories of &_src_& describing
42914 the interface that is expected.
42915
42916
42917
42918
42919 . ////////////////////////////////////////////////////////////////////////////
42920 . ////////////////////////////////////////////////////////////////////////////
42921
42922 . /////////////////////////////////////////////////////////////////////////////
42923 . These lines are processing instructions for the Simple DocBook Processor that
42924 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42925 . PDFs than using xmlto and fop. They will be ignored by all other XML
42926 . processors.
42927 . /////////////////////////////////////////////////////////////////////////////
42928
42929 .literal xml
42930 <?sdop
42931   format="newpage"
42932   foot_right_recto="&chaptertitle;"
42933   foot_right_verso="&chaptertitle;"
42934 ?>
42935 .literal off
42936
42937 .makeindex "Options index"   "option"
42938 .makeindex "Variables index" "variable"
42939 .makeindex "Concept index"   "concept"
42940
42941
42942 . /////////////////////////////////////////////////////////////////////////////
42943 . /////////////////////////////////////////////////////////////////////////////