43ce00cdc2a62dca7aee73154bc614cd6e66cee9
[exim.git] / doc / doc-docbook / spec.xfpt
1
2 . /////////////////////////////////////////////////////////////////////////////
3 . This is the primary source of the Exim Manual. It is an xfpt document that is
4 . converted into DocBook XML for subsequent conversion into printable and online
5 . formats. The markup used herein is "standard" xfpt markup, with some extras.
6 . The markup is summarized in a file called Markup.txt.
7 .
8 . WARNING: When you use the .new macro, make sure it appears *before* any
9 . adjacent index items; otherwise you get an empty "paragraph" which causes
10 . unwanted vertical space.
11 . /////////////////////////////////////////////////////////////////////////////
12
13 .include stdflags
14 .include stdmacs
15
16 . /////////////////////////////////////////////////////////////////////////////
17 . This outputs the standard DocBook boilerplate.
18 . /////////////////////////////////////////////////////////////////////////////
19
20 .docbook
21
22 . /////////////////////////////////////////////////////////////////////////////
23 . These lines are processing instructions for the Simple DocBook Processor that
24 . Philip Hazel has developed as a less cumbersome way of making PostScript and
25 . PDFs than using xmlto and fop. They will be ignored by all other XML
26 . processors.
27 . /////////////////////////////////////////////////////////////////////////////
28
29 .literal xml
30 <?sdop
31   foot_right_recto="&chaptertitle; (&chapternumber;)"
32   foot_right_verso="&chaptertitle; (&chapternumber;)"
33   toc_chapter_blanks="yes,yes"
34   table_warn_overflow="overprint"
35 ?>
36 .literal off
37
38 . /////////////////////////////////////////////////////////////////////////////
39 . This generates the outermost <book> element that wraps the entire document.
40 . /////////////////////////////////////////////////////////////////////////////
41
42 .book
43
44 . /////////////////////////////////////////////////////////////////////////////
45 . These definitions set some parameters and save some typing.
46 . Update the Copyright year (only) when changing content.
47 . /////////////////////////////////////////////////////////////////////////////
48
49 .set previousversion "4.96"
50 .include ./local_params
51
52 .set ACL "access control lists (ACLs)"
53 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
54
55 .set drivernamemax "64"
56
57 .macro copyyear
58 2022
59 .endmacro
60
61 . /////////////////////////////////////////////////////////////////////////////
62 . Additional xfpt markup used by this document, over and above the default
63 . provided in the xfpt library.
64 . /////////////////////////////////////////////////////////////////////////////
65
66 . --- Override the &$ flag to automatically insert a $ with the variable name.
67
68 .flag &$  $&   "<varname>$"  "</varname>"
69
70 . --- Short flags for daggers in option headings. They will always be inside
71 . --- an italic string, but we want the daggers to be in Roman.
72
73 .flag &!!      "</emphasis>&dagger;<emphasis>"
74 .flag &!?      "</emphasis>&Dagger;<emphasis>"
75
76 . --- A macro for an Exim option definition heading, generating a one-line
77 . --- table with four columns. For cases when the option name is given with
78 . --- a space, so that it can be split, a fifth argument is used for the
79 . --- index entry.
80
81 .macro option
82 .arg 5
83 .oindex "&%$5%&"
84 .endarg
85 .arg -5
86 .oindex "&%$1%&"
87 .endarg
88 .itable all 0 0 4 8* left 6* center 6* center 6* right
89 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
90 .endtable
91 .endmacro
92
93 . --- A macro for the common 2-column tables. The width of the first column
94 . --- is suitable for the many tables at the start of the main options chapter;
95 . --- a small number of other 2-column tables override it.
96
97 .macro table2 196pt 254pt
98 .itable none 0 0 2 $1 left $2 left
99 .endmacro
100
101
102 . --- A macro for a plain variable, including the .vitem and .vindex
103 .macro var
104 .vitem $1
105 .vindex $1
106 .endmacro
107
108 . --- A macro for a "tainted" marker, done as a one-element table
109 .macro tmark
110 .itable none 0 0 1 10pt left
111 .row &'Tainted'&
112 .endtable
113 .endmacro
114
115 . --- A macro for a tainted variable, adding a taint-marker
116 .macro tvar
117 .var $1
118 .tmark
119 .endmacro
120
121 . --- A macro for a cmdline option, including a .oindex
122 . --- 1st arg is the option name, undecorated (we do that here).
123 . --- 2nd arg, optional, text (decorated as needed) to be appended to the name
124 .macro cmdopt
125 .vitem  &%$1%&$=2+&~$2+
126 .oindex &%$1%&
127 .endmacro
128
129 . --- A macro that generates .row, but puts &I; at the start of the first
130 . --- argument, thus indenting it. Assume a minimum of two arguments, and
131 . --- allow up to four arguments, which is as many as we'll ever need.
132
133 .macro irow
134 .arg 4
135 .row "&I;$1" "$2" "$3" "$4"
136 .endarg
137 .arg -4
138 .arg 3
139 .row "&I;$1" "$2" "$3"
140 .endarg
141 .arg -3
142 .row "&I;$1" "$2"
143 .endarg
144 .endarg
145 .endmacro
146
147 . --- Macros for option, variable, and concept index entries. For a "range"
148 . --- style of entry, use .scindex for the start and .ecindex for the end. The
149 . --- first argument of .scindex and the only argument of .ecindex must be the
150 . --- ID that ties them together.
151 . --- The index entry points to the most-recent chapter head, section or subsection
152 . --- head, or list-item.
153
154 .macro cindex
155 &<indexterm role="concept">&
156 &<primary>&$1&</primary>&
157 .arg 2
158 &<secondary>&$2&</secondary>&
159 .endarg
160 &</indexterm>&
161 .endmacro
162
163 .macro scindex
164 &<indexterm role="concept" id="$1" class="startofrange">&
165 &<primary>&$2&</primary>&
166 .arg 3
167 &<secondary>&$3&</secondary>&
168 .endarg
169 &</indexterm>&
170 .endmacro
171
172 .macro ecindex
173 &<indexterm role="concept" startref="$1" class="endofrange"/>&
174 .endmacro
175
176 .macro oindex
177 &<indexterm role="option">&
178 &<primary>&$1&</primary>&
179 .arg 2
180 &<secondary>&$2&</secondary>&
181 .endarg
182 &</indexterm>&
183 .endmacro
184
185 . --- The index entry points to the most-recent chapter head, section or subsection
186 . --- head, or varlist item.
187
188 .macro vindex
189 &<indexterm role="variable">&
190 &<primary>&$1&</primary>&
191 .arg 2
192 &<secondary>&$2&</secondary>&
193 .endarg
194 &</indexterm>&
195 .endmacro
196
197 .macro index
198 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
199 .endmacro
200
201
202 . use this for a concept-index entry for a header line
203 .macro chindex
204 .cindex "&'$1'& header line"
205 .cindex "header lines" $1
206 .endmacro
207 . ////////////////////////////////////////////////////////////////////////////
208
209
210 . ////////////////////////////////////////////////////////////////////////////
211 . The <bookinfo> element is removed from the XML before processing for ASCII
212 . output formats.
213 . ////////////////////////////////////////////////////////////////////////////
214
215 .literal xml
216 <bookinfo>
217 <title>Specification of the Exim Mail Transfer Agent</title>
218 <titleabbrev>The Exim MTA</titleabbrev>
219 <date>
220 .fulldate
221 </date>
222 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
223 <authorinitials>EM</authorinitials>
224 <revhistory><revision>
225 .versiondatexml
226   <authorinitials>EM</authorinitials>
227 </revision></revhistory>
228 <copyright><year>
229 .copyyear
230            </year><holder>The Exim Maintainers</holder></copyright>
231 </bookinfo>
232 .literal off
233
234
235 . /////////////////////////////////////////////////////////////////////////////
236 . These implement index entries of the form "x, see y" and "x, see also y".
237 . However, the DocBook DTD doesn't allow <indexterm> entries
238 . at the top level, so we have to put the .chapter directive first.
239 . /////////////////////////////////////////////////////////////////////////////
240
241 .chapter "Introduction" "CHID1"
242
243 .macro seeother
244 .literal xml
245 <indexterm role="$2">
246   <primary>$3</primary>
247 .arg 5
248   <secondary>$5</secondary>
249 .endarg
250   <$1><emphasis>$4</emphasis></$1>
251 </indexterm>
252 .literal off
253 .endmacro
254
255 . NB: for the 4-arg variant the ordering is awkward
256 .macro see
257 .seeother see "$1" "$2" "$3" "$4"
258 .endmacro
259 .macro seealso
260 .seeother seealso "$1" "$2" "$3" "$4"
261 .endmacro
262
263 .see     variable "<emphasis>$1</emphasis>, <emphasis>$2</emphasis>, etc." "numerical variables"
264 .see     concept address        rewriting                       rewriting
265 .see     concept "Bounce Address Tag Validation"        BATV
266 .see     concept "Client SMTP Authorization"            CSA
267 .see     concept "CR character" "carriage return"
268 .see     concept CRL            "certificate revocation list"
269 .seealso concept de-tainting    "tainted data"
270 .see     concept delivery       "bounce message"                "failure report"
271 .see     concept dialup         "intermittently connected hosts"
272 .see     concept exiscan        "content scanning"
273 .see     concept fallover       fallback
274 .see     concept filter         "Sieve filter"                  Sieve
275 .see     concept headers        "header lines"
276 .see     concept ident          "RFC 1413"
277 .see     concept "LF character" "linefeed"
278 .seealso concept maximum        limit
279 .see     concept monitor        "Exim monitor"
280 .see     concept "no_<emphasis>xxx</emphasis>"          "entry for xxx"
281 .see     concept NUL            "binary zero"
282 .see     concept "passwd file"  "/etc/passwd"
283 .see     concept "process id"   pid
284 .see     concept RBL            "DNS list"
285 .see     concept redirection    "address redirection"
286 .see     concept "return path"  "envelope sender"
287 .see     concept scanning       "content scanning"
288 .see     concept SSL            TLS
289 .see     concept string         expansion expansion
290 .see     concept "top bit"      "8-bit characters"
291 .see     concept variables      "expansion, variables"
292 .see     concept "zero, binary" "binary zero"
293
294
295 . /////////////////////////////////////////////////////////////////////////////
296 . This is the real start of the first chapter. See the comment above as to why
297 . we can't have the .chapter line here.
298 . chapter "Introduction"
299 . /////////////////////////////////////////////////////////////////////////////
300
301 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
302 Unix-like operating systems. It was designed on the assumption that it would be
303 run on hosts that are permanently connected to the Internet. However, it can be
304 used on intermittently connected hosts with suitable configuration adjustments.
305
306 Configuration files currently exist for the following operating systems: AIX,
307 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
308 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
309 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
310 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
311 Some of these operating systems are no longer current and cannot easily be
312 tested, so the configuration files may no longer work in practice.
313
314 There are also configuration files for compiling Exim in the Cygwin environment
315 that can be installed on systems running Windows. However, this document does
316 not contain any information about running Exim in the Cygwin environment.
317
318 The terms and conditions for the use and distribution of Exim are contained in
319 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
320 Public Licence, a copy of which may be found in the file &_LICENCE_&.
321
322 The use, supply, or promotion of Exim for the purpose of sending bulk,
323 unsolicited electronic mail is incompatible with the basic aims of Exim,
324 which revolve around the free provision of a service that enhances the quality
325 of personal communications. The author of Exim regards indiscriminate
326 mass-mailing as an antisocial, irresponsible abuse of the Internet.
327
328 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
329 experience of running and working on the Smail 3 code, I could never have
330 contemplated starting to write a new MTA. Many of the ideas and user interfaces
331 were originally taken from Smail 3, though the actual code of Exim is entirely
332 new, and has developed far beyond the initial concept.
333
334 Many people, both in Cambridge and around the world, have contributed to the
335 development and the testing of Exim, and to porting it to various operating
336 systems. I am grateful to them all. The distribution now contains a file called
337 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
338 contributors.
339
340
341 .section "Exim documentation" "SECID1"
342 . Keep this example change bar when updating the documentation!
343
344 .new
345 .cindex "documentation"
346 This edition of the Exim specification applies to version &version() of Exim.
347 Substantive changes from the &previousversion; edition are marked in some
348 renditions of this document; this paragraph is so marked if the rendition is
349 capable of showing a change indicator.
350 .wen
351
352 This document is very much a reference manual; it is not a tutorial. The reader
353 is expected to have some familiarity with the SMTP mail transfer protocol and
354 with general Unix system administration. Although there are some discussions
355 and examples in places, the information is mostly organized in a way that makes
356 it easy to look up, rather than in a natural order for sequential reading.
357 Furthermore, this manual aims to cover every aspect of Exim in detail, including
358 a number of rarely-used, special-purpose features that are unlikely to be of
359 very wide interest.
360
361 .cindex "books about Exim"
362 An &"easier"& discussion of Exim which provides more in-depth explanatory,
363 introductory, and tutorial material can be found in a book entitled &'The Exim
364 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
365 (&url(https://www.uit.co.uk/exim-book/)).
366
367 The book also contains a chapter that gives a general introduction to SMTP and
368 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
369 with the latest release of Exim. (Note that the earlier book about Exim,
370 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
371
372 .cindex "Debian" "information sources"
373 If you are using a Debian distribution of Exim, you will find information about
374 Debian-specific features in the file
375 &_/usr/share/doc/exim4-base/README.Debian_&.
376 The command &(man update-exim.conf)& is another source of Debian-specific
377 information.
378
379 .cindex "&_doc/NewStuff_&"
380 .cindex "&_doc/ChangeLog_&"
381 .cindex "change log"
382 As Exim develops, there may be features in newer versions that have not
383 yet made it into this document, which is updated only when the most significant
384 digit of the fractional part of the version number changes. Specifications of
385 new features that are not yet in this manual are placed in the file
386 &_doc/NewStuff_& in the Exim distribution.
387
388 Some features may be classified as &"experimental"&. These may change
389 incompatibly while they are developing, or even be withdrawn. For this reason,
390 they are not documented in this manual. Information about experimental features
391 can be found in the file &_doc/experimental.txt_&.
392
393 All changes to Exim (whether new features, bug fixes, or other kinds of
394 change) are noted briefly in the file called &_doc/ChangeLog_&.
395
396 .cindex "&_doc/spec.txt_&"
397 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
398 that it can easily be searched with a text editor. Other files in the &_doc_&
399 directory are:
400
401 .table2 100pt
402 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
403 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
404 .row &_exim.8_&              "a man page of Exim's command line options"
405 .row &_experimental.txt_&    "documentation of experimental features"
406 .row &_filter.txt_&          "specification of the filter language"
407 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
408 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
409 .row &_openssl.txt_&         "installing a current OpenSSL release"
410 .endtable
411
412 The main specification and the specification of the filtering language are also
413 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
414 &<<SECTavail>>& below tells you how to get hold of these.
415
416
417
418 .section "FTP site and websites" "SECID2"
419 .cindex "website"
420 .cindex "FTP site"
421 The primary site for Exim source distributions is the &%exim.org%& FTP site,
422 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
423 website, are hosted at the University of Cambridge.
424
425 .cindex "wiki"
426 .cindex "FAQ"
427 As well as Exim distribution tar files, the Exim website contains a number of
428 differently formatted versions of the documentation. A recent addition to the
429 online information is the Exim wiki (&url(https://wiki.exim.org)),
430 which contains what used to be a separate FAQ, as well as various other
431 examples, tips, and know-how that have been contributed by Exim users.
432 The wiki site should always redirect to the correct place, which is currently
433 provided by GitHub, and is open to editing by anyone with a GitHub account.
434
435 .cindex Bugzilla
436 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
437 this to report bugs, and also to add items to the wish list. Please search
438 first to check that you are not duplicating a previous entry.
439 Please do not ask for configuration help in the bug-tracker.
440
441
442 .section "Mailing lists" "SECID3"
443 .cindex "mailing lists" "for Exim users"
444 The following Exim mailing lists exist:
445
446 .table2 140pt
447 .row &'exim-announce@lists.exim.org'&   "Moderated, low volume announcements list"
448 .row &'exim-users@lists.exim.org'&      "General discussion list"
449 .row &'exim-users-de@lists.exim.org'&   "General discussion list in German language"
450 .row &'exim-dev@lists.exim.org'&        "Discussion of bugs, enhancements, etc."
451 .row &'exim-cvs@lists.exim.org'&        "Automated commit messages from the VCS"
452 .endtable
453
454 You can subscribe to these lists, change your existing subscriptions, and view
455 or search the archives via the mailing lists link on the Exim home page.
456 .cindex "Debian" "mailing list for"
457 If you are using a Debian distribution of Exim, you may wish to subscribe to
458 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
459 via this web page:
460 .display
461 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
462 .endd
463 Please ask Debian-specific questions on that list and not on the general Exim
464 lists.
465
466 .section "Bug reports" "SECID5"
467 .cindex "bug reports"
468 .cindex "reporting bugs"
469 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
470 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
471 whether some behaviour is a bug or not, the best thing to do is to post a
472 message to the &'exim-dev'& mailing list and have it discussed.
473
474
475
476 .section "Where to find the Exim distribution" "SECTavail"
477 .cindex "FTP site"
478 .cindex "HTTPS download site"
479 .cindex "distribution" "FTP site"
480 .cindex "distribution" "https site"
481 The master distribution site for the Exim distribution is
482 .display
483 &url(https://downloads.exim.org/)
484 .endd
485 The service is available over HTTPS, HTTP and FTP.
486 We encourage people to migrate to HTTPS.
487
488 The content served at &url(https://downloads.exim.org/) is identical to the
489 content served at &url(https://ftp.exim.org/pub/exim) and
490 &url(ftp://ftp.exim.org/pub/exim).
491
492 If accessing via a hostname containing &'ftp'&, then the file references that
493 follow are relative to the &_exim_& directories at these sites.
494 If accessing via the hostname &'downloads'& then the subdirectories described
495 here are top-level directories.
496
497 There are now quite a number of independent mirror sites around
498 the world. Those that I know about are listed in the file called &_Mirrors_&.
499
500 Within the top exim directory there are subdirectories called &_exim3_& (for
501 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
502 distributions), and &_Testing_& for testing versions. In the &_exim4_&
503 subdirectory, the current release can always be found in files called
504 .display
505 &_exim-n.nn.tar.xz_&
506 &_exim-n.nn.tar.gz_&
507 &_exim-n.nn.tar.bz2_&
508 .endd
509 where &'n.nn'& is the highest such version number in the directory. The three
510 files contain identical data; the only difference is the type of compression.
511 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
512 most portable to old systems.
513
514 .cindex "distribution" "signing details"
515 .cindex "distribution" "public key"
516 .cindex "public key for signed distribution"
517 The distributions will be PGP signed by an individual key of the Release
518 Coordinator.  This key will have a uid containing an email address in the
519 &'exim.org'& domain and will have signatures from other people, including
520 other Exim maintainers.  We expect that the key will be in the "strong set" of
521 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
522 PGP keys, a version of which can be found in the release directory in the file
523 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
524 such as &'pool.sks-keyservers.net'&.
525
526 At the time of the last update, releases were being made by Jeremy Harris and signed
527 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
528 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
529 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
530
531 The signatures for the tar bundles are in:
532 .display
533 &_exim-n.nn.tar.xz.asc_&
534 &_exim-n.nn.tar.gz.asc_&
535 &_exim-n.nn.tar.bz2.asc_&
536 .endd
537 For each released version, the log of changes is made available in a
538 separate file in the directory &_ChangeLogs_& so that it is possible to
539 find out what has changed without having to download the entire distribution.
540
541 .cindex "documentation" "available formats"
542 The main distribution contains ASCII versions of this specification and other
543 documentation; other formats of the documents are available in separate files
544 inside the &_exim4_& directory of the FTP site:
545 .display
546 &_exim-html-n.nn.tar.gz_&
547 &_exim-pdf-n.nn.tar.gz_&
548 &_exim-postscript-n.nn.tar.gz_&
549 &_exim-texinfo-n.nn.tar.gz_&
550 .endd
551 These tar files contain only the &_doc_& directory, not the complete
552 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
553
554
555 .section "Limitations" "SECID6"
556 .ilist
557 .cindex "limitations of Exim"
558 .cindex "bang paths" "not handled by Exim"
559 Exim is designed for use as an Internet MTA, and therefore handles addresses in
560 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
561 simple two-component bang paths can be converted by a straightforward rewriting
562 configuration. This restriction does not prevent Exim from being interfaced to
563 UUCP as a transport mechanism, provided that domain addresses are used.
564 .next
565 .cindex "domainless addresses"
566 .cindex "address" "without domain"
567 Exim insists that every address it handles has a domain attached. For incoming
568 local messages, domainless addresses are automatically qualified with a
569 configured domain value. Configuration options specify from which remote
570 systems unqualified addresses are acceptable. These are then qualified on
571 arrival.
572 .next
573 .cindex "transport" "external"
574 .cindex "external transports"
575 The only external transport mechanisms that are currently implemented are SMTP
576 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
577 transport is available, and there are facilities for writing messages to files
578 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
579 to send messages to other transport mechanisms such as UUCP, provided they can
580 handle domain-style addresses. Batched SMTP input is also catered for.
581 .next
582 Exim is not designed for storing mail for dial-in hosts. When the volumes of
583 such mail are large, it is better to get the messages &"delivered"& into files
584 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
585 other means.
586 .next
587 Although Exim does have basic facilities for scanning incoming messages, these
588 are not comprehensive enough to do full virus or spam scanning. Such operations
589 are best carried out using additional specialized software packages. If you
590 compile Exim with the content-scanning extension, straightforward interfaces to
591 a number of common scanners are provided.
592 .endlist
593
594
595 .section "Runtime configuration" "SECID7"
596 Exim's runtime configuration is held in a single text file that is divided
597 into a number of sections. The entries in this file consist of keywords and
598 values, in the style of Smail 3 configuration files. A default configuration
599 file which is suitable for simple online installations is provided in the
600 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
601
602
603 .section "Calling interface" "SECID8"
604 .cindex "Sendmail compatibility" "command line interface"
605 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
606 can be a straight replacement for &_/usr/lib/sendmail_& or
607 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
608 about Sendmail in order to run Exim. For actions other than sending messages,
609 Sendmail-compatible options also exist, but those that produce output (for
610 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
611 format. There are also some additional options that are compatible with Smail
612 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
613 documents all Exim's command line options. This information is automatically
614 made into the man page that forms part of the Exim distribution.
615
616 Control of messages in the queue can be done via certain privileged command
617 line options. There is also an optional monitor program called &'eximon'&,
618 which displays current information in an X window, and which contains a menu
619 interface to Exim's command line administration options.
620
621
622
623 .section "Terminology" "SECID9"
624 .cindex "terminology definitions"
625 .cindex "body of message" "definition of"
626 The &'body'& of a message is the actual data that the sender wants to transmit.
627 It is the last part of a message and is separated from the &'header'& (see
628 below) by a blank line.
629
630 .cindex "bounce message" "definition of"
631 When a message cannot be delivered, it is normally returned to the sender in a
632 delivery failure message or a &"non-delivery report"& (NDR). The term
633 &'bounce'& is commonly used for this action, and the error reports are often
634 called &'bounce messages'&. This is a convenient shorthand for &"delivery
635 failure error report"&. Such messages have an empty sender address in the
636 message's &'envelope'& (see below) to ensure that they cannot themselves give
637 rise to further bounce messages.
638
639 The term &'default'& appears frequently in this manual. It is used to qualify a
640 value which is used in the absence of any setting in the configuration. It may
641 also qualify an action which is taken unless a configuration setting specifies
642 otherwise.
643
644 The term &'defer'& is used when the delivery of a message to a specific
645 destination cannot immediately take place for some reason (a remote host may be
646 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
647 until a later time.
648
649 The word &'domain'& is sometimes used to mean all but the first component of a
650 host's name. It is &'not'& used in that sense here, where it normally refers to
651 the part of an email address following the @ sign.
652
653 .cindex "envelope, definition of"
654 .cindex "sender" "definition of"
655 A message in transit has an associated &'envelope'&, as well as a header and a
656 body. The envelope contains a sender address (to which bounce messages should
657 be delivered), and any number of recipient addresses. References to the
658 sender or the recipients of a message usually mean the addresses in the
659 envelope. An MTA uses these addresses for delivery, and for returning bounce
660 messages, not the addresses that appear in the header lines.
661
662 .cindex "message" "header, definition of"
663 .cindex "header section" "definition of"
664 The &'header'& of a message is the first part of a message's text, consisting
665 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
666 &'Subject:'&, etc. Long header lines can be split over several text lines by
667 indenting the continuations. The header is separated from the body by a blank
668 line.
669
670 .cindex "local part" "definition of"
671 .cindex "domain" "definition of"
672 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
673 part of an email address that precedes the @ sign. The part that follows the
674 @ sign is called the &'domain'& or &'mail domain'&.
675
676 .cindex "local delivery" "definition of"
677 .cindex "remote delivery, definition of"
678 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
679 delivery to a file or a pipe on the local host from delivery by SMTP over
680 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
681 host it is running on are &'remote'&.
682
683 .cindex "return path" "definition of"
684 &'Return path'& is another name that is used for the sender address in a
685 message's envelope.
686
687 .cindex "queue" "definition of"
688 The term &'queue'& is used to refer to the set of messages awaiting delivery
689 because this term is in widespread use in the context of MTAs. However, in
690 Exim's case, the reality is more like a pool than a queue, because there is
691 normally no ordering of waiting messages.
692
693 .cindex "queue runner" "definition of"
694 The term &'queue runner'& is used to describe a process that scans the queue
695 and attempts to deliver those messages whose retry times have come. This term
696 is used by other MTAs and also relates to the command &%runq%&, but in Exim
697 the waiting messages are normally processed in an unpredictable order.
698
699 .cindex "spool directory" "definition of"
700 The term &'spool directory'& is used for a directory in which Exim keeps the
701 messages in its queue &-- that is, those that it is in the process of
702 delivering. This should not be confused with the directory in which local
703 mailboxes are stored, which is called a &"spool directory"& by some people. In
704 the Exim documentation, &"spool"& is always used in the first sense.
705
706
707
708
709
710
711 . ////////////////////////////////////////////////////////////////////////////
712 . ////////////////////////////////////////////////////////////////////////////
713
714 .chapter "Incorporated code" "CHID2"
715 .cindex "incorporated code"
716 .cindex "regular expressions" "library"
717 .cindex "PCRE2"
718 .cindex "OpenDMARC"
719 A number of pieces of external code are included in the Exim distribution.
720
721 .ilist
722 Regular expressions are supported in the main Exim program and in the
723 Exim monitor using the freely-distributable PCRE2 library, copyright
724 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
725 Exim, so you will need to use the version of PCRE2 shipped with your system,
726 or obtain and install the full version of the library from
727 &url(https://github.com/PhilipHazel/pcre2/releases).
728 .next
729 .cindex "cdb" "acknowledgment"
730 Support for the cdb (Constant DataBase) lookup method is provided by code
731 contributed by Nigel Metheringham of (at the time he contributed it) Planet
732 Online Ltd. The implementation is completely contained within the code of Exim.
733 It does not link against an external cdb library. The code contains the
734 following statements:
735
736 .blockquote
737 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
738
739 This program is free software; you can redistribute it and/or modify it under
740 the terms of the GNU General Public License as published by the Free Software
741 Foundation; either version 2 of the License, or (at your option) any later
742 version.
743 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
744 the spec and sample code for cdb can be obtained from
745 &url(https://cr.yp.to/cdb.html). This implementation borrows
746 some code from Dan Bernstein's implementation (which has no license
747 restrictions applied to it).
748 .endblockquote
749 .next
750 .cindex "SPA authentication"
751 .cindex "Samba project"
752 .cindex "Microsoft Secure Password Authentication"
753 Client support for Microsoft's &'Secure Password Authentication'& is provided
754 by code contributed by Marc Prud'hommeaux. Server support was contributed by
755 Tom Kistner. This includes code taken from the Samba project, which is released
756 under the Gnu GPL.
757 .next
758 .cindex "Cyrus"
759 .cindex "&'pwcheck'& daemon"
760 .cindex "&'pwauthd'& daemon"
761 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
762 by code taken from the Cyrus-SASL library and adapted by Alexander S.
763 Sabourenkov. The permission notice appears below, in accordance with the
764 conditions expressed therein.
765
766 .blockquote
767 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
768
769 Redistribution and use in source and binary forms, with or without
770 modification, are permitted provided that the following conditions
771 are met:
772
773 .olist
774 Redistributions of source code must retain the above copyright
775 notice, this list of conditions and the following disclaimer.
776 .next
777 Redistributions in binary form must reproduce the above copyright
778 notice, this list of conditions and the following disclaimer in
779 the documentation and/or other materials provided with the
780 distribution.
781 .next
782 The name &"Carnegie Mellon University"& must not be used to
783 endorse or promote products derived from this software without
784 prior written permission. For permission or any other legal
785 details, please contact
786 .display
787               Office of Technology Transfer
788               Carnegie Mellon University
789               5000 Forbes Avenue
790               Pittsburgh, PA  15213-3890
791               (412) 268-4387, fax: (412) 268-7395
792               tech-transfer@andrew.cmu.edu
793 .endd
794 .next
795 Redistributions of any form whatsoever must retain the following
796 acknowledgment:
797
798 &"This product includes software developed by Computing Services
799 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
800
801 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
802 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
803 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
804 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
805 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
806 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
807 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
808 .endlist
809 .endblockquote
810
811 .next
812 .cindex "Exim monitor" "acknowledgment"
813 .cindex "X-windows"
814 .cindex "Athena"
815 The Exim Monitor program, which is an X-Window application, includes
816 modified versions of the Athena StripChart and TextPop widgets.
817 This code is copyright by DEC and MIT, and their permission notice appears
818 below, in accordance with the conditions expressed therein.
819
820 .blockquote
821 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
822 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
823
824 All Rights Reserved
825
826 Permission to use, copy, modify, and distribute this software and its
827 documentation for any purpose and without fee is hereby granted,
828 provided that the above copyright notice appear in all copies and that
829 both that copyright notice and this permission notice appear in
830 supporting documentation, and that the names of Digital or MIT not be
831 used in advertising or publicity pertaining to distribution of the
832 software without specific, written prior permission.
833
834 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
835 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
836 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
837 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
838 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
839 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
840 SOFTWARE.
841 .endblockquote
842
843 .next
844 .cindex "opendmarc" "acknowledgment"
845 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
846 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
847 derived code are indicated in the respective source files. The full OpenDMARC
848 license is provided in the LICENSE.opendmarc file contained in the distributed
849 source code.
850
851 .next
852 Many people have contributed code fragments, some large, some small, that were
853 not covered by any specific license requirements. It is assumed that the
854 contributors are happy to see their code incorporated into Exim under the GPL.
855 .endlist
856
857
858
859
860
861 . ////////////////////////////////////////////////////////////////////////////
862 . ////////////////////////////////////////////////////////////////////////////
863
864 .chapter "How Exim receives and delivers mail" "CHID11" &&&
865          "Receiving and delivering mail"
866
867
868 .section "Overall philosophy" "SECID10"
869 .cindex "design philosophy"
870 Exim is designed to work efficiently on systems that are permanently connected
871 to the Internet and are handling a general mix of mail. In such circumstances,
872 most messages can be delivered immediately. Consequently, Exim does not
873 maintain independent queues of messages for specific domains or hosts, though
874 it does try to send several messages in a single SMTP connection after a host
875 has been down, and it also maintains per-host retry information.
876
877
878 .section "Policy control" "SECID11"
879 .cindex "policy control" "overview"
880 Policy controls are now an important feature of MTAs that are connected to the
881 Internet. Perhaps their most important job is to stop MTAs from being abused as
882 &"open relays"& by misguided individuals who send out vast amounts of
883 unsolicited junk and want to disguise its source. Exim provides flexible
884 facilities for specifying policy controls on incoming mail:
885
886 .ilist
887 .cindex "&ACL;" "introduction"
888 Exim 4 (unlike previous versions of Exim) implements policy controls on
889 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
890 series of statements that may either grant or deny access. ACLs can be used at
891 several places in the SMTP dialogue while receiving a message from a remote
892 host. However, the most common places are after each RCPT command, and at the
893 very end of the message. The sysadmin can specify conditions for accepting or
894 rejecting individual recipients or the entire message, respectively, at these
895 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
896 error code.
897 .next
898 An ACL is also available for locally generated, non-SMTP messages. In this
899 case, the only available actions are to accept or deny the entire message.
900 .next
901 When Exim is compiled with the content-scanning extension, facilities are
902 provided in the ACL mechanism for passing the message to external virus and/or
903 spam scanning software. The result of such a scan is passed back to the ACL,
904 which can then use it to decide what to do with the message.
905 .next
906 When a message has been received, either from a remote host or from the local
907 host, but before the final acknowledgment has been sent, a locally supplied C
908 function called &[local_scan()]& can be run to inspect the message and decide
909 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
910 is accepted, the list of recipients can be modified by the function.
911 .next
912 Using the &[local_scan()]& mechanism is another way of calling external scanner
913 software. The &%SA-Exim%& add-on package works this way. It does not require
914 Exim to be compiled with the content-scanning extension.
915 .next
916 After a message has been accepted, a further checking mechanism is available in
917 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
918 runs at the start of every delivery process.
919 .endlist
920
921
922
923 .section "User filters" "SECID12"
924 .cindex "filter" "introduction"
925 .cindex "Sieve filter"
926 In a conventional Exim configuration, users are able to run private filters by
927 setting up appropriate &_.forward_& files in their home directories. See
928 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
929 configuration needed to support this, and the separate document entitled
930 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
931 of filtering are available:
932
933 .ilist
934 Sieve filters are written in the standard filtering language that is defined
935 by RFC 3028.
936 .next
937 Exim filters are written in a syntax that is unique to Exim, but which is more
938 powerful than Sieve, which it pre-dates.
939 .endlist
940
941 User filters are run as part of the routing process, described below.
942
943
944
945 .section "Message identification" "SECTmessiden"
946 .cindex "message ids" "details of format"
947 .cindex "format" "of message id"
948 .cindex "id of message"
949 .cindex "base62"
950 .cindex "base36"
951 .cindex "Darwin"
952 .cindex "Cygwin"
953 .cindex "exim_msgdate"
954 Every message handled by Exim is given a &'message id'& which is sixteen
955 characters long. It is divided into three parts, separated by hyphens, for
956 example &`16VDhn-000000001bo-D342`&. Each part is a sequence of letters and digits,
957 normally encoding numbers in base 62. However, in the Darwin operating
958 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
959 (avoiding the use of lower case letters) is used instead, because the message
960 id is used to construct filenames, and the names of files in those systems are
961 not always case-sensitive.
962
963 .cindex "pid (process id)" "re-use of"
964 The detail of the contents of the message id have changed as Exim has evolved.
965 Earlier versions relied on the operating system not re-using a process id (pid)
966 within one second. On modern operating systems, this assumption can no longer
967 be made, so the algorithm had to be changed. To retain backward compatibility,
968 the format of the message id was retained, which is why the following rules are
969 somewhat eccentric:
970
971 .ilist
972 The first six characters of the message id are the time at which the message
973 started to be received, to a granularity of one second. That is, this field
974 contains the number of seconds since the start of the epoch (the normal Unix
975 way of representing the date and time of day).
976 .next
977 After the first hyphen, the next
978 .new
979 eleven
980 .wen
981 characters are the id of the process that received the message.
982 .next
983 .new
984 There are two different possibilities for the final four characters:
985 .olist
986 .oindex "&%localhost_number%&"
987 If &%localhost_number%& is not set, this value is the fractional part of the
988 time of reception, normally in units of
989 microseconds.
990 but for systems
991 that must use base 36 instead of base 62 (because of case-insensitive file
992 systems), the units are
993 2 us.
994 .next
995 If &%localhost_number%& is set, it is multiplied by
996 500000 (250000) and added to
997 the fractional part of the time, which in this case is in units of 2 us (4 us).
998 .endlist
999 .wen
1000 .endlist
1001
1002 After a message has been received, Exim waits for the clock to tick at the
1003 appropriate resolution before proceeding, so that if another message is
1004 received by the same process, or by another process with the same (re-used)
1005 pid, it is guaranteed that the time will be different. In most cases, the clock
1006 will already have ticked while the message was being received.
1007
1008 The exim_msgdate utility (see section &<<SECTexim_msgdate>>&) can be
1009 used to display the date, and optionally the process id, of an Exim
1010 Message ID.
1011
1012
1013 .section "Receiving mail" "SECID13"
1014 .cindex "receiving mail"
1015 .cindex "message" "reception"
1016 The only way Exim can receive mail from another host is using SMTP over
1017 TCP/IP, in which case the sender and recipient addresses are transferred using
1018 SMTP commands. However, from a locally running process (such as a user's MUA),
1019 there are several possibilities:
1020
1021 .ilist
1022 If the process runs Exim with the &%-bm%& option, the message is read
1023 non-interactively (usually via a pipe), with the recipients taken from the
1024 command line, or from the body of the message if &%-t%& is also used.
1025 .next
1026 If the process runs Exim with the &%-bS%& option, the message is also read
1027 non-interactively, but in this case the recipients are listed at the start of
1028 the message in a series of SMTP RCPT commands, terminated by a DATA
1029 command. This is called &"batch SMTP"& format,
1030 but it isn't really SMTP. The SMTP commands are just another way of passing
1031 envelope addresses in a non-interactive submission.
1032 .next
1033 If the process runs Exim with the &%-bs%& option, the message is read
1034 interactively, using the SMTP protocol. A two-way pipe is normally used for
1035 passing data between the local process and the Exim process.
1036 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1037 example, the ACLs for SMTP commands are used for this form of submission.
1038 .next
1039 A local process may also make a TCP/IP call to the host's loopback address
1040 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1041 does not treat the loopback address specially. It treats all such connections
1042 in the same way as connections from other hosts.
1043 .endlist
1044
1045
1046 .cindex "message sender, constructed by Exim"
1047 .cindex "sender" "constructed by Exim"
1048 In the three cases that do not involve TCP/IP, the sender address is
1049 constructed from the login name of the user that called Exim and a default
1050 qualification domain (which can be set by the &%qualify_domain%& configuration
1051 option). For local or batch SMTP, a sender address that is passed using the
1052 SMTP MAIL command is ignored. However, the system administrator may allow
1053 certain users (&"trusted users"&) to specify a different sender addresses
1054 unconditionally, or all users to specify certain forms of different sender
1055 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1056 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1057 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1058 users to change sender addresses.
1059
1060 Messages received by either of the non-interactive mechanisms are subject to
1061 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1062 (either over TCP/IP or interacting with a local process) can be checked by a
1063 number of ACLs that operate at different times during the SMTP session. Either
1064 individual recipients or the entire message can be rejected if local policy
1065 requirements are not met. The &[local_scan()]& function (see chapter
1066 &<<CHAPlocalscan>>&) is run for all incoming messages.
1067
1068 Exim can be configured not to start a delivery process when a message is
1069 received; this can be unconditional, or depend on the number of incoming SMTP
1070 connections or the system load. In these situations, new messages wait on the
1071 queue until a queue runner process picks them up. However, in standard
1072 configurations under normal conditions, delivery is started as soon as a
1073 message is received.
1074
1075
1076
1077
1078
1079 .section "Handling an incoming message" "SECID14"
1080 .cindex "spool directory" "files that hold a message"
1081 .cindex "file" "how a message is held"
1082 When Exim accepts a message, it writes two files in its spool directory. The
1083 first contains the envelope information, the current status of the message, and
1084 the header lines, and the second contains the body of the message. The names of
1085 the two spool files consist of the message id, followed by &`-H`& for the
1086 file containing the envelope and header, and &`-D`& for the data file.
1087
1088 .cindex "spool directory" "&_input_& sub-directory"
1089 By default, all these message files are held in a single directory called
1090 &_input_& inside the general Exim spool directory. Some operating systems do
1091 not perform very well if the number of files in a directory gets large; to
1092 improve performance in such cases, the &%split_spool_directory%& option can be
1093 used. This causes Exim to split up the input files into 62 sub-directories
1094 whose names are single letters or digits. When this is done, the queue is
1095 processed one sub-directory at a time instead of all at once, which can improve
1096 overall performance even when there are not enough files in each directory to
1097 affect file system performance.
1098
1099 The envelope information consists of the address of the message's sender and
1100 the addresses of the recipients. This information is entirely separate from
1101 any addresses contained in the header lines. The status of the message includes
1102 a list of recipients who have already received the message. The format of the
1103 first spool file is described in chapter &<<CHAPspool>>&.
1104
1105 .cindex "rewriting" "addresses"
1106 Address rewriting that is specified in the rewrite section of the configuration
1107 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1108 both in the header lines and the envelope, at the time the message is accepted.
1109 If during the course of delivery additional addresses are generated (for
1110 example, via aliasing), these new addresses are rewritten as soon as they are
1111 generated. At the time a message is actually delivered (transported) further
1112 rewriting can take place; because this is a transport option, it can be
1113 different for different forms of delivery. It is also possible to specify the
1114 addition or removal of certain header lines at the time the message is
1115 delivered (see chapters &<<CHAProutergeneric>>& and
1116 &<<CHAPtransportgeneric>>&).
1117
1118
1119
1120 .section "Life of a message" "SECID15"
1121 .cindex "message" "life of"
1122 .cindex "message" "frozen"
1123 A message remains in the spool directory until it is completely delivered to
1124 its recipients or to an error address, or until it is deleted by an
1125 administrator or by the user who originally created it. In cases when delivery
1126 cannot proceed &-- for example when a message can neither be delivered to its
1127 recipients nor returned to its sender, the message is marked &"frozen"& on the
1128 spool, and no more deliveries are attempted.
1129
1130 .cindex "frozen messages" "thawing"
1131 .cindex "message" "thawing frozen"
1132 An administrator can &"thaw"& such messages when the problem has been
1133 corrected, and can also freeze individual messages by hand if necessary. In
1134 addition, an administrator can force a delivery error, causing a bounce message
1135 to be sent.
1136
1137 .oindex "&%timeout_frozen_after%&"
1138 .oindex "&%ignore_bounce_errors_after%&"
1139 There are options called &%ignore_bounce_errors_after%& and
1140 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1141 The first applies only to frozen bounces, the second to all frozen messages.
1142
1143 .cindex "message" "log file for"
1144 .cindex "log" "file for each message"
1145 While Exim is working on a message, it writes information about each delivery
1146 attempt to its main log file. This includes successful, unsuccessful, and
1147 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1148 lines are also written to a separate &'message log'& file for each message.
1149 These logs are solely for the benefit of the administrator and are normally
1150 deleted along with the spool files when processing of a message is complete.
1151 The use of individual message logs can be disabled by setting
1152 &%no_message_logs%&; this might give an improvement in performance on very busy
1153 systems.
1154
1155 .cindex "journal file"
1156 .cindex "file" "journal"
1157 All the information Exim itself needs to set up a delivery is kept in the first
1158 spool file, along with the header lines. When a successful delivery occurs, the
1159 address is immediately written at the end of a journal file, whose name is the
1160 message id followed by &`-J`&. At the end of a delivery run, if there are some
1161 addresses left to be tried again later, the first spool file (the &`-H`& file)
1162 is updated to indicate which these are, and the journal file is then deleted.
1163 Updating the spool file is done by writing a new file and renaming it, to
1164 minimize the possibility of data loss.
1165
1166 Should the system or Exim crash after a successful delivery but before
1167 the spool file has been updated, the journal is left lying around. The next
1168 time Exim attempts to deliver the message, it reads the journal file and
1169 updates the spool file before proceeding. This minimizes the chances of double
1170 deliveries caused by crashes.
1171
1172
1173
1174 .section "Processing an address for delivery" "SECTprocaddress"
1175 .cindex "drivers" "definition of"
1176 .cindex "router" "definition of"
1177 .cindex "transport" "definition of"
1178 The main delivery processing elements of Exim are called &'routers'& and
1179 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1180 number of them is provided in the source distribution, and compile-time options
1181 specify which ones are included in the binary. Runtime options specify which
1182 ones are actually used for delivering messages.
1183
1184 .cindex "drivers" "instance definition"
1185 Each driver that is specified in the runtime configuration is an &'instance'&
1186 of that particular driver type. Multiple instances are allowed; for example,
1187 you can set up several different &(smtp)& transports, each with different
1188 option values that might specify different ports or different timeouts. Each
1189 instance has its own identifying name. In what follows we will normally use the
1190 instance name when discussing one particular instance (that is, one specific
1191 configuration of the driver), and the generic driver name when discussing
1192 the driver's features in general.
1193
1194 A &'router'& is a driver that operates on an address, either determining how
1195 its delivery should happen, by assigning it to a specific transport, or
1196 converting the address into one or more new addresses (for example, via an
1197 alias file). A router may also explicitly choose to fail an address, causing it
1198 to be bounced.
1199
1200 A &'transport'& is a driver that transmits a copy of the message from Exim's
1201 spool to some destination. There are two kinds of transport: for a &'local'&
1202 transport, the destination is a file or a pipe on the local host, whereas for a
1203 &'remote'& transport the destination is some other host. A message is passed
1204 to a specific transport as a result of successful routing. If a message has
1205 several recipients, it may be passed to a number of different transports.
1206
1207 .cindex "preconditions" "definition of"
1208 An address is processed by passing it to each configured router instance in
1209 turn, subject to certain preconditions, until a router accepts the address or
1210 specifies that it should be bounced. We will describe this process in more
1211 detail shortly. First, as a simple example, we consider how each recipient
1212 address in a message is processed in a small configuration of three routers.
1213
1214 To make this a more concrete example, it is described in terms of some actual
1215 routers, but remember, this is only an example. You can configure Exim's
1216 routers in many different ways, and there may be any number of routers in a
1217 configuration.
1218
1219 The first router that is specified in a configuration is often one that handles
1220 addresses in domains that are not recognized specifically by the local host.
1221 Typically these are addresses for arbitrary domains on the Internet. A precondition
1222 is set up which looks for the special domains known to the host (for example,
1223 its own domain name), and the router is run for addresses that do &'not'&
1224 match. Typically, this is a router that looks up domains in the DNS in order to
1225 find the hosts to which this address routes. If it succeeds, the address is
1226 assigned to a suitable SMTP transport; if it does not succeed, the router is
1227 configured to fail the address.
1228
1229 The second router is reached only when the domain is recognized as one that
1230 &"belongs"& to the local host. This router does redirection &-- also known as
1231 aliasing and forwarding. When it generates one or more new addresses from the
1232 original, each of them is routed independently from the start. Otherwise, the
1233 router may cause an address to fail, or it may simply decline to handle the
1234 address, in which case the address is passed to the next router.
1235
1236 The final router in many configurations is one that checks to see if the
1237 address belongs to a local mailbox. The precondition may involve a check to
1238 see if the local part is the name of a login account, or it may look up the
1239 local part in a file or a database. If its preconditions are not met, or if
1240 the router declines, we have reached the end of the routers. When this happens,
1241 the address is bounced.
1242
1243
1244
1245 .section "Processing an address for verification" "SECID16"
1246 .cindex "router" "for verification"
1247 .cindex "verifying address" "overview"
1248 As well as being used to decide how to deliver to an address, Exim's routers
1249 are also used for &'address verification'&. Verification can be requested as
1250 one of the checks to be performed in an ACL for incoming messages, on both
1251 sender and recipient addresses, and it can be tested using the &%-bv%& and
1252 &%-bvs%& command line options.
1253
1254 When an address is being verified, the routers are run in &"verify mode"&. This
1255 does not affect the way the routers work, but it is a state that can be
1256 detected. By this means, a router can be skipped or made to behave differently
1257 when verifying. A common example is a configuration in which the first router
1258 sends all messages to a message-scanning program unless they have been
1259 previously scanned. Thus, the first router accepts all addresses without any
1260 checking, making it useless for verifying. Normally, the &%no_verify%& option
1261 would be set for such a router, causing it to be skipped in verify mode.
1262
1263
1264
1265
1266 .section "Running an individual router" "SECTrunindrou"
1267 .cindex "router" "running details"
1268 .cindex "preconditions" "checking"
1269 .cindex "router" "result of running"
1270 As explained in the example above, a number of preconditions are checked before
1271 running a router. If any are not met, the router is skipped, and the address is
1272 passed to the next router. When all the preconditions on a router &'are'& met,
1273 the router is run. What happens next depends on the outcome, which is one of
1274 the following:
1275
1276 .ilist
1277 &'accept'&: The router accepts the address, and either assigns it to a
1278 transport or generates one or more &"child"& addresses. Processing the
1279 original address ceases
1280 .oindex "&%unseen%&"
1281 unless the &%unseen%& option is set on the router. This option
1282 can be used to set up multiple deliveries with different routing (for example,
1283 for keeping archive copies of messages). When &%unseen%& is set, the address is
1284 passed to the next router. Normally, however, an &'accept'& return marks the
1285 end of routing.
1286
1287 Any child addresses generated by the router are processed independently,
1288 starting with the first router by default. It is possible to change this by
1289 setting the &%redirect_router%& option to specify which router to start at for
1290 child addresses. Unlike &%pass_router%& (see below) the router specified by
1291 &%redirect_router%& may be anywhere in the router configuration.
1292 .next
1293 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1294 requests that the address be passed to another router. By default, the address
1295 is passed to the next router, but this can be changed by setting the
1296 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1297 must be below the current router (to avoid loops).
1298 .next
1299 &'decline'&: The router declines to accept the address because it does not
1300 recognize it at all. By default, the address is passed to the next router, but
1301 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1302 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1303 &'decline'& into &'fail'&.
1304 .next
1305 &'fail'&: The router determines that the address should fail, and queues it for
1306 the generation of a bounce message. There is no further processing of the
1307 original address unless &%unseen%& is set on the router.
1308 .next
1309 &'defer'&: The router cannot handle the address at the present time. (A
1310 database may be offline, or a DNS lookup may have timed out.) No further
1311 processing of the address happens in this delivery attempt. It is tried again
1312 next time the message is considered for delivery.
1313 .next
1314 &'error'&: There is some error in the router (for example, a syntax error in
1315 its configuration). The action is as for defer.
1316 .endlist
1317
1318 If an address reaches the end of the routers without having been accepted by
1319 any of them, it is bounced as unrouteable. The default error message in this
1320 situation is &"unrouteable address"&, but you can set your own message by
1321 making use of the &%cannot_route_message%& option. This can be set for any
1322 router; the value from the last router that &"saw"& the address is used.
1323
1324 Sometimes while routing you want to fail a delivery when some conditions are
1325 met but others are not, instead of passing the address on for further routing.
1326 You can do this by having a second router that explicitly fails the delivery
1327 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1328 facility for this purpose.
1329
1330
1331 .section "Duplicate addresses" "SECID17"
1332 .cindex "case of local parts"
1333 .cindex "address duplicate, discarding"
1334 .cindex "duplicate addresses"
1335 Once routing is complete, Exim scans the addresses that are assigned to local
1336 and remote transports and discards any duplicates that it finds. During this
1337 check, local parts are treated case-sensitively. This happens only when
1338 actually delivering a message; when testing routers with &%-bt%&, all the
1339 routed addresses are shown.
1340
1341
1342
1343 .section "Router preconditions" "SECTrouprecon"
1344 .cindex "router" "preconditions, order of processing"
1345 .cindex "preconditions" "order of processing"
1346 The preconditions that are tested for each router are listed below, in the
1347 order in which they are tested. The individual configuration options are
1348 described in more detail in chapter &<<CHAProutergeneric>>&.
1349
1350 .olist
1351 .cindex affix "router precondition"
1352 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1353 the local parts handled by the router may or must have certain prefixes and/or
1354 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1355 skipped. These conditions are tested first. When an affix is present, it is
1356 removed from the local part before further processing, including the evaluation
1357 of any other conditions.
1358 .next
1359 Routers can be designated for use only when not verifying an address, that is,
1360 only when routing it for delivery (or testing its delivery routing). If the
1361 &%verify%& option is set false, the router is skipped when Exim is verifying an
1362 address.
1363 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1364 &%verify_recipient%&, which independently control the use of the router for
1365 sender and recipient verification. You can set these options directly if
1366 you want a router to be used for only one type of verification.
1367 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1368 .next
1369 If the &%address_test%& option is set false, the router is skipped when Exim is
1370 run with the &%-bt%& option to test an address routing. This can be helpful
1371 when the first router sends all new messages to a scanner of some sort; it
1372 makes it possible to use &%-bt%& to test subsequent delivery routing without
1373 having to simulate the effect of the scanner.
1374 .next
1375 Routers can be designated for use only when verifying an address, as
1376 opposed to routing it for delivery. The &%verify_only%& option controls this.
1377 Again, cutthrough delivery counts as a verification.
1378 .next
1379 Individual routers can be explicitly skipped when running the routers to
1380 check an address given in the SMTP EXPN command (see the &%expn%& option).
1381
1382 .next
1383 If the &%domains%& option is set, the domain of the address must be in the set
1384 of domains that it defines.
1385 .cindex "tainted data" "de-tainting"
1386 .cindex "de-tainting" "using router domains option"
1387 A match verifies the variable &$domain$& (which carries tainted data)
1388 and assigns an untainted value to the &$domain_data$& variable.
1389 Such an untainted value is often needed in the transport.
1390 For specifics of the matching operation and the resulting untainted value,
1391 refer to section &<<SECTdomainlist>>&.
1392
1393 When an untainted value is wanted, use this option
1394 rather than the generic &%condition%& option.
1395
1396 .next
1397 .vindex "&$local_part_prefix$&"
1398 .vindex "&$local_part_prefix_v$&"
1399 .vindex "&$local_part$&"
1400 .vindex "&$local_part_suffix$&"
1401 .vindex "&$local_part_suffix_v$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines.
1405 A match verifies the variable &$local_part$& (which carries tainted data)
1406 and assigns an untainted value to the &$local_part_data$& variable.
1407 Such an untainted value is often needed in the transport.
1408 For specifics of the matching operation and the resulting untainted value,
1409 refer to section &<<SECTlocparlis>>&.
1410
1411 When an untainted value is wanted, use this option
1412 rather than the generic &%condition%& option.
1413
1414 If &%local_part_prefix%& or
1415 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1416 part before this check. If you want to do precondition tests on local parts
1417 that include affixes, you can do so by using a &%condition%& option (see below)
1418 that uses the variables &$local_part$&, &$local_part_prefix$&,
1419 &$local_part_prefix_v$&, &$local_part_suffix$&
1420 and &$local_part_suffix_v$& as necessary.
1421
1422 .next
1423 .vindex "&$local_user_uid$&"
1424 .vindex "&$local_user_gid$&"
1425 .vindex "&$home$&"
1426 If the &%check_local_user%& option is set, the local part must be the name of
1427 an account on the local host. If this check succeeds, the uid and gid of the
1428 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1429 user's home directory is placed in &$home$&; these values can be used in the
1430 remaining preconditions.
1431
1432 .next
1433 If the &%router_home_directory%& option is set, it is expanded at this point,
1434 because it overrides the value of &$home$&. If this expansion were left till
1435 later, the value of &$home$& as set by &%check_local_user%& would be used in
1436 subsequent tests. Having two different values of &$home$& in the same router
1437 could lead to confusion.
1438
1439 .next
1440 If the &%senders%& option is set, the envelope sender address must be in the
1441 set of addresses that it defines.
1442
1443 .next
1444 If the &%require_files%& option is set, the existence or non-existence of
1445 specified files is tested.
1446
1447 .next
1448 .cindex "customizing" "precondition"
1449 If the &%condition%& option is set, it is evaluated and tested. This option
1450 uses an expanded string to allow you to set up your own custom preconditions.
1451 Expanded strings are described in chapter &<<CHAPexpand>>&.
1452
1453 Note that while using
1454 this option for address matching technically works,
1455 it does not set any de-tainted values.
1456 Such values are often needed, either for router-specific options or
1457 for transport options.
1458 Using the &%domains%& and &%local_parts%& options is usually the most
1459 convenient way to obtain them.
1460 .endlist
1461
1462
1463 Note that &%require_files%& comes near the end of the list, so you cannot use
1464 it to check for the existence of a file in which to lookup up a domain, local
1465 part, or sender. However, as these options are all expanded, you can use the
1466 &%exists%& expansion condition to make such tests within each condition. The
1467 &%require_files%& option is intended for checking files that the router may be
1468 going to use internally, or which are needed by a specific transport (for
1469 example, &_.procmailrc_&).
1470
1471
1472
1473 .section "Delivery in detail" "SECID18"
1474 .cindex "delivery" "in detail"
1475 When a message is to be delivered, the sequence of events is as follows:
1476
1477 .olist
1478 If a system-wide filter file is specified, the message is passed to it. The
1479 filter may add recipients to the message, replace the recipients, discard the
1480 message, cause a new message to be generated, or cause the message delivery to
1481 fail. The format of the system filter file is the same as for Exim user filter
1482 files, described in the separate document entitled &'Exim's interfaces to mail
1483 filtering'&.
1484 .cindex "Sieve filter" "not available for system filter"
1485 (&*Note*&: Sieve cannot be used for system filter files.)
1486
1487 Some additional features are available in system filters &-- see chapter
1488 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1489 filter only once per delivery attempt, however many recipients it has. However,
1490 if there are several delivery attempts because one or more addresses could not
1491 be immediately delivered, the system filter is run each time. The filter
1492 condition &%first_delivery%& can be used to detect the first run of the system
1493 filter.
1494 .next
1495 Each recipient address is offered to each configured router, in turn, subject to
1496 its preconditions, until one is able to handle it. If no router can handle the
1497 address, that is, if they all decline, the address is failed. Because routers
1498 can be targeted at particular domains, several locally handled domains can be
1499 processed entirely independently of each other.
1500 .next
1501 .cindex "routing" "loops in"
1502 .cindex "loop" "while routing"
1503 A router that accepts an address may assign it to a local or a remote
1504 transport. However, the transport is not run at this time. Instead, the address
1505 is placed on a list for the particular transport, which will be run later.
1506 Alternatively, the router may generate one or more new addresses (typically
1507 from alias, forward, or filter files). New addresses are fed back into this
1508 process from the top, but in order to avoid loops, a router ignores any address
1509 which has an identically-named ancestor that was processed by itself.
1510 .next
1511 When all the routing has been done, addresses that have been successfully
1512 handled are passed to their assigned transports. When local transports are
1513 doing real local deliveries, they handle only one address at a time, but if a
1514 local transport is being used as a pseudo-remote transport (for example, to
1515 collect batched SMTP messages for transmission by some other means) multiple
1516 addresses can be handled. Remote transports can always handle more than one
1517 address at a time, but can be configured not to do so, or to restrict multiple
1518 addresses to the same domain.
1519 .next
1520 Each local delivery to a file or a pipe runs in a separate process under a
1521 non-privileged uid, and these deliveries are run one at a time. Remote
1522 deliveries also run in separate processes, normally under a uid that is private
1523 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1524 run in parallel. The maximum number of simultaneous remote deliveries for any
1525 one message is set by the &%remote_max_parallel%& option.
1526 The order in which deliveries are done is not defined, except that all local
1527 deliveries happen before any remote deliveries.
1528 .next
1529 .cindex "queue runner"
1530 When it encounters a local delivery during a queue run, Exim checks its retry
1531 database to see if there has been a previous temporary delivery failure for the
1532 address before running the local transport. If there was a previous failure,
1533 Exim does not attempt a new delivery until the retry time for the address is
1534 reached. However, this happens only for delivery attempts that are part of a
1535 queue run. Local deliveries are always attempted when delivery immediately
1536 follows message reception, even if retry times are set for them. This makes for
1537 better behaviour if one particular message is causing problems (for example,
1538 causing quota overflow, or provoking an error in a filter file).
1539 .next
1540 .cindex "delivery" "retry in remote transports"
1541 Remote transports do their own retry handling, since an address may be
1542 deliverable to one of a number of hosts, each of which may have a different
1543 retry time. If there have been previous temporary failures and no host has
1544 reached its retry time, no delivery is attempted, whether in a queue run or
1545 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1546 .next
1547 If there were any permanent errors, a bounce message is returned to an
1548 appropriate address (the sender in the common case), with details of the error
1549 for each failing address. Exim can be configured to send copies of bounce
1550 messages to other addresses.
1551 .next
1552 .cindex "delivery" "deferral"
1553 If one or more addresses suffered a temporary failure, the message is left on
1554 the queue, to be tried again later. Delivery of these addresses is said to be
1555 &'deferred'&.
1556 .next
1557 When all the recipient addresses have either been delivered or bounced,
1558 handling of the message is complete. The spool files and message log are
1559 deleted, though the message log can optionally be preserved if required.
1560 .endlist
1561
1562
1563
1564
1565 .section "Retry mechanism" "SECID19"
1566 .cindex "delivery" "retry mechanism"
1567 .cindex "retry" "description of mechanism"
1568 .cindex "queue runner"
1569 Exim's mechanism for retrying messages that fail to get delivered at the first
1570 attempt is the queue runner process. You must either run an Exim daemon that
1571 uses the &%-q%& option with a time interval to start queue runners at regular
1572 intervals or use some other means (such as &'cron'&) to start them. If you do
1573 not arrange for queue runners to be run, messages that fail temporarily at the
1574 first attempt will remain in your queue forever. A queue runner process works
1575 its way through the queue, one message at a time, trying each delivery that has
1576 passed its retry time.
1577 You can run several queue runners at once.
1578
1579 Exim uses a set of configured rules to determine when next to retry the failing
1580 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1581 should give up trying to deliver to the address, at which point it generates a
1582 bounce message. If no retry rules are set for a particular host, address, and
1583 error combination, no retries are attempted, and temporary errors are treated
1584 as permanent.
1585
1586
1587
1588 .subsection "Temporary delivery failure" SECID20
1589 .cindex "delivery" "temporary failure"
1590 There are many reasons why a message may not be immediately deliverable to a
1591 particular address. Failure to connect to a remote machine (because it, or the
1592 connection to it, is down) is one of the most common. Temporary failures may be
1593 detected during routing as well as during the transport stage of delivery.
1594 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1595 is on a file system where the user is over quota. Exim can be configured to
1596 impose its own quotas on local mailboxes; where system quotas are set they will
1597 also apply.
1598
1599 If a host is unreachable for a period of time, a number of messages may be
1600 waiting for it by the time it recovers, and sending them in a single SMTP
1601 connection is clearly beneficial. Whenever a delivery to a remote host is
1602 deferred,
1603 .cindex "hints database" "deferred deliveries"
1604 Exim makes a note in its hints database, and whenever a successful
1605 SMTP delivery has happened, it looks to see if any other messages are waiting
1606 for the same host. If any are found, they are sent over the same SMTP
1607 connection, subject to a configuration limit as to the maximum number in any
1608 one connection.
1609
1610
1611
1612 .subsection "Permanent delivery failure" SECID21
1613 .cindex "delivery" "permanent failure"
1614 .cindex "bounce message" "when generated"
1615 When a message cannot be delivered to some or all of its intended recipients, a
1616 bounce message is generated. Temporary delivery failures turn into permanent
1617 errors when their timeout expires. All the addresses that fail in a given
1618 delivery attempt are listed in a single message. If the original message has
1619 many recipients, it is possible for some addresses to fail in one delivery
1620 attempt and others to fail subsequently, giving rise to more than one bounce
1621 message. The wording of bounce messages can be customized by the administrator.
1622 See chapter &<<CHAPemsgcust>>& for details.
1623
1624 .cindex "&'X-Failed-Recipients:'& header line"
1625 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1626 failed addresses, for the benefit of programs that try to analyse such messages
1627 automatically.
1628
1629 .cindex "bounce message" "recipient of"
1630 A bounce message is normally sent to the sender of the original message, as
1631 obtained from the message's envelope. For incoming SMTP messages, this is the
1632 address given in the MAIL command. However, when an address is expanded via a
1633 forward or alias file, an alternative address can be specified for delivery
1634 failures of the generated addresses. For a mailing list expansion (see section
1635 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1636 of the list.
1637
1638
1639
1640 .subsection "Failures to deliver bounce messages" SECID22
1641 .cindex "bounce message" "failure to deliver"
1642 If a bounce message (either locally generated or received from a remote host)
1643 itself suffers a permanent delivery failure, the message is left in the queue,
1644 but it is frozen, awaiting the attention of an administrator. There are options
1645 that can be used to make Exim discard such failed messages, or to keep them
1646 for only a short time (see &%timeout_frozen_after%& and
1647 &%ignore_bounce_errors_after%&).
1648
1649
1650
1651
1652
1653 . ////////////////////////////////////////////////////////////////////////////
1654 . ////////////////////////////////////////////////////////////////////////////
1655
1656 .chapter "Building and installing Exim" "CHID3"
1657 .scindex IIDbuex "building Exim"
1658
1659 .section "Unpacking" "SECID23"
1660 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1661 creates a directory with the name of the current release (for example,
1662 &_exim-&version()_&) into which the following files are placed:
1663
1664 .table2 140pt
1665 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1666 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1667   documented"
1668 .irow &_LICENCE_&         "the GNU General Public Licence"
1669 .irow &_Makefile_&        "top-level make file"
1670 .irow &_NOTICE_&          "conditions for the use of Exim"
1671 .irow &_README_&          "list of files, directories and simple build &&&
1672   instructions"
1673 .endtable
1674
1675 Other files whose names begin with &_README_& may also be present. The
1676 following subdirectories are created:
1677
1678 .table2 140pt
1679 .irow &_Local_&           "an empty directory for local configuration files"
1680 .irow &_OS_&              "OS-specific files"
1681 .irow &_doc_&             "documentation files"
1682 .irow &_exim_monitor_&    "source files for the Exim monitor"
1683 .irow &_scripts_&         "scripts used in the build process"
1684 .irow &_src_&             "remaining source files"
1685 .irow &_util_&            "independent utilities"
1686 .endtable
1687
1688 The main utility programs are contained in the &_src_& directory and are built
1689 with the Exim binary. The &_util_& directory contains a few optional scripts
1690 that may be useful to some sites.
1691
1692
1693 .section "Multiple machine architectures and operating systems" "SECID24"
1694 .cindex "building Exim" "multiple OS/architectures"
1695 The building process for Exim is arranged to make it easy to build binaries for
1696 a number of different architectures and operating systems from the same set of
1697 source files. Compilation does not take place in the &_src_& directory.
1698 Instead, a &'build directory'& is created for each architecture and operating
1699 system.
1700 .cindex "symbolic link" "to build directory"
1701 Symbolic links to the sources are installed in this directory, which is where
1702 the actual building takes place. In most cases, Exim can discover the machine
1703 architecture and operating system for itself, but the defaults can be
1704 overridden if necessary.
1705 .cindex compiler requirements
1706 .cindex compiler version
1707 A C99-capable compiler will be required for the build.
1708
1709
1710 .section "PCRE2 library" "SECTpcre"
1711 .cindex "PCRE2 library"
1712 Exim no longer has an embedded regular-expression library as the vast majority of
1713 modern systems include PCRE2 as a system library, although you may need to
1714 install the PCRE2 package or the PCRE2 development package for your operating
1715 system. If your system has a normal PCRE2 installation the Exim build
1716 process will need no further configuration. If the library or the
1717 headers are in an unusual location you will need to either set the PCRE2_LIBS
1718 and INCLUDE directives appropriately,
1719 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1720 If your operating system has no
1721 PCRE2 support then you will need to obtain and build the current PCRE2
1722 from &url(https://github.com/PhilipHazel/pcre2/releases).
1723 More information on PCRE2 is available at &url(https://www.pcre.org/).
1724
1725 .section "DBM libraries" "SECTdb"
1726 .cindex "DBM libraries" "discussion of"
1727 .cindex "hints database" "DBM files used for"
1728 Even if you do not use any DBM files in your configuration, Exim still needs a
1729 DBM library in order to operate, because it uses indexed files for its hints
1730 databases. Unfortunately, there are a number of DBM libraries in existence, and
1731 different operating systems often have different ones installed.
1732
1733 .cindex "Solaris" "DBM library for"
1734 .cindex "IRIX, DBM library for"
1735 .cindex "BSD, DBM library for"
1736 .cindex "Linux, DBM library for"
1737 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1738 Linux distribution, the DBM configuration should happen automatically, and you
1739 may be able to ignore this section. Otherwise, you may have to learn more than
1740 you would like about DBM libraries from what follows.
1741
1742 .cindex "&'ndbm'& DBM library"
1743 Licensed versions of Unix normally contain a library of DBM functions operating
1744 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1745 versions of Unix seem to vary in what they contain as standard. In particular,
1746 some early versions of Linux have no default DBM library, and different
1747 distributors have chosen to bundle different libraries with their packaged
1748 versions. However, the more recent releases seem to have standardized on the
1749 Berkeley DB library.
1750
1751 Different DBM libraries have different conventions for naming the files they
1752 use. When a program opens a file called &_dbmfile_&, there are several
1753 possibilities:
1754
1755 .olist
1756 A traditional &'ndbm'& implementation, such as that supplied as part of
1757 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1758 .next
1759 .cindex "&'gdbm'& DBM library"
1760 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1761 compatibility interface it makes two different hard links to it with names
1762 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1763 filename is used unmodified.
1764 .next
1765 .cindex "Berkeley DB library"
1766 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1767 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1768 programmer exactly the same as the traditional &'ndbm'& implementation.
1769 .next
1770 If the Berkeley package is used in its native mode, it operates on a single
1771 file called &_dbmfile_&; the programmer's interface is somewhat different to
1772 the traditional &'ndbm'& interface.
1773 .next
1774 To complicate things further, there are several very different versions of the
1775 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1776 2.&'x'& and 3.&'x'& were current for a while,
1777 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1778 Maintenance of some of the earlier releases has ceased,
1779 and Exim no longer supports versions before 3.&'x'&.
1780 All versions of Berkeley DB could be obtained from
1781 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1782 page with far newer versions listed.
1783 It is probably wise to plan to move your storage configurations away from
1784 Berkeley DB format, as today there are smaller and simpler alternatives more
1785 suited to Exim's usage model.
1786 .next
1787 .cindex "&'tdb'& DBM library"
1788 Yet another DBM library, called &'tdb'&, is available from
1789 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1790 operates on a single file.
1791 .endlist
1792
1793 .cindex "USE_DB"
1794 .cindex "DBM libraries" "configuration for building"
1795 Exim and its utilities can be compiled to use any of these interfaces. In order
1796 to use any version of the Berkeley DB package in native mode, you must set
1797 USE_DB in an appropriate configuration file (typically
1798 &_Local/Makefile_&). For example:
1799 .code
1800 USE_DB=yes
1801 .endd
1802 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1803 error is diagnosed if you set more than one of these.
1804 You can set USE_NDBM if needed to override an operating system default.
1805
1806 At the lowest level, the build-time configuration sets none of these options,
1807 thereby assuming an interface of type (1). However, some operating system
1808 configuration files (for example, those for the BSD operating systems and
1809 Linux) assume type (4) by setting USE_DB as their default, and the
1810 configuration files for Cygwin set USE_GDBM. Anything you set in
1811 &_Local/Makefile_&, however, overrides these system defaults.
1812
1813 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1814 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1815 in one of these lines:
1816 .code
1817 DBMLIB = -ldb
1818 DBMLIB = -ltdb
1819 DBMLIB = -lgdbm -lgdbm_compat
1820 .endd
1821 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1822 Settings like that will work if the DBM library is installed in the standard
1823 place. Sometimes it is not, and the library's header file may also not be in
1824 the default path. You may need to set INCLUDE to specify where the header
1825 file is, and to specify the path to the library more fully in DBMLIB, as in
1826 this example:
1827 .code
1828 INCLUDE=-I/usr/local/include/db-4.1
1829 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1830 .endd
1831 There is further detailed discussion about the various DBM libraries in the
1832 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1833
1834
1835
1836 .section "Pre-building configuration" "SECID25"
1837 .cindex "building Exim" "pre-building configuration"
1838 .cindex "configuration for building Exim"
1839 .cindex "&_Local/Makefile_&"
1840 .cindex "&_src/EDITME_&"
1841 Before building Exim, a local configuration file that specifies options
1842 independent of any operating system has to be created with the name
1843 &_Local/Makefile_&. A template for this file is supplied as the file
1844 &_src/EDITME_&, and it contains full descriptions of all the option settings
1845 therein. These descriptions are therefore not repeated here. If you are
1846 building Exim for the first time, the simplest thing to do is to copy
1847 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1848
1849 There are three settings that you must supply, because Exim will not build
1850 without them. They are the location of the runtime configuration file
1851 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1852 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1853 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1854 a colon-separated list of filenames; Exim uses the first of them that exists.
1855
1856 There are a few other parameters that can be specified either at build time or
1857 at runtime, to enable the same binary to be used on a number of different
1858 machines. However, if the locations of Exim's spool directory and log file
1859 directory (if not within the spool directory) are fixed, it is recommended that
1860 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1861 detected early in Exim's execution (such as a malformed configuration file) can
1862 be logged.
1863
1864 .cindex "content scanning" "specifying at build time"
1865 Exim's interfaces for calling virus and spam scanning software directly from
1866 access control lists are not compiled by default. If you want to include these
1867 facilities, you need to set
1868 .code
1869 WITH_CONTENT_SCAN=yes
1870 .endd
1871 in your &_Local/Makefile_&. For details of the facilities themselves, see
1872 chapter &<<CHAPexiscan>>&.
1873
1874
1875 .cindex "&_Local/eximon.conf_&"
1876 .cindex "&_exim_monitor/EDITME_&"
1877 If you are going to build the Exim monitor, a similar configuration process is
1878 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1879 your installation and saved under the name &_Local/eximon.conf_&. If you are
1880 happy with the default settings described in &_exim_monitor/EDITME_&,
1881 &_Local/eximon.conf_& can be empty, but it must exist.
1882
1883 This is all the configuration that is needed in straightforward cases for known
1884 operating systems. However, the building process is set up so that it is easy
1885 to override options that are set by default or by operating-system-specific
1886 configuration files, for example, to change the C compiler, which
1887 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1888 do this.
1889
1890
1891
1892 .section "Support for iconv()" "SECID26"
1893 .cindex "&[iconv()]& support"
1894 .cindex "RFC 2047"
1895 The contents of header lines in messages may be encoded according to the rules
1896 described RFC 2047. This makes it possible to transmit characters that are not
1897 in the ASCII character set, and to label them as being in a particular
1898 character set. When Exim is inspecting header lines by means of the &%$h_%&
1899 mechanism, it decodes them, and translates them into a specified character set
1900 (default is set at build time). The translation is possible only if the operating system
1901 supports the &[iconv()]& function.
1902
1903 However, some of the operating systems that supply &[iconv()]& do not support
1904 very many conversions. The GNU &%libiconv%& library (available from
1905 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1906 systems to remedy this deficiency, as well as on systems that do not supply
1907 &[iconv()]& at all. After installing &%libiconv%&, you should add
1908 .code
1909 HAVE_ICONV=yes
1910 .endd
1911 to your &_Local/Makefile_& and rebuild Exim.
1912
1913
1914
1915 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1916 .cindex "TLS" "including support for TLS"
1917 .cindex "encryption" "including support for"
1918 .cindex "OpenSSL" "building Exim with"
1919 .cindex "GnuTLS" "building Exim with"
1920 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1921 command as per RFC 2487. It can also support clients that expect to
1922 start a TLS session immediately on connection to a non-standard port (see the
1923 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1924 line option).
1925
1926 If you want to build Exim with TLS support, you must first install either the
1927 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1928 implementing SSL.
1929
1930 If you do not want TLS support you should set
1931 .code
1932 DISABLE_TLS=yes
1933 .endd
1934 in &_Local/Makefile_&.
1935
1936 If OpenSSL is installed, you should set
1937 .code
1938 USE_OPENSL=yes
1939 TLS_LIBS=-lssl -lcrypto
1940 .endd
1941 in &_Local/Makefile_&. You may also need to specify the locations of the
1942 OpenSSL library and include files. For example:
1943 .code
1944 USE_OPENSSL=yes
1945 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1946 TLS_INCLUDE=-I/usr/local/openssl/include/
1947 .endd
1948 .cindex "pkg-config" "OpenSSL"
1949 If you have &'pkg-config'& available, then instead you can just use:
1950 .code
1951 USE_OPENSSL=yes
1952 USE_OPENSSL_PC=openssl
1953 .endd
1954 .cindex "USE_GNUTLS"
1955 If GnuTLS is installed, you should set
1956 .code
1957 USE_GNUTLS=yes
1958 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1959 .endd
1960 in &_Local/Makefile_&, and again you may need to specify the locations of the
1961 library and include files. For example:
1962 .code
1963 USE_GNUTLS=yes
1964 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1965 TLS_INCLUDE=-I/usr/gnu/include
1966 .endd
1967 .cindex "pkg-config" "GnuTLS"
1968 If you have &'pkg-config'& available, then instead you can just use:
1969 .code
1970 USE_GNUTLS=yes
1971 USE_GNUTLS_PC=gnutls
1972 .endd
1973
1974 You do not need to set TLS_INCLUDE if the relevant directory is already
1975 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1976 given in chapter &<<CHAPTLS>>&.
1977
1978
1979
1980
1981 .section "Use of tcpwrappers" "SECID27"
1982
1983 .cindex "tcpwrappers, building Exim to support"
1984 .cindex "USE_TCP_WRAPPERS"
1985 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1986 .cindex "tcp_wrappers_daemon_name"
1987 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1988 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1989 alternative to Exim's own checking facilities for installations that are
1990 already making use of &'tcpwrappers'& for other purposes. To do this, you
1991 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1992 &_tcpd.h_& to be available at compile time, and also ensure that the library
1993 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1994 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1995 you might have
1996 .code
1997 USE_TCP_WRAPPERS=yes
1998 CFLAGS=-O -I/usr/local/include
1999 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2000 .endd
2001 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2002 files is &"exim"&. For example, the line
2003 .code
2004 exim : LOCAL  192.168.1.  .friendly.domain.example
2005 .endd
2006 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2007 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2008 All other connections are denied. The daemon name used by &'tcpwrappers'&
2009 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2010 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2011 configure file. Consult the &'tcpwrappers'& documentation for
2012 further details.
2013
2014
2015 .section "Including support for IPv6" "SECID28"
2016 .cindex "IPv6" "including support for"
2017 Exim contains code for use on systems that have IPv6 support. Setting
2018 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2019 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2020 where the IPv6 support is not fully integrated into the normal include and
2021 library files.
2022
2023 Two different types of DNS record for handling IPv6 addresses have been
2024 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2025 currently seen as the mainstream. Another record type called A6 was proposed
2026 as better than AAAA because it had more flexibility. However, it was felt to be
2027 over-complex, and its status was reduced to &"experimental"&.
2028 Exim used to
2029 have a compile option for including A6 record support but this has now been
2030 withdrawn.
2031
2032
2033
2034 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2035 .cindex "lookup modules"
2036 .cindex "dynamic modules"
2037 .cindex ".so building"
2038 On some platforms, Exim supports not compiling all lookup types directly into
2039 the main binary, instead putting some into external modules which can be loaded
2040 on demand.
2041 This permits packagers to build Exim with support for lookups with extensive
2042 library dependencies without requiring all users to install all of those
2043 dependencies.
2044 Most, but not all, lookup types can be built this way.
2045
2046 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2047 installed; Exim will only load modules from that directory, as a security
2048 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2049 for your OS; see &_OS/Makefile-Linux_& for an example.
2050 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2051 see &_src/EDITME_& for details.
2052
2053 Then, for each module to be loaded dynamically, define the relevant
2054 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2055 For example, this will build in lsearch but load sqlite and mysql support
2056 on demand:
2057 .code
2058 LOOKUP_LSEARCH=yes
2059 LOOKUP_SQLITE=2
2060 LOOKUP_MYSQL=2
2061 .endd
2062
2063
2064 .section "The building process" "SECID29"
2065 .cindex "build directory"
2066 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2067 created, run &'make'& at the top level. It determines the architecture and
2068 operating system types, and creates a build directory if one does not exist.
2069 For example, on a Sun system running Solaris 8, the directory
2070 &_build-SunOS5-5.8-sparc_& is created.
2071 .cindex "symbolic link" "to source files"
2072 Symbolic links to relevant source files are installed in the build directory.
2073
2074 If this is the first time &'make'& has been run, it calls a script that builds
2075 a make file inside the build directory, using the configuration files from the
2076 &_Local_& directory. The new make file is then passed to another instance of
2077 &'make'&. This does the real work, building a number of utility scripts, and
2078 then compiling and linking the binaries for the Exim monitor (if configured), a
2079 number of utility programs, and finally Exim itself. The command &`make
2080 makefile`& can be used to force a rebuild of the make file in the build
2081 directory, should this ever be necessary.
2082
2083 If you have problems building Exim, check for any comments there may be in the
2084 &_README_& file concerning your operating system, and also take a look at the
2085 FAQ, where some common problems are covered.
2086
2087
2088
2089 .section 'Output from &"make"&' "SECID283"
2090 The output produced by the &'make'& process for compile lines is often very
2091 unreadable, because these lines can be very long. For this reason, the normal
2092 output is suppressed by default, and instead output similar to that which
2093 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2094 each module that is being compiled or linked. However, it is still possible to
2095 get the full output, by calling &'make'& like this:
2096 .code
2097 FULLECHO='' make -e
2098 .endd
2099 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2100 command reflection in &'make'&. When you ask for the full output, it is
2101 given in addition to the short output.
2102
2103
2104
2105 .section "Overriding build-time options for Exim" "SECToverride"
2106 .cindex "build-time options, overriding"
2107 The main make file that is created at the beginning of the building process
2108 consists of the concatenation of a number of files which set configuration
2109 values, followed by a fixed set of &'make'& instructions. If a value is set
2110 more than once, the last setting overrides any previous ones. This provides a
2111 convenient way of overriding defaults. The files that are concatenated are, in
2112 order:
2113 .display
2114 &_OS/Makefile-Default_&
2115 &_OS/Makefile-_&<&'ostype'&>
2116 &_Local/Makefile_&
2117 &_Local/Makefile-_&<&'ostype'&>
2118 &_Local/Makefile-_&<&'archtype'&>
2119 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2120 &_OS/Makefile-Base_&
2121 .endd
2122 .cindex "&_Local/Makefile_&"
2123 .cindex "building Exim" "operating system type"
2124 .cindex "building Exim" "architecture type"
2125 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2126 architecture type. &_Local/Makefile_& is required to exist, and the building
2127 process fails if it is absent. The other three &_Local_& files are optional,
2128 and are often not needed.
2129
2130 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2131 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2132 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2133 values are used, thereby providing a means of forcing particular settings.
2134 Otherwise, the scripts try to get values from the &%uname%& command. If this
2135 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2136 of &'ad hoc'& transformations are then applied, to produce the standard names
2137 that Exim expects. You can run these scripts directly from the shell in order
2138 to find out what values are being used on your system.
2139
2140
2141 &_OS/Makefile-Default_& contains comments about the variables that are set
2142 therein. Some (but not all) are mentioned below. If there is something that
2143 needs changing, review the contents of this file and the contents of the make
2144 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2145 default values are.
2146
2147
2148 .cindex "building Exim" "overriding default settings"
2149 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2150 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2151 need to change the original files. Instead, you should make the changes by
2152 putting the new values in an appropriate &_Local_& file. For example,
2153 .cindex "Tru64-Unix build-time settings"
2154 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2155 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2156 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2157 called with the option &%-std1%&, to make it recognize some of the features of
2158 Standard C that Exim uses. (Most other compilers recognize Standard C by
2159 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2160 containing the lines
2161 .code
2162 CC=cc
2163 CFLAGS=-std1
2164 .endd
2165 If you are compiling for just one operating system, it may be easier to put
2166 these lines directly into &_Local/Makefile_&.
2167
2168 Keeping all your local configuration settings separate from the distributed
2169 files makes it easy to transfer them to new versions of Exim simply by copying
2170 the contents of the &_Local_& directory.
2171
2172
2173 .cindex "NIS lookup type" "including support for"
2174 .cindex "NIS+ lookup type" "including support for"
2175 .cindex "LDAP" "including support for"
2176 .cindex "lookup" "inclusion in binary"
2177 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2178 lookup, but not all systems have these components installed, so the default is
2179 not to include the relevant code in the binary. All the different kinds of file
2180 and database lookup that Exim supports are implemented as separate code modules
2181 which are included only if the relevant compile-time options are set. In the
2182 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2183 .code
2184 LOOKUP_LDAP=yes
2185 LOOKUP_NIS=yes
2186 LOOKUP_NISPLUS=yes
2187 .endd
2188 and similar settings apply to the other lookup types. They are all listed in
2189 &_src/EDITME_&. In many cases the relevant include files and interface
2190 libraries need to be installed before compiling Exim.
2191 .cindex "cdb" "including support for"
2192 However, there are some optional lookup types (such as cdb) for which
2193 the code is entirely contained within Exim, and no external include
2194 files or libraries are required. When a lookup type is not included in the
2195 binary, attempts to configure Exim to use it cause runtime configuration
2196 errors.
2197
2198 .cindex "pkg-config" "lookups"
2199 .cindex "pkg-config" "authenticators"
2200 Many systems now use a tool called &'pkg-config'& to encapsulate information
2201 about how to compile against a library; Exim has some initial support for
2202 being able to use pkg-config for lookups and authenticators.  For any given
2203 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2204 variable with the &`_PC`& suffix in the name and assign as the value the
2205 name of the package to be queried.  The results of querying via the
2206 &'pkg-config'& command will be added to the appropriate Makefile variables
2207 with &`+=`& directives, so your version of &'make'& will need to support that
2208 syntax.  For instance:
2209 .code
2210 LOOKUP_SQLITE=yes
2211 LOOKUP_SQLITE_PC=sqlite3
2212 AUTH_GSASL=yes
2213 AUTH_GSASL_PC=libgsasl
2214 AUTH_HEIMDAL_GSSAPI=yes
2215 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2216 .endd
2217
2218 .cindex "Perl" "including support for"
2219 Exim can be linked with an embedded Perl interpreter, allowing Perl
2220 subroutines to be called during string expansion. To enable this facility,
2221 .code
2222 EXIM_PERL=perl.o
2223 .endd
2224 must be defined in &_Local/Makefile_&. Details of this facility are given in
2225 chapter &<<CHAPperl>>&.
2226
2227 .cindex "X11 libraries, location of"
2228 The location of the X11 libraries is something that varies a lot between
2229 operating systems, and there may be different versions of X11 to cope
2230 with. Exim itself makes no use of X11, but if you are compiling the Exim
2231 monitor, the X11 libraries must be available.
2232 The following three variables are set in &_OS/Makefile-Default_&:
2233 .code
2234 X11=/usr/X11R6
2235 XINCLUDE=-I$(X11)/include
2236 XLFLAGS=-L$(X11)/lib
2237 .endd
2238 These are overridden in some of the operating-system configuration files. For
2239 example, in &_OS/Makefile-SunOS5_& there is
2240 .code
2241 X11=/usr/openwin
2242 XINCLUDE=-I$(X11)/include
2243 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2244 .endd
2245 If you need to override the default setting for your operating system, place a
2246 definition of all three of these variables into your
2247 &_Local/Makefile-<ostype>_& file.
2248
2249 .cindex "EXTRALIBS"
2250 If you need to add any extra libraries to the link steps, these can be put in a
2251 variable called EXTRALIBS, which appears in all the link commands, but by
2252 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2253 command for linking the main Exim binary, and not for any associated utilities.
2254
2255 .cindex "DBM libraries" "configuration for building"
2256 There is also DBMLIB, which appears in the link commands for binaries that
2257 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2258 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2259 binary, and which can be used, for example, to include additional X11
2260 libraries.
2261
2262 .cindex "configuration file" "editing"
2263 The make file copes with rebuilding Exim correctly if any of the configuration
2264 files are edited. However, if an optional configuration file is deleted, it is
2265 necessary to touch the associated non-optional file (that is,
2266 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2267
2268
2269 .section "OS-specific header files" "SECID30"
2270 .cindex "&_os.h_&"
2271 .cindex "building Exim" "OS-specific C header files"
2272 The &_OS_& directory contains a number of files with names of the form
2273 &_os.h-<ostype>_&. These are system-specific C header files that should not
2274 normally need to be changed. There is a list of macro settings that are
2275 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2276 are porting Exim to a new operating system.
2277
2278
2279
2280 .section "Overriding build-time options for the monitor" "SECID31"
2281 .cindex "building Eximon"
2282 A similar process is used for overriding things when building the Exim monitor,
2283 where the files that are involved are
2284 .display
2285 &_OS/eximon.conf-Default_&
2286 &_OS/eximon.conf-_&<&'ostype'&>
2287 &_Local/eximon.conf_&
2288 &_Local/eximon.conf-_&<&'ostype'&>
2289 &_Local/eximon.conf-_&<&'archtype'&>
2290 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2291 .endd
2292 .cindex "&_Local/eximon.conf_&"
2293 As with Exim itself, the final three files need not exist, and in this case the
2294 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2295 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2296 variables of the same name, preceded by EXIMON_. For example, setting
2297 EXIMON_LOG_DEPTH in the environment overrides the value of
2298 LOG_DEPTH at runtime.
2299 .ecindex IIDbuex
2300
2301
2302 .section "Installing Exim binaries and scripts" "SECID32"
2303 .cindex "installing Exim"
2304 .cindex "BIN_DIRECTORY"
2305 The command &`make install`& runs the &(exim_install)& script with no
2306 arguments. The script copies binaries and utility scripts into the directory
2307 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2308 .cindex "setuid" "installing Exim with"
2309 The install script copies files only if they are newer than the files they are
2310 going to replace. The Exim binary is required to be owned by root and have the
2311 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2312 install`& as root so that it can set up the Exim binary in this way. However, in
2313 some special situations (for example, if a host is doing no local deliveries)
2314 it may be possible to run Exim without making the binary setuid root (see
2315 chapter &<<CHAPsecurity>>& for details).
2316
2317 .cindex "CONFIGURE_FILE"
2318 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2319 in &_Local/Makefile_&. If this names a single file, and the file does not
2320 exist, the default configuration file &_src/configure.default_& is copied there
2321 by the installation script. If a runtime configuration file already exists, it
2322 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2323 alternative files, no default is installed.
2324
2325 .cindex "system aliases file"
2326 .cindex "&_/etc/aliases_&"
2327 One change is made to the default configuration file when it is installed: the
2328 default configuration contains a router that references a system aliases file.
2329 The path to this file is set to the value specified by
2330 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2331 If the system aliases file does not exist, the installation script creates it,
2332 and outputs a comment to the user.
2333
2334 The created file contains no aliases, but it does contain comments about the
2335 aliases a site should normally have. Mail aliases have traditionally been
2336 kept in &_/etc/aliases_&. However, some operating systems are now using
2337 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2338 Exim's configuration if necessary.
2339
2340 The default configuration uses the local host's name as the only local domain,
2341 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2342 running as the local user. System aliases and &_.forward_& files in users' home
2343 directories are supported, but no NIS or NIS+ support is configured. Domains
2344 other than the name of the local host are routed using the DNS, with delivery
2345 over SMTP.
2346
2347 It is possible to install Exim for special purposes (such as building a binary
2348 distribution) in a private part of the file system. You can do this by a
2349 command such as
2350 .code
2351 make DESTDIR=/some/directory/ install
2352 .endd
2353 This has the effect of pre-pending the specified directory to all the file
2354 paths, except the name of the system aliases file that appears in the default
2355 configuration. (If a default alias file is created, its name &'is'& modified.)
2356 For backwards compatibility, ROOT is used if DESTDIR is not set,
2357 but this usage is deprecated.
2358
2359 .cindex "installing Exim" "what is not installed"
2360 Running &'make install'& does not copy the Exim 4 conversion script
2361 &'convert4r4'&. You will probably run this only once if you are
2362 upgrading from Exim 3. None of the documentation files in the &_doc_&
2363 directory are copied, except for the info files when you have set
2364 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2365
2366 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2367 to their names. The Exim binary itself, however, is handled differently. It is
2368 installed under a name that includes the version number and the compile number,
2369 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2370 called &_exim_& to point to the binary. If you are updating a previous version
2371 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2372 from the directory (as seen by other processes).
2373
2374 .cindex "installing Exim" "testing the script"
2375 If you want to see what the &'make install'& will do before running it for
2376 real, you can pass the &%-n%& option to the installation script by this
2377 command:
2378 .code
2379 make INSTALL_ARG=-n install
2380 .endd
2381 The contents of the variable INSTALL_ARG are passed to the installation
2382 script. You do not need to be root to run this test. Alternatively, you can run
2383 the installation script directly, but this must be from within the build
2384 directory. For example, from the top-level Exim directory you could use this
2385 command:
2386 .code
2387 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2388 .endd
2389 .cindex "installing Exim" "install script options"
2390 There are two other options that can be supplied to the installation script.
2391
2392 .ilist
2393 &%-no_chown%& bypasses the call to change the owner of the installed binary
2394 to root, and the call to make it a setuid binary.
2395 .next
2396 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2397 installed binary.
2398 .endlist
2399
2400 INSTALL_ARG can be used to pass these options to the script. For example:
2401 .code
2402 make INSTALL_ARG=-no_symlink install
2403 .endd
2404 The installation script can also be given arguments specifying which files are
2405 to be copied. For example, to install just the Exim binary, and nothing else,
2406 without creating the symbolic link, you could use:
2407 .code
2408 make INSTALL_ARG='-no_symlink exim' install
2409 .endd
2410
2411
2412
2413 .section "Installing info documentation" "SECTinsinfdoc"
2414 .cindex "installing Exim" "&'info'& documentation"
2415 Not all systems use the GNU &'info'& system for documentation, and for this
2416 reason, the Texinfo source of Exim's documentation is not included in the main
2417 distribution. Instead it is available separately from the FTP site (see section
2418 &<<SECTavail>>&).
2419
2420 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2421 source of the documentation is found in the source tree, running &`make
2422 install`& automatically builds the info files and installs them.
2423
2424
2425
2426 .section "Setting up the spool directory" "SECID33"
2427 .cindex "spool directory" "creating"
2428 When it starts up, Exim tries to create its spool directory if it does not
2429 exist. The Exim uid and gid are used for the owner and group of the spool
2430 directory. Sub-directories are automatically created in the spool directory as
2431 necessary.
2432
2433
2434
2435
2436 .section "Testing" "SECID34"
2437 .cindex "testing" "installation"
2438 Having installed Exim, you can check that the runtime configuration file is
2439 syntactically valid by running the following command, which assumes that the
2440 Exim binary directory is within your PATH environment variable:
2441 .code
2442 exim -bV
2443 .endd
2444 If there are any errors in the configuration file, Exim outputs error messages.
2445 Otherwise it outputs the version number and build date,
2446 the DBM library that is being used, and information about which drivers and
2447 other optional code modules are included in the binary.
2448 Some simple routing tests can be done by using the address testing option. For
2449 example,
2450 .display
2451 &`exim -bt`& <&'local username'&>
2452 .endd
2453 should verify that it recognizes a local mailbox, and
2454 .display
2455 &`exim -bt`& <&'remote address'&>
2456 .endd
2457 a remote one. Then try getting it to deliver mail, both locally and remotely.
2458 This can be done by passing messages directly to Exim, without going through a
2459 user agent. For example:
2460 .code
2461 exim -v postmaster@your.domain.example
2462 From: user@your.domain.example
2463 To: postmaster@your.domain.example
2464 Subject: Testing Exim
2465
2466 This is a test message.
2467 ^D
2468 .endd
2469 The &%-v%& option causes Exim to output some verification of what it is doing.
2470 In this case you should see copies of three log lines, one for the message's
2471 arrival, one for its delivery, and one containing &"Completed"&.
2472
2473 .cindex "delivery" "problems with"
2474 If you encounter problems, look at Exim's log files (&'mainlog'& and
2475 &'paniclog'&) to see if there is any relevant information there. Another source
2476 of information is running Exim with debugging turned on, by specifying the
2477 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2478 with debugging turned on by a command of the form
2479 .display
2480 &`exim -d -M`& <&'exim-message-id'&>
2481 .endd
2482 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2483 produces rather a lot of output, but you can cut this down to specific areas.
2484 For example, if you use &%-d-all+route%& only the debugging information
2485 relevant to routing is included. (See the &%-d%& option in chapter
2486 &<<CHAPcommandline>>& for more details.)
2487
2488 .cindex '&"sticky"& bit'
2489 .cindex "lock files"
2490 One specific problem that has shown up on some sites is the inability to do
2491 local deliveries into a shared mailbox directory, because it does not have the
2492 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2493 writing to a mailbox file, and if it cannot create the lock file, the delivery
2494 is deferred. You can get round this either by setting the &"sticky bit"& on the
2495 directory, or by setting a specific group for local deliveries and allowing
2496 that group to create files in the directory (see the comments above the
2497 &(local_delivery)& transport in the default configuration file). Another
2498 approach is to configure Exim not to use lock files, but just to rely on
2499 &[fcntl()]& locking instead. However, you should do this only if all user
2500 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2501 see chapter &<<CHAPappendfile>>&.
2502
2503 One thing that cannot be tested on a system that is already running an MTA is
2504 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2505 &%-oX%& option can be used to run an Exim daemon that listens on some other
2506 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2507 &'exim_checkaccess'& utility can be used to check out policy controls on
2508 incoming SMTP mail.
2509
2510 Testing a new version on a system that is already running Exim can most easily
2511 be done by building a binary with a different CONFIGURE_FILE setting. From
2512 within the runtime configuration, all other file and directory names
2513 that Exim uses can be altered, in order to keep it entirely clear of the
2514 production version.
2515
2516
2517 .section "Replacing another MTA with Exim" "SECID35"
2518 .cindex "replacing another MTA"
2519 Building and installing Exim for the first time does not of itself put it in
2520 general use. The name by which the system's MTA is called by mail user agents
2521 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2522 operating system), and it is necessary to make this name point to the &'exim'&
2523 binary in order to get the user agents to pass messages to Exim. This is
2524 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2525 or &_/usr/lib/sendmail_&
2526 .cindex "symbolic link" "to &'exim'& binary"
2527 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2528 privilege and executable status from the old MTA. It is then necessary to stop
2529 and restart the mailer daemon, if one is running.
2530
2531 .cindex "FreeBSD, MTA indirection"
2532 .cindex "&_/etc/mail/mailer.conf_&"
2533 Some operating systems have introduced alternative ways of switching MTAs. For
2534 example, if you are running FreeBSD, you need to edit the file
2535 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2536 described. A typical example of the contents of this file for running Exim is
2537 as follows:
2538 .code
2539 sendmail            /usr/exim/bin/exim
2540 send-mail           /usr/exim/bin/exim
2541 mailq               /usr/exim/bin/exim -bp
2542 newaliases          /usr/bin/true
2543 .endd
2544 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2545 your Exim installation is &"live"&. Check it by sending a message from your
2546 favourite user agent.
2547
2548 You should consider what to tell your users about the change of MTA. Exim may
2549 have different capabilities to what was previously running, and there are
2550 various operational differences such as the text of messages produced by
2551 command line options and in bounce messages. If you allow your users to make
2552 use of Exim's filtering capabilities, you should make the document entitled
2553 &'Exim's interface to mail filtering'& available to them.
2554
2555
2556
2557 .section "Running the daemon" SECTdaemonLaunch
2558 The most common command line for launching the Exim daemon looks like
2559 .code
2560 exim -bd -q5m
2561 .endd
2562 This starts a daemon which
2563 .ilist
2564 listens for incoming smtp connections, launching handler processes for
2565 each new one
2566 .next
2567 starts a queue-runner process every five minutes, to inspect queued messages
2568 and run delivery attempts on any that have arrived at their retry time
2569 .endlist
2570 Should a queue run take longer than the time between queue-runner starts,
2571 they will run in parallel.
2572 Numbers of jobs of the various types are subject to policy controls
2573 defined in the configuration.
2574
2575
2576 .section "Upgrading Exim" "SECID36"
2577 .cindex "upgrading Exim"
2578 If you are already running Exim on your host, building and installing a new
2579 version automatically makes it available to MUAs, or any other programs that
2580 call the MTA directly. However, if you are running an Exim daemon, you do need
2581 .cindex restart "on HUP signal"
2582 .cindex signal "HUP, to restart"
2583 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2584 new binary. You do not need to stop processing mail in order to install a new
2585 version of Exim. The install script does not modify an existing runtime
2586 configuration file.
2587
2588
2589
2590
2591 .section "Stopping the Exim daemon on Solaris" "SECID37"
2592 .cindex "Solaris" "stopping Exim on"
2593 The standard command for stopping the mailer daemon on Solaris is
2594 .code
2595 /etc/init.d/sendmail stop
2596 .endd
2597 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2598 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2599 for the text &"sendmail"&; this is not present because the actual program name
2600 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2601 solution is to replace the line that finds the process id with something like
2602 .code
2603 pid=`cat /var/spool/exim/exim-daemon.pid`
2604 .endd
2605 to obtain the daemon's pid directly from the file that Exim saves it in.
2606
2607 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2608 still be received from local processes, and if automatic delivery is configured
2609 (the normal case), deliveries will still occur.
2610
2611
2612
2613
2614 . ////////////////////////////////////////////////////////////////////////////
2615 . ////////////////////////////////////////////////////////////////////////////
2616
2617 .chapter "The Exim command line" "CHAPcommandline"
2618 .scindex IIDclo1 "command line" "options"
2619 .scindex IIDclo2 "options" "command line"
2620 Exim's command line takes the standard Unix form of a sequence of options,
2621 each starting with a hyphen character, followed by a number of arguments. The
2622 options are compatible with the main options of Sendmail, and there are also
2623 some additional options, some of which are compatible with Smail 3. Certain
2624 combinations of options do not make sense, and provoke an error if used.
2625 The form of the arguments depends on which options are set.
2626
2627
2628 .section "Setting options by program name" "SECID38"
2629 .cindex "&'mailq'&"
2630 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2631 were present before any other options.
2632 The &%-bp%& option requests a listing of the contents of the mail queue on the
2633 standard output.
2634 This feature is for compatibility with some systems that contain a command of
2635 that name in one of the standard libraries, symbolically linked to
2636 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2637
2638 .cindex "&'rsmtp'&"
2639 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2640 were present before any other options, for compatibility with Smail. The
2641 &%-bS%& option is used for reading in a number of messages in batched SMTP
2642 format.
2643
2644 .cindex "&'rmail'&"
2645 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2646 &%-oee%& options were present before any other options, for compatibility with
2647 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2648
2649 .cindex "&'runq'&"
2650 .cindex "queue runner"
2651 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2652 were present before any other options, for compatibility with Smail. The &%-q%&
2653 option causes a single queue runner process to be started.
2654
2655 .cindex "&'newaliases'&"
2656 .cindex "alias file" "building"
2657 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2658 If Exim is called under the name &'newaliases'& it behaves as if the option
2659 &%-bi%& were present before any other options, for compatibility with Sendmail.
2660 This option is used for rebuilding Sendmail's alias file. Exim does not have
2661 the concept of a single alias file, but can be configured to run a given
2662 command if called with the &%-bi%& option.
2663
2664
2665 .section "Trusted and admin users" "SECTtrustedadmin"
2666 Some Exim options are available only to &'trusted users'& and others are
2667 available only to &'admin users'&. In the description below, the phrases &"Exim
2668 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2669 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2670 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2671
2672 .ilist
2673 .cindex "trusted users" "definition of"
2674 .cindex "user" "trusted definition of"
2675 The trusted users are root, the Exim user, any user listed in the
2676 &%trusted_users%& configuration option, and any user whose current group or any
2677 supplementary group is one of those listed in the &%trusted_groups%&
2678 configuration option. Note that the Exim group is not automatically trusted.
2679
2680 .cindex '&"From"& line'
2681 .cindex "envelope from"
2682 .cindex "envelope sender"
2683 Trusted users are always permitted to use the &%-f%& option or a leading
2684 &"From&~"& line to specify the envelope sender of a message that is passed to
2685 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2686 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2687 users to set envelope senders.
2688
2689 .chindex From:
2690 .chindex Sender:
2691 For a trusted user, there is never any check on the contents of the &'From:'&
2692 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2693 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2694
2695 Trusted users may also specify a host name, host address, interface address,
2696 protocol name, ident value, and authentication data when submitting a message
2697 locally. Thus, they are able to insert messages into Exim's queue locally that
2698 have the characteristics of messages received from a remote host. Untrusted
2699 users may in some circumstances use &%-f%&, but can never set the other values
2700 that are available to trusted users.
2701 .next
2702 .cindex "user" "admin definition of"
2703 .cindex "admin user" "definition of"
2704 The admin users are root, the Exim user, and any user that is a member of the
2705 Exim group or of any group listed in the &%admin_groups%& configuration option.
2706 The current group does not have to be one of these groups.
2707
2708 Admin users are permitted to list the queue, and to carry out certain
2709 operations on messages, for example, to force delivery failures. It is also
2710 necessary to be an admin user in order to see the full information provided by
2711 the Exim monitor, and full debugging output.
2712
2713 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2714 Exim to attempt delivery of messages on its queue is restricted to admin users.
2715 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2716 option false (that is, specifying &%no_prod_requires_admin%&).
2717
2718 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2719 is restricted to admin users unless &%queue_list_requires_admin%& is set
2720 false.
2721 .endlist
2722
2723
2724 &*Warning*&: If you configure your system so that admin users are able to
2725 edit Exim's configuration file, you are giving those users an easy way of
2726 getting root. There is further discussion of this issue at the start of chapter
2727 &<<CHAPconf>>&.
2728
2729
2730
2731
2732 .section "Command line options" "SECID39"
2733 Exim's command line options are described in alphabetical order below. If none
2734 of the options that specifies a specific action (such as starting the daemon or
2735 a queue runner, or testing an address, or receiving a message in a specific
2736 format, or listing the queue) are present, and there is at least one argument
2737 on the command line, &%-bm%& (accept a local message on the standard input,
2738 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2739 outputs a brief message about itself and exits.
2740
2741 . ////////////////////////////////////////////////////////////////////////////
2742 . Insert a stylized XML comment here, to identify the start of the command line
2743 . options. This is for the benefit of the Perl script that automatically
2744 . creates a man page for the options.
2745 . ////////////////////////////////////////////////////////////////////////////
2746
2747 .literal xml
2748 <!-- === Start of command line options === -->
2749 .literal off
2750
2751
2752 .vlist
2753 .cmdopt "--" "--"
2754 .cindex "options" "command line; terminating"
2755 This is a pseudo-option whose only purpose is to terminate the options and
2756 therefore to cause subsequent command line items to be treated as arguments
2757 rather than options, even if they begin with hyphens.
2758
2759 .cmdopt --help
2760 This option causes Exim to output a few sentences stating what it is.
2761 The same output is generated if the Exim binary is called with no options and
2762 no arguments.
2763
2764 .cmdopt --version
2765 This option is an alias for &%-bV%& and causes version information to be
2766 displayed.
2767
2768 .vitem &%-Ac%& &&&
2769        &%-Am%&
2770 .oindex "&%-Ac%&"
2771 .oindex "&%-Am%&"
2772 These options are used by Sendmail for selecting configuration files and are
2773 ignored by Exim.
2774
2775 .cmdopt -B <&'type'&>
2776 .oindex "&%-B%&"
2777 .cindex "8-bit characters"
2778 .cindex "Sendmail compatibility" "8-bit characters"
2779 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2780 clean; it ignores this option.
2781
2782 .cmdopt -bd
2783 .cindex "daemon"
2784 .cindex "SMTP" "listener"
2785 .cindex "queue runner"
2786 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2787 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2788 that the daemon should also initiate periodic queue runs.
2789
2790 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2791 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2792 disconnect from the controlling terminal. When running this way, it can be
2793 stopped by pressing ctrl-C.
2794
2795 By default, Exim listens for incoming connections to the standard SMTP port on
2796 all the host's running interfaces. However, it is possible to listen on other
2797 ports, on multiple ports, and only on specific interfaces. Chapter
2798 &<<CHAPinterfaces>>& contains a description of the options that control this.
2799
2800 When a listening daemon
2801 .cindex "daemon" "process id (pid)"
2802 .cindex "pid (process id)" "of daemon"
2803 is started without the use of &%-oX%& (that is, without overriding the normal
2804 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2805 in Exim's spool directory. This location can be overridden by setting
2806 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2807 running as root.
2808
2809 When &%-oX%& is used on the command line to start a listening daemon, the
2810 process id is not written to the normal pid file path. However, &%-oP%& can be
2811 used to specify a path on the command line if a pid file is required.
2812
2813 The SIGHUP signal
2814 .cindex "SIGHUP"
2815 .cindex restart "on HUP signal"
2816 .cindex signal "HUP, to restart"
2817 .cindex "daemon" "restarting"
2818 .cindex signal "to reload configuration"
2819 .cindex daemon "reload configuration"
2820 .cindex reload configuration
2821 can be used to cause the daemon to re-execute itself. This should be done
2822 whenever Exim's configuration file, or any file that is incorporated into it by
2823 means of the &%.include%& facility, is changed, and also whenever a new version
2824 of Exim is installed. It is not necessary to do this when other files that are
2825 referenced from the configuration (for example, alias files) are changed,
2826 because these are reread each time they are used.
2827
2828 .new
2829 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2830 to cleanly shut down.
2831 Subprocesses handling recceiving or delivering messages,
2832 or for scanning the queue,
2833 will not be affected by the termination of the daemon process.
2834 .wen
2835
2836 .cmdopt -bdf
2837 This option has the same effect as &%-bd%& except that it never disconnects
2838 from the controlling terminal, even when no debugging is specified.
2839
2840 .cmdopt -be
2841 .cindex "testing" "string expansion"
2842 .cindex "expansion" "testing"
2843 Run Exim in expansion testing mode. Exim discards its root privilege, to
2844 prevent ordinary users from using this mode to read otherwise inaccessible
2845 files. If no arguments are given, Exim runs interactively, prompting for lines
2846 of data. Otherwise, it processes each argument in turn.
2847
2848 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2849 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2850 used without command line arguments. If successful, it uses the &[readline()]&
2851 function, which provides extensive line-editing facilities, for reading the
2852 test data. A line history is supported.
2853
2854 Long expansion expressions can be split over several lines by using backslash
2855 continuations. As in Exim's runtime configuration, white space at the start of
2856 continuation lines is ignored. Each argument or data line is passed through the
2857 string expansion mechanism, and the result is output. Variable values from the
2858 configuration file (for example, &$qualify_domain$&) are available, but no
2859 message-specific values (such as &$message_exim_id$&) are set, because no message
2860 is being processed (but see &%-bem%& and &%-Mset%&).
2861
2862 &*Note*&: If you use this mechanism to test lookups, and you change the data
2863 files or databases you are using, you must exit and restart Exim before trying
2864 the same lookup again. Otherwise, because each Exim process caches the results
2865 of lookups, you will just get the same result as before.
2866
2867 Macro processing is done on lines before string-expansion: new macros can be
2868 defined and macros will be expanded.
2869 Because macros in the config file are often used for secrets, those are only
2870 available to admin users.
2871
2872 .new
2873 The word &"set"& at the start of a line, followed by a single space,
2874 is recognised specially as defining a value for a variable.
2875 The syntax is otherwise the same as the ACL modifier &"set ="&.
2876 .wen
2877
2878 .cmdopt -bem <&'filename'&>
2879 .cindex "testing" "string expansion"
2880 .cindex "expansion" "testing"
2881 This option operates like &%-be%& except that it must be followed by the name
2882 of a file. For example:
2883 .code
2884 exim -bem /tmp/testmessage
2885 .endd
2886 The file is read as a message (as if receiving a locally-submitted non-SMTP
2887 message) before any of the test expansions are done. Thus, message-specific
2888 variables such as &$message_size$& and &$header_from:$& are available. However,
2889 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2890 recipients are read from the headers in the normal way, and are shown in the
2891 &$recipients$& variable. Note that recipients cannot be given on the command
2892 line, because further arguments are taken as strings to expand (just like
2893 &%-be%&).
2894
2895 .cmdopt -bF <&'filename'&>
2896 .cindex "system filter" "testing"
2897 .cindex "testing" "system filter"
2898 This option is the same as &%-bf%& except that it assumes that the filter being
2899 tested is a system filter. The additional commands that are available only in
2900 system filters are recognized.
2901
2902 .cmdopt -bf <&'filename'&>
2903 .cindex "filter" "testing"
2904 .cindex "testing" "filter file"
2905 .cindex "forward file" "testing"
2906 .cindex "testing" "forward file"
2907 .cindex "Sieve filter" "testing"
2908 This option runs Exim in user filter testing mode; the file is the filter file
2909 to be tested, and a test message must be supplied on the standard input. If
2910 there are no message-dependent tests in the filter, an empty file can be
2911 supplied.
2912
2913 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2914 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2915 filter and a user filter in the same run. For example:
2916 .code
2917 exim -bF /system/filter -bf /user/filter </test/message
2918 .endd
2919 This is helpful when the system filter adds header lines or sets filter
2920 variables that are used by the user filter.
2921
2922 If the test filter file does not begin with one of the special lines
2923 .code
2924 # Exim filter
2925 # Sieve filter
2926 .endd
2927 it is taken to be a normal &_.forward_& file, and is tested for validity under
2928 that interpretation. See sections &<<SECTitenonfilred>>& to
2929 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2930 redirection lists.
2931
2932 The result of an Exim command that uses &%-bf%&, provided no errors are
2933 detected, is a list of the actions that Exim would try to take if presented
2934 with the message for real. More details of filter testing are given in the
2935 separate document entitled &'Exim's interfaces to mail filtering'&.
2936
2937 When testing a filter file,
2938 .cindex "&""From""& line"
2939 .cindex "envelope from"
2940 .cindex "envelope sender"
2941 .oindex "&%-f%&" "for filter testing"
2942 the envelope sender can be set by the &%-f%& option,
2943 or by a &"From&~"& line at the start of the test message. Various parameters
2944 that would normally be taken from the envelope recipient address of the message
2945 can be set by means of additional command line options (see the next four
2946 options).
2947
2948 .cmdopt -bfd <&'domain'&>
2949 .vindex "&$qualify_domain$&"
2950 This sets the domain of the recipient address when a filter file is being
2951 tested by means of the &%-bf%& option. The default is the value of
2952 &$qualify_domain$&.
2953
2954 .cmdopt -bfl <&'local&~part'&>
2955 This sets the local part of the recipient address when a filter file is being
2956 tested by means of the &%-bf%& option. The default is the username of the
2957 process that calls Exim. A local part should be specified with any prefix or
2958 suffix stripped, because that is how it appears to the filter when a message is
2959 actually being delivered.
2960
2961 .cmdopt -bfp <&'prefix'&>
2962 .cindex affix "filter testing"
2963 This sets the prefix of the local part of the recipient address when a filter
2964 file is being tested by means of the &%-bf%& option. The default is an empty
2965 prefix.
2966
2967 .cmdopt -bfs <&'suffix'&>
2968 .cindex affix "filter testing"
2969 This sets the suffix of the local part of the recipient address when a filter
2970 file is being tested by means of the &%-bf%& option. The default is an empty
2971 suffix.
2972
2973 .cmdopt -bh <&'IP&~address'&>
2974 .cindex "testing" "incoming SMTP"
2975 .cindex "SMTP" "testing incoming"
2976 .cindex "testing" "relay control"
2977 .cindex "relaying" "testing configuration"
2978 .cindex "policy control" "testing"
2979 .cindex "debugging" "&%-bh%& option"
2980 This option runs a fake SMTP session as if from the given IP address, using the
2981 standard input and output. The IP address may include a port number at the end,
2982 after a full stop. For example:
2983 .code
2984 exim -bh 10.9.8.7.1234
2985 exim -bh fe80::a00:20ff:fe86:a061.5678
2986 .endd
2987 When an IPv6 address is given, it is converted into canonical form. In the case
2988 of the second example above, the value of &$sender_host_address$& after
2989 conversion to the canonical form is
2990 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2991
2992 Comments as to what is going on are written to the standard error file. These
2993 include lines beginning with &"LOG"& for anything that would have been logged.
2994 This facility is provided for testing configuration options for incoming
2995 messages, to make sure they implement the required policy. For example, you can
2996 test your relay controls using &%-bh%&.
2997
2998 &*Warning 1*&:
2999 .cindex "RFC 1413"
3000 You can test features of the configuration that rely on ident (RFC 1413)
3001 information by using the &%-oMt%& option. However, Exim cannot actually perform
3002 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3003 connection.
3004
3005 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3006 are also skipped when testing using &%-bh%&. If you want these callouts to
3007 occur, use &%-bhc%& instead.
3008
3009 Messages supplied during the testing session are discarded, and nothing is
3010 written to any of the real log files. There may be pauses when DNS (and other)
3011 lookups are taking place, and of course these may time out. The &%-oMi%& option
3012 can be used to specify a specific IP interface and port if this is important,
3013 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3014 session were authenticated.
3015
3016 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3017 output just states whether a given recipient address from a given host is
3018 acceptable or not. See section &<<SECTcheckaccess>>&.
3019
3020 Features such as authentication and encryption, where the client input is not
3021 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3022 specialized SMTP test program such as
3023 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3024
3025 .cmdopt -bhc <&'IP&~address'&>
3026 This option operates in the same way as &%-bh%&, except that address
3027 verification callouts are performed if required. This includes consulting and
3028 updating the callout cache database.
3029
3030 .cmdopt -bi
3031 .cindex "alias file" "building"
3032 .cindex "building alias file"
3033 .cindex "Sendmail compatibility" "&%-bi%& option"
3034 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3035 Exim does not have the concept of a single alias file, and so it cannot mimic
3036 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3037 tend to appear in various scripts such as NIS make files, so the option must be
3038 recognized.
3039
3040 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3041 configuration option is run, under the uid and gid of the caller of Exim. If
3042 the &%-oA%& option is used, its value is passed to the command as an argument.
3043 The command set by &%bi_command%& may not contain arguments. The command can
3044 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3045 if this is required. If the &%bi_command%& option is not set, calling Exim with
3046 &%-bi%& is a no-op.
3047
3048 . // Keep :help first, then the rest in alphabetical order
3049 .cmdopt -bI:help
3050 .cindex "querying exim information"
3051 We shall provide various options starting &`-bI:`& for querying Exim for
3052 information.  The output of many of these will be intended for machine
3053 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3054 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3055 options shall cause Exim to exit after producing the requested output.
3056
3057 .cmdopt -bI:dscp
3058 .cindex "DSCP" "values"
3059 This option causes Exim to emit an alphabetically sorted list of all
3060 recognised DSCP names.
3061
3062 .cmdopt -bI:sieve
3063 .cindex "Sieve filter" "capabilities"
3064 This option causes Exim to emit an alphabetically sorted list of all supported
3065 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3066 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3067 &`SIEVE`& capability response line.  As the precise list may depend upon
3068 compile-time build options, which this option will adapt to, this is the only
3069 way to guarantee a correct response.
3070
3071 .cmdopt -bm
3072 .cindex "local message reception"
3073 This option runs an Exim receiving process that accepts an incoming,
3074 locally-generated message on the standard input. The recipients are given as the
3075 command arguments (except when &%-t%& is also present &-- see below). Each
3076 argument can be a comma-separated list of RFC 2822 addresses. This is the
3077 default option for selecting the overall action of an Exim call; it is assumed
3078 if no other conflicting option is present.
3079
3080 If any addresses in the message are unqualified (have no domain), they are
3081 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3082 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3083 suppressing this for special cases.
3084
3085 Policy checks on the contents of local messages can be enforced by means of
3086 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3087
3088 .cindex "return code" "for &%-bm%&"
3089 The return code is zero if the message is successfully accepted. Otherwise, the
3090 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3091
3092 The format
3093 .cindex "message" "format"
3094 .cindex "format" "message"
3095 .cindex "&""From""& line"
3096 .cindex "UUCP" "&""From""& line"
3097 .cindex "Sendmail compatibility" "&""From""& line"
3098 of the message must be as defined in RFC 2822, except that, for
3099 compatibility with Sendmail and Smail, a line in one of the forms
3100 .code
3101 From sender Fri Jan  5 12:55 GMT 1997
3102 From sender Fri, 5 Jan 97 12:55:01
3103 .endd
3104 (with the weekday optional, and possibly with additional text after the date)
3105 is permitted to appear at the start of the message. There appears to be no
3106 authoritative specification of the format of this line. Exim recognizes it by
3107 matching against the regular expression defined by the &%uucp_from_pattern%&
3108 option, which can be changed if necessary.
3109
3110 .oindex "&%-f%&" "overriding &""From""& line"
3111 The specified sender is treated as if it were given as the argument to the
3112 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3113 preference to the address taken from the message. The caller of Exim must be a
3114 trusted user for the sender of a message to be set in this way.
3115
3116 .cmdopt -bmalware <&'filename'&>
3117 .cindex "testing", "malware"
3118 .cindex "malware scan test"
3119 This debugging option causes Exim to scan the given file or directory
3120 (depending on the used scanner interface),
3121 using the malware scanning framework.  The option of &%av_scanner%& influences
3122 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3123 the expansion should have defaults which apply to this invocation.  ACLs are
3124 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3125 will never be populated and &%-bmalware%& will fail.
3126
3127 Exim will have changed working directory before resolving the filename, so
3128 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3129 user when it tries to open the file, rather than as the invoking user.
3130 This option requires admin privileges.
3131
3132 The &%-bmalware%& option will not be extended to be more generally useful,
3133 there are better tools for file-scanning.  This option exists to help
3134 administrators verify their Exim and AV scanner configuration.
3135
3136 .cmdopt -bnq
3137 .cindex "address qualification, suppressing"
3138 By default, Exim automatically qualifies unqualified addresses (those
3139 without domains) that appear in messages that are submitted locally (that
3140 is, not over TCP/IP). This qualification applies both to addresses in
3141 envelopes, and addresses in header lines. Sender addresses are qualified using
3142 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3143 defaults to the value of &%qualify_domain%&).
3144
3145 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3146 being used to re-submit messages that originally came from remote hosts after
3147 content scanning, you probably do not want to qualify unqualified addresses in
3148 header lines. (Such lines will be present only if you have not enabled a header
3149 syntax check in the appropriate ACL.)
3150
3151 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3152 messages that originate on the local host. When this is used, unqualified
3153 addresses in the envelope provoke errors (causing message rejection) and
3154 unqualified addresses in header lines are left alone.
3155
3156
3157 .cmdopt -bP
3158 .cindex "configuration options" "extracting"
3159 .cindex "options" "configuration &-- extracting"
3160 If this option is given with no arguments, it causes the values of all Exim's
3161 main configuration options to be written to the standard output. The values
3162 of one or more specific options can be requested by giving their names as
3163 arguments, for example:
3164 .code
3165 exim -bP qualify_domain hold_domains
3166 .endd
3167 .cindex "hiding configuration option values"
3168 .cindex "configuration options" "hiding value of"
3169 .cindex "options" "hiding value of"
3170 However, any option setting that is preceded by the word &"hide"& in the
3171 configuration file is not shown in full, except to an admin user. For other
3172 users, the output is as in this example:
3173 .code
3174 mysql_servers = <value not displayable>
3175 .endd
3176 If &%config%& is given as an argument, the config is
3177 output, as it was parsed, any include file resolved, any comment removed.
3178
3179 If &%config_file%& is given as an argument, the name of the runtime
3180 configuration file is output. (&%configure_file%& works too, for
3181 backward compatibility.)
3182 If a list of configuration files was supplied, the value that is output here
3183 is the name of the file that was actually used.
3184
3185 .cindex "options" "hiding name of"
3186 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3187 name will not be output.
3188
3189 .cindex "daemon" "process id (pid)"
3190 .cindex "pid (process id)" "of daemon"
3191 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3192 directories where log files and daemon pid files are written are output,
3193 respectively. If these values are unset, log files are written in a
3194 sub-directory of the spool directory called &%log%&, and the pid file is
3195 written directly into the spool directory.
3196
3197 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3198 .code
3199 exim -bP +local_domains
3200 .endd
3201 it searches for a matching named list of any type (domain, host, address, or
3202 local part) and outputs what it finds.
3203
3204 .cindex "options" "router &-- extracting"
3205 .cindex "options" "transport &-- extracting"
3206 .cindex "options" "authenticator &-- extracting"
3207 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3208 followed by the name of an appropriate driver instance, the option settings for
3209 that driver are output. For example:
3210 .code
3211 exim -bP transport local_delivery
3212 .endd
3213 The generic driver options are output first, followed by the driver's private
3214 options. A list of the names of drivers of a particular type can be obtained by
3215 using one of the words &%router_list%&, &%transport_list%&, or
3216 &%authenticator_list%&, and a complete list of all drivers with their option
3217 settings can be obtained by using &%routers%&, &%transports%&, or
3218 &%authenticators%&.
3219
3220 .cindex "environment"
3221 If &%environment%& is given as an argument, the set of environment
3222 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3223 variables.
3224
3225 .cindex "options" "macro &-- extracting"
3226 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3227 are available, similarly to the drivers.  Because macros are sometimes used
3228 for storing passwords, this option is restricted.
3229 The output format is one item per line.
3230 For the "-bP macro <name>" form, if no such macro is found
3231 the exit status will be nonzero.
3232
3233 .cmdopt -bp
3234 .cindex "queue" "listing messages in"
3235 .cindex "listing" "messages in the queue"
3236 This option requests a listing of the contents of the mail queue on the
3237 standard output. If the &%-bp%& option is followed by a list of message ids,
3238 just those messages are listed. By default, this option can be used only by an
3239 admin user. However, the &%queue_list_requires_admin%& option can be set false
3240 to allow any user to see the queue.
3241
3242 Each message in the queue is displayed as in the following example:
3243 .code
3244 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3245           red.king@looking-glass.fict.example
3246           <other addresses>
3247 .endd
3248 .cindex "message" "size in queue listing"
3249 .cindex "size" "of message"
3250 The first line contains the length of time the message has been in the queue
3251 (in this case 25 minutes), the size of the message (2.9K), the unique local
3252 identifier for the message, and the message sender, as contained in the
3253 envelope. For bounce messages, the sender address is empty, and appears as
3254 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3255 the default sender address, the user's login name is shown in parentheses
3256 before the sender address.
3257
3258 .cindex "frozen messages" "in queue listing"
3259 If the message is frozen (attempts to deliver it are suspended) then the text
3260 &"*** frozen ***"& is displayed at the end of this line.
3261
3262 The recipients of the message (taken from the envelope, not the headers) are
3263 displayed on subsequent lines. Those addresses to which the message has already
3264 been delivered are marked with the letter D. If an original address gets
3265 expanded into several addresses via an alias or forward file, the original is
3266 displayed with a D only when deliveries for all of its child addresses are
3267 complete.
3268
3269
3270 .cmdopt -bpa
3271 This option operates like &%-bp%&, but in addition it shows delivered addresses
3272 that were generated from the original top level address(es) in each message by
3273 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3274 of just &"D"&.
3275
3276
3277 .cmdopt -bpc
3278 .cindex "queue" "count of messages on"
3279 This option counts the number of messages in the queue, and writes the total
3280 to the standard output. It is restricted to admin users, unless
3281 &%queue_list_requires_admin%& is set false.
3282
3283
3284 .cmdopt -bpi
3285 .cindex queue "list of message IDs"
3286 This option operates like &%-bp%&, but only outputs message ids
3287 (one per line).
3288
3289
3290 .cmdopt -bpr
3291 This option operates like &%-bp%&, but the output is not sorted into
3292 chronological order of message arrival. This can speed it up when there are
3293 lots of messages in the queue, and is particularly useful if the output is
3294 going to be post-processed in a way that doesn't need the sorting.
3295
3296 .cmdopt -bpra
3297 This option is a combination of &%-bpr%& and &%-bpa%&.
3298
3299 .cmdopt -bpri
3300 This option is a combination of &%-bpr%& and &%-bpi%&.
3301
3302 .cmdopt -bpru
3303 This option is a combination of &%-bpr%& and &%-bpu%&.
3304
3305
3306 .cmdopt -bpu
3307 This option operates like &%-bp%& but shows only undelivered top-level
3308 addresses for each message displayed. Addresses generated by aliasing or
3309 forwarding are not shown, unless the message was deferred after processing by a
3310 router with the &%one_time%& option set.
3311
3312
3313 .cmdopt -brt
3314 .cindex "testing" "retry configuration"
3315 .cindex "retry" "configuration testing"
3316 This option is for testing retry rules, and it must be followed by up to three
3317 arguments. It causes Exim to look for a retry rule that matches the values
3318 and to write it to the standard output. For example:
3319 .code
3320 exim -brt bach.comp.mus.example
3321 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3322 .endd
3323 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3324 argument, which is required, can be a complete address in the form
3325 &'local_part@domain'&, or it can be just a domain name. If the second argument
3326 contains a dot, it is interpreted as an optional second domain name; if no
3327 retry rule is found for the first argument, the second is tried. This ties in
3328 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3329 rule is found that matches the host, one that matches the mail domain is
3330 sought. Finally, an argument that is the name of a specific delivery error, as
3331 used in setting up retry rules, can be given. For example:
3332 .code
3333 exim -brt haydn.comp.mus.example quota_3d
3334 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3335 .endd
3336
3337 .cmdopt -brw
3338 .cindex "testing" "rewriting"
3339 .cindex "rewriting" "testing"
3340 This option is for testing address rewriting rules, and it must be followed by
3341 a single argument, consisting of either a local part without a domain, or a
3342 complete address with a fully qualified domain. Exim outputs how this address
3343 would be rewritten for each possible place it might appear. See chapter
3344 &<<CHAPrewrite>>& for further details.
3345
3346 .cmdopt -bS
3347 .cindex "SMTP" "batched incoming"
3348 .cindex "batched SMTP input"
3349 This option is used for batched SMTP input, which is an alternative interface
3350 for non-interactive local message submission. A number of messages can be
3351 submitted in a single run. However, despite its name, this is not really SMTP
3352 input. Exim reads each message's envelope from SMTP commands on the standard
3353 input, but generates no responses. If the caller is trusted, or
3354 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3355 believed; otherwise the sender is always the caller of Exim.
3356
3357 The message itself is read from the standard input, in SMTP format (leading
3358 dots doubled), terminated by a line containing just a single dot. An error is
3359 provoked if the terminating dot is missing. A further message may then follow.
3360
3361 As for other local message submissions, the contents of incoming batch SMTP
3362 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3363 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3364 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3365
3366 Some other SMTP commands are recognized in the input. HELO and EHLO act
3367 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3368 QUIT quits, ignoring the rest of the standard input.
3369
3370 .cindex "return code" "for &%-bS%&"
3371 If any error is encountered, reports are written to the standard output and
3372 error streams, and Exim gives up immediately. The return code is 0 if no error
3373 was detected; it is 1 if one or more messages were accepted before the error
3374 was detected; otherwise it is 2.
3375
3376 More details of input using batched SMTP are given in section
3377 &<<SECTincomingbatchedSMTP>>&.
3378
3379 .cmdopt -bs
3380 .cindex "SMTP" "local input"
3381 .cindex "local SMTP input"
3382 This option causes Exim to accept one or more messages by reading SMTP commands
3383 on the standard input, and producing SMTP replies on the standard output. SMTP
3384 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3385 Some user agents use this interface as a way of passing locally-generated
3386 messages to the MTA.
3387
3388 In
3389 .cindex "sender" "source of"
3390 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3391 set, the senders of messages are taken from the SMTP MAIL commands.
3392 Otherwise the content of these commands is ignored and the sender is set up as
3393 the calling user. Unqualified addresses are automatically qualified using
3394 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3395 &%-bnq%& option is used.
3396
3397 .cindex "inetd"
3398 The
3399 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3400 using a listening daemon. Exim can distinguish the two cases by checking
3401 whether the standard input is a TCP/IP socket. When Exim is called from
3402 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3403 above concerning senders and qualification do not apply. In this situation,
3404 Exim behaves in exactly the same way as it does when receiving a message via
3405 the listening daemon.
3406
3407 .cmdopt -bt
3408 .cindex "testing" "addresses"
3409 .cindex "address" "testing"
3410 This option runs Exim in address testing mode, in which each argument is taken
3411 as a recipient address to be tested for deliverability. The results are
3412 written to the standard output. If a test fails, and the caller is not an admin
3413 user, no details of the failure are output, because these might contain
3414 sensitive information such as usernames and passwords for database lookups.
3415
3416 If no arguments are given, Exim runs in an interactive manner, prompting with a
3417 right angle bracket for addresses to be tested.
3418
3419 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3420 &[readline()]& function, because it is running as &'root'& and there are
3421 security issues.
3422
3423 Each address is handled as if it were the recipient address of a message
3424 (compare the &%-bv%& option). It is passed to the routers and the result is
3425 written to the standard output. However, any router that has
3426 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3427 genuine routing tests if your first router passes everything to a scanner
3428 program.
3429
3430 .cindex "return code" "for &%-bt%&"
3431 The return code is 2 if any address failed outright; it is 1 if no address
3432 failed outright but at least one could not be resolved for some reason. Return
3433 code 0 is given only when all addresses succeed.
3434
3435 .cindex "duplicate addresses"
3436 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3437 addresses after routing is complete, so that only one delivery takes place.
3438 This does not happen when testing with &%-bt%&; the full results of routing are
3439 always shown.
3440
3441 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3442 routers in the configuration makes any tests on the sender address of a
3443 message,
3444 .oindex "&%-f%&" "for address testing"
3445 you can use the &%-f%& option to set an appropriate sender when running
3446 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3447 default qualifying domain. However, if you have set up (for example) routers
3448 whose behaviour depends on the contents of an incoming message, you cannot test
3449 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3450 doing such tests.
3451
3452 .cmdopt -bV
3453 .cindex "version number of Exim"
3454 This option causes Exim to write the current version number, compilation
3455 number, and compilation date of the &'exim'& binary to the standard output.
3456 It also lists the DBM library that is being used, the optional modules (such as
3457 specific lookup types), the drivers that are included in the binary, and the
3458 name of the runtime configuration file that is in use.
3459
3460 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3461 configuration file. However, this is a static check only. It cannot check
3462 values that are to be expanded. For example, although a misspelt ACL verb is
3463 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3464 alone to discover (for example) all the typos in the configuration; some
3465 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3466 dynamic testing facilities.
3467
3468 .cmdopt -bv
3469 .cindex "verifying address" "using &%-bv%&"
3470 .cindex "address" "verification"
3471 This option runs Exim in address verification mode, in which each argument is
3472 taken as a recipient address to be verified by the routers. (This does
3473 not involve any verification callouts). During normal operation, verification
3474 happens mostly as a consequence processing a &%verify%& condition in an ACL
3475 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3476 including callouts, see the &%-bh%& and &%-bhc%& options.
3477
3478 If verification fails, and the caller is not an admin user, no details of the
3479 failure are output, because these might contain sensitive information such as
3480 usernames and passwords for database lookups.
3481
3482 If no arguments are given, Exim runs in an interactive manner, prompting with a
3483 right angle bracket for addresses to be verified.
3484
3485 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3486 &[readline()]& function, because it is running as &'exim'& and there are
3487 security issues.
3488
3489 Verification differs from address testing (the &%-bt%& option) in that routers
3490 that have &%no_verify%& set are skipped, and if the address is accepted by a
3491 router that has &%fail_verify%& set, verification fails. The address is
3492 verified as a recipient if &%-bv%& is used; to test verification for a sender
3493 address, &%-bvs%& should be used.
3494
3495 If the &%-v%& option is not set, the output consists of a single line for each
3496 address, stating whether it was verified or not, and giving a reason in the
3497 latter case. Without &%-v%&, generating more than one address by redirection
3498 causes verification to end successfully, without considering the generated
3499 addresses. However, if just one address is generated, processing continues,
3500 and the generated address must verify successfully for the overall verification
3501 to succeed.
3502
3503 When &%-v%& is set, more details are given of how the address has been handled,
3504 and in the case of address redirection, all the generated addresses are also
3505 considered. Verification may succeed for some and fail for others.
3506
3507 The
3508 .cindex "return code" "for &%-bv%&"
3509 return code is 2 if any address failed outright; it is 1 if no address
3510 failed outright but at least one could not be resolved for some reason. Return
3511 code 0 is given only when all addresses succeed.
3512
3513 If any of the routers in the configuration makes any tests on the sender
3514 address of a message, you should use the &%-f%& option to set an appropriate
3515 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3516 calling user at the default qualifying domain.
3517
3518 .cmdopt -bvs
3519 This option acts like &%-bv%&, but verifies the address as a sender rather
3520 than a recipient address. This affects any rewriting and qualification that
3521 might happen.
3522
3523 .cmdopt -bw
3524 .cindex "daemon"
3525 .cindex "inetd"
3526 .cindex "inetd" "wait mode"
3527 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3528 similarly to the &%-bd%& option.  All port specifications on the command-line
3529 and in the configuration file are ignored.  Queue-running may not be specified.
3530
3531 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3532 listening for connections.  This permits the system to start up and have
3533 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3534 each port only when the first connection is received.
3535
3536 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3537 which the daemon will exit, which should cause inetd to listen once more.
3538
3539 .cmdopt -C <&'filelist'&>
3540 .cindex "configuration file" "alternate"
3541 .cindex "CONFIGURE_FILE"
3542 .cindex "alternate configuration file"
3543 This option causes Exim to find the runtime configuration file from the given
3544 list instead of from the list specified by the CONFIGURE_FILE
3545 compile-time setting. Usually, the list will consist of just a single filename,
3546 but it can be a colon-separated list of names. In this case, the first
3547 file that exists is used. Failure to open an existing file stops Exim from
3548 proceeding any further along the list, and an error is generated.
3549
3550 When this option is used by a caller other than root, and the list is different
3551 from the compiled-in list, Exim gives up its root privilege immediately, and
3552 runs with the real and effective uid and gid set to those of the caller.
3553 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3554 file contains a list of full pathnames, one per line, for configuration files
3555 which are trusted. Root privilege is retained for any configuration file so
3556 listed, as long as the caller is the Exim user (or the user specified in the
3557 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3558 not writeable by inappropriate users or groups.
3559
3560 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3561 configuration using &%-C%& right through message reception and delivery,
3562 even if the caller is root. The reception works, but by that time, Exim is
3563 running as the Exim user, so when it re-executes to regain privilege for the
3564 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3565 test reception and delivery using two separate commands (one to put a message
3566 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3567
3568 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3569 prefix string with which any file named in a &%-C%& command line option
3570 must start. In addition, the filename must not contain the sequence &`/../`&.
3571 However, if the value of the &%-C%& option is identical to the value of
3572 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3573 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3574 unset, any filename can be used with &%-C%&.
3575
3576 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3577 to a directory to which only root has access. This prevents someone who has
3578 broken into the Exim account from running a privileged Exim with an arbitrary
3579 configuration file.
3580
3581 The &%-C%& facility is useful for ensuring that configuration files are
3582 syntactically correct, but cannot be used for test deliveries, unless the
3583 caller is privileged, or unless it is an exotic configuration that does not
3584 require privilege. No check is made on the owner or group of the files
3585 specified by this option.
3586
3587
3588 .vitem &%-D%&<&'macro'&>=<&'value'&>
3589 .oindex "&%-D%&"
3590 .cindex "macro" "setting on command line"
3591 This option can be used to override macro definitions in the configuration file
3592 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3593 unprivileged caller, it causes Exim to give up its root privilege.
3594 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3595 completely disabled, and its use causes an immediate error exit.
3596
3597 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3598 colon-separated list of macros which are considered safe and, if &%-D%& only
3599 supplies macros from this list, and the values are acceptable, then Exim will
3600 not give up root privilege if the caller is root, the Exim run-time user, or
3601 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3602 to be removed in the future.  Acceptable values for the macros satisfy the
3603 regexp: &`^[A-Za-z0-9_/.-]*$`&
3604
3605 The entire option (including equals sign if present) must all be within one
3606 command line item. &%-D%& can be used to set the value of a macro to the empty
3607 string, in which case the equals sign is optional. These two commands are
3608 synonymous:
3609 .code
3610 exim -DABC  ...
3611 exim -DABC= ...
3612 .endd
3613 To include spaces in a macro definition item, quotes must be used. If you use
3614 quotes, spaces are permitted around the macro name and the equals sign. For
3615 example:
3616 .code
3617 exim '-D ABC = something' ...
3618 .endd
3619 &%-D%& may be repeated up to 10 times on a command line.
3620 Only macro names up to 22 letters long can be set.
3621
3622
3623 .vitem &%-d%&<&'debug&~options'&>
3624 .oindex "&%-d%&"
3625 .cindex "debugging" "list of selectors"
3626 .cindex "debugging" "&%-d%& option"
3627 This option causes debugging information to be written to the standard
3628 error stream. It is restricted to admin users because debugging output may show
3629 database queries that contain password information. Also, the details of users'
3630 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3631 writes an error message to the standard error stream and exits with a non-zero
3632 return code.
3633
3634 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3635 standard debugging data is output. This can be reduced, or increased to include
3636 some more rarely needed information, by directly following &%-d%& with a string
3637 made up of names preceded by plus or minus characters. These add or remove sets
3638 of debugging data, respectively. For example, &%-d+filter%& adds filter
3639 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3640 no spaces are allowed in the debug setting. The available debugging categories
3641 are:
3642 .itable none 0 0 2 20* left 80* left
3643 .irow acl            "ACL interpretation"
3644 .irow auth           "authenticators"
3645 .irow deliver        "general delivery logic"
3646 .irow dns            "DNS lookups (see also resolver)"
3647 .irow dnsbl          "DNS black list (aka RBL) code"
3648 .irow exec           "arguments for &[execv()]& calls"
3649 .irow expand         "detailed debugging for string expansions"
3650 .irow filter         "filter handling"
3651 .irow hints_lookup   "hints data lookups"
3652 .irow host_lookup    "all types of name-to-IP address handling"
3653 .irow ident          "ident lookup"
3654 .irow interface      "lists of local interfaces"
3655 .irow lists          "matching things in lists"
3656 .irow load           "system load checks"
3657 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3658                     &<<CHAPlocalscan>>&)"
3659 .irow lookup         "general lookup code and all lookups"
3660 .irow memory         "memory handling"
3661 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3662 .irow pid            "modifier: add pid to debug output lines"
3663 .irow process_info   "setting info for the process log"
3664 .irow queue_run      "queue runs"
3665 .irow receive        "general message reception logic"
3666 .irow resolver       "turn on the DNS resolver's debugging output"
3667 .irow retry          "retry handling"
3668 .irow rewrite        "address rewriting""
3669 .irow route          "address routing"
3670 .irow timestamp      "modifier: add timestamp to debug output lines"
3671 .irow tls            "TLS logic"
3672 .irow transport      "transports"
3673 .irow uid            "changes of uid/gid and looking up uid/gid"
3674 .irow verify         "address verification logic"
3675 .irow all            "almost all of the above (see below), and also &%-v%&"
3676 .endtable
3677 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3678 for &`-all`&. The reason for this is that &`+all`& is something that people
3679 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3680 is included, an awful lot of output that is very rarely of interest is
3681 generated, so it now has to be explicitly requested. However, &`-all`& does
3682 turn everything off.
3683
3684 .cindex "resolver, debugging output"
3685 .cindex "DNS resolver, debugging output"
3686 The &`resolver`& option produces output only if the DNS resolver was compiled
3687 with DEBUG enabled. This is not the case in some operating systems. Also,
3688 unfortunately, debugging output from the DNS resolver is written to stdout
3689 rather than stderr.
3690
3691 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3692 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3693 However, the &`pid`& selector is forced when debugging is turned on for a
3694 daemon, which then passes it on to any re-executed Exims. Exim also
3695 automatically adds the pid to debug lines when several remote deliveries are
3696 run in parallel.
3697
3698 The &`timestamp`& selector causes the current time to be inserted at the start
3699 of all debug output lines. This can be useful when trying to track down delays
3700 in processing.
3701
3702 .cindex debugging "UTF-8 in"
3703 .cindex UTF-8 "in debug output"
3704 The &`noutf8`& selector disables the use of
3705 UTF-8 line-drawing characters to group related information.
3706 When disabled. ascii-art is used instead.
3707 Using the &`+all`& option does not set this modifier,
3708
3709 If the &%debug_print%& option is set in any driver, it produces output whenever
3710 any debugging is selected, or if &%-v%& is used.
3711
3712 .vitem &%-dd%&<&'debug&~options'&>
3713 .oindex "&%-dd%&"
3714 This option behaves exactly like &%-d%& except when used on a command that
3715 starts a daemon process. In that case, debugging is turned off for the
3716 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3717 behaviour of the daemon without creating as much output as full debugging does.
3718
3719 .cmdopt -dropcr
3720 This is an obsolete option that is now a no-op. It used to affect the way Exim
3721 handled CR and LF characters in incoming messages. What happens now is
3722 described in section &<<SECTlineendings>>&.
3723
3724 .cmdopt -E
3725 .cindex "bounce message" "generating"
3726 This option specifies that an incoming message is a locally-generated delivery
3727 failure report. It is used internally by Exim when handling delivery failures
3728 and is not intended for external use. Its only effect is to stop Exim
3729 generating certain messages to the postmaster, as otherwise message cascades
3730 could occur in some situations. As part of the same option, a message id may
3731 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3732 new message contains the id, following &"R="&, as a cross-reference.
3733
3734 .vitem &%-e%&&'x'&
3735 .oindex "&%-e%&&'x'&"
3736 There are a number of Sendmail options starting with &%-oe%& which seem to be
3737 called by various programs without the leading &%o%& in the option. For
3738 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3739 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3740
3741 .cmdopt -F <&'string'&>
3742 .cindex "sender" "name"
3743 .cindex "name" "of sender"
3744 This option sets the sender's full name for use when a locally-generated
3745 message is being accepted. In the absence of this option, the user's &'gecos'&
3746 entry from the password data is used. As users are generally permitted to alter
3747 their &'gecos'& entries, no security considerations are involved. White space
3748 between &%-F%& and the <&'string'&> is optional.
3749
3750 .cmdopt -f <&'address'&>
3751 .cindex "sender" "address"
3752 .cindex "address" "sender"
3753 .cindex "trusted users"
3754 .cindex "envelope from"
3755 .cindex "envelope sender"
3756 .cindex "user" "trusted"
3757 This option sets the address of the envelope sender of a locally-generated
3758 message (also known as the return path). The option can normally be used only
3759 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3760 users to use it.
3761
3762 Processes running as root or the Exim user are always trusted. Other
3763 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3764 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3765 of a local message is set to the caller's login name at the default qualify
3766 domain.
3767
3768 There is one exception to the restriction on the use of &%-f%&: an empty sender
3769 can be specified by any user, trusted or not, to create a message that can
3770 never provoke a bounce. An empty sender can be specified either as an empty
3771 string, or as a pair of angle brackets with nothing between them, as in these
3772 examples of shell commands:
3773 .code
3774 exim -f '<>' user@domain
3775 exim -f "" user@domain
3776 .endd
3777 In addition, the use of &%-f%& is not restricted when testing a filter file
3778 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3779 &%-bv%& options.
3780
3781 Allowing untrusted users to change the sender address does not of itself make
3782 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3783 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3784 though this can be overridden by setting &%no_local_from_check%&.
3785
3786 White
3787 .cindex "&""From""& line"
3788 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3789 given as two arguments or one combined argument). The sender of a
3790 locally-generated message can also be set (when permitted) by an initial
3791 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3792 if &%-f%& is also present, it overrides &"From&~"&.
3793
3794 .cmdopt -G
3795 .cindex "submission fixups, suppressing (command-line)"
3796 This option is equivalent to an ACL applying:
3797 .code
3798 control = suppress_local_fixups
3799 .endd
3800 for every message received.  Note that Sendmail will complain about such
3801 bad formatting, where Exim silently just does not fix it up.  This may change
3802 in future.
3803
3804 As this affects audit information, the caller must be a trusted user to use
3805 this option.
3806
3807 .cmdopt -h <&'number'&>
3808 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3809 This option is accepted for compatibility with Sendmail, but has no effect. (In
3810 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3811 headers.)
3812
3813 .cmdopt -i
3814 .cindex "Solaris" "&'mail'& command"
3815 .cindex "dot" "in incoming non-SMTP message"
3816 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3817 line by itself should not terminate an incoming, non-SMTP message.
3818 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3819 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3820 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3821 by its &'mailx'& command.
3822
3823 .cmdopt -L <&'tag'&>
3824 .cindex "syslog" "process name; set with flag"
3825 This option is equivalent to setting &%syslog_processname%& in the config
3826 file and setting &%log_file_path%& to &`syslog`&.
3827 Its use is restricted to administrators.  The configuration file has to be
3828 read and parsed, to determine access rights, before this is set and takes
3829 effect, so early configuration file errors will not honour this flag.
3830
3831 The tag should not be longer than 32 characters.
3832
3833 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3834 .cindex "forcing delivery"
3835 .cindex "delivery" "forcing attempt"
3836 .cindex "frozen messages" "forcing delivery"
3837 This option requests Exim to run a delivery attempt on each message in turn. If
3838 any of the messages are frozen, they are automatically thawed before the
3839 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3840 and &%hold_domains%& are ignored.
3841
3842 Retry
3843 .cindex "hints database" "overriding retry hints"
3844 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3845 the normal retry time has not yet been reached. This option requires the caller
3846 to be an admin user. However, there is an option called &%prod_requires_admin%&
3847 which can be set false to relax this restriction (and also the same requirement
3848 for the &%-q%&, &%-R%&, and &%-S%& options).
3849
3850 The deliveries happen synchronously, that is, the original Exim process does
3851 not terminate until all the delivery attempts have finished. No output is
3852 produced unless there is a serious error. If you want to see what is happening,
3853 use the &%-v%& option as well, or inspect Exim's main log.
3854
3855 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3856 .cindex "message" "adding recipients"
3857 .cindex "recipient" "adding"
3858 This option requests Exim to add the addresses to the list of recipients of the
3859 message (&"ar"& for &"add recipients"&). The first argument must be a message
3860 id, and the remaining ones must be email addresses. However, if the message is
3861 active (in the middle of a delivery attempt), it is not altered. This option
3862 can be used only by an admin user.
3863
3864 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3865         &~<&'host&~IP'&>&&&
3866         &~<&'sequence&~number'&>&&&
3867         &~<&'message&~id'&>"
3868 .oindex "&%-MC%&"
3869 .cindex "SMTP" "passed connection"
3870 .cindex "SMTP" "multiple deliveries"
3871 .cindex "multiple SMTP deliveries"
3872 This option is not intended for use by external callers. It is used internally
3873 by Exim to invoke another instance of itself to deliver a waiting message using
3874 an existing SMTP connection, which is passed as the standard input. Details are
3875 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3876 must be root or the Exim user in order to use it.
3877
3878 .cmdopt -MCA
3879 This option is not intended for use by external callers. It is used internally
3880 by Exim in conjunction with the &%-MC%& option. It signifies that the
3881 connection to the remote host has been authenticated.
3882
3883 .cmdopt -MCD
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option. It signifies that the
3886 remote host supports the ESMTP &_DSN_& extension.
3887
3888 .cmdopt -MCd
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-d%& option
3891 to pass on an information string on the purpose of the process.
3892
3893 .cmdopt -MCG <&'queue&~name'&>
3894 This option is not intended for use by external callers. It is used internally
3895 by Exim in conjunction with the &%-MC%& option. It signifies that an
3896 alternate queue is used, named by the following argument.
3897
3898 .cmdopt -MCK
3899 This option is not intended for use by external callers. It is used internally
3900 by Exim in conjunction with the &%-MC%& option. It signifies that a
3901 remote host supports the ESMTP &_CHUNKING_& extension.
3902
3903 .cmdopt -MCL
3904 This option is not intended for use by external callers. It is used internally
3905 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3906 which Exim is connected advertised limits on numbers of mails, recipients or
3907 recipient domains.
3908 The limits are given by the following three arguments.
3909
3910 .cmdopt -MCP
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3913 which Exim is connected supports pipelining.
3914
3915 .cmdopt -MCp
3916 This option is not intended for use by external callers. It is used internally
3917 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3918 t a remote server is via a SOCKS proxy, using addresses and ports given by
3919 the following four arguments.
3920
3921 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3922 This option is not intended for use by external callers. It is used internally
3923 by Exim in conjunction with the &%-MC%& option when the original delivery was
3924 started by a queue runner. It passes on the process id of the queue runner,
3925 together with the file descriptor number of an open pipe. Closure of the pipe
3926 signals the final completion of the sequence of processes that are passing
3927 messages through the same SMTP connection.
3928
3929 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3930 This option is not intended for use by external callers. It is used internally
3931 by Exim to implement quota checking for local users.
3932
3933 .cmdopt -MCS
3934 This option is not intended for use by external callers. It is used internally
3935 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3936 ESMTP SIZE option should be used on messages delivered down the existing
3937 connection.
3938
3939 .cmdopt -MCT
3940 This option is not intended for use by external callers. It is used internally
3941 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3942 host to which Exim is connected supports TLS encryption.
3943
3944 .vitem &%-MCr%&&~<&'SNI'&> &&&
3945        &%-MCs%&&~<&'SNI'&>
3946 .oindex "&%-MCs%&"
3947 .oindex "&%-MCr%&"
3948 These options are not intended for use by external callers. It is used internally
3949 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3950 a TLS Server Name Indication was sent as part of the channel establishment.
3951 The argument gives the SNI string.
3952 The "r" variant indicates a DANE-verified connection.
3953
3954 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3955 This option is not intended for use by external callers. It is used internally
3956 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3957 connection is being proxied by a parent process for handling TLS encryption.
3958 The arguments give the local address and port being proxied, and the TLS cipher.
3959
3960 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3961 .cindex "hints database" "not overridden by &%-Mc%&"
3962 .cindex "delivery" "manually started &-- not forced"
3963 This option requests Exim to run a delivery attempt on each message, in turn,
3964 but unlike the &%-M%& option, it does check for retry hints, and respects any
3965 that are found. This option is not very useful to external callers. It is
3966 provided mainly for internal use by Exim when it needs to re-invoke itself in
3967 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3968 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3969 respects retry times and other options such as &%hold_domains%& that are
3970 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3971 If you want to run a specific delivery as if in a queue run, you should use
3972 &%-q%& with a message id argument. A distinction between queue run deliveries
3973 and other deliveries is made in one or two places.
3974
3975 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3976 .cindex "message" "changing sender"
3977 .cindex "sender" "changing"
3978 This option requests Exim to change the sender address in the message to the
3979 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3980 &"edit sender"&). There must be exactly two arguments. The first argument must
3981 be a message id, and the second one an email address. However, if the message
3982 is active (in the middle of a delivery attempt), its status is not altered.
3983 This option can be used only by an admin user.
3984
3985 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
3986 .cindex "freezing messages"
3987 .cindex "message" "manually freezing"
3988 This option requests Exim to mark each listed message as &"frozen"&. This
3989 prevents any delivery attempts taking place until the message is &"thawed"&,
3990 either manually or as a result of the &%auto_thaw%& configuration option.
3991 However, if any of the messages are active (in the middle of a delivery
3992 attempt), their status is not altered. This option can be used only by an admin
3993 user.
3994
3995 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
3996 .cindex "giving up on messages"
3997 .cindex "message" "abandoning delivery attempts"
3998 .cindex "delivery" "abandoning further attempts"
3999 This option requests Exim to give up trying to deliver the listed messages,
4000 including any that are frozen. However, if any of the messages are active,
4001 their status is not altered. For non-bounce messages, a delivery error message
4002 is sent to the sender, containing the text &"cancelled by administrator"&.
4003 Bounce messages are just discarded. This option can be used only by an admin
4004 user.
4005
4006 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4007 .cindex queue named
4008 .cindex "named queues" "moving messages"
4009 .cindex "queue" "moving messages"
4010 This option requests that each listed message be moved from its current
4011 queue to the given named queue.
4012 The destination queue name argument is required, but can be an empty
4013 string to define the default queue.
4014 If the messages are not currently located in the default queue,
4015 a &%-qG<name>%& option will be required to define the source queue.
4016
4017 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4018 .cindex "delivery" "cancelling all"
4019 This option requests Exim to mark all the recipient addresses in the messages
4020 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4021 message is active (in the middle of a delivery attempt), its status is not
4022 altered. This option can be used only by an admin user.
4023
4024 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4025 .cindex "delivery" "cancelling by address"
4026 .cindex "recipient" "removing"
4027 .cindex "removing recipients"
4028 This option requests Exim to mark the given addresses as already delivered
4029 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4030 the remaining ones must be email addresses. These are matched to recipient
4031 addresses in the message in a case-sensitive manner. If the message is active
4032 (in the middle of a delivery attempt), its status is not altered. This option
4033 can be used only by an admin user.
4034
4035 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4036 .cindex "removing messages"
4037 .cindex "abandoning mail"
4038 .cindex "message" "manually discarding"
4039 This option requests Exim to remove the given messages from the queue. No
4040 bounce messages are sent; each message is simply forgotten. However, if any of
4041 the messages are active, their status is not altered. This option can be used
4042 only by an admin user or by the user who originally caused the message to be
4043 placed in the queue.
4044
4045 . .new
4046 . .vitem &%-MS%&
4047 . .oindex "&%-MS%&"
4048 . .cindex REQUIRETLS
4049 . This option is used to request REQUIRETLS processing on the message.
4050 . It is used internally by Exim in conjunction with -E when generating
4051 . a bounce message.
4052 . .wen
4053
4054 .cmdopt -Mset <&'message&~id'&>
4055 .cindex "testing" "string expansion"
4056 .cindex "expansion" "testing"
4057 This option is useful only in conjunction with &%-be%& (that is, when testing
4058 string expansions). Exim loads the given message from its spool before doing
4059 the test expansions, thus setting message-specific variables such as
4060 &$message_size$& and the header variables. The &$recipients$& variable is made
4061 available. This feature is provided to make it easier to test expansions that
4062 make use of these variables. However, this option can be used only by an admin
4063 user. See also &%-bem%&.
4064
4065 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4066 .cindex "thawing messages"
4067 .cindex "unfreezing messages"
4068 .cindex "frozen messages" "thawing"
4069 .cindex "message" "thawing frozen"
4070 This option requests Exim to &"thaw"& any of the listed messages that are
4071 &"frozen"&, so that delivery attempts can resume. However, if any of the
4072 messages are active, their status is not altered. This option can be used only
4073 by an admin user.
4074
4075 .cmdopt -Mvb <&'message&~id'&>
4076 .cindex "listing" "message body"
4077 .cindex "message" "listing body of"
4078 This option causes the contents of the message body (-D) spool file to be
4079 written to the standard output. This option can be used only by an admin user.
4080
4081 .cmdopt -Mvc <&'message&~id'&>
4082 .cindex "message" "listing in RFC 2822 format"
4083 .cindex "listing" "message in RFC 2822 format"
4084 This option causes a copy of the complete message (header lines plus body) to
4085 be written to the standard output in RFC 2822 format. This option can be used
4086 only by an admin user.
4087
4088 .cmdopt -Mvh <&'message&~id'&>
4089 .cindex "listing" "message headers"
4090 .cindex "header lines" "listing"
4091 .cindex "message" "listing header lines"
4092 This option causes the contents of the message headers (-H) spool file to be
4093 written to the standard output. This option can be used only by an admin user.
4094
4095 .cmdopt -Mvl <&'message&~id'&>
4096 .cindex "listing" "message log"
4097 .cindex "message" "listing message log"
4098 This option causes the contents of the message log spool file to be written to
4099 the standard output. This option can be used only by an admin user.
4100
4101 .cmdopt -m
4102 This is a synonym for &%-om%& that is accepted by Sendmail
4103 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4104 p. 1M-258), so Exim treats it that way too.
4105
4106 .cmdopt -N
4107 .cindex "debugging" "&%-N%& option"
4108 .cindex "debugging" "suppressing delivery"
4109 This is a debugging option that inhibits delivery of a message at the transport
4110 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4111 it just doesn't actually transport the message, but instead behaves as if it
4112 had successfully done so. However, it does not make any updates to the retry
4113 database, and the log entries for deliveries are flagged with &"*>"& rather
4114 than &"=>"&.
4115
4116 Because &%-N%& discards any message to which it applies, only root or the Exim
4117 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4118 words, an ordinary user can use it only when supplying an incoming message to
4119 which it will apply. Although transportation never fails when &%-N%& is set, an
4120 address may be deferred because of a configuration problem on a transport, or a
4121 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4122 the message, and applies to any subsequent delivery attempts that may happen
4123 for that message.
4124
4125 .cmdopt -n
4126 This option is interpreted by Sendmail to mean &"no aliasing"&.
4127 For normal modes of operation, it is ignored by Exim.
4128 When combined with &%-bP%& it makes the output more terse (suppresses
4129 option names, environment values and config pretty printing).
4130
4131 .cmdopt -O <&'data'&>
4132 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4133 Exim.
4134
4135 .cmdopt -oA <&'file&~name'&>
4136 .cindex "Sendmail compatibility" "&%-oA%& option"
4137 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4138 alternative alias filename. Exim handles &%-bi%& differently; see the
4139 description above.
4140
4141 .cmdopt -oB <&'n'&>
4142 .cindex "SMTP" "passed connection"
4143 .cindex "SMTP" "multiple deliveries"
4144 .cindex "multiple SMTP deliveries"
4145 This is a debugging option which limits the maximum number of messages that can
4146 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4147 transport. If <&'n'&> is omitted, the limit is set to 1.
4148
4149 .cmdopt -odb
4150 .cindex "background delivery"
4151 .cindex "delivery" "in the background"
4152 This option applies to all modes in which Exim accepts incoming messages,
4153 including the listening daemon. It requests &"background"& delivery of such
4154 messages, which means that the accepting process automatically starts a
4155 delivery process for each message received, but does not wait for the delivery
4156 processes to finish.
4157
4158 When all the messages have been received, the reception process exits,
4159 leaving the delivery processes to finish in their own time. The standard output
4160 and error streams are closed at the start of each delivery process.
4161 This is the default action if none of the &%-od%& options are present.
4162
4163 If one of the queueing options in the configuration file
4164 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4165 overrides it if &%queue_only_override%& is set true, which is the default
4166 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4167
4168 .cmdopt -odf
4169 .cindex "foreground delivery"
4170 .cindex "delivery" "in the foreground"
4171 This option requests &"foreground"& (synchronous) delivery when Exim has
4172 accepted a locally-generated message. (For the daemon it is exactly the same as
4173 &%-odb%&.) A delivery process is automatically started to deliver the message,
4174 and Exim waits for it to complete before proceeding.
4175
4176 The original Exim reception process does not finish until the delivery
4177 process for the final message has ended. The standard error stream is left open
4178 during deliveries.
4179
4180 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4181 false and one of the queueing options in the configuration file is in effect.
4182
4183 If there is a temporary delivery error during foreground delivery, the
4184 message is left in the queue for later delivery, and the original reception
4185 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4186 restricted configuration that never queues messages.
4187
4188
4189 .cmdopt -odi
4190 This option is synonymous with &%-odf%&. It is provided for compatibility with
4191 Sendmail.
4192
4193 .cmdopt -odq
4194 .cindex "non-immediate delivery"
4195 .cindex "delivery" "suppressing immediate"
4196 .cindex "queueing incoming messages"
4197 This option applies to all modes in which Exim accepts incoming messages,
4198 including the listening daemon. It specifies that the accepting process should
4199 not automatically start a delivery process for each message received. Messages
4200 are placed in the queue, and remain there until a subsequent queue runner
4201 process encounters them. There are several configuration options (such as
4202 &%queue_only%&) that can be used to queue incoming messages under certain
4203 conditions. This option overrides all of them and also &%-odqs%&. It always
4204 forces queueing.
4205
4206 .cmdopt -odqs
4207 .cindex "SMTP" "delaying delivery"
4208 .cindex "first pass routing"
4209 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4210 However, like &%-odb%& and &%-odi%&, this option has no effect if
4211 &%queue_only_override%& is false and one of the queueing options in the
4212 configuration file is in effect.
4213
4214 When &%-odqs%& does operate, a delivery process is started for each incoming
4215 message, in the background by default, but in the foreground if &%-odi%& is
4216 also present. The recipient addresses are routed, and local deliveries are done
4217 in the normal way. However, if any SMTP deliveries are required, they are not
4218 done at this time, so the message remains in the queue until a subsequent queue
4219 runner process encounters it. Because routing was done, Exim knows which
4220 messages are waiting for which hosts, and so a number of messages for the same
4221 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4222 configuration option has the same effect for specific domains. See also the
4223 &%-qq%& option.
4224
4225 .cmdopt -oee
4226 .cindex "error" "reporting"
4227 If an error is detected while a non-SMTP message is being received (for
4228 example, a malformed address), the error is reported to the sender in a mail
4229 message.
4230
4231 .cindex "return code" "for &%-oee%&"
4232 Provided
4233 this error message is successfully sent, the Exim receiving process
4234 exits with a return code of zero. If not, the return code is 2 if the problem
4235 is that the original message has no recipients, or 1 for any other error.
4236 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4237
4238 .cmdopt -oem
4239 .cindex "error" "reporting"
4240 .cindex "return code" "for &%-oem%&"
4241 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4242 return code, whether or not the error message was successfully sent.
4243 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4244
4245 .cmdopt -oep
4246 .cindex "error" "reporting"
4247 If an error is detected while a non-SMTP message is being received, the
4248 error is reported by writing a message to the standard error file (stderr).
4249 .cindex "return code" "for &%-oep%&"
4250 The return code is 1 for all errors.
4251
4252 .cmdopt -oeq
4253 .cindex "error" "reporting"
4254 This option is supported for compatibility with Sendmail, but has the same
4255 effect as &%-oep%&.
4256
4257 .cmdopt -oew
4258 .cindex "error" "reporting"
4259 This option is supported for compatibility with Sendmail, but has the same
4260 effect as &%-oem%&.
4261
4262 .cmdopt -oi
4263 .cindex "dot" "in incoming non-SMTP message"
4264 This option, which has the same effect as &%-i%&, specifies that a dot on a
4265 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4266 single dot does terminate, though Exim does no special processing for other
4267 lines that start with a dot. This option is set by default if Exim is called as
4268 &'rmail'&. See also &%-ti%&.
4269
4270 .cmdopt -oitrue
4271 This option is treated as synonymous with &%-oi%&.
4272
4273 .cmdopt -oMa <&'host&~address'&>
4274 .cindex "sender" "host address, specifying for local message"
4275 A number of options starting with &%-oM%& can be used to set values associated
4276 with remote hosts on locally-submitted messages (that is, messages not received
4277 over TCP/IP). These options can be used by any caller in conjunction with the
4278 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4279 other circumstances, they are ignored unless the caller is trusted.
4280
4281 The &%-oMa%& option sets the sender host address. This may include a port
4282 number at the end, after a full stop (period). For example:
4283 .code
4284 exim -bs -oMa 10.9.8.7.1234
4285 .endd
4286 An alternative syntax is to enclose the IP address in square brackets,
4287 followed by a colon and the port number:
4288 .code
4289 exim -bs -oMa [10.9.8.7]:1234
4290 .endd
4291 The IP address is placed in the &$sender_host_address$& variable, and the
4292 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4293 are present on the command line, the sender host IP address is taken from
4294 whichever one is last.
4295
4296 .cmdopt -oMaa <&'name'&>
4297 .cindex "authentication" "name, specifying for local message"
4298 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4299 option sets the value of &$sender_host_authenticated$& (the authenticator
4300 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4301 This option can be used with &%-bh%& and &%-bs%& to set up an
4302 authenticated SMTP session without actually using the SMTP AUTH command.
4303
4304 .cmdopt -oMai <&'string'&>
4305 .cindex "authentication" "id, specifying for local message"
4306 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4307 option sets the value of &$authenticated_id$& (the id that was authenticated).
4308 This overrides the default value (the caller's login id, except with &%-bh%&,
4309 where there is no default) for messages from local sources. See chapter
4310 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4311
4312 .cmdopt -oMas <&'address'&>
4313 .cindex "authentication" "sender, specifying for local message"
4314 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4315 option sets the authenticated sender value in &$authenticated_sender$&. It
4316 overrides the sender address that is created from the caller's login id for
4317 messages from local sources, except when &%-bh%& is used, when there is no
4318 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4319 specified on a MAIL command overrides this value. See chapter
4320 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4321
4322 .cmdopt -oMi <&'interface&~address'&>
4323 .cindex "interface" "address, specifying for local message"
4324 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4325 option sets the IP interface address value. A port number may be included,
4326 using the same syntax as for &%-oMa%&. The interface address is placed in
4327 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4328
4329 .cmdopt -oMm <&'message&~reference'&>
4330 .cindex "message reference" "message reference, specifying for local message"
4331 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4332 option sets the message reference, e.g. message-id, and is logged during
4333 delivery. This is useful when some kind of audit trail is required to tie
4334 messages together. The format of the message reference is checked and will
4335 abort if the format is invalid. The option will only be accepted if exim is
4336 running in trusted mode, not as any regular user.
4337
4338 The best example of a message reference is when Exim sends a bounce message.
4339 The message reference is the message-id of the original message for which Exim
4340 is sending the bounce.
4341
4342 .cmdopt -oMr <&'protocol&~name'&>
4343 .cindex "protocol, specifying for local message"
4344 .vindex "&$received_protocol$&"
4345 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4346 option sets the received protocol value that is stored in
4347 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4348 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4349 SMTP protocol names (see the description of &$received_protocol$& in section
4350 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4351 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4352 be set by &%-oMr%&. Repeated use of this option is not supported.
4353
4354 .cmdopt -oMs <&'host&~name'&>
4355 .cindex "sender" "host name, specifying for local message"
4356 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4357 option sets the sender host name in &$sender_host_name$&. When this option is
4358 present, Exim does not attempt to look up a host name from an IP address; it
4359 uses the name it is given.
4360
4361 .cmdopt -oMt <&'ident&~string'&>
4362 .cindex "sender" "ident string, specifying for local message"
4363 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4364 option sets the sender ident value in &$sender_ident$&. The default setting for
4365 local callers is the login id of the calling process, except when &%-bh%& is
4366 used, when there is no default.
4367
4368 .cmdopt -om
4369 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4370 In Sendmail, this option means &"me too"&, indicating that the sender of a
4371 message should receive a copy of the message if the sender appears in an alias
4372 expansion. Exim always does this, so the option does nothing.
4373
4374 .cmdopt -oo
4375 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4376 This option is ignored. In Sendmail it specifies &"old style headers"&,
4377 whatever that means.
4378
4379 .cmdopt -oP <&'path'&>
4380 .cindex "pid (process id)" "of daemon"
4381 .cindex "daemon" "process id (pid)"
4382 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4383 value. The option specifies the file to which the process id of the daemon is
4384 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4385 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4386 because in those cases, the normal pid file is not used.
4387
4388 .cmdopt -oPX
4389 .cindex "pid (process id)" "of daemon"
4390 .cindex "daemon" "process id (pid)"
4391 This option is not intended for general use.
4392 The daemon uses it when terminating due to a SIGTEM, possibly in
4393 combination with &%-oP%&&~<&'path'&>.
4394 It causes the pid file to be removed.
4395
4396 .cmdopt -or <&'time'&>
4397 .cindex "timeout" "for non-SMTP input"
4398 This option sets a timeout value for incoming non-SMTP messages. If it is not
4399 set, Exim will wait forever for the standard input. The value can also be set
4400 by the &%receive_timeout%& option. The format used for specifying times is
4401 described in section &<<SECTtimeformat>>&.
4402
4403 .cmdopt -os <&'time'&>
4404 .cindex "timeout" "for SMTP input"
4405 .cindex "SMTP" "input timeout"
4406 This option sets a timeout value for incoming SMTP messages. The timeout
4407 applies to each SMTP command and block of data. The value can also be set by
4408 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4409 for specifying times is described in section &<<SECTtimeformat>>&.
4410
4411 .cmdopt -ov
4412 This option has exactly the same effect as &%-v%&.
4413
4414 .cmdopt -oX <&'number&~or&~string'&>
4415 .cindex "TCP/IP" "setting listening ports"
4416 .cindex "TCP/IP" "setting listening interfaces"
4417 .cindex "port" "receiving TCP/IP"
4418 This option is relevant only when the &%-bd%& (start listening daemon) option
4419 is also given. It controls which ports and interfaces the daemon uses. Details
4420 of the syntax, and how it interacts with configuration file options, are given
4421 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4422 file is written unless &%-oP%& is also present to specify a pid filename.
4423
4424 .cmdopt -oY
4425 .cindex "daemon notifier socket"
4426 This option controls the creation of an inter-process communications endpoint
4427 by the Exim daemon.
4428 It is only relevant when the &%-bd%& (start listening daemon) option is also
4429 given.
4430 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4431 option is also present.
4432 .new
4433 If this option is given then the socket will not be created.  This is required
4434 if the system is running multiple daemons, in which case it should
4435 be used on all.
4436 The features supported by the socket will not be available in such cases.
4437
4438 The socket is currently used for
4439 .ilist
4440 fast ramp-up of queue runner processes
4441 .next
4442 caching compiled regexes
4443 .next
4444 obtaining a current queue size
4445 .endlist
4446 .wen
4447
4448 .cmdopt -pd
4449 .cindex "Perl" "starting the interpreter"
4450 This option applies when an embedded Perl interpreter is linked with Exim (see
4451 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4452 option, forcing the starting of the interpreter to be delayed until it is
4453 needed.
4454
4455 .cmdopt -ps
4456 .cindex "Perl" "starting the interpreter"
4457 This option applies when an embedded Perl interpreter is linked with Exim (see
4458 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4459 option, forcing the starting of the interpreter to occur as soon as Exim is
4460 started.
4461
4462 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4463 .oindex "&%-p%&"
4464 For compatibility with Sendmail, this option is equivalent to
4465 .display
4466 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4467 .endd
4468 It sets the incoming protocol and host name (for trusted callers). The
4469 host name and its colon can be omitted when only the protocol is to be set.
4470 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4471 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4472 or &`s`& using this option (but that does not seem a real limitation).
4473 Repeated use of this option is not supported.
4474
4475 .cmdopt -q
4476 .cindex "queue runner" "starting manually"
4477 This option is normally restricted to admin users. However, there is a
4478 configuration option called &%prod_requires_admin%& which can be set false to
4479 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4480 and &%-S%& options).
4481
4482 .cindex "queue runner" "description of operation"
4483 If other commandline options do not specify an action,
4484 the &%-q%& option starts one queue runner process. This scans the queue of
4485 waiting messages, and runs a delivery process for each one in turn. It waits
4486 for each delivery process to finish before starting the next one. A delivery
4487 process may not actually do any deliveries if the retry times for the addresses
4488 have not been reached. Use &%-qf%& (see below) if you want to override this.
4489
4490 If
4491 .cindex "SMTP" "passed connection"
4492 .cindex "SMTP" "multiple deliveries"
4493 .cindex "multiple SMTP deliveries"
4494 the delivery process spawns other processes to deliver other messages down
4495 passed SMTP connections, the queue runner waits for these to finish before
4496 proceeding.
4497
4498 When all the queued messages have been considered, the original queue runner
4499 process terminates. In other words, a single pass is made over the waiting
4500 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4501 this to be repeated periodically.
4502
4503 Exim processes the waiting messages in an unpredictable order. It isn't very
4504 random, but it is likely to be different each time, which is all that matters.
4505 If one particular message screws up a remote MTA, other messages to the same
4506 MTA have a chance of getting through if they get tried first.
4507
4508 It is possible to cause the messages to be processed in lexical message id
4509 order, which is essentially the order in which they arrived, by setting the
4510 &%queue_run_in_order%& option, but this is not recommended for normal use.
4511
4512 .vitem &%-q%&<&'qflags'&>
4513 The &%-q%& option may be followed by one or more flag letters that change its
4514 behaviour. They are all optional, but if more than one is present, they must
4515 appear in the correct order. Each flag is described in a separate item below.
4516
4517 .vitem &%-qq...%&
4518 .oindex "&%-qq%&"
4519 .cindex "queue" "double scanning"
4520 .cindex "queue" "routing"
4521 .cindex "routing" "whole queue before delivery"
4522 .cindex "first pass routing"
4523 .cindex "queue runner" "two phase"
4524 An option starting with &%-qq%& requests a two-stage queue run. In the first
4525 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4526 every domain. Addresses are routed, local deliveries happen, but no remote
4527 transports are run.
4528
4529 Performance will be best if the &%queue_run_in_order%& option is false.
4530 If that is so and
4531 the &%queue_fast_ramp%& option is true
4532 and a daemon-notifier socket is available
4533 then in the first phase of the run,
4534 once a threshold number of messages are routed for a given host,
4535 a delivery process is forked in parallel with the rest of the scan.
4536
4537 .cindex "hints database" "remembering routing"
4538 The hints database that remembers which messages are waiting for specific hosts
4539 is updated, as if delivery to those hosts had been deferred.
4540
4541 After the first queue scan complete,
4542 a second, normal queue scan is done, with routing and delivery taking
4543 place as normal.
4544 Messages that are routed to the same host should mostly be
4545 delivered down a single SMTP
4546 .cindex "SMTP" "passed connection"
4547 .cindex "SMTP" "multiple deliveries"
4548 .cindex "multiple SMTP deliveries"
4549 connection because of the hints that were set up during the first queue scan.
4550
4551 .new
4552 Two-phase queue runs should be used on systems which, even intermittently,
4553 have a large queue (such as mailing-list operators).
4554 They may also be useful for hosts that are connected to the Internet
4555 intermittently.
4556 .wen
4557
4558 .vitem &%-q[q]i...%&
4559 .oindex "&%-qi%&"
4560 .cindex "queue" "initial delivery"
4561 If the &'i'& flag is present, the queue runner runs delivery processes only for
4562 those messages that haven't previously been tried. (&'i'& stands for &"initial
4563 delivery"&.) This can be helpful if you are putting messages in the queue using
4564 &%-odq%& and want a queue runner just to process the new messages.
4565
4566 .vitem &%-q[q][i]f...%&
4567 .oindex "&%-qf%&"
4568 .cindex "queue" "forcing delivery"
4569 .cindex "delivery" "forcing in queue run"
4570 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4571 message, whereas without &'f'& only those non-frozen addresses that have passed
4572 their retry times are tried.
4573
4574 .vitem &%-q[q][i]ff...%&
4575 .oindex "&%-qff%&"
4576 .cindex "frozen messages" "forcing delivery"
4577 If &'ff'& is present, a delivery attempt is forced for every message, whether
4578 frozen or not.
4579
4580 .vitem &%-q[q][i][f[f]]l%&
4581 .oindex "&%-ql%&"
4582 .cindex "queue" "local deliveries only"
4583 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4584 be done. If a message requires any remote deliveries, it remains in the queue
4585 for later delivery.
4586
4587 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4588 .oindex "&%-qG%&"
4589 .cindex queue named
4590 .cindex "named queues"  "deliver from"
4591 .cindex "queue" "delivering specific messages"
4592 If the &'G'& flag and a name is present, the queue runner operates on the
4593 queue with the given name rather than the default queue.
4594 The name should not contain a &'/'& character.
4595 For a periodic queue run (see below)
4596 append to the name a slash and a time value.
4597
4598 If other commandline options specify an action, a &'-qG<name>'& option
4599 will specify a queue to operate on.
4600 For example:
4601 .code
4602 exim -bp -qGquarantine
4603 mailq -qGquarantine
4604 exim -qGoffpeak -Rf @special.domain.example
4605 .endd
4606
4607 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4608 When scanning the queue, Exim can be made to skip over messages whose ids are
4609 lexically less than a given value by following the &%-q%& option with a
4610 starting message id. For example:
4611 .code
4612 exim -q 0t5C6f-0000c8-00
4613 .endd
4614 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4615 second message id is given, messages whose ids are lexically greater than it
4616 are also skipped. If the same id is given twice, for example,
4617 .code
4618 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4619 .endd
4620 just one delivery process is started, for that message. This differs from
4621 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4622 that it counts as a delivery from a queue run. Note that the selection
4623 mechanism does not affect the order in which the messages are scanned. There
4624 are also other ways of selecting specific sets of messages for delivery in a
4625 queue run &-- see &%-R%& and &%-S%&.
4626
4627 .vitem &%-q%&<&'qflags'&><&'time'&>
4628 .cindex "queue runner" "starting periodically"
4629 .cindex "periodic queue running"
4630 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4631 starting a queue runner process at intervals specified by the given time value
4632 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4633 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4634 single daemon process handles both functions. A common way of starting up a
4635 combined daemon at system boot time is to use a command such as
4636 .code
4637 /usr/exim/bin/exim -bd -q30m
4638 .endd
4639 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4640 process every 30 minutes.
4641
4642 .new
4643 .cindex "named queues" "queue runners"
4644 It is possible to set up runners for multiple named queues within one daemon,
4645 For example:
4646 .code
4647 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4648 .endd
4649 .wen
4650
4651 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4652 pid file is written unless one is explicitly requested by the &%-oP%& option.
4653
4654 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4655 .oindex "&%-qR%&"
4656 This option is synonymous with &%-R%&. It is provided for Sendmail
4657 compatibility.
4658
4659 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4660 .oindex "&%-qS%&"
4661 This option is synonymous with &%-S%&.
4662
4663 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4664 .oindex "&%-R%&"
4665 .cindex "queue runner" "for specific recipients"
4666 .cindex "delivery" "to given domain"
4667 .cindex "domain" "delivery to"
4668 The <&'rsflags'&> may be empty, in which case the white space before the string
4669 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4670 which are the possible values for <&'rsflags'&>. White space is required if
4671 <&'rsflags'&> is not empty.
4672
4673 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4674 perform a single queue run, except that, when scanning the messages on the
4675 queue, Exim processes only those that have at least one undelivered recipient
4676 address containing the given string, which is checked in a case-independent
4677 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4678 regular expression; otherwise it is a literal string.
4679
4680 If you want to do periodic queue runs for messages with specific recipients,
4681 you can combine &%-R%& with &%-q%& and a time value. For example:
4682 .code
4683 exim -q25m -R @special.domain.example
4684 .endd
4685 This example does a queue run for messages with recipients in the given domain
4686 every 25 minutes. Any additional flags that are specified with &%-q%& are
4687 applied to each queue run.
4688
4689 Once a message is selected for delivery by this mechanism, all its addresses
4690 are processed. For the first selected message, Exim overrides any retry
4691 information and forces a delivery attempt for each undelivered address. This
4692 means that if delivery of any address in the first message is successful, any
4693 existing retry information is deleted, and so delivery attempts for that
4694 address in subsequently selected messages (which are processed without forcing)
4695 will run. However, if delivery of any address does not succeed, the retry
4696 information is updated, and in subsequently selected messages, the failing
4697 address will be skipped.
4698
4699 .cindex "frozen messages" "forcing delivery"
4700 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4701 all selected messages, not just the first; frozen messages are included when
4702 &'ff'& is present.
4703
4704 The &%-R%& option makes it straightforward to initiate delivery of all messages
4705 to a given domain after a host has been down for some time. When the SMTP
4706 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4707 effect is to run Exim with the &%-R%& option, but it can be configured to run
4708 an arbitrary command instead.
4709
4710 .cmdopt -r
4711 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4712
4713 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4714 .oindex "&%-S%&"
4715 .cindex "delivery" "from given sender"
4716 .cindex "queue runner" "for specific senders"
4717 This option acts like &%-R%& except that it checks the string against each
4718 message's sender instead of against the recipients. If &%-R%& is also set, both
4719 conditions must be met for a message to be selected. If either of the options
4720 has &'f'& or &'ff'& in its flags, the associated action is taken.
4721
4722 .cmdopt -Tqt <&'times'&>
4723 This is an option that is exclusively for use by the Exim testing suite. It is not
4724 recognized when Exim is run normally. It allows for the setting up of explicit
4725 &"queue times"& so that various warning/retry features can be tested.
4726
4727 .cmdopt -t
4728 .cindex "recipient" "extracting from header lines"
4729 .chindex Bcc:
4730 .chindex Cc:
4731 .chindex To:
4732 When Exim is receiving a locally-generated, non-SMTP message on its standard
4733 input, the &%-t%& option causes the recipients of the message to be obtained
4734 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4735 from the command arguments. The addresses are extracted before any rewriting
4736 takes place and the &'Bcc:'& header line, if present, is then removed.
4737
4738 .cindex "Sendmail compatibility" "&%-t%& option"
4739 If the command has any arguments, they specify addresses to which the message
4740 is &'not'& to be delivered. That is, the argument addresses are removed from
4741 the recipients list obtained from the headers. This is compatible with Smail 3
4742 and in accordance with the documented behaviour of several versions of
4743 Sendmail, as described in man pages on a number of operating systems (e.g.
4744 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4745 argument addresses to those obtained from the headers, and the O'Reilly
4746 Sendmail book documents it that way. Exim can be made to add argument addresses
4747 instead of subtracting them by setting the option
4748 &%extract_addresses_remove_arguments%& false.
4749
4750 .cindex "&%Resent-%& header lines" "with &%-t%&"
4751 If there are any &%Resent-%& header lines in the message, Exim extracts
4752 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4753 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4754 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4755 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4756
4757 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4758 message is resent several times). The RFC also specifies that they should be
4759 added at the front of the message, and separated by &'Received:'& lines. It is
4760 not at all clear how &%-t%& should operate in the present of multiple sets,
4761 nor indeed exactly what constitutes a &"set"&.
4762 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4763 are often added at the end of the header, and if a message is resent more than
4764 once, it is common for the original set of &%Resent-%& headers to be renamed as
4765 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4766
4767 .cmdopt -ti
4768 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4769 compatibility with Sendmail.
4770
4771 .cmdopt -tls-on-connect
4772 .cindex "TLS" "use without STARTTLS"
4773 .cindex "TLS" "automatic start"
4774 This option is available when Exim is compiled with TLS support. It forces all
4775 incoming SMTP connections to behave as if the incoming port is listed in the
4776 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4777 &<<CHAPTLS>>& for further details.
4778
4779
4780 .cmdopt -U
4781 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4782 Sendmail uses this option for &"initial message submission"&, and its
4783 documentation states that in future releases, it may complain about
4784 syntactically invalid messages rather than fixing them when this flag is not
4785 set. Exim ignores this option.
4786
4787 .cmdopt -v
4788 This option causes Exim to write information to the standard error stream,
4789 describing what it is doing. In particular, it shows the log lines for
4790 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4791 dialogue is shown. Some of the log lines shown may not actually be written to
4792 the log if the setting of &%log_selector%& discards them. Any relevant
4793 selectors are shown with each log line. If none are shown, the logging is
4794 unconditional.
4795
4796 .cmdopt -x
4797 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4798 National Language Support extended characters in the body of the mail item"&).
4799 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4800 this option.
4801
4802 .cmdopt -X <&'logfile'&>
4803 This option is interpreted by Sendmail to cause debug information to be sent
4804 to the named file.  It is ignored by Exim.
4805
4806 .cmdopt -z <&'log-line'&>
4807 This option writes its argument to Exim's logfile.
4808 Use is restricted to administrators; the intent is for operational notes.
4809 Quotes should be used to maintain a multi-word item as a single argument,
4810 under most shells.
4811 .endlist
4812
4813 .ecindex IIDclo1
4814 .ecindex IIDclo2
4815
4816
4817 . ////////////////////////////////////////////////////////////////////////////
4818 . Insert a stylized DocBook comment here, to identify the end of the command
4819 . line options. This is for the benefit of the Perl script that automatically
4820 . creates a man page for the options.
4821 . ////////////////////////////////////////////////////////////////////////////
4822
4823 .literal xml
4824 <!-- === End of command line options === -->
4825 .literal off
4826
4827
4828
4829
4830
4831 . ////////////////////////////////////////////////////////////////////////////
4832 . ////////////////////////////////////////////////////////////////////////////
4833
4834
4835 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4836          "The runtime configuration file"
4837
4838 .cindex "runtime configuration"
4839 .cindex "configuration file" "general description"
4840 .cindex "CONFIGURE_FILE"
4841 .cindex "configuration file" "errors in"
4842 .cindex "error" "in configuration file"
4843 .cindex "return code" "for bad configuration"
4844 Exim uses a single runtime configuration file that is read whenever an Exim
4845 binary is executed. Note that in normal operation, this happens frequently,
4846 because Exim is designed to operate in a distributed manner, without central
4847 control.
4848
4849 If a syntax error is detected while reading the configuration file, Exim
4850 writes a message on the standard error, and exits with a non-zero return code.
4851 The message is also written to the panic log. &*Note*&: Only simple syntax
4852 errors can be detected at this time. The values of any expanded options are
4853 not checked until the expansion happens, even when the expansion does not
4854 actually alter the string.
4855
4856 The name of the configuration file is compiled into the binary for security
4857 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4858 most configurations, this specifies a single file. However, it is permitted to
4859 give a colon-separated list of filenames, in which case Exim uses the first
4860 existing file in the list.
4861
4862 .cindex "EXIM_USER"
4863 .cindex "EXIM_GROUP"
4864 .cindex "CONFIGURE_OWNER"
4865 .cindex "CONFIGURE_GROUP"
4866 .cindex "configuration file" "ownership"
4867 .cindex "ownership" "configuration file"
4868 The runtime configuration file must be owned by root or by the user that is
4869 specified at compile time by the CONFIGURE_OWNER option (if set). The
4870 configuration file must not be world-writeable, or group-writeable unless its
4871 group is the root group or the one specified at compile time by the
4872 CONFIGURE_GROUP option.
4873
4874 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4875 to root, anybody who is able to edit the runtime configuration file has an
4876 easy way to run commands as root. If you specify a user or group in the
4877 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4878 who are members of that group will trivially be able to obtain root privileges.
4879
4880 Up to Exim version 4.72, the runtime configuration file was also permitted to
4881 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4882 since it offered a simple privilege escalation for any attacker who managed to
4883 compromise the Exim user account.
4884
4885 A default configuration file, which will work correctly in simple situations,
4886 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4887 defines just one filename, the installation process copies the default
4888 configuration to a new file of that name if it did not previously exist. If
4889 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4890 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4891 configuration.
4892
4893
4894
4895 .section "Using a different configuration file" "SECID40"
4896 .cindex "configuration file" "alternate"
4897 A one-off alternate configuration can be specified by the &%-C%& command line
4898 option, which may specify a single file or a list of files. However, when
4899 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4900 unless the argument for &%-C%& is identical to the built-in value from
4901 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4902 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4903 is useful mainly for checking the syntax of configuration files before
4904 installing them. No owner or group checks are done on a configuration file
4905 specified by &%-C%&, if root privilege has been dropped.
4906
4907 Even the Exim user is not trusted to specify an arbitrary configuration file
4908 with the &%-C%& option to be used with root privileges, unless that file is
4909 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4910 testing a configuration using &%-C%& right through message reception and
4911 delivery, even if the caller is root. The reception works, but by that time,
4912 Exim is running as the Exim user, so when it re-execs to regain privilege for
4913 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4914 can test reception and delivery using two separate commands (one to put a
4915 message in the queue, using &%-odq%&, and another to do the delivery, using
4916 &%-M%&).
4917
4918 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4919 prefix string with which any file named in a &%-C%& command line option must
4920 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4921 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4922 filename can be used with &%-C%&.
4923
4924 One-off changes to a configuration can be specified by the &%-D%& command line
4925 option, which defines and overrides values for macros used inside the
4926 configuration file. However, like &%-C%&, the use of this option by a
4927 non-privileged user causes Exim to discard its root privilege.
4928 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4929 completely disabled, and its use causes an immediate error exit.
4930
4931 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4932 to declare certain macro names trusted, such that root privilege will not
4933 necessarily be discarded.
4934 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4935 considered safe and, if &%-D%& only supplies macros from this list, and the
4936 values are acceptable, then Exim will not give up root privilege if the caller
4937 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4938 transition mechanism and is expected to be removed in the future.  Acceptable
4939 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4940
4941 Some sites may wish to use the same Exim binary on different machines that
4942 share a file system, but to use different configuration files on each machine.
4943 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4944 looks for a file whose name is the configuration filename followed by a dot
4945 and the machine's node name, as obtained from the &[uname()]& function. If this
4946 file does not exist, the standard name is tried. This processing occurs for
4947 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4948
4949 In some esoteric situations different versions of Exim may be run under
4950 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4951 help with this. See the comments in &_src/EDITME_& for details.
4952
4953
4954
4955 .section "Configuration file format" "SECTconffilfor"
4956 .cindex "configuration file" "format of"
4957 .cindex "format" "configuration file"
4958 Exim's configuration file is divided into a number of different parts. General
4959 option settings must always appear at the start of the file. The other parts
4960 are all optional, and may appear in any order. Each part other than the first
4961 is introduced by the word &"begin"& followed by at least one literal
4962 space, and the name of the part. The optional parts are:
4963
4964 .ilist
4965 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4966 &<<CHAPACL>>&).
4967 .next
4968 .cindex "AUTH" "configuration"
4969 &'authenticators'&: Configuration settings for the authenticator drivers. These
4970 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4971 .next
4972 &'routers'&: Configuration settings for the router drivers. Routers process
4973 addresses and determine how the message is to be delivered (see chapters
4974 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4975 .next
4976 &'transports'&: Configuration settings for the transport drivers. Transports
4977 define mechanisms for copying messages to destinations (see chapters
4978 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4979 .next
4980 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4981 If there is no retry section, or if it is empty (that is, no retry rules are
4982 defined), Exim will not retry deliveries. In this situation, temporary errors
4983 are treated the same as permanent errors. Retry rules are discussed in chapter
4984 &<<CHAPretry>>&.
4985 .next
4986 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4987 when new addresses are generated during delivery. Rewriting is discussed in
4988 chapter &<<CHAPrewrite>>&.
4989 .next
4990 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4991 want to use this feature, you must set
4992 .code
4993 LOCAL_SCAN_HAS_OPTIONS=yes
4994 .endd
4995 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4996 facility are given in chapter &<<CHAPlocalscan>>&.
4997 .endlist
4998
4999 .cindex "configuration file" "leading white space in"
5000 .cindex "configuration file" "trailing white space in"
5001 .cindex "white space" "in configuration file"
5002 Leading and trailing white space in configuration lines is always ignored.
5003
5004 Blank lines in the file, and lines starting with a # character (ignoring
5005 leading white space) are treated as comments and are ignored. &*Note*&: A
5006 # character other than at the beginning of a line is not treated specially,
5007 and does not introduce a comment.
5008
5009 Any non-comment line can be continued by ending it with a backslash. Note that
5010 the general rule for white space means that trailing white space after the
5011 backslash and leading white space at the start of continuation
5012 lines is ignored. Comment lines beginning with # (but not empty lines) may
5013 appear in the middle of a sequence of continuation lines.
5014
5015 A convenient way to create a configuration file is to start from the
5016 default, which is supplied in &_src/configure.default_&, and add, delete, or
5017 change settings as required.
5018
5019 The ACLs, retry rules, and rewriting rules have their own syntax which is
5020 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5021 respectively. The other parts of the configuration file have some syntactic
5022 items in common, and these are described below, from section &<<SECTcos>>&
5023 onwards. Before that, the inclusion, macro, and conditional facilities are
5024 described.
5025
5026
5027
5028 .section "File inclusions in the configuration file" "SECID41"
5029 .cindex "inclusions in configuration file"
5030 .cindex "configuration file" "including other files"
5031 .cindex "&`.include`& in configuration file"
5032 .cindex "&`.include_if_exists`& in configuration file"
5033 You can include other files inside Exim's runtime configuration file by
5034 using this syntax:
5035 .display
5036 &`.include`& <&'filename'&>
5037 &`.include_if_exists`& <&'filename'&>
5038 .endd
5039 on a line by itself. Double quotes round the filename are optional. If you use
5040 the first form, a configuration error occurs if the file does not exist; the
5041 second form does nothing for non-existent files.
5042 The first form allows a relative name. It is resolved relative to
5043 the directory of the including file. For the second form an absolute filename
5044 is required.
5045
5046 Includes may be nested to any depth, but remember that Exim reads its
5047 configuration file often, so it is a good idea to keep them to a minimum.
5048 If you change the contents of an included file, you must HUP the daemon,
5049 because an included file is read only when the configuration itself is read.
5050
5051 The processing of inclusions happens early, at a physical line level, so, like
5052 comment lines, an inclusion can be used in the middle of an option setting,
5053 for example:
5054 .code
5055 hosts_lookup = a.b.c \
5056                .include /some/file
5057 .endd
5058 Include processing happens after macro processing (see below). Its effect is to
5059 process the lines of the included file as if they occurred inline where the
5060 inclusion appears.
5061
5062
5063
5064 .section "Macros in the configuration file" "SECTmacrodefs"
5065 .cindex "macro" "description of"
5066 .cindex "configuration file" "macros"
5067 If a line in the main part of the configuration (that is, before the first
5068 &"begin"& line) begins with an upper case letter, it is taken as a macro
5069 definition, and must be of the form
5070 .display
5071 <&'name'&> = <&'rest of line'&>
5072 .endd
5073 The name must consist of letters, digits, and underscores, and need not all be
5074 in upper case, though that is recommended. The rest of the line, including any
5075 continuations, is the replacement text, and has leading and trailing white
5076 space removed. Quotes are not removed. The replacement text can never end with
5077 a backslash character, but this doesn't seem to be a serious limitation.
5078
5079 Macros may also be defined between router, transport, authenticator, or ACL
5080 definitions. They may not, however, be defined within an individual driver or
5081 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5082
5083 .section "Macro substitution" "SECID42"
5084 Once a macro is defined, all subsequent lines in the file (and any included
5085 files) are scanned for the macro name; if there are several macros, the line is
5086 scanned for each, in turn, in the order in which the macros are defined. The
5087 replacement text is not re-scanned for the current macro, though it is scanned
5088 for subsequently defined macros. For this reason, a macro name may not contain
5089 the name of a previously defined macro as a substring. You could, for example,
5090 define
5091 .display
5092 &`ABCD_XYZ = `&<&'something'&>
5093 &`ABCD = `&<&'something else'&>
5094 .endd
5095 but putting the definitions in the opposite order would provoke a configuration
5096 error. Macro expansion is applied to individual physical lines from the file,
5097 before checking for line continuation or file inclusion (see above). If a line
5098 consists solely of a macro name, and the expansion of the macro is empty, the
5099 line is ignored. A macro at the start of a line may turn the line into a
5100 comment line or a &`.include`& line.
5101
5102
5103 .section "Redefining macros" "SECID43"
5104 Once defined, the value of a macro can be redefined later in the configuration
5105 (or in an included file). Redefinition is specified by using &'=='& instead of
5106 &'='&. For example:
5107 .code
5108 MAC =  initial value
5109 ...
5110 MAC == updated value
5111 .endd
5112 Redefinition does not alter the order in which the macros are applied to the
5113 subsequent lines of the configuration file. It is still the same order in which
5114 the macros were originally defined. All that changes is the macro's value.
5115 Redefinition makes it possible to accumulate values. For example:
5116 .code
5117 MAC =  initial value
5118 ...
5119 MAC == MAC and something added
5120 .endd
5121 This can be helpful in situations where the configuration file is built
5122 from a number of other files.
5123
5124 .section "Overriding macro values" "SECID44"
5125 The values set for macros in the configuration file can be overridden by the
5126 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5127 used, unless called by root or the Exim user. A definition on the command line
5128 using the &%-D%& option causes all definitions and redefinitions within the
5129 file to be ignored.
5130
5131
5132
5133 .section "Example of macro usage" "SECID45"
5134 As an example of macro usage, consider a configuration where aliases are looked
5135 up in a MySQL database. It helps to keep the file less cluttered if long
5136 strings such as SQL statements are defined separately as macros, for example:
5137 .code
5138 ALIAS_QUERY = select mailbox from user where \
5139               login='${quote_mysql:$local_part}';
5140 .endd
5141 This can then be used in a &(redirect)& router setting like this:
5142 .code
5143 data = ${lookup mysql{ALIAS_QUERY}}
5144 .endd
5145 In earlier versions of Exim macros were sometimes used for domain, host, or
5146 address lists. In Exim 4 these are handled better by named lists &-- see
5147 section &<<SECTnamedlists>>&.
5148
5149
5150 .section "Builtin macros" "SECTbuiltinmacros"
5151 Exim defines some macros depending on facilities available, which may
5152 differ due to build-time definitions and from one release to another.
5153 All of these macros start with an underscore.
5154 They can be used to conditionally include parts of a configuration
5155 (see below).
5156
5157 The following classes of macros are defined:
5158 .display
5159 &` _HAVE_*                    `&  build-time defines
5160 &` _DRIVER_ROUTER_*           `&  router drivers
5161 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5162 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5163 &` _EXP_COND_*                `&  expansion conditions
5164 &` _EXP_ITEM_*                `&  expansion items
5165 &` _EXP_OP_*                  `&  expansion operators
5166 &` _EXP_VAR_*                 `&  expansion variables
5167 &` _LOG_*                     `&  log_selector values
5168 &` _OPT_MAIN_*                `&  main config options
5169 &` _OPT_ROUTERS_*             `&  generic router options
5170 &` _OPT_TRANSPORTS_*          `&  generic transport options
5171 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5172 &` _OPT_ROUTER_*_*            `&  private router options
5173 &` _OPT_TRANSPORT_*_*         `&  private transport options
5174 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5175 .endd
5176
5177 Use an &"exim -bP macros"& command to get the list of macros.
5178
5179
5180 .section "Conditional skips in the configuration file" "SECID46"
5181 .cindex "configuration file" "conditional skips"
5182 .cindex "&`.ifdef`&"
5183 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5184 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5185 portions of the configuration file. The processing happens whenever the file is
5186 read (that is, when an Exim binary starts to run).
5187
5188 The implementation is very simple. Instances of the first four directives must
5189 be followed by text that includes the names of one or macros. The condition
5190 that is tested is whether or not any macro substitution has taken place in the
5191 line. Thus:
5192 .code
5193 .ifdef AAA
5194 message_size_limit = 50M
5195 .else
5196 message_size_limit = 100M
5197 .endif
5198 .endd
5199 sets a message size limit of 50M if the macro &`AAA`& is defined
5200 (or &`A`& or &`AA`&), and 100M
5201 otherwise. If there is more than one macro named on the line, the condition
5202 is true if any of them are defined. That is, it is an &"or"& condition. To
5203 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5204
5205 Although you can use a macro expansion to generate one of these directives,
5206 it is not very useful, because the condition &"there was a macro substitution
5207 in this line"& will always be true.
5208
5209 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5210 to clarify complicated nestings.
5211
5212
5213
5214 .section "Common option syntax" "SECTcos"
5215 .cindex "common option syntax"
5216 .cindex "syntax of common options"
5217 .cindex "configuration file" "common option syntax"
5218 For the main set of options, driver options, and &[local_scan()]& options,
5219 each setting is on a line by itself, and starts with a name consisting of
5220 lower-case letters and underscores. Many options require a data value, and in
5221 these cases the name must be followed by an equals sign (with optional white
5222 space) and then the value. For example:
5223 .code
5224 qualify_domain = mydomain.example.com
5225 .endd
5226 .cindex "hiding configuration option values"
5227 .cindex "configuration options" "hiding value of"
5228 .cindex "options" "hiding value of"
5229 Some option settings may contain sensitive data, for example, passwords for
5230 accessing databases. To stop non-admin users from using the &%-bP%& command
5231 line option to read these values, you can precede the option settings with the
5232 word &"hide"&. For example:
5233 .code
5234 hide mysql_servers = localhost/users/admin/secret-password
5235 .endd
5236 For non-admin users, such options are displayed like this:
5237 .code
5238 mysql_servers = <value not displayable>
5239 .endd
5240 If &"hide"& is used on a driver option, it hides the value of that option on
5241 all instances of the same driver.
5242
5243 The following sections describe the syntax used for the different data types
5244 that are found in option settings.
5245
5246
5247 .section "Boolean options" "SECID47"
5248 .cindex "format" "boolean"
5249 .cindex "boolean configuration values"
5250 .oindex "&%no_%&&'xxx'&"
5251 .oindex "&%not_%&&'xxx'&"
5252 Options whose type is given as boolean are on/off switches. There are two
5253 different ways of specifying such options: with and without a data value. If
5254 the option name is specified on its own without data, the switch is turned on;
5255 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5256 boolean options may be followed by an equals sign and one of the words
5257 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5258 the following two settings have exactly the same effect:
5259 .code
5260 queue_only
5261 queue_only = true
5262 .endd
5263 The following two lines also have the same (opposite) effect:
5264 .code
5265 no_queue_only
5266 queue_only = false
5267 .endd
5268 You can use whichever syntax you prefer.
5269
5270
5271
5272
5273 .section "Integer values" "SECID48"
5274 .cindex "integer configuration values"
5275 .cindex "format" "integer"
5276 If an option's type is given as &"integer"&, the value can be given in decimal,
5277 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5278 number is assumed. Otherwise, it is treated as an octal number unless it starts
5279 with the characters &"0x"&, in which case the remainder is interpreted as a
5280 hexadecimal number.
5281
5282 If an integer value is followed by the letter K, it is multiplied by 1024; if
5283 it is followed by the letter M, it is multiplied by 1024x1024;
5284 if by the letter G, 1024x1024x1024.
5285 When the values
5286 of integer option settings are output, values which are an exact multiple of
5287 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5288 and M. The printing style is independent of the actual input format that was
5289 used.
5290
5291
5292 .section "Octal integer values" "SECID49"
5293 .cindex "integer format"
5294 .cindex "format" "octal integer"
5295 If an option's type is given as &"octal integer"&, its value is always
5296 interpreted as an octal number, whether or not it starts with the digit zero.
5297 Such options are always output in octal.
5298
5299
5300 .section "Fixed point numbers" "SECID50"
5301 .cindex "fixed point configuration values"
5302 .cindex "format" "fixed point"
5303 If an option's type is given as &"fixed-point"&, its value must be a decimal
5304 integer, optionally followed by a decimal point and up to three further digits.
5305
5306
5307
5308 .section "Time intervals" "SECTtimeformat"
5309 .cindex "time interval" "specifying in configuration"
5310 .cindex "format" "time interval"
5311 A time interval is specified as a sequence of numbers, each followed by one of
5312 the following letters, with no intervening white space:
5313
5314 .table2 30pt
5315 .irow &%s%& seconds
5316 .irow &%m%& minutes
5317 .irow &%h%& hours
5318 .irow &%d%& days
5319 .irow &%w%& weeks
5320 .endtable
5321
5322 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5323 intervals are output in the same format. Exim does not restrict the values; it
5324 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5325
5326
5327
5328 .section "String values" "SECTstrings"
5329 .cindex "string" "format of configuration values"
5330 .cindex "format" "string"
5331 If an option's type is specified as &"string"&, the value can be specified with
5332 or without double-quotes. If it does not start with a double-quote, the value
5333 consists of the remainder of the line plus any continuation lines, starting at
5334 the first character after any leading white space, with trailing white space
5335 removed, and with no interpretation of the characters in the string. Because
5336 Exim removes comment lines (those beginning with #) at an early stage, they can
5337 appear in the middle of a multi-line string. The following two settings are
5338 therefore equivalent:
5339 .code
5340 trusted_users = uucp:mail
5341 trusted_users = uucp:\
5342                 # This comment line is ignored
5343                 mail
5344 .endd
5345 .cindex "string" "quoted"
5346 .cindex "escape characters in quoted strings"
5347 If a string does start with a double-quote, it must end with a closing
5348 double-quote, and any backslash characters other than those used for line
5349 continuation are interpreted as escape characters, as follows:
5350
5351 .table2 100pt
5352 .irow &`\\`&                     "single backslash"
5353 .irow &`\n`&                     "newline"
5354 .irow &`\r`&                     "carriage return"
5355 .irow &`\t`&                     "tab"
5356 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5357 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5358                                    character"
5359 .endtable
5360
5361 If a backslash is followed by some other character, including a double-quote
5362 character, that character replaces the pair.
5363
5364 Quoting is necessary only if you want to make use of the backslash escapes to
5365 insert special characters, or if you need to specify a value with leading or
5366 trailing spaces. These cases are rare, so quoting is almost never needed in
5367 current versions of Exim. In versions of Exim before 3.14, quoting was required
5368 in order to continue lines, so you may come across older configuration files
5369 and examples that apparently quote unnecessarily.
5370
5371
5372 .section "Expanded strings" "SECID51"
5373 .cindex "expansion" "definition of"
5374 Some strings in the configuration file are subjected to &'string expansion'&,
5375 by which means various parts of the string may be changed according to the
5376 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5377 is as just described; in particular, the handling of backslashes in quoted
5378 strings is done as part of the input process, before expansion takes place.
5379 However, backslash is also an escape character for the expander, so any
5380 backslashes that are required for that reason must be doubled if they are
5381 within a quoted configuration string.
5382
5383
5384 .section "User and group names" "SECID52"
5385 .cindex "user name" "format of"
5386 .cindex "format" "user name"
5387 .cindex "groups" "name format"
5388 .cindex "format" "group name"
5389 User and group names are specified as strings, using the syntax described
5390 above, but the strings are interpreted specially. A user or group name must
5391 either consist entirely of digits, or be a name that can be looked up using the
5392 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5393
5394
5395 .section "List construction" "SECTlistconstruct"
5396 .cindex "list" "syntax of in configuration"
5397 .cindex "format" "list item in configuration"
5398 .cindex "string" "list, definition of"
5399 The data for some configuration options is a list of items, with colon as the
5400 default separator. Many of these options are shown with type &"string list"& in
5401 the descriptions later in this document. Others are listed as &"domain list"&,
5402 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5403 are all the same; however, those other than &"string list"& are subject to
5404 particular kinds of interpretation, as described in chapter
5405 &<<CHAPdomhosaddlists>>&.
5406
5407 In all these cases, the entire list is treated as a single string as far as the
5408 input syntax is concerned. The &%trusted_users%& setting in section
5409 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5410 in a list, it must be entered as two colons. Leading and trailing white space
5411 on each item in a list is ignored. This makes it possible to include items that
5412 start with a colon, and in particular, certain forms of IPv6 address. For
5413 example, the list
5414 .code
5415 local_interfaces = 127.0.0.1 : ::::1
5416 .endd
5417 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5418
5419 &*Note*&: Although leading and trailing white space is ignored in individual
5420 list items, it is not ignored when parsing the list. The spaces around the first
5421 colon in the example above are necessary. If they were not there, the list would
5422 be interpreted as the two items 127.0.0.1:: and 1.
5423
5424 .section "Changing list separators" "SECTlistsepchange"
5425 .cindex "list separator" "changing"
5426 .cindex "IPv6" "addresses in lists"
5427 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5428 introduced to allow the separator character to be changed. If a list begins
5429 with a left angle bracket, followed by any punctuation character, that
5430 character is used instead of colon as the list separator. For example, the list
5431 above can be rewritten to use a semicolon separator like this:
5432 .code
5433 local_interfaces = <; 127.0.0.1 ; ::1
5434 .endd
5435 This facility applies to all lists, with the exception of the list in
5436 &%log_file_path%&. It is recommended that the use of non-colon separators be
5437 confined to circumstances where they really are needed.
5438
5439 .cindex "list separator" "newline as"
5440 .cindex "newline" "as list separator"
5441 It is also possible to use newline and other control characters (those with
5442 code values less than 32, plus DEL) as separators in lists. Such separators
5443 must be provided literally at the time the list is processed. For options that
5444 are string-expanded, you can write the separator using a normal escape
5445 sequence. This will be processed by the expander before the string is
5446 interpreted as a list. For example, if a newline-separated list of domains is
5447 generated by a lookup, you can process it directly by a line such as this:
5448 .code
5449 domains = <\n ${lookup mysql{.....}}
5450 .endd
5451 This avoids having to change the list separator in such data. You are unlikely
5452 to want to use a control character as a separator in an option that is not
5453 expanded, because the value is literal text. However, it can be done by giving
5454 the value in quotes. For example:
5455 .code
5456 local_interfaces = "<\n 127.0.0.1 \n ::1"
5457 .endd
5458 Unlike printing character separators, which can be included in list items by
5459 doubling, it is not possible to include a control character as data when it is
5460 set as the separator. Two such characters in succession are interpreted as
5461 enclosing an empty list item.
5462
5463
5464
5465 .section "Empty items in lists" "SECTempitelis"
5466 .cindex "list" "empty item in"
5467 An empty item at the end of a list is always ignored. In other words, trailing
5468 separator characters are ignored. Thus, the list in
5469 .code
5470 senders = user@domain :
5471 .endd
5472 contains only a single item. If you want to include an empty string as one item
5473 in a list, it must not be the last item. For example, this list contains three
5474 items, the second of which is empty:
5475 .code
5476 senders = user1@domain : : user2@domain
5477 .endd
5478 &*Note*&: There must be white space between the two colons, as otherwise they
5479 are interpreted as representing a single colon data character (and the list
5480 would then contain just one item). If you want to specify a list that contains
5481 just one, empty item, you can do it as in this example:
5482 .code
5483 senders = :
5484 .endd
5485 In this case, the first item is empty, and the second is discarded because it
5486 is at the end of the list.
5487
5488
5489
5490
5491 .section "Format of driver configurations" "SECTfordricon"
5492 .cindex "drivers" "configuration format"
5493 There are separate parts in the configuration for defining routers, transports,
5494 and authenticators. In each part, you are defining a number of driver
5495 instances, each with its own set of options. Each driver instance is defined by
5496 a sequence of lines like this:
5497 .display
5498 <&'instance name'&>:
5499   <&'option'&>
5500   ...
5501   <&'option'&>
5502 .endd
5503 In the following example, the instance name is &(localuser)&, and it is
5504 followed by three options settings:
5505 .code
5506 localuser:
5507   driver = accept
5508   check_local_user
5509   transport = local_delivery
5510 .endd
5511 For each driver instance, you specify which Exim code module it uses &-- by the
5512 setting of the &%driver%& option &-- and (optionally) some configuration
5513 settings. For example, in the case of transports, if you want a transport to
5514 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5515 a local file you would use the &(appendfile)& driver. Each of the drivers is
5516 described in detail in its own separate chapter later in this manual.
5517
5518 You can have several routers, transports, or authenticators that are based on
5519 the same underlying driver (each must have a different instance name).
5520
5521 The order in which routers are defined is important, because addresses are
5522 passed to individual routers one by one, in order. The order in which
5523 transports are defined does not matter at all. The order in which
5524 authenticators are defined is used only when Exim, as a client, is searching
5525 them to find one that matches an authentication mechanism offered by the
5526 server.
5527
5528 .cindex "generic options"
5529 .cindex "options" "generic &-- definition of"
5530 Within a driver instance definition, there are two kinds of option: &'generic'&
5531 and &'private'&. The generic options are those that apply to all drivers of the
5532 same type (that is, all routers, all transports or all authenticators). The
5533 &%driver%& option is a generic option that must appear in every definition.
5534 .cindex "private options"
5535 The private options are special for each driver, and none need appear, because
5536 they all have default values.
5537
5538 The options may appear in any order, except that the &%driver%& option must
5539 precede any private options, since these depend on the particular driver. For
5540 this reason, it is recommended that &%driver%& always be the first option.
5541
5542 Driver instance names, which are used for reference in log entries and
5543 elsewhere, can be any sequence of letters, digits, and underscores (starting
5544 with a letter) and must be unique among drivers of the same type. A router and
5545 a transport (for example) can each have the same name, but no two router
5546 instances can have the same name. The name of a driver instance should not be
5547 confused with the name of the underlying driver module. For example, the
5548 configuration lines:
5549 .code
5550 remote_smtp:
5551   driver = smtp
5552 .endd
5553 create an instance of the &(smtp)& transport driver whose name is
5554 &(remote_smtp)&. The same driver code can be used more than once, with
5555 different instance names and different option settings each time. A second
5556 instance of the &(smtp)& transport, with different options, might be defined
5557 thus:
5558 .code
5559 special_smtp:
5560   driver = smtp
5561   port = 1234
5562   command_timeout = 10s
5563 .endd
5564 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5565 these transport instances from routers, and these names would appear in log
5566 lines.
5567
5568 Comment lines may be present in the middle of driver specifications. The full
5569 list of option settings for any particular driver instance, including all the
5570 defaulted values, can be extracted by making use of the &%-bP%& command line
5571 option.
5572
5573
5574
5575
5576
5577
5578 . ////////////////////////////////////////////////////////////////////////////
5579 . ////////////////////////////////////////////////////////////////////////////
5580
5581 .chapter "The default configuration file" "CHAPdefconfil"
5582 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5583 .cindex "default" "configuration file &""walk through""&"
5584 The default configuration file supplied with Exim as &_src/configure.default_&
5585 is sufficient for a host with simple mail requirements. As an introduction to
5586 the way Exim is configured, this chapter &"walks through"& the default
5587 configuration, giving brief explanations of the settings. Detailed descriptions
5588 of the options are given in subsequent chapters. The default configuration file
5589 itself contains extensive comments about ways you might want to modify the
5590 initial settings. However, note that there are many options that are not
5591 mentioned at all in the default configuration.
5592
5593
5594
5595 .section "Macros" "SECTdefconfmacros"
5596 All macros should be defined before any options.
5597
5598 One macro is specified, but commented out, in the default configuration:
5599 .code
5600 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5601 .endd
5602 If all off-site mail is expected to be delivered to a "smarthost", then set the
5603 hostname here and uncomment the macro.  This will affect which router is used
5604 later on.  If this is left commented out, then Exim will perform direct-to-MX
5605 deliveries using a &(dnslookup)& router.
5606
5607 In addition to macros defined here, Exim includes a number of built-in macros
5608 to enable configuration to be guarded by a binary built with support for a
5609 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5610
5611
5612 .section "Main configuration settings" "SECTdefconfmain"
5613 The main (global) configuration option settings section must always come first
5614 in the file, after the macros.
5615 The first thing you'll see in the file, after some initial comments, is the line
5616 .code
5617 # primary_hostname =
5618 .endd
5619 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5620 to know the official, fully qualified name of your host, and this is where you
5621 can specify it. However, in most cases you do not need to set this option. When
5622 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5623
5624 The first three non-comment configuration lines are as follows:
5625 .code
5626 domainlist local_domains    = @
5627 domainlist relay_to_domains =
5628 hostlist   relay_from_hosts = 127.0.0.1
5629 .endd
5630 These are not, in fact, option settings. They are definitions of two named
5631 domain lists and one named host list. Exim allows you to give names to lists of
5632 domains, hosts, and email addresses, in order to make it easier to manage the
5633 configuration file (see section &<<SECTnamedlists>>&).
5634
5635 The first line defines a domain list called &'local_domains'&; this is used
5636 later in the configuration to identify domains that are to be delivered
5637 on the local host.
5638
5639 .cindex "@ in a domain list"
5640 There is just one item in this list, the string &"@"&. This is a special form
5641 of entry which means &"the name of the local host"&. Thus, if the local host is
5642 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5643 be delivered locally. Because the local host's name is referenced indirectly,
5644 the same configuration file can be used on different hosts.
5645
5646 The second line defines a domain list called &'relay_to_domains'&, but the
5647 list itself is empty. Later in the configuration we will come to the part that
5648 controls mail relaying through the local host; it allows relaying to any
5649 domains in this list. By default, therefore, no relaying on the basis of a mail
5650 domain is permitted.
5651
5652 The third line defines a host list called &'relay_from_hosts'&. This list is
5653 used later in the configuration to permit relaying from any host or IP address
5654 that matches the list. The default contains just the IP address of the IPv4
5655 loopback interface, which means that processes on the local host are able to
5656 submit mail for relaying by sending it over TCP/IP to that interface. No other
5657 hosts are permitted to submit messages for relaying.
5658
5659 Just to be sure there's no misunderstanding: at this point in the configuration
5660 we aren't actually setting up any controls. We are just defining some domains
5661 and hosts that will be used in the controls that are specified later.
5662
5663 The next two configuration lines are genuine option settings:
5664 .code
5665 acl_smtp_rcpt = acl_check_rcpt
5666 acl_smtp_data = acl_check_data
5667 .endd
5668 These options specify &'Access Control Lists'& (ACLs) that are to be used
5669 during an incoming SMTP session for every recipient of a message (every RCPT
5670 command), and after the contents of the message have been received,
5671 respectively. The names of the lists are &'acl_check_rcpt'& and
5672 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5673 section of the configuration. The RCPT ACL controls which recipients are
5674 accepted for an incoming message &-- if a configuration does not provide an ACL
5675 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5676 contents of a message to be checked.
5677
5678 Two commented-out option settings are next:
5679 .code
5680 # av_scanner = clamd:/tmp/clamd
5681 # spamd_address = 127.0.0.1 783
5682 .endd
5683 These are example settings that can be used when Exim is compiled with the
5684 content-scanning extension. The first specifies the interface to the virus
5685 scanner, and the second specifies the interface to SpamAssassin. Further
5686 details are given in chapter &<<CHAPexiscan>>&.
5687
5688 Three more commented-out option settings follow:
5689 .code
5690 # tls_advertise_hosts = *
5691 # tls_certificate = /etc/ssl/exim.crt
5692 # tls_privatekey = /etc/ssl/exim.pem
5693 .endd
5694 These are example settings that can be used when Exim is compiled with
5695 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5696 first one specifies the list of clients that are allowed to use TLS when
5697 connecting to this server; in this case, the wildcard means all clients. The
5698 other options specify where Exim should find its TLS certificate and private
5699 key, which together prove the server's identity to any clients that connect.
5700 More details are given in chapter &<<CHAPTLS>>&.
5701
5702 Another two commented-out option settings follow:
5703 .code
5704 # daemon_smtp_ports = 25 : 465 : 587
5705 # tls_on_connect_ports = 465
5706 .endd
5707 .cindex "port" "465 and 587"
5708 .cindex "port" "for message submission"
5709 .cindex "message" "submission, ports for"
5710 .cindex "submissions protocol"
5711 .cindex "smtps protocol"
5712 .cindex "ssmtp protocol"
5713 .cindex "SMTP" "submissions protocol"
5714 .cindex "SMTP" "ssmtp protocol"
5715 .cindex "SMTP" "smtps protocol"
5716 These options provide better support for roaming users who wish to use this
5717 server for message submission. They are not much use unless you have turned on
5718 TLS (as described in the previous paragraph) and authentication (about which
5719 more in section &<<SECTdefconfauth>>&).
5720 Mail submission from mail clients (MUAs) should be separate from inbound mail
5721 to your domain (MX delivery) for various good reasons (eg, ability to impose
5722 much saner TLS protocol and ciphersuite requirements without unintended
5723 consequences).
5724 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5725 which uses STARTTLS, so this is the &"submission"& port.
5726 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5727 which should be used in preference to 587.
5728 You should also consider deploying SRV records to help clients find
5729 these ports.
5730 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5731
5732 Two more commented-out options settings follow:
5733 .code
5734 # qualify_domain =
5735 # qualify_recipient =
5736 .endd
5737 The first of these specifies a domain that Exim uses when it constructs a
5738 complete email address from a local login name. This is often needed when Exim
5739 receives a message from a local process. If you do not set &%qualify_domain%&,
5740 the value of &%primary_hostname%& is used. If you set both of these options,
5741 you can have different qualification domains for sender and recipient
5742 addresses. If you set only the first one, its value is used in both cases.
5743
5744 .cindex "domain literal" "recognizing format"
5745 The following line must be uncommented if you want Exim to recognize
5746 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5747 (an IP address within square brackets) instead of a named domain.
5748 .code
5749 # allow_domain_literals
5750 .endd
5751 The RFCs still require this form, but many people think that in the modern
5752 Internet it makes little sense to permit mail to be sent to specific hosts by
5753 quoting their IP addresses. This ancient format has been used by people who
5754 try to abuse hosts by using them for unwanted relaying. However, some
5755 people believe there are circumstances (for example, messages addressed to
5756 &'postmaster'&) where domain literals are still useful.
5757
5758 The next configuration line is a kind of trigger guard:
5759 .code
5760 never_users = root
5761 .endd
5762 It specifies that no delivery must ever be run as the root user. The normal
5763 convention is to set up &'root'& as an alias for the system administrator. This
5764 setting is a guard against slips in the configuration.
5765 The list of users specified by &%never_users%& is not, however, the complete
5766 list; the build-time configuration in &_Local/Makefile_& has an option called
5767 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5768 contents of &%never_users%& are added to this list. By default
5769 FIXED_NEVER_USERS also specifies root.
5770
5771 When a remote host connects to Exim in order to send mail, the only information
5772 Exim has about the host's identity is its IP address. The next configuration
5773 line,
5774 .code
5775 host_lookup = *
5776 .endd
5777 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5778 in order to get a host name. This improves the quality of the logging
5779 information, but if you feel it is too expensive, you can remove it entirely,
5780 or restrict the lookup to hosts on &"nearby"& networks.
5781 Note that it is not always possible to find a host name from an IP address,
5782 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5783 unreachable.
5784
5785 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5786 1413 (hence their names):
5787 .code
5788 rfc1413_hosts = *
5789 rfc1413_query_timeout = 0s
5790 .endd
5791 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5792 Few hosts offer RFC1413 service these days; calls have to be
5793 terminated by a timeout and this needlessly delays the startup
5794 of an incoming SMTP connection.
5795 If you have hosts for which you trust RFC1413 and need this
5796 information, you can change this.
5797
5798 This line enables an efficiency SMTP option.  It is negotiated by clients
5799 and not expected to cause problems but can be disabled if needed.
5800 .code
5801 prdr_enable = true
5802 .endd
5803
5804 When Exim receives messages over SMTP connections, it expects all addresses to
5805 be fully qualified with a domain, as required by the SMTP definition. However,
5806 if you are running a server to which simple clients submit messages, you may
5807 find that they send unqualified addresses. The two commented-out options:
5808 .code
5809 # sender_unqualified_hosts =
5810 # recipient_unqualified_hosts =
5811 .endd
5812 show how you can specify hosts that are permitted to send unqualified sender
5813 and recipient addresses, respectively.
5814
5815 The &%log_selector%& option is used to increase the detail of logging
5816 over the default:
5817 .code
5818 log_selector = +smtp_protocol_error +smtp_syntax_error \
5819                +tls_certificate_verified
5820 .endd
5821
5822 The &%percent_hack_domains%& option is also commented out:
5823 .code
5824 # percent_hack_domains =
5825 .endd
5826 It provides a list of domains for which the &"percent hack"& is to operate.
5827 This is an almost obsolete form of explicit email routing. If you do not know
5828 anything about it, you can safely ignore this topic.
5829
5830 The next two settings in the main part of the default configuration are
5831 concerned with messages that have been &"frozen"& on Exim's queue. When a
5832 message is frozen, Exim no longer continues to try to deliver it. Freezing
5833 occurs when a bounce message encounters a permanent failure because the sender
5834 address of the original message that caused the bounce is invalid, so the
5835 bounce cannot be delivered. This is probably the most common case, but there
5836 are also other conditions that cause freezing, and frozen messages are not
5837 always bounce messages.
5838 .code
5839 ignore_bounce_errors_after = 2d
5840 timeout_frozen_after = 7d
5841 .endd
5842 The first of these options specifies that failing bounce messages are to be
5843 discarded after 2 days in the queue. The second specifies that any frozen
5844 message (whether a bounce message or not) is to be timed out (and discarded)
5845 after a week. In this configuration, the first setting ensures that no failing
5846 bounce message ever lasts a week.
5847
5848 Exim queues it's messages in a spool directory. If you expect to have
5849 large queues, you may consider using this option. It splits the spool
5850 directory into subdirectories to avoid file system degradation from
5851 many files in a single directory, resulting in better performance.
5852 Manual manipulation of queued messages becomes more complex (though fortunately
5853 not often needed).
5854 .code
5855 # split_spool_directory = true
5856 .endd
5857
5858 In an ideal world everybody follows the standards. For non-ASCII
5859 messages RFC 2047 is a standard, allowing a maximum line length of 76
5860 characters. Exim adheres that standard and won't process messages which
5861 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5862 In particular, the Exim maintainers have had multiple reports of
5863 problems from Russian administrators of issues until they disable this
5864 check, because of some popular, yet buggy, mail composition software.
5865 .code
5866 # check_rfc2047_length = false
5867 .endd
5868
5869 If you need to be strictly RFC compliant you may wish to disable the
5870 8BITMIME advertisement. Use this, if you exchange mails with systems
5871 that are not 8-bit clean.
5872 .code
5873 # accept_8bitmime = false
5874 .endd
5875
5876 Libraries you use may depend on specific environment settings.  This
5877 imposes a security risk (e.g. PATH). There are two lists:
5878 &%keep_environment%& for the variables to import as they are, and
5879 &%add_environment%& for variables we want to set to a fixed value.
5880 Note that TZ is handled separately, by the &%timezone%& runtime
5881 option and by the TIMEZONE_DEFAULT buildtime option.
5882 .code
5883 # keep_environment = ^LDAP
5884 # add_environment = PATH=/usr/bin::/bin
5885 .endd
5886
5887
5888 .section "ACL configuration" "SECID54"
5889 .cindex "default" "ACLs"
5890 .cindex "&ACL;" "default configuration"
5891 In the default configuration, the ACL section follows the main configuration.
5892 It starts with the line
5893 .code
5894 begin acl
5895 .endd
5896 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5897 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5898 and &%acl_smtp_data%& above.
5899
5900 .cindex "RCPT" "ACL for"
5901 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5902 RCPT command specifies one of the message's recipients. The ACL statements
5903 are considered in order, until the recipient address is either accepted or
5904 rejected. The RCPT command is then accepted or rejected, according to the
5905 result of the ACL processing.
5906 .code
5907 acl_check_rcpt:
5908 .endd
5909 This line, consisting of a name terminated by a colon, marks the start of the
5910 ACL, and names it.
5911 .code
5912 accept  hosts = :
5913 .endd
5914 This ACL statement accepts the recipient if the sending host matches the list.
5915 But what does that strange list mean? It doesn't actually contain any host
5916 names or IP addresses. The presence of the colon puts an empty item in the
5917 list; Exim matches this only if the incoming message did not come from a remote
5918 host, because in that case, the remote hostname is empty. The colon is
5919 important. Without it, the list itself is empty, and can never match anything.
5920
5921 What this statement is doing is to accept unconditionally all recipients in
5922 messages that are submitted by SMTP from local processes using the standard
5923 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5924 manner.
5925 .code
5926 deny    domains       = +local_domains
5927         local_parts   = ^[.] : ^.*[@%!/|]
5928         message       = Restricted characters in address
5929
5930 deny    domains       = !+local_domains
5931         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5932         message       = Restricted characters in address
5933 .endd
5934 These statements are concerned with local parts that contain any of the
5935 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5936 Although these characters are entirely legal in local parts (in the case of
5937 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5938 in Internet mail addresses.
5939
5940 The first three have in the past been associated with explicitly routed
5941 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5942 option). Addresses containing these characters are regularly tried by spammers
5943 in an attempt to bypass relaying restrictions, and also by open relay testing
5944 programs. Unless you really need them it is safest to reject these characters
5945 at this early stage. This configuration is heavy-handed in rejecting these
5946 characters for all messages it accepts from remote hosts. This is a deliberate
5947 policy of being as safe as possible.
5948
5949 The first rule above is stricter, and is applied to messages that are addressed
5950 to one of the local domains handled by this host. This is implemented by the
5951 first condition, which restricts it to domains that are listed in the
5952 &'local_domains'& domain list. The &"+"& character is used to indicate a
5953 reference to a named list. In this configuration, there is just one domain in
5954 &'local_domains'&, but in general there may be many.
5955
5956 The second condition on the first statement uses two regular expressions to
5957 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5958 or &"|"&. If you have local accounts that include these characters, you will
5959 have to modify this rule.
5960
5961 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5962 allows them because they have been encountered in practice. (Consider the
5963 common convention of local parts constructed as
5964 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5965 the author of Exim, who has no second initial.) However, a local part starting
5966 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5967 filename (for example, for a mailing list). This is also true for local parts
5968 that contain slashes. A pipe symbol can also be troublesome if the local part
5969 is incorporated unthinkingly into a shell command line.
5970
5971 The second rule above applies to all other domains, and is less strict. This
5972 allows your own users to send outgoing messages to sites that use slashes
5973 and vertical bars in their local parts. It blocks local parts that begin
5974 with a dot, slash, or vertical bar, but allows these characters within the
5975 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5976 and &"!"& is blocked, as before. The motivation here is to prevent your users
5977 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5978 .code
5979 accept  local_parts   = postmaster
5980         domains       = +local_domains
5981 .endd
5982 This statement, which has two conditions, accepts an incoming address if the
5983 local part is &'postmaster'& and the domain is one of those listed in the
5984 &'local_domains'& domain list. The &"+"& character is used to indicate a
5985 reference to a named list. In this configuration, there is just one domain in
5986 &'local_domains'&, but in general there may be many.
5987
5988 The presence of this statement means that mail to postmaster is never blocked
5989 by any of the subsequent tests. This can be helpful while sorting out problems
5990 in cases where the subsequent tests are incorrectly denying access.
5991 .code
5992 require verify        = sender
5993 .endd
5994 This statement requires the sender address to be verified before any subsequent
5995 ACL statement can be used. If verification fails, the incoming recipient
5996 address is refused. Verification consists of trying to route the address, to
5997 see if a bounce message could be delivered to it. In the case of remote
5998 addresses, basic verification checks only the domain, but &'callouts'& can be
5999 used for more verification if required. Section &<<SECTaddressverification>>&
6000 discusses the details of address verification.
6001 .code
6002 accept  hosts         = +relay_from_hosts
6003         control       = submission
6004 .endd
6005 This statement accepts the address if the message is coming from one of the
6006 hosts that are defined as being allowed to relay through this host. Recipient
6007 verification is omitted here, because in many cases the clients are dumb MUAs
6008 that do not cope well with SMTP error responses. For the same reason, the
6009 second line specifies &"submission mode"& for messages that are accepted. This
6010 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6011 messages that are deficient in some way, for example, because they lack a
6012 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6013 probably add recipient verification here, and disable submission mode.
6014 .code
6015 accept  authenticated = *
6016         control       = submission
6017 .endd
6018 This statement accepts the address if the client host has authenticated itself.
6019 Submission mode is again specified, on the grounds that such messages are most
6020 likely to come from MUAs. The default configuration does not define any
6021 authenticators, though it does include some nearly complete commented-out
6022 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6023 fact authenticate until you complete the authenticator definitions.
6024 .code
6025 require message = relay not permitted
6026         domains = +local_domains : +relay_to_domains
6027 .endd
6028 This statement rejects the address if its domain is neither a local domain nor
6029 one of the domains for which this host is a relay.
6030 .code
6031 require verify = recipient
6032 .endd
6033 This statement requires the recipient address to be verified; if verification
6034 fails, the address is rejected.
6035 .code
6036 # deny    dnslists    = black.list.example
6037 #         message     = rejected because $sender_host_address \
6038 #                       is in a black list at $dnslist_domain\n\
6039 #                       $dnslist_text
6040 #
6041 # warn    dnslists    = black.list.example
6042 #         add_header  = X-Warning: $sender_host_address is in \
6043 #                       a black list at $dnslist_domain
6044 #         log_message = found in $dnslist_domain
6045 .endd
6046 These commented-out lines are examples of how you could configure Exim to check
6047 sending hosts against a DNS black list. The first statement rejects messages
6048 from blacklisted hosts, whereas the second just inserts a warning header
6049 line.
6050 .code
6051 # require verify = csa
6052 .endd
6053 This commented-out line is an example of how you could turn on client SMTP
6054 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6055 records.
6056 .code
6057 accept
6058 .endd
6059 The final statement in the first ACL unconditionally accepts any recipient
6060 address that has successfully passed all the previous tests.
6061 .code
6062 acl_check_data:
6063 .endd
6064 This line marks the start of the second ACL, and names it. Most of the contents
6065 of this ACL are commented out:
6066 .code
6067 # deny    malware   = *
6068 #         message   = This message contains a virus \
6069 #                     ($malware_name).
6070 .endd
6071 These lines are examples of how to arrange for messages to be scanned for
6072 viruses when Exim has been compiled with the content-scanning extension, and a
6073 suitable virus scanner is installed. If the message is found to contain a
6074 virus, it is rejected with the given custom error message.
6075 .code
6076 # warn    spam      = nobody
6077 #         message   = X-Spam_score: $spam_score\n\
6078 #                     X-Spam_score_int: $spam_score_int\n\
6079 #                     X-Spam_bar: $spam_bar\n\
6080 #                     X-Spam_report: $spam_report
6081 .endd
6082 These lines are an example of how to arrange for messages to be scanned by
6083 SpamAssassin when Exim has been compiled with the content-scanning extension,
6084 and SpamAssassin has been installed. The SpamAssassin check is run with
6085 &`nobody`& as its user parameter, and the results are added to the message as a
6086 series of extra header line. In this case, the message is not rejected,
6087 whatever the spam score.
6088 .code
6089 accept
6090 .endd
6091 This final line in the DATA ACL accepts the message unconditionally.
6092
6093
6094 .section "Router configuration" "SECID55"
6095 .cindex "default" "routers"
6096 .cindex "routers" "default"
6097 The router configuration comes next in the default configuration, introduced
6098 by the line
6099 .code
6100 begin routers
6101 .endd
6102 Routers are the modules in Exim that make decisions about where to send
6103 messages. An address is passed to each router, in turn, until it is either
6104 accepted, or failed. This means that the order in which you define the routers
6105 matters. Each router is fully described in its own chapter later in this
6106 manual. Here we give only brief overviews.
6107 .code
6108 # domain_literal:
6109 #   driver = ipliteral
6110 #   domains = !+local_domains
6111 #   transport = remote_smtp
6112 .endd
6113 .cindex "domain literal" "default router"
6114 This router is commented out because the majority of sites do not want to
6115 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6116 you uncomment this router, you also need to uncomment the setting of
6117 &%allow_domain_literals%& in the main part of the configuration.
6118
6119 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6120 macro has been defined, per
6121 .code
6122 .ifdef ROUTER_SMARTHOST
6123 smarthost:
6124 #...
6125 .else
6126 dnslookup:
6127 #...
6128 .endif
6129 .endd
6130
6131 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6132 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6133 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6134 skip these routers because of the &%domains%& option.
6135
6136 .code
6137 smarthost:
6138   driver = manualroute
6139   domains = ! +local_domains
6140   transport = smarthost_smtp
6141   route_data = ROUTER_SMARTHOST
6142   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6143   no_more
6144 .endd
6145 This router only handles mail which is not to any local domains; this is
6146 specified by the line
6147 .code
6148 domains = ! +local_domains
6149 .endd
6150 The &%domains%& option lists the domains to which this router applies, but the
6151 exclamation mark is a negation sign, so the router is used only for domains
6152 that are not in the domain list called &'local_domains'& (which was defined at
6153 the start of the configuration). The plus sign before &'local_domains'&
6154 indicates that it is referring to a named list. Addresses in other domains are
6155 passed on to the following routers.
6156
6157 The name of the router driver is &(manualroute)& because we are manually
6158 specifying how mail should be routed onwards, instead of using DNS MX.
6159 While the name of this router instance is arbitrary, the &%driver%& option must
6160 be one of the driver modules that is in the Exim binary.
6161
6162 With no pre-conditions other than &%domains%&, all mail for non-local domains
6163 will be handled by this router, and the &%no_more%& setting will ensure that no
6164 other routers will be used for messages matching the pre-conditions.  See
6165 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6166 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6167 and the macro supplies the value; the address is then queued for the
6168 &(smarthost_smtp)& transport.
6169
6170 .code
6171 dnslookup:
6172   driver = dnslookup
6173   domains = ! +local_domains
6174   transport = remote_smtp
6175   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6176   no_more
6177 .endd
6178 The &%domains%& option behaves as per smarthost, above.
6179
6180 The name of the router driver is &(dnslookup)&,
6181 and is specified by the &%driver%& option. Do not be confused by the fact that
6182 the name of this router instance is the same as the name of the driver. The
6183 instance name is arbitrary, but the name set in the &%driver%& option must be
6184 one of the driver modules that is in the Exim binary.
6185
6186 The &(dnslookup)& router routes addresses by looking up their domains in the
6187 DNS in order to obtain a list of hosts to which the address is routed. If the
6188 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6189 specified by the &%transport%& option. If the router does not find the domain
6190 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6191 the address fails and is bounced.
6192
6193 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6194 be entirely ignored. This option is present because a number of cases have been
6195 encountered where MX records in the DNS point to host names
6196 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6197 Completely ignoring these IP addresses causes Exim to fail to route the
6198 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6199 continue to try to deliver the message periodically until the address timed
6200 out.
6201 .code
6202 system_aliases:
6203   driver = redirect
6204   allow_fail
6205   allow_defer
6206   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6207 # user = exim
6208   file_transport = address_file
6209   pipe_transport = address_pipe
6210 .endd
6211 Control reaches this and subsequent routers only for addresses in the local
6212 domains. This router checks to see whether the local part is defined as an
6213 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6214 data that it looks up from that file. If no data is found for the local part,
6215 the value of the &%data%& option is empty, causing the address to be passed to
6216 the next router.
6217
6218 &_/etc/aliases_& is a conventional name for the system aliases file that is
6219 often used. That is why it is referenced by from the default configuration
6220 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6221 &_Local/Makefile_& before building Exim.
6222 .code
6223 userforward:
6224   driver = redirect
6225   check_local_user
6226 # local_part_suffix = +* : -*
6227 # local_part_suffix_optional
6228   file = $home/.forward
6229 # allow_filter
6230   no_verify
6231   no_expn
6232   check_ancestor
6233   file_transport = address_file
6234   pipe_transport = address_pipe
6235   reply_transport = address_reply
6236 .endd
6237 This is the most complicated router in the default configuration. It is another
6238 redirection router, but this time it is looking for forwarding data set up by
6239 individual users. The &%check_local_user%& setting specifies a check that the
6240 local part of the address is the login name of a local user. If it is not, the
6241 router is skipped. The two commented options that follow &%check_local_user%&,
6242 namely:
6243 .code
6244 # local_part_suffix = +* : -*
6245 # local_part_suffix_optional
6246 .endd
6247 .vindex "&$local_part_suffix$&"
6248 show how you can specify the recognition of local part suffixes. If the first
6249 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6250 by any sequence of characters, is removed from the local part and placed in the
6251 variable &$local_part_suffix$&. The second suffix option specifies that the
6252 presence of a suffix in the local part is optional. When a suffix is present,
6253 the check for a local login uses the local part with the suffix removed.
6254
6255 When a local user account is found, the file called &_.forward_& in the user's
6256 home directory is consulted. If it does not exist, or is empty, the router
6257 declines. Otherwise, the contents of &_.forward_& are interpreted as
6258 redirection data (see chapter &<<CHAPredirect>>& for more details).
6259
6260 .cindex "Sieve filter" "enabling in default router"
6261 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6262 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6263 is commented out by default), the contents of the file are interpreted as a set
6264 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6265 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6266 separate document entitled &'Exim's interfaces to mail filtering'&.
6267
6268 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6269 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6270 There are two reasons for doing this:
6271
6272 .olist
6273 Whether or not a local user has a &_.forward_& file is not really relevant when
6274 checking an address for validity; it makes sense not to waste resources doing
6275 unnecessary work.
6276 .next
6277 More importantly, when Exim is verifying addresses or handling an EXPN
6278 command during an SMTP session, it is running as the Exim user, not as root.
6279 The group is the Exim group, and no additional groups are set up.
6280 It may therefore not be possible for Exim to read users' &_.forward_& files at
6281 this time.
6282 .endlist
6283
6284 The setting of &%check_ancestor%& prevents the router from generating a new
6285 address that is the same as any previous address that was redirected. (This
6286 works round a problem concerning a bad interaction between aliasing and
6287 forwarding &-- see section &<<SECTredlocmai>>&).
6288
6289 The final three option settings specify the transports that are to be used when
6290 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6291 auto-reply, respectively. For example, if a &_.forward_& file contains
6292 .code
6293 a.nother@elsewhere.example, /home/spqr/archive
6294 .endd
6295 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6296 transport.
6297 .code
6298 localuser:
6299   driver = accept
6300   check_local_user
6301 # local_part_suffix = +* : -*
6302 # local_part_suffix_optional
6303   transport = local_delivery
6304 .endd
6305 The final router sets up delivery into local mailboxes, provided that the local
6306 part is the name of a local login, by accepting the address and assigning it to
6307 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6308 routers, so the address is bounced. The commented suffix settings fulfil the
6309 same purpose as they do for the &(userforward)& router.
6310
6311
6312 .section "Transport configuration" "SECID56"
6313 .cindex "default" "transports"
6314 .cindex "transports" "default"
6315 Transports define mechanisms for actually delivering messages. They operate
6316 only when referenced from routers, so the order in which they are defined does
6317 not matter. The transports section of the configuration starts with
6318 .code
6319 begin transports
6320 .endd
6321 Two remote transports and four local transports are defined.
6322 .code
6323 remote_smtp:
6324   driver = smtp
6325   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6326 .ifdef _HAVE_PRDR
6327   hosts_try_prdr = *
6328 .endif
6329 .endd
6330 This transport is used for delivering messages over SMTP connections.
6331 The list of remote hosts comes from the router.
6332 The &%message_size_limit%& usage is a hack to avoid sending on messages
6333 with over-long lines.
6334
6335 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6336 negotiated between client and server and not expected to cause problems
6337 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6338 use of the &%hosts_try_prdr%& configuration option.
6339
6340 The other remote transport is used when delivering to a specific smarthost
6341 with whom there must be some kind of existing relationship, instead of the
6342 usual federated system.
6343
6344 .code
6345 smarthost_smtp:
6346   driver = smtp
6347   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6348   multi_domain
6349   #
6350 .ifdef _HAVE_TLS
6351   # Comment out any of these which you have to, then file a Support
6352   # request with your smarthost provider to get things fixed:
6353   hosts_require_tls = *
6354   tls_verify_hosts = *
6355   # As long as tls_verify_hosts is enabled, this this will have no effect,
6356   # but if you have to comment it out then this will at least log whether
6357   # you succeed or not:
6358   tls_try_verify_hosts = *
6359   #
6360   # The SNI name should match the name which we'll expect to verify;
6361   # many mail systems don't use SNI and this doesn't matter, but if it does,
6362   # we need to send a name which the remote site will recognize.
6363   # This _should_ be the name which the smarthost operators specified as
6364   # the hostname for sending your mail to.
6365   tls_sni = ROUTER_SMARTHOST
6366   #
6367 .ifdef _HAVE_OPENSSL
6368   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6369 .endif
6370 .ifdef _HAVE_GNUTLS
6371   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6372 .endif
6373 .endif
6374 .ifdef _HAVE_PRDR
6375   hosts_try_prdr = *
6376 .endif
6377 .endd
6378 After the same &%message_size_limit%& hack, we then specify that this Transport
6379 can handle messages to multiple domains in one run.  The assumption here is
6380 that you're routing all non-local mail to the same place and that place is
6381 happy to take all messages from you as quickly as possible.
6382 All other options depend upon built-in macros; if Exim was built without TLS support
6383 then no other options are defined.
6384 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6385 and versions using the &%tls_require_ciphers%& option, where the value to be
6386 used depends upon the library providing TLS.
6387 Beyond that, the options adopt the stance that you should have TLS support available
6388 from your smarthost on today's Internet, so we turn on requiring TLS for the
6389 mail to be delivered, and requiring that the certificate be valid, and match
6390 the expected hostname.  The &%tls_sni%& option can be used by service providers
6391 to select an appropriate certificate to present to you and here we re-use the
6392 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6393 You want to specify the hostname which you'll expect to validate for, and that
6394 should not be subject to insecure tampering via DNS results.
6395
6396 For the &%hosts_try_prdr%& option see the previous transport.
6397
6398 All other options are defaulted.
6399 .code
6400 local_delivery:
6401   driver = appendfile
6402   file = /var/mail/$local_part_data
6403   delivery_date_add
6404   envelope_to_add
6405   return_path_add
6406 # group = mail
6407 # mode = 0660
6408 .endd
6409 This &(appendfile)& transport is used for local delivery to user mailboxes in
6410 traditional BSD mailbox format.
6411
6412 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6413 as it is provided by a potential bad actor.
6414 Instead we use &$local_part_data$&,
6415 the result of looking up &$local_part$& in the user database
6416 (done by using &%check_local_user%& in the the router).
6417
6418 By default &(appendfile)& runs under the uid and gid of the
6419 local user, which requires the sticky bit to be set on the &_/var/mail_&
6420 directory. Some systems use the alternative approach of running mail deliveries
6421 under a particular group instead of using the sticky bit. The commented options
6422 show how this can be done.
6423
6424 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6425 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6426 similarly-named options above.
6427 .code
6428 address_pipe:
6429   driver = pipe
6430   return_output
6431 .endd
6432 This transport is used for handling deliveries to pipes that are generated by
6433 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6434 option specifies that any output on stdout or stderr generated by the pipe is to
6435 be returned to the sender.
6436 .code
6437 address_file:
6438   driver = appendfile
6439   delivery_date_add
6440   envelope_to_add
6441   return_path_add
6442 .endd
6443 This transport is used for handling deliveries to files that are generated by
6444 redirection. The name of the file is not specified in this instance of
6445 &(appendfile)&, because it comes from the &(redirect)& router.
6446 .code
6447 address_reply:
6448   driver = autoreply
6449 .endd
6450 This transport is used for handling automatic replies generated by users'
6451 filter files.
6452
6453
6454
6455 .section "Default retry rule" "SECID57"
6456 .cindex "retry" "default rule"
6457 .cindex "default" "retry rule"
6458 The retry section of the configuration file contains rules which affect the way
6459 Exim retries deliveries that cannot be completed at the first attempt. It is
6460 introduced by the line
6461 .code
6462 begin retry
6463 .endd
6464 In the default configuration, there is just one rule, which applies to all
6465 errors:
6466 .code
6467 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6468 .endd
6469 This causes any temporarily failing address to be retried every 15 minutes for
6470 2 hours, then at intervals starting at one hour and increasing by a factor of
6471 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6472 is not delivered after 4 days of temporary failure, it is bounced. The time is
6473 measured from first failure, not from the time the message was received.
6474
6475 If the retry section is removed from the configuration, or is empty (that is,
6476 if no retry rules are defined), Exim will not retry deliveries. This turns
6477 temporary errors into permanent errors.
6478
6479
6480 .section "Rewriting configuration" "SECID58"
6481 The rewriting section of the configuration, introduced by
6482 .code
6483 begin rewrite
6484 .endd
6485 contains rules for rewriting addresses in messages as they arrive. There are no
6486 rewriting rules in the default configuration file.
6487
6488
6489
6490 .section "Authenticators configuration" "SECTdefconfauth"
6491 .cindex "AUTH" "configuration"
6492 The authenticators section of the configuration, introduced by
6493 .code
6494 begin authenticators
6495 .endd
6496 defines mechanisms for the use of the SMTP AUTH command. The default
6497 configuration file contains two commented-out example authenticators
6498 which support plaintext username/password authentication using the
6499 standard PLAIN mechanism and the traditional but non-standard LOGIN
6500 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6501 to support most MUA software.
6502
6503 The example PLAIN authenticator looks like this:
6504 .code
6505 #PLAIN:
6506 #  driver                  = plaintext
6507 #  server_set_id           = $auth2
6508 #  server_prompts          = :
6509 #  server_condition        = Authentication is not yet configured
6510 #  server_advertise_condition = ${if def:tls_in_cipher }
6511 .endd
6512 And the example LOGIN authenticator looks like this:
6513 .code
6514 #LOGIN:
6515 #  driver                  = plaintext
6516 #  server_set_id           = $auth1
6517 #  server_prompts          = <| Username: | Password:
6518 #  server_condition        = Authentication is not yet configured
6519 #  server_advertise_condition = ${if def:tls_in_cipher }
6520 .endd
6521
6522 The &%server_set_id%& option makes Exim remember the authenticated username
6523 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6524 &%server_prompts%& option configures the &(plaintext)& authenticator so
6525 that it implements the details of the specific authentication mechanism,
6526 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6527 when Exim offers authentication to clients; in the examples, this is only
6528 when TLS or SSL has been started, so to enable the authenticators you also
6529 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6530
6531 The &%server_condition%& setting defines how to verify that the username and
6532 password are correct. In the examples it just produces an error message.
6533 To make the authenticators work, you can use a string expansion
6534 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6535
6536 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6537 usercode and password are in different positions.
6538 Chapter &<<CHAPplaintext>>& covers both.
6539
6540 .ecindex IIDconfiwal
6541
6542
6543
6544 . ////////////////////////////////////////////////////////////////////////////
6545 . ////////////////////////////////////////////////////////////////////////////
6546
6547 .chapter "Regular expressions" "CHAPregexp"
6548
6549 .cindex "regular expressions" "library"
6550 .cindex "PCRE2"
6551 Exim supports the use of regular expressions in many of its options. It
6552 uses the PCRE2 regular expression library; this provides regular expression
6553 matching that is compatible with Perl 5. The syntax and semantics of
6554 regular expressions is discussed in
6555 online Perl manpages, in
6556 many Perl reference books, and also in
6557 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6558 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6559 . --- the http: URL here redirects to another page with the ISBN in the URL
6560 . --- where trying to use https: just redirects back to http:, so sticking
6561 . --- to the old URL for now.  2018-09-07.
6562
6563 The documentation for the syntax and semantics of the regular expressions that
6564 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6565 description is included here. The PCRE2 functions are called from Exim using
6566 the default option settings (that is, with no PCRE2 options set), except that
6567 the PCRE2_CASELESS option is set when the matching is required to be
6568 case-insensitive.
6569
6570 In most cases, when a regular expression is required in an Exim configuration,
6571 it has to start with a circumflex, in order to distinguish it from plain text
6572 or an &"ends with"& wildcard. In this example of a configuration setting, the
6573 second item in the colon-separated list is a regular expression.
6574 .code
6575 domains = a.b.c : ^\\d{3} : *.y.z : ...
6576 .endd
6577 The doubling of the backslash is required because of string expansion that
6578 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6579 of this issue, and a way of avoiding the need for doubling backslashes. The
6580 regular expression that is eventually used in this example contains just one
6581 backslash. The circumflex is included in the regular expression, and has the
6582 normal effect of &"anchoring"& it to the start of the string that is being
6583 matched.
6584
6585 There are, however, two cases where a circumflex is not required for the
6586 recognition of a regular expression: these are the &%match%& condition in a
6587 string expansion, and the &%matches%& condition in an Exim filter file. In
6588 these cases, the relevant string is always treated as a regular expression; if
6589 it does not start with a circumflex, the expression is not anchored, and can
6590 match anywhere in the subject string.
6591
6592 In all cases, if you want a regular expression to match at the end of a string,
6593 you must code the $ metacharacter to indicate this. For example:
6594 .code
6595 domains = ^\\d{3}\\.example
6596 .endd
6597 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6598 You need to use:
6599 .code
6600 domains = ^\\d{3}\\.example\$
6601 .endd
6602 if you want &'example'& to be the top-level domain. The backslash before the
6603 $ is needed because string expansion also interprets dollar characters.
6604
6605
6606
6607 . ////////////////////////////////////////////////////////////////////////////
6608 . ////////////////////////////////////////////////////////////////////////////
6609
6610 .chapter "File and database lookups" "CHAPfdlookup"
6611 .scindex IIDfidalo1 "file" "lookups"
6612 .scindex IIDfidalo2 "database" "lookups"
6613 .cindex "lookup" "description of"
6614 Exim can be configured to look up data in files or databases as it processes
6615 messages. Two different kinds of syntax are used:
6616
6617 .olist
6618 A string that is to be expanded may contain explicit lookup requests. These
6619 cause parts of the string to be replaced by data that is obtained from the
6620 lookup. Lookups of this type are conditional expansion items. Different results
6621 can be defined for the cases of lookup success and failure. See chapter
6622 &<<CHAPexpand>>&, where string expansions are described in detail.
6623 The key for the lookup is &*specified*& as part of the string to be expanded.
6624 .next
6625 Lists of domains, hosts, and email addresses can contain lookup requests as a
6626 way of avoiding excessively long linear lists. In this case, the data that is
6627 returned by the lookup is often (but not always) discarded; whether the lookup
6628 succeeds or fails is what really counts. These kinds of list are described in
6629 chapter &<<CHAPdomhosaddlists>>&.
6630 Depending on the lookup type (see below)
6631 the key for the lookup may need to be &*specified*& as above
6632 or may be &*implicit*&,
6633 given by the context in which the list is being checked.
6634 .endlist
6635
6636 String expansions, lists, and lookups interact with each other in such a way
6637 that there is no order in which to describe any one of them that does not
6638 involve references to the others. Each of these three chapters makes more sense
6639 if you have read the other two first. If you are reading this for the first
6640 time, be aware that some of it will make a lot more sense after you have read
6641 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6642
6643 .section "Examples of different lookup syntax" "SECID60"
6644 It is easy to confuse the two different kinds of lookup, especially as the
6645 lists that may contain the second kind are always expanded before being
6646 processed as lists. Therefore, they may also contain lookups of the first kind.
6647 Be careful to distinguish between the following two examples:
6648 .code
6649 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6650 domains = lsearch;/some/file
6651 .endd
6652 .ilist
6653 The first uses a string expansion, the result of which must be a domain list.
6654 The key for an expansion-style lookup must be given explicitly.
6655 No strings have been specified for a successful or a failing lookup; the
6656 defaults in this case are the looked-up data and an empty string, respectively.
6657 The expansion takes place before the string is processed as a list, and the
6658 file that is searched could contain lines like this:
6659 .code
6660 192.168.3.4: domain1:domain2:...
6661 192.168.1.9: domain3:domain4:...
6662 .endd
6663 When the lookup succeeds, the result of the expansion is a list of domains (and
6664 possibly other types of item that are allowed in domain lists).
6665 .cindex "tainted data" "de-tainting"
6666 .cindex "de-tainting" "using a lookup expansion"
6667 The result of the expansion is not tainted.
6668
6669 .next
6670 In the second example, the lookup is a single item in a domain list. It causes
6671 Exim to use a lookup to see if the domain that is being processed can be found
6672 in the file.
6673 The file could contains lines like this:
6674 .code
6675 domain1:
6676 domain2:
6677 .endd
6678 Any data that follows the keys is not relevant when checking that the domain
6679 matches the list item.
6680
6681 The key for a list-style lookup is implicit, from the lookup context, if
6682 the lookup is a single-key type (see below).
6683 For query-style lookup types the query must be given explicitly.
6684 .endlist
6685
6686 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6687 Consider a file containing lines like this:
6688 .code
6689 192.168.5.6: lsearch;/another/file
6690 .endd
6691 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6692 first &%domains%& setting above generates the second setting, which therefore
6693 causes a second lookup to occur.
6694
6695 The lookup type may optionally be followed by a comma
6696 and a comma-separated list of options.
6697 Each option is a &"name=value"& pair.
6698 Whether an option is meaningful depends on the lookup type.
6699
6700 All lookups support the option &"cache=no_rd"&.
6701 If this is given then the cache that Exim manages for lookup results
6702 is not checked before doing the lookup.
6703 The result of the lookup is still written to the cache.
6704
6705 The rest of this chapter describes the different lookup types that are
6706 available. Any of them can be used in any part of the configuration where a
6707 lookup is permitted.
6708
6709
6710 .section "Lookup types" "SECID61"
6711 .cindex "lookup" "types of"
6712 .cindex "single-key lookup" "definition of"
6713 Two different types of data lookup are implemented:
6714
6715 .ilist
6716 The &'single-key'& type requires the specification of a file in which to look,
6717 and a single key to search for. The key must be a non-empty string for the
6718 lookup to succeed. The lookup type determines how the file is searched.
6719 .cindex "tainted data" "single-key lookups"
6720 The file string may not be tainted.
6721
6722 .cindex "tainted data" "de-tainting"
6723 .cindex "de-tainting" "using a single-key lookup"
6724 All single-key lookups support the option &"ret=key"&.
6725 If this is given and the lookup
6726 (either underlying implementation or cached value)
6727 returns data, the result is replaced with a non-tainted
6728 version of the lookup key.
6729
6730 .next
6731 .cindex "query-style lookup" "definition of"
6732 The &'query-style'& type accepts a generalized database query. No particular
6733 key value is assumed by Exim for query-style lookups. You can use whichever
6734 Exim variables you need to construct the database query.
6735
6736 For the string-expansion kind of lookups, the query is given in the first
6737 bracketed argument of the &${lookup ...}$& expansion.
6738 For the list-argument kind of lookup the quury is given by the remainder of the
6739 list item after the first semicolon.
6740
6741 .cindex "tainted data" "quoting for lookups"
6742 If tainted data is used in the query then it should be quuted by
6743 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6744 appropriate for the lookup.
6745 .endlist
6746
6747 The code for each lookup type is in a separate source file that is included in
6748 the binary of Exim only if the corresponding compile-time option is set. The
6749 default settings in &_src/EDITME_& are:
6750 .code
6751 LOOKUP_DBM=yes
6752 LOOKUP_LSEARCH=yes
6753 .endd
6754 which means that only linear searching and DBM lookups are included by default.
6755 For some types of lookup (e.g. SQL databases), you need to install appropriate
6756 libraries and header files before building Exim.
6757
6758
6759
6760
6761 .section "Single-key lookup types" "SECTsinglekeylookups"
6762 .cindex "lookup" "single-key types"
6763 .cindex "single-key lookup" "list of types"
6764 The following single-key lookup types are implemented:
6765
6766 .subsection cdb
6767 .cindex "cdb" "description of"
6768 .cindex "lookup" "cdb"
6769 .cindex "binary zero" "in lookup key"
6770 The given file is searched as a Constant DataBase file, using the key
6771 string without a terminating binary zero. The cdb format is designed for
6772 indexed files that are read frequently and never updated, except by total
6773 re-creation. As such, it is particularly suitable for large files containing
6774 aliases or other indexed data referenced by an MTA. Information about cdb and
6775 tools for building the files can be found in several places:
6776 .display
6777 &url(https://cr.yp.to/cdb.html)
6778 &url(https://www.corpit.ru/mjt/tinycdb.html)
6779 &url(https://packages.debian.org/stable/utils/freecdb)
6780 &url(https://github.com/philpennock/cdbtools) (in Go)
6781 .endd
6782 A cdb distribution is not needed in order to build Exim with cdb support,
6783 because the code for reading cdb files is included directly in Exim itself.
6784 However, no means of building or testing cdb files is provided with Exim, so
6785 you need to obtain a cdb distribution in order to do this.
6786
6787 .subsection dbm
6788 .cindex "DBM" "lookup type"
6789 .cindex "lookup" "dbm"
6790 .cindex "binary zero" "in lookup key"
6791 Calls to DBM library functions are used to extract data from the given
6792 DBM file by looking up the record with the given key. A terminating binary
6793 zero is included in the key that is passed to the DBM library. See section
6794 &<<SECTdb>>& for a discussion of DBM libraries.
6795
6796 .cindex "Berkeley DB library" "file format"
6797 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6798 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6799 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6800 the DB_UNKNOWN option. This enables it to handle any of the types of database
6801 that the library supports, and can be useful for accessing DBM files created by
6802 other applications. (For earlier DB versions, DB_HASH is always used.)
6803
6804 .subsection dbmjz
6805 .cindex "lookup" "dbmjz"
6806 .cindex "lookup" "dbm &-- embedded NULs"
6807 .cindex "sasldb2"
6808 .cindex "dbmjz lookup type"
6809 This is the same as &(dbm)&, except that the lookup key is
6810 interpreted as an Exim list; the elements of the list are joined together with
6811 ASCII NUL characters to form the lookup key.  An example usage would be to
6812 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6813 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6814 &(cram_md5)& authenticator.
6815
6816 .subsection dbmnz
6817 .cindex "lookup" "dbmnz"
6818 .cindex "lookup" "dbm &-- terminating zero"
6819 .cindex "binary zero" "in lookup key"
6820 .cindex "Courier"
6821 .cindex "&_/etc/userdbshadow.dat_&"
6822 .cindex "dbmnz lookup type"
6823 This is the same as &(dbm)&, except that a terminating binary zero
6824 is not included in the key that is passed to the DBM library. You may need this
6825 if you want to look up data in files that are created by or shared with some
6826 other application that does not use terminating zeros. For example, you need to
6827 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6828 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6829 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6830 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6831
6832 .subsection dsearch
6833 .cindex "lookup" "dsearch"
6834 .cindex "dsearch lookup type"
6835 The given file must be an absolute directory path; this is searched for an entry
6836 whose name is the key by calling the &[lstat()]& function.
6837 The key may not contain any forward slash characters.
6838 If &[lstat()]& succeeds then so does the lookup.
6839 .cindex "tainted data" "dsearch result"
6840 The result is regarded as untainted.
6841
6842 Options for the lookup can be given by appending them after the word "dsearch",
6843 separated by a comma.  Options, if present, are a comma-separated list having
6844 each element starting with a tag name and an equals.
6845
6846 Two options are supported, for the return value and for filtering match
6847 candidates.
6848 The "ret" option requests an alternate result value of
6849 the entire path for the entry. Example:
6850 .code
6851 ${lookup {passwd} dsearch,ret=full {/etc}}
6852 .endd
6853 The default result is just the requested entry.
6854 The "filter" option requests that only directory entries of a given type
6855 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6856 not matching "." or ".."). Example:
6857 .code
6858 ${lookup {passwd} dsearch,filter=file {/etc}}
6859 .endd
6860 The default matching is for any entry type, including directories
6861 and symlinks.
6862
6863 An example of how this
6864 lookup can be used to support virtual domains is given in section
6865 &<<SECTvirtualdomains>>&.
6866
6867 .subsection iplsearch
6868 .cindex "lookup" "iplsearch"
6869 .cindex "iplsearch lookup type"
6870 The given file is a text file containing keys and data. A key is
6871 terminated by a colon or white space or the end of the line. The keys in the
6872 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6873 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6874 being interpreted as a key terminator. For example:
6875 .code
6876 1.2.3.4:           data for 1.2.3.4
6877 192.168.0.0/16:    data for 192.168.0.0/16
6878 "abcd::cdab":      data for abcd::cdab
6879 "abcd:abcd::/32"   data for abcd:abcd::/32
6880 .endd
6881 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6882 file is searched linearly, using the CIDR masks where present, until a matching
6883 key is found. The first key that matches is used; there is no attempt to find a
6884 &"best"& match. Apart from the way the keys are matched, the processing for
6885 &(iplsearch)& is the same as for &(lsearch)&.
6886
6887 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6888 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6889 lookup types support only literal keys.
6890
6891 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6892 the implicit key is the host's IP address rather than its name (see section
6893 &<<SECThoslispatsikey>>&).
6894
6895 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6896 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6897 notation before executing the lookup.)
6898
6899 One option is supported, "ret=full", to request the return of the entire line
6900 rather than omitting the key portion.
6901 Note however that the key portion will have been de-quoted.
6902
6903 .subsection json
6904 .cindex lookup json
6905 .cindex json "lookup type"
6906 .cindex JSON expansions
6907 The given file is a text file with a JSON structure.
6908 An element of the structure is extracted, defined by the search key.
6909 The key is a list of subelement selectors
6910 (colon-separated by default but changeable in the usual way)
6911 which are applied in turn to select smaller and smaller portions
6912 of the JSON structure.
6913 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6914 nunbered array element is selected.
6915 Otherwise it must apply to a JSON object; the named element is selected.
6916 The final resulting element can be a simple JSON type or a JSON object
6917 or array; for the latter two a string-representation of the JSON
6918 is returned.
6919 For elements of type string, the returned value is de-quoted.
6920
6921
6922 .subsection lmdb
6923 .cindex LMDB
6924 .cindex lookup lmdb
6925 .cindex database lmdb
6926 The given file is an LMDB database.
6927 LMDB is a memory-mapped key-value store,
6928 with API modeled loosely on that of BerkeleyDB.
6929 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6930 for the feature set and operation modes.
6931
6932 Exim provides read-only access via the LMDB C library.
6933 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6934 or your operating system package repository.
6935 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6936
6937 You will need to separately create the LMDB database file,
6938 possibly using the &"mdb_load"& utility.
6939
6940
6941 .subsection lsearch
6942 .cindex "linear search"
6943 .cindex "lookup" "lsearch"
6944 .cindex "lsearch lookup type"
6945 .cindex "case sensitivity" "in lsearch lookup"
6946 The given file is a text file that is searched linearly for a
6947 line beginning with the search key, terminated by a colon or white space or the
6948 end of the line. The search is case-insensitive; that is, upper and lower case
6949 letters are treated as the same. The first occurrence of the key that is found
6950 in the file is used.
6951
6952 White space between the key and the colon is permitted. The remainder of the
6953 line, with leading and trailing white space removed, is the data. This can be
6954 continued onto subsequent lines by starting them with any amount of white
6955 space, but only a single space character is included in the data at such a
6956 junction. If the data begins with a colon, the key must be terminated by a
6957 colon, for example:
6958 .code
6959 baduser:  :fail:
6960 .endd
6961 Empty lines and lines beginning with # are ignored, even if they occur in the
6962 middle of an item. This is the traditional textual format of alias files. Note
6963 that the keys in an &(lsearch)& file are literal strings. There is no
6964 wildcarding of any kind.
6965
6966 .cindex "lookup" "lsearch &-- colons in keys"
6967 .cindex "white space" "in lsearch key"
6968 In most &(lsearch)& files, keys are not required to contain colons or #
6969 characters, or white space. However, if you need this feature, it is available.
6970 If a key begins with a doublequote character, it is terminated only by a
6971 matching quote (or end of line), and the normal escaping rules apply to its
6972 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6973 quoted keys (exactly as for unquoted keys). There is no special handling of
6974 quotes for the data part of an &(lsearch)& line.
6975
6976 .subsection nis
6977 .cindex "NIS lookup type"
6978 .cindex "lookup" "NIS"
6979 .cindex "binary zero" "in lookup key"
6980 The given file is the name of a NIS map, and a NIS lookup is done with
6981 the given key, without a terminating binary zero. There is a variant called
6982 &(nis0)& which does include the terminating binary zero in the key. This is
6983 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6984 aliases; the full map names must be used.
6985
6986 .subsection (n)wildlsearch
6987 .cindex "wildlsearch lookup type"
6988 .cindex "lookup" "wildlsearch"
6989 .cindex "nwildlsearch lookup type"
6990 .cindex "lookup" "nwildlsearch"
6991 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6992 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6993 the file may be wildcarded. The difference between these two lookup types is
6994 that for &(wildlsearch)&, each key in the file is string-expanded before being
6995 used, whereas for &(nwildlsearch)&, no expansion takes place.
6996
6997 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6998 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6999 file that are regular expressions can be made case-sensitive by the use of
7000 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7001
7002 .olist
7003 The string may begin with an asterisk to mean &"ends with"&. For example:
7004 .code
7005 *.a.b.c       data for anything.a.b.c
7006 *fish         data for anythingfish
7007 .endd
7008 .next
7009 The string may begin with a circumflex to indicate a regular expression. For
7010 example, for &(wildlsearch)&:
7011 .code
7012 ^\N\d+\.a\.b\N    data for <digits>.a.b
7013 .endd
7014 Note the use of &`\N`& to disable expansion of the contents of the regular
7015 expression. If you are using &(nwildlsearch)&, where the keys are not
7016 string-expanded, the equivalent entry is:
7017 .code
7018 ^\d+\.a\.b        data for <digits>.a.b
7019 .endd
7020 The case-insensitive flag is set at the start of compiling the regular
7021 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7022 For example, to make the entire pattern case-sensitive:
7023 .code
7024 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7025 .endd
7026
7027 If the regular expression contains white space or colon characters, you must
7028 either quote it (see &(lsearch)& above), or represent these characters in other
7029 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7030 colon. This may be easier than quoting, because if you quote, you have to
7031 escape all the backslashes inside the quotes.
7032
7033 &*Note*&: It is not possible to capture substrings in a regular expression
7034 match for later use, because the results of all lookups are cached. If a lookup
7035 is repeated, the result is taken from the cache, and no actual pattern matching
7036 takes place. The values of all the numeric variables are unset after a
7037 &((n)wildlsearch)& match.
7038
7039 .next
7040 Although I cannot see it being of much use, the general matching function that
7041 is used to implement &((n)wildlsearch)& means that the string may begin with a
7042 lookup name terminated by a semicolon, and followed by lookup data. For
7043 example:
7044 .code
7045 cdb;/some/file  data for keys that match the file
7046 .endd
7047 The data that is obtained from the nested lookup is discarded.
7048 .endlist olist
7049
7050 Keys that do not match any of these patterns are interpreted literally. The
7051 continuation rules for the data are the same as for &(lsearch)&, and keys may
7052 be followed by optional colons.
7053
7054 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7055 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7056 lookup types support only literal keys.
7057
7058 .subsection spf
7059 .cindex "spf lookup type"
7060 .cindex "lookup" "spf"
7061 If Exim is built with SPF support, manual lookups can be done
7062 (as opposed to the standard ACL condition method).
7063 For details see section &<<SECSPF>>&.
7064
7065
7066 .section "Query-style lookup types" "SECTquerystylelookups"
7067 .cindex "lookup" "query-style types"
7068 .cindex "query-style lookup" "list of types"
7069 The supported query-style lookup types are listed below. Further details about
7070 many of them are given in later sections.
7071
7072 .subsection dnsdb
7073 .cindex "DNS" "as a lookup type"
7074 .cindex "lookup" "DNS"
7075 This does a DNS search for one or more records whose domain names
7076 are given in the supplied query. The resulting data is the contents of the
7077 records. See section &<<SECTdnsdb>>&.
7078
7079 .subsection ibase
7080 .cindex "InterBase lookup type"
7081 .cindex "lookup" "InterBase"
7082 This does a lookup in an InterBase database.
7083
7084 .subsection ldap
7085 .cindex "LDAP" "lookup type"
7086 .cindex "lookup" "LDAP"
7087 This does an LDAP lookup using a query in the form of a URL, and
7088 returns attributes from a single entry. There is a variant called &(ldapm)&
7089 that permits values from multiple entries to be returned. A third variant
7090 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7091 any attribute values. See section &<<SECTldap>>&.
7092
7093 .subsection mysql
7094 .cindex "MySQL" "lookup type"
7095 .cindex "lookup" "MySQL"
7096 The format of the query is an SQL statement that is passed to a
7097 MySQL database. See section &<<SECTsql>>&.
7098
7099 .subsection nisplus
7100 .cindex "NIS+ lookup type"
7101 .cindex "lookup" "NIS+"
7102 This does a NIS+ lookup using a query that can specify the name of
7103 the field to be returned. See section &<<SECTnisplus>>&.
7104
7105 .subsection oracle
7106 .cindex "Oracle" "lookup type"
7107 .cindex "lookup" "Oracle"
7108 The format of the query is an SQL statement that is passed to an
7109 Oracle database. See section &<<SECTsql>>&.
7110
7111 .subsection passwd
7112 .cindex "lookup" "passwd"
7113 .cindex "passwd lookup type"
7114 .cindex "&_/etc/passwd_&"
7115 This is a query-style lookup with queries that are just user names. The
7116 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7117 success, the result string is the same as you would get from an &(lsearch)&
7118 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7119 password value. For example:
7120 .code
7121 *:42:42:King Rat:/home/kr:/bin/bash
7122 .endd
7123
7124 .subsection pgsql
7125 .cindex "PostgreSQL lookup type"
7126 .cindex "lookup" "PostgreSQL"
7127 The format of the query is an SQL statement that is passed to a
7128 PostgreSQL database. See section &<<SECTsql>>&.
7129
7130 .subsection redis
7131 .cindex "Redis lookup type"
7132 .cindex lookup Redis
7133 The format of the query is either a simple get or simple set,
7134 passed to a Redis database. See section &<<SECTsql>>&.
7135
7136 .subsection sqlite
7137 .cindex "sqlite lookup type"
7138 .cindex "lookup" "sqlite"
7139 The format of the query is
7140 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7141
7142 .subsection testdb
7143 This is a lookup type that is used for testing Exim. It is
7144 not likely to be useful in normal operation.
7145
7146 .subsection whoson
7147 .cindex "whoson lookup type"
7148 .cindex "lookup" "whoson"
7149 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7150 allows a server to check whether a particular (dynamically allocated) IP
7151 address is currently allocated to a known (trusted) user and, optionally, to
7152 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7153 at one time for &"POP before SMTP"& authentication, but that approach has been
7154 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7155 &"POP before SMTP"& checking using ACL statements such as
7156 .code
7157 require condition = \
7158   ${lookup whoson {$sender_host_address}{yes}{no}}
7159 .endd
7160 The query consists of a single IP address. The value returned is the name of
7161 the authenticated user, which is stored in the variable &$value$&. However, in
7162 this example, the data in &$value$& is not used; the result of the lookup is
7163 one of the fixed strings &"yes"& or &"no"&.
7164
7165
7166
7167 .section "Temporary errors in lookups" "SECID63"
7168 .cindex "lookup" "temporary error in"
7169 Lookup functions can return temporary error codes if the lookup cannot be
7170 completed. For example, an SQL or LDAP database might be unavailable. For this
7171 reason, it is not advisable to use a lookup that might do this for critical
7172 options such as a list of local domains.
7173
7174 When a lookup cannot be completed in a router or transport, delivery
7175 of the message (to the relevant address) is deferred, as for any other
7176 temporary error. In other circumstances Exim may assume the lookup has failed,
7177 or may give up altogether.
7178
7179
7180
7181 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7182 .cindex "wildcard lookups"
7183 .cindex "lookup" "default values"
7184 .cindex "lookup" "wildcard"
7185 .cindex "lookup" "* added to type"
7186 .cindex "default" "in single-key lookups"
7187 In this context, a &"default value"& is a value specified by the administrator
7188 that is to be used if a lookup fails.
7189
7190 &*Note:*& This section applies only to single-key lookups. For query-style
7191 lookups, the facilities of the query language must be used. An attempt to
7192 specify a default for a query-style lookup provokes an error.
7193
7194 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7195 and the initial lookup fails, the key &"*"& is looked up in the file to
7196 provide a default value. See also the section on partial matching below.
7197
7198 .cindex "*@ with single-key lookup"
7199 .cindex "lookup" "*@ added to type"
7200 .cindex "alias file" "per-domain default"
7201 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7202 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7203 character, a second lookup is done with everything before the last @ replaced
7204 by *. This makes it possible to provide per-domain defaults in alias files
7205 that include the domains in the keys. If the second lookup fails (or doesn't
7206 take place because there is no @ in the key), &"*"& is looked up.
7207 For example, a &(redirect)& router might contain:
7208 .code
7209 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7210 .endd
7211 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7212 looks up these keys, in this order:
7213 .code
7214 jane@eyre.example
7215 *@eyre.example
7216 *
7217 .endd
7218 The data is taken from whichever key it finds first. &*Note*&: In an
7219 &(lsearch)& file, this does not mean the first of these keys in the file. A
7220 complete scan is done for each key, and only if it is not found at all does
7221 Exim move on to try the next key.
7222
7223
7224
7225 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7226 .cindex "partial matching"
7227 .cindex "wildcard lookups"
7228 .cindex "lookup" "partial matching"
7229 .cindex "lookup" "wildcard"
7230 .cindex "asterisk" "in search type"
7231 The normal operation of a single-key lookup is to search the file for an exact
7232 match with the given key. However, in a number of situations where domains are
7233 being looked up, it is useful to be able to do partial matching. In this case,
7234 information in the file that has a key starting with &"*."& is matched by any
7235 domain that ends with the components that follow the full stop. For example, if
7236 a key in a DBM file is
7237 .code
7238 *.dates.fict.example
7239 .endd
7240 then when partial matching is enabled this is matched by (amongst others)
7241 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7242 by &'dates.fict.example'&, if that does not appear as a separate key in the
7243 file.
7244
7245 &*Note*&: Partial matching is not available for query-style lookups. It is
7246 also not available for any lookup items in address lists (see section
7247 &<<SECTaddresslist>>&).
7248
7249 Partial matching is implemented by doing a series of separate lookups using
7250 keys constructed by modifying the original subject key. This means that it can
7251 be used with any of the single-key lookup types, provided that
7252 partial matching keys
7253 beginning with a special prefix (default &"*."&) are included in the data file.
7254 Keys in the file that do not begin with the prefix are matched only by
7255 unmodified subject keys when partial matching is in use.
7256
7257 Partial matching is requested by adding the string &"partial-"& to the front of
7258 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7259 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7260 is added at the start of the subject key, and it is looked up again. If that
7261 fails, further lookups are tried with dot-separated components removed from the
7262 start of the subject key, one-by-one, and &"*."& added on the front of what
7263 remains.
7264
7265 A minimum number of two non-* components are required. This can be adjusted
7266 by including a number before the hyphen in the search type. For example,
7267 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7268 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7269 subject key is &'2250.dates.fict.example'& then the following keys are looked
7270 up when the minimum number of non-* components is two:
7271 .code
7272 2250.dates.fict.example
7273 *.2250.dates.fict.example
7274 *.dates.fict.example
7275 *.fict.example
7276 .endd
7277 As soon as one key in the sequence is successfully looked up, the lookup
7278 finishes.
7279
7280 .cindex "lookup" "partial matching &-- changing prefix"
7281 .cindex "prefix" "for partial matching"
7282 The use of &"*."& as the partial matching prefix is a default that can be
7283 changed. The motivation for this feature is to allow Exim to operate with file
7284 formats that are used by other MTAs. A different prefix can be supplied in
7285 parentheses instead of the hyphen after &"partial"&. For example:
7286 .code
7287 domains = partial(.)lsearch;/some/file
7288 .endd
7289 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7290 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7291 components is unchanged). The prefix may consist of any punctuation characters
7292 other than a closing parenthesis. It may be empty, for example:
7293 .code
7294 domains = partial1()cdb;/some/file
7295 .endd
7296 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7297 &`a.b.c`&, &`b.c`&, and &`c`&.
7298
7299 If &"partial0"& is specified, what happens at the end (when the lookup with
7300 just one non-wild component has failed, and the original key is shortened right
7301 down to the null string) depends on the prefix:
7302
7303 .ilist
7304 If the prefix has zero length, the whole lookup fails.
7305 .next
7306 If the prefix has length 1, a lookup for just the prefix is done. For
7307 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7308 .next
7309 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7310 remainder is looked up. With the default prefix, therefore, the final lookup is
7311 for &"*"& on its own.
7312 .next
7313 Otherwise, the whole prefix is looked up.
7314 .endlist
7315
7316
7317 If the search type ends in &"*"& or &"*@"& (see section
7318 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7319 this implies happens after all partial lookups have failed. If &"partial0"& is
7320 specified, adding &"*"& to the search type has no effect with the default
7321 prefix, because the &"*"& key is already included in the sequence of partial
7322 lookups. However, there might be a use for lookup types such as
7323 &"partial0(.)lsearch*"&.
7324
7325 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7326 in domain lists and the like. Partial matching works only in terms of
7327 dot-separated components; a key such as &`*fict.example`&
7328 in a database file is useless, because the asterisk in a partial matching
7329 subject key is always followed by a dot.
7330
7331
7332
7333
7334 .section "Lookup caching" "SECID64"
7335 .cindex "lookup" "caching"
7336 .cindex "caching" "lookup data"
7337 Exim caches all lookup results in order to avoid needless repetition of
7338 lookups. However, because (apart from the daemon) Exim operates as a collection
7339 of independent, short-lived processes, this caching applies only within a
7340 single Exim process. There is no inter-process lookup caching facility.
7341
7342 If an option &"cache=no_rd"& is used on the lookup then
7343 the cache is only written to, cached data is not used for the operation
7344 and a real lookup is done.
7345
7346 For single-key lookups, Exim keeps the relevant files open in case there is
7347 another lookup that needs them. In some types of configuration this can lead to
7348 many files being kept open for messages with many recipients. To avoid hitting
7349 the operating system limit on the number of simultaneously open files, Exim
7350 closes the least recently used file when it needs to open more files than its
7351 own internal limit, which can be changed via the &%lookup_open_max%& option.
7352
7353 The single-key lookup files are closed and the lookup caches are flushed at
7354 strategic points during delivery &-- for example, after all routing is
7355 complete.
7356
7357
7358
7359
7360 .section "Quoting lookup data" "SECID65"
7361 .cindex "lookup" "quoting"
7362 .cindex "quoting" "in lookups"
7363 When data from an incoming message is included in a query-style lookup, there
7364 is the possibility of special characters in the data messing up the syntax of
7365 the query. For example, a NIS+ query that contains
7366 .code
7367 [name=$local_part]
7368 .endd
7369 will be broken if the local part happens to contain a closing square bracket.
7370 For NIS+, data can be enclosed in double quotes like this:
7371 .code
7372 [name="$local_part"]
7373 .endd
7374 but this still leaves the problem of a double quote in the data. The rule for
7375 NIS+ is that double quotes must be doubled. Other lookup types have different
7376 rules, and to cope with the differing requirements, an expansion operator
7377 of the following form is provided:
7378 .code
7379 ${quote_<lookup-type>:<string>}
7380 .endd
7381 For example, the safest way to write the NIS+ query is
7382 .code
7383 [name="${quote_nisplus:$local_part}"]
7384 .endd
7385 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7386 operator can be used for all lookup types, but has no effect for single-key
7387 lookups, since no quoting is ever needed in their key strings.
7388
7389
7390
7391
7392 .section "More about dnsdb" "SECTdnsdb"
7393 .cindex "dnsdb lookup"
7394 .cindex "lookup" "dnsdb"
7395 .cindex "DNS" "as a lookup type"
7396 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7397 of a record type and a domain name, separated by an equals sign. For example,
7398 an expansion string could contain:
7399 .code
7400 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7401 .endd
7402 If the lookup succeeds, the result is placed in &$value$&, which in this case
7403 is used on its own as the result. If the lookup does not succeed, the
7404 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7405 &<<SECTforexpfai>>& for an explanation of what this means.
7406
7407 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7408 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7409 If no type is given, TXT is assumed.
7410
7411 For any record type, if multiple records are found, the data is returned as a
7412 concatenation, with newline as the default separator. The order, of course,
7413 depends on the DNS resolver. You can specify a different separator character
7414 between multiple records by putting a right angle-bracket followed immediately
7415 by the new separator at the start of the query. For example:
7416 .code
7417 ${lookup dnsdb{>: a=host1.example}}
7418 .endd
7419 It is permitted to specify a space as the separator character. Further
7420 white space is ignored.
7421 For lookup types that return multiple fields per record,
7422 an alternate field separator can be specified using a comma after the main
7423 separator character, followed immediately by the field separator.
7424
7425 .cindex "PTR record" "in &(dnsdb)& lookup"
7426 When the type is PTR,
7427 the data can be an IP address, written as normal; inversion and the addition of
7428 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7429 .code
7430 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7431 .endd
7432 If the data for a PTR record is not a syntactically valid IP address, it is not
7433 altered and nothing is added.
7434
7435 .cindex "MX record" "in &(dnsdb)& lookup"
7436 .cindex "SRV record" "in &(dnsdb)& lookup"
7437 For an MX lookup, both the preference value and the host name are returned for
7438 each record, separated by a space. For an SRV lookup, the priority, weight,
7439 port, and host name are returned for each record, separated by spaces.
7440 The field separator can be modified as above.
7441
7442 .cindex "TXT record" "in &(dnsdb)& lookup"
7443 .cindex "SPF record" "in &(dnsdb)& lookup"
7444 For TXT records with multiple items of data, only the first item is returned,
7445 unless a field separator is specified.
7446 To concatenate items without a separator, use a semicolon instead.
7447 For SPF records the
7448 default behaviour is to concatenate multiple items without using a separator.
7449 .code
7450 ${lookup dnsdb{>\n,: txt=a.b.example}}
7451 ${lookup dnsdb{>\n; txt=a.b.example}}
7452 ${lookup dnsdb{spf=example.org}}
7453 .endd
7454 It is permitted to specify a space as the separator character. Further
7455 white space is ignored.
7456
7457 .cindex "SOA record" "in &(dnsdb)& lookup"
7458 For an SOA lookup, while no result is obtained the lookup is redone with
7459 successively more leading components dropped from the given domain.
7460 Only the primary-nameserver field is returned unless a field separator is
7461 specified.
7462 .code
7463 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7464 .endd
7465
7466 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7467 .cindex "dnsdb modifiers"
7468 .cindex "modifiers" "dnsdb"
7469 .cindex "options" "dnsdb"
7470 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7471 each followed by a comma,
7472 that may appear before the record type.
7473
7474 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7475 temporary DNS error for any of them, the behaviour is controlled by
7476 a defer-option modifier.
7477 The possible keywords are
7478 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7479 With &"strict"& behaviour, any temporary DNS error causes the
7480 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7481 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7482 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7483 error causes the whole lookup to defer only if none of the other lookups
7484 succeed. The default is &"lax"&, so the following lookups are equivalent:
7485 .code
7486 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7487 ${lookup dnsdb{a=one.host.com:two.host.com}}
7488 .endd
7489 Thus, in the default case, as long as at least one of the DNS lookups
7490 yields some data, the lookup succeeds.
7491
7492 .cindex "DNSSEC" "dns lookup"
7493 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7494 The possible keywords are
7495 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7496 With &"strict"& or &"lax"& DNSSEC information is requested
7497 with the lookup.
7498 With &"strict"& a response from the DNS resolver that
7499 is not labelled as authenticated data
7500 is treated as equivalent to a temporary DNS error.
7501 The default is &"lax"&.
7502
7503 See also the &$lookup_dnssec_authenticated$& variable.
7504
7505 .cindex timeout "dns lookup"
7506 .cindex "DNS" timeout
7507 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7508 The form is &"retrans_VAL"& where VAL is an Exim time specification
7509 (e.g. &"5s"&).
7510 The default value is set by the main configuration option &%dns_retrans%&.
7511
7512 Retries for the dnsdb lookup can be controlled by a retry modifier.
7513 The form if &"retry_VAL"& where VAL is an integer.
7514 The default count is set by the main configuration option &%dns_retry%&.
7515
7516 .cindex caching "of dns lookup"
7517 .cindex TTL "of dns lookup"
7518 .cindex DNS TTL
7519 Dnsdb lookup results are cached within a single process (and its children).
7520 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7521 value of the set of returned DNS records.
7522
7523
7524 .subsection "Pseudo dnsdb record types" SECID66
7525 .cindex "MX record" "in &(dnsdb)& lookup"
7526 By default, both the preference value and the host name are returned for
7527 each MX record, separated by a space. If you want only host names, you can use
7528 the pseudo-type MXH:
7529 .code
7530 ${lookup dnsdb{mxh=a.b.example}}
7531 .endd
7532 In this case, the preference values are omitted, and just the host names are
7533 returned.
7534
7535 .cindex "name server for enclosing domain"
7536 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7537 records on the given domain, but if none are found, it removes the first
7538 component of the domain name, and tries again. This process continues until NS
7539 records are found or there are no more components left (or there is a DNS
7540 error). In other words, it may return the name servers for a top-level domain,
7541 but it never returns the root name servers. If there are no NS records for the
7542 top-level domain, the lookup fails. Consider these examples:
7543 .code
7544 ${lookup dnsdb{zns=xxx.quercite.com}}
7545 ${lookup dnsdb{zns=xxx.edu}}
7546 .endd
7547 Assuming that in each case there are no NS records for the full domain name,
7548 the first returns the name servers for &%quercite.com%&, and the second returns
7549 the name servers for &%edu%&.
7550
7551 You should be careful about how you use this lookup because, unless the
7552 top-level domain does not exist, the lookup always returns some host names. The
7553 sort of use to which this might be put is for seeing if the name servers for a
7554 given domain are on a blacklist. You can probably assume that the name servers
7555 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7556 such a list.
7557
7558 .cindex "CSA" "in &(dnsdb)& lookup"
7559 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7560 records according to the CSA rules, which are described in section
7561 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7562 not sufficient because of the extra parent domain search behaviour of CSA. The
7563 result of a successful lookup such as:
7564 .code
7565 ${lookup dnsdb {csa=$sender_helo_name}}
7566 .endd
7567 has two space-separated fields: an authorization code and a target host name.
7568 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7569 authorization required but absent, or &"?"& for unknown.
7570
7571 .cindex "A+" "in &(dnsdb)& lookup"
7572 The pseudo-type A+ performs an AAAA
7573 and then an A lookup.  All results are returned; defer processing
7574 (see below) is handled separately for each lookup.  Example:
7575 .code
7576 ${lookup dnsdb {>; a+=$sender_helo_name}}
7577 .endd
7578
7579
7580 .subsection "Multiple dnsdb lookups" SECID67
7581 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7582 However, you can specify a list of domains or IP addresses in a single
7583 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7584 the default separator, but with the ability to change this. For example:
7585 .code
7586 ${lookup dnsdb{one.domain.com:two.domain.com}}
7587 ${lookup dnsdb{a=one.host.com:two.host.com}}
7588 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7589 .endd
7590 In order to retain backwards compatibility, there is one special case: if
7591 the lookup type is PTR and no change of separator is specified, Exim looks
7592 to see if the rest of the string is precisely one IPv6 address. In this
7593 case, it does not treat it as a list.
7594
7595 The data from each lookup is concatenated, with newline separators by default,
7596 in the same way that multiple DNS records for a single item are handled. A
7597 different separator can be specified, as described above.
7598
7599
7600
7601
7602 .section "More about LDAP" "SECTldap"
7603 .cindex "LDAP" "lookup, more about"
7604 .cindex "lookup" "LDAP"
7605 .cindex "Solaris" "LDAP"
7606 The original LDAP implementation came from the University of Michigan; this has
7607 become &"Open LDAP"&, and there are now two different releases. Another
7608 implementation comes from Netscape, and Solaris 7 and subsequent releases
7609 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7610 the lookup function level, their error handling is different. For this reason
7611 it is necessary to set a compile-time variable when building Exim with LDAP, to
7612 indicate which LDAP library is in use. One of the following should appear in
7613 your &_Local/Makefile_&:
7614 .code
7615 LDAP_LIB_TYPE=UMICHIGAN
7616 LDAP_LIB_TYPE=OPENLDAP1
7617 LDAP_LIB_TYPE=OPENLDAP2
7618 LDAP_LIB_TYPE=NETSCAPE
7619 LDAP_LIB_TYPE=SOLARIS
7620 .endd
7621 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7622 same interface as the University of Michigan version.
7623
7624 There are three LDAP lookup types in Exim. These behave slightly differently in
7625 the way they handle the results of a query:
7626
7627 .ilist
7628 &(ldap)& requires the result to contain just one entry; if there are more, it
7629 gives an error.
7630 .next
7631 &(ldapdn)& also requires the result to contain just one entry, but it is the
7632 Distinguished Name that is returned rather than any attribute values.
7633 .next
7634 &(ldapm)& permits the result to contain more than one entry; the attributes
7635 from all of them are returned.
7636 .endlist
7637
7638
7639 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7640 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7641 the data returned by a successful lookup is described in the next section.
7642 First we explain how LDAP queries are coded.
7643
7644
7645 .subsection "Format of LDAP queries" SECTforldaque
7646 .cindex "LDAP" "query format"
7647 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7648 the configuration of a &(redirect)& router one might have this setting:
7649 .code
7650 data = ${lookup ldap \
7651   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7652   c=UK?mailbox?base?}}
7653 .endd
7654 .cindex "LDAP" "with TLS"
7655 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7656 secure (encrypted) LDAP connections. The second of these ensures that an
7657 encrypted TLS connection is used.
7658
7659 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7660 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7661 See the &%ldap_start_tls%& option.
7662
7663 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7664 controlled. Every part of the TLS configuration can be configured by settings in
7665 &_exim.conf_&. Depending on the version of the client libraries installed on
7666 your system, some of the initialization may have required setting options in
7667 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7668 certificates. This revealed a nuance where the current UID that exim was
7669 running as could affect which config files it read. With Exim 4.83, these
7670 methods become optional, only taking effect if not specifically set in
7671 &_exim.conf_&.
7672
7673
7674 .subsection "LDAP quoting" SECID68
7675 .cindex "LDAP" "quoting"
7676 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7677 and the second because the LDAP query is represented as a URL. Furthermore,
7678 within an LDAP query, two different kinds of quoting are required. For this
7679 reason, there are two different LDAP-specific quoting operators.
7680
7681 The &%quote_ldap%& operator is designed for use on strings that are part of
7682 filter specifications. Conceptually, it first does the following conversions on
7683 the string:
7684 .code
7685 *   =>   \2A
7686 (   =>   \28
7687 )   =>   \29
7688 \   =>   \5C
7689 .endd
7690 in accordance with RFC 2254. The resulting string is then quoted according
7691 to the rules for URLs, that is, all non-alphanumeric characters except
7692 .code
7693 ! $ ' - . _ ( ) * +
7694 .endd
7695 are converted to their hex values, preceded by a percent sign. For example:
7696 .code
7697 ${quote_ldap: a(bc)*, a<yz>; }
7698 .endd
7699 yields
7700 .code
7701 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7702 .endd
7703 Removing the URL quoting, this is (with a leading and a trailing space):
7704 .code
7705 a\28bc\29\2A, a<yz>;
7706 .endd
7707 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7708 base DN specifications in queries. Conceptually, it first converts the string
7709 by inserting a backslash in front of any of the following characters:
7710 .code
7711 , + " \ < > ;
7712 .endd
7713 It also inserts a backslash before any leading spaces or # characters, and
7714 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7715 is then quoted according to the rules for URLs. For example:
7716 .code
7717 ${quote_ldap_dn: a(bc)*, a<yz>; }
7718 .endd
7719 yields
7720 .code
7721 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7722 .endd
7723 Removing the URL quoting, this is (with a trailing space):
7724 .code
7725 \ a(bc)*\, a\<yz\>\;\
7726 .endd
7727 There are some further comments about quoting in the section on LDAP
7728 authentication below.
7729
7730
7731 .subsection "LDAP connections" SECID69
7732 .cindex "LDAP" "connections"
7733 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7734 is in use, via a Unix domain socket. The example given above does not specify
7735 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7736 by starting it with
7737 .code
7738 ldap://<hostname>:<port>/...
7739 .endd
7740 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7741 used. When no server is specified in a query, a list of default servers is
7742 taken from the &%ldap_default_servers%& configuration option. This supplies a
7743 colon-separated list of servers which are tried in turn until one successfully
7744 handles a query, or there is a serious error. Successful handling either
7745 returns the requested data, or indicates that it does not exist. Serious errors
7746 are syntactical, or multiple values when only a single value is expected.
7747 Errors which cause the next server to be tried are connection failures, bind
7748 failures, and timeouts.
7749
7750 For each server name in the list, a port number can be given. The standard way
7751 of specifying a host and port is to use a colon separator (RFC 1738). Because
7752 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7753 doubled. For example
7754 .code
7755 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7756 .endd
7757 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7758 to the LDAP library with no server name, and the library's default (normally
7759 the local host) is used.
7760
7761 If you are using the OpenLDAP library, you can connect to an LDAP server using
7762 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7763 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7764 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7765 not available.
7766
7767 For this type of connection, instead of a host name for the server, a pathname
7768 for the socket is required, and the port number is not relevant. The pathname
7769 can be specified either as an item in &%ldap_default_servers%&, or inline in
7770 the query. In the former case, you can have settings such as
7771 .code
7772 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7773 .endd
7774 When the pathname is given in the query, you have to escape the slashes as
7775 &`%2F`& to fit in with the LDAP URL syntax. For example:
7776 .code
7777 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7778 .endd
7779 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7780 a pathname, it uses the Unix domain socket code, even if the query actually
7781 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7782 socket connection. This behaviour means that you can use a setting of
7783 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7784 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7785 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7786 backup host.
7787
7788 If an explicit &`ldapi`& type is given in a query when a host name is
7789 specified, an error is diagnosed. However, if there are more items in
7790 &%ldap_default_servers%&, they are tried. In other words:
7791
7792 .ilist
7793 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7794 interface.
7795 .next
7796 Using &`ldapi`& with a host name causes an error.
7797 .endlist
7798
7799
7800 Using &`ldapi`& with no host or path in the query, and no setting of
7801 &%ldap_default_servers%&, does whatever the library does by default.
7802
7803
7804
7805 .subsection "LDAP authentication and control information" SECID70
7806 .cindex "LDAP" "authentication"
7807 The LDAP URL syntax provides no way of passing authentication and other control
7808 information to the server. To make this possible, the URL in an LDAP query may
7809 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7810 spaces. If a value contains spaces it must be enclosed in double quotes, and
7811 when double quotes are used, backslash is interpreted in the usual way inside
7812 them. The following names are recognized:
7813 .itable none 0 0 2 20* left 80* left
7814 .irow DEREFERENCE "set the dereferencing parameter"
7815 .irow NETTIME     "set a timeout for a network operation"
7816 .irow USER        "set the DN, for authenticating the LDAP bind"
7817 .irow PASS        "set the password, likewise"
7818 .irow REFERRALS   "set the referrals parameter"
7819 .irow SERVERS     "set alternate server list for this query only"
7820 .irow SIZE        "set the limit for the number of entries returned"
7821 .irow TIME        "set the maximum waiting time for a query"
7822 .endtable
7823 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7824 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7825 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7826 library from trying to follow referrals issued by the LDAP server.
7827
7828 .cindex LDAP timeout
7829 .cindex timeout "LDAP lookup"
7830 The name CONNECT is an obsolete name for NETTIME, retained for
7831 backwards compatibility. This timeout (specified as a number of seconds) is
7832 enforced from the client end for operations that can be carried out over a
7833 network. Specifically, it applies to network connections and calls to the
7834 &'ldap_result()'& function. If the value is greater than zero, it is used if
7835 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7836 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7837 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7838 Netscape SDK; for OpenLDAP no action is taken.
7839
7840 The TIME parameter (also a number of seconds) is passed to the server to
7841 set a server-side limit on the time taken to complete a search.
7842
7843 The SERVERS parameter allows you to specify an alternate list of ldap servers
7844 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7845 default list of ldap servers, and a single lookup can specify a single ldap
7846 server to use.  But when you need to do a lookup with a list of servers that is
7847 different than the default list (maybe different order, maybe a completely
7848 different set of servers), the SERVERS parameter allows you to specify this
7849 alternate list (colon-separated).
7850
7851 Here is an example of an LDAP query in an Exim lookup that uses some of these
7852 values. This is a single line, folded to fit on the page:
7853 .code
7854 ${lookup ldap
7855   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7856   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7857   {$value}fail}
7858 .endd
7859 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7860 any of the auxiliary data. Exim configuration settings that include lookups
7861 which contain password information should be preceded by &"hide"& to prevent
7862 non-admin users from using the &%-bP%& option to see their values.
7863
7864 The auxiliary data items may be given in any order. The default is no
7865 connection timeout (the system timeout is used), no user or password, no limit
7866 on the number of entries returned, and no time limit on queries.
7867
7868 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7869 removes any URL quoting that it may contain before passing it to the LDAP library.
7870 Apparently
7871 some libraries do this for themselves, but some do not. Removing the URL
7872 quoting has two advantages:
7873
7874 .ilist
7875 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7876 DNs as with DNs inside actual queries.
7877 .next
7878 It permits spaces inside USER= DNs.
7879 .endlist
7880
7881 For example, a setting such as
7882 .code
7883 USER=cn=${quote_ldap_dn:$1}
7884 .endd
7885 should work even if &$1$& contains spaces.
7886
7887 Expanded data for the PASS= value should be quoted using the &%quote%&
7888 expansion operator, rather than the LDAP quote operators. The only reason this
7889 field needs quoting is to ensure that it conforms to the Exim syntax, which
7890 does not allow unquoted spaces. For example:
7891 .code
7892 PASS=${quote:$3}
7893 .endd
7894 The LDAP authentication mechanism can be used to check passwords as part of
7895 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7896 &<<CHAPexpand>>&.
7897
7898
7899
7900 .subsection "Format of data returned by LDAP" SECID71
7901 .cindex "LDAP" "returned data formats"
7902 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7903 as a sequence of values, for example
7904 .code
7905 cn=manager,o=University of Cambridge,c=UK
7906 .endd
7907 The &(ldap)& lookup type generates an error if more than one entry matches the
7908 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7909 the result between the data from different entries. It is possible for multiple
7910 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7911 you know that whatever values are returned all came from a single entry in the
7912 directory.
7913
7914 In the common case where you specify a single attribute in your LDAP query, the
7915 result is not quoted, and does not contain the attribute name. If the attribute
7916 has multiple values, they are separated by commas. Any comma that is
7917 part of an attribute's value is doubled.
7918
7919 If you specify multiple attributes, the result contains space-separated, quoted
7920 strings, each preceded by the attribute name and an equals sign. Within the
7921 quotes, the quote character, backslash, and newline are escaped with
7922 backslashes, and commas are used to separate multiple values for the attribute.
7923 Any commas in attribute values are doubled
7924 (permitting treatment of the values as a comma-separated list).
7925 Apart from the escaping, the string within quotes takes the same form as the
7926 output when a single attribute is requested. Specifying no attributes is the
7927 same as specifying all of an entry's attributes.
7928
7929 Here are some examples of the output format. The first line of each pair is an
7930 LDAP query, and the second is the data that is returned. The attribute called
7931 &%attr1%& has two values, one of them with an embedded comma, whereas
7932 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7933 (they have SUP &%attr%& in their schema definitions).
7934
7935 .code
7936 ldap:///o=base?attr1?sub?(uid=fred)
7937 value1.1,value1,,2
7938
7939 ldap:///o=base?attr2?sub?(uid=fred)
7940 value two
7941
7942 ldap:///o=base?attr?sub?(uid=fred)
7943 value1.1,value1,,2,value two
7944
7945 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7946 attr1="value1.1,value1,,2" attr2="value two"
7947
7948 ldap:///o=base??sub?(uid=fred)
7949 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7950 .endd
7951 You can
7952 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7953 results of LDAP lookups.
7954 The &%extract%& operator in string expansions can be used to pick out
7955 individual fields from data that consists of &'key'&=&'value'& pairs.
7956 The &%listextract%& operator should be used to pick out individual values
7957 of attributes, even when only a single value is expected.
7958 The doubling of embedded commas allows you to use the returned data as a
7959 comma separated list (using the "<," syntax for changing the input list separator).
7960
7961
7962
7963
7964 .section "More about NIS+" "SECTnisplus"
7965 .cindex "NIS+ lookup type"
7966 .cindex "lookup" "NIS+"
7967 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7968 and field name. If this is given, the result of a successful query is the
7969 contents of the named field; otherwise the result consists of a concatenation
7970 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7971 values containing spaces are quoted. For example, the query
7972 .code
7973 [name=mg1456],passwd.org_dir
7974 .endd
7975 might return the string
7976 .code
7977 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7978 home=/home/mg1456 shell=/bin/bash shadow=""
7979 .endd
7980 (split over two lines here to fit on the page), whereas
7981 .code
7982 [name=mg1456],passwd.org_dir:gcos
7983 .endd
7984 would just return
7985 .code
7986 Martin Guerre
7987 .endd
7988 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7989 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7990 operator is to double any quote characters within the text.
7991
7992
7993
7994 .section "SQL lookups" "SECTsql"
7995 .cindex "SQL lookup types"
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 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8007 and SQLite
8008 databases. Queries for these databases contain SQL statements, so an example
8009 might be
8010 .code
8011 ${lookup mysql{select mailbox from users where id='userx'}\
8012   {$value}fail}
8013 .endd
8014 If the result of the query contains more than one field, the data for each
8015 field in the row is returned, preceded by its name, so the result of
8016 .code
8017 ${lookup pgsql{select home,name from users where id='userx'}\
8018   {$value}}
8019 .endd
8020 might be
8021 .code
8022 home=/home/userx name="Mister X"
8023 .endd
8024 Empty values and values containing spaces are double quoted, with embedded
8025 quotes escaped by a backslash. If the result of the query contains just one
8026 field, the value is passed back verbatim, without a field name, for example:
8027 .code
8028 Mister X
8029 .endd
8030 If the result of the query yields more than one row, it is all concatenated,
8031 with a newline between the data for each row.
8032
8033
8034 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8035 .cindex "MySQL" "lookup type"
8036 .cindex "PostgreSQL lookup type"
8037 .cindex "lookup" "MySQL"
8038 .cindex "lookup" "PostgreSQL"
8039 .cindex "Oracle" "lookup type"
8040 .cindex "lookup" "Oracle"
8041 .cindex "InterBase lookup type"
8042 .cindex "lookup" "InterBase"
8043 .cindex "Redis lookup type"
8044 .cindex lookup Redis
8045 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8046 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8047 or &%redis_servers%&
8048 option (as appropriate) must be set to a colon-separated list of server
8049 information.
8050 .oindex &%mysql_servers%&
8051 .oindex &%pgsql_servers%&
8052 .oindex &%oracle_servers%&
8053 .oindex &%ibase_servers%&
8054 .oindex &%redis_servers%&
8055 (For MySQL and PostgreSQL, the global option need not be set if all
8056 queries contain their own server information &-- see section
8057 &<<SECTspeserque>>&.)
8058 For all but Redis
8059 each item in the list is a slash-separated list of four
8060 items: host name, database name, user name, and password. In the case of
8061 Oracle, the host name field is used for the &"service name"&, and the database
8062 name field is not used and should be empty. For example:
8063 .code
8064 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8065 .endd
8066 Because password data is sensitive, you should always precede the setting with
8067 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8068 option. Here is an example where two MySQL servers are listed:
8069 .code
8070 hide mysql_servers = localhost/users/root/secret:\
8071                      otherhost/users/root/othersecret
8072 .endd
8073 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8074 because this is a colon-separated list, the colon has to be doubled. For each
8075 query, these parameter groups are tried in order until a connection is made and
8076 a query is successfully processed. The result of a query may be that no data is
8077 found, but that is still a successful query. In other words, the list of
8078 servers provides a backup facility, not a list of different places to look.
8079
8080 For Redis the global option need not be specified if all queries contain their
8081 own server information &-- see section &<<SECTspeserque>>&.
8082 If specified, the option must be set to a colon-separated list of server
8083 information.
8084 Each item in the list is a slash-separated list of three items:
8085 host, database number, and password.
8086 .olist
8087 The host is required and may be either an IPv4 address and optional
8088 port number (separated by a colon, which needs doubling due to the
8089 higher-level list), or a Unix socket pathname enclosed in parentheses
8090 .next
8091 The database number is optional; if present that number is selected in the backend
8092 .next
8093 The password is optional; if present it is used to authenticate to the backend
8094 .endlist
8095
8096 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8097 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8098 respectively, and the characters single-quote, double-quote, and backslash
8099 itself are escaped with backslashes.
8100
8101 The &%quote_redis%& expansion operator
8102 escapes whitespace and backslash characters with a backslash.
8103
8104 .subsection "Specifying the server in the query" SECTspeserque
8105 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8106 it is possible to specify a list of servers with an individual query. This is
8107 done by appending a comma-separated option to the query type:
8108 .display
8109 &`,servers=`&&'server1:server2:server3:...'&
8110 .endd
8111 Each item in the list may take one of two forms:
8112 .olist
8113 If it contains no slashes it is assumed to be just a host name. The appropriate
8114 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8115 of the same name, and the remaining parameters (database, user, password) are
8116 taken from there.
8117 .next
8118 If it contains any slashes, it is taken as a complete parameter set.
8119 .endlist
8120 The list of servers is used in exactly the same way as the global list.
8121 Once a connection to a server has happened and a query has been
8122 successfully executed, processing of the lookup ceases.
8123
8124 This feature is intended for use in master/slave situations where updates
8125 are occurring and you want to update the master rather than a slave. If the
8126 master is in the list as a backup for reading, you might have a global setting
8127 like this:
8128 .code
8129 mysql_servers = slave1/db/name/pw:\
8130                 slave2/db/name/pw:\
8131                 master/db/name/pw
8132 .endd
8133 In an updating lookup, you could then write:
8134 .code
8135 ${lookup mysql,servers=master {UPDATE ...} }
8136 .endd
8137 That query would then be sent only to the master server. If, on the other hand,
8138 the master is not to be used for reading, and so is not present in the global
8139 option, you can still update it by a query of this form:
8140 .code
8141 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8142 .endd
8143
8144 An older syntax places the servers specification before the query,
8145 semicolon separated:
8146 .code
8147 ${lookup mysql{servers=master; UPDATE ...} }
8148 .endd
8149 The new version avoids potential issues with tainted
8150 arguments in the query, for explicit expansion.
8151 &*Note*&: server specifications in list-style lookups are still problematic.
8152
8153
8154 .subsection "Special MySQL features" SECID73
8155 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8156 causes a connection to the server on the local host by means of a Unix domain
8157 socket. An alternate socket can be specified in parentheses.
8158 An option group name for MySQL option files can be specified in square brackets;
8159 the default value is &"exim"&.
8160 The full syntax of each item in &%mysql_servers%& is:
8161 .display
8162 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8163   <&'database'&>/<&'user'&>/<&'password'&>
8164 .endd
8165 Any of the four sub-parts of the first field can be omitted. For normal use on
8166 the local host it can be left blank or set to just &"localhost"&.
8167
8168 No database need be supplied &-- but if it is absent here, it must be given in
8169 the queries.
8170
8171 If a MySQL query is issued that does not request any data (an insert, update,
8172 or delete command), the result of the lookup is the number of rows affected.
8173
8174 &*Warning*&: This can be misleading. If an update does not actually change
8175 anything (for example, setting a field to the value it already has), the result
8176 is zero because no rows are affected.
8177
8178
8179 .subsection "Special PostgreSQL features" SECID74
8180 PostgreSQL lookups can also use Unix domain socket connections to the database.
8181 This is usually faster and costs less CPU time than a TCP/IP connection.
8182 However it can be used only if the mail server runs on the same machine as the
8183 database server. A configuration line for PostgreSQL via Unix domain sockets
8184 looks like this:
8185 .code
8186 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8187 .endd
8188 In other words, instead of supplying a host name, a path to the socket is
8189 given. The path name is enclosed in parentheses so that its slashes aren't
8190 visually confused with the delimiters for the other server parameters.
8191
8192 If a PostgreSQL query is issued that does not request any data (an insert,
8193 update, or delete command), the result of the lookup is the number of rows
8194 affected.
8195
8196 .subsection "More about SQLite" SECTsqlite
8197 .cindex "lookup" "SQLite"
8198 .cindex "sqlite lookup type"
8199 SQLite is different to the other SQL lookups because a filename is required in
8200 addition to the SQL query. An SQLite database is a single file, and there is no
8201 daemon as in the other SQL databases.
8202
8203 .oindex &%sqlite_dbfile%&
8204 There are two ways of
8205 specifying the file.
8206 The first is is by using the &%sqlite_dbfile%& main option.
8207 The second, which allows separate files for each query,
8208 is to use an option appended, comma-separated, to the &"sqlite"&
8209 lookup type word.  The option is the word &"file"&, then an equals,
8210 then the filename.
8211 The filename in this case cannot contain whitespace or open-brace charachters.
8212
8213 A deprecated method is available, prefixing the query with the filename
8214 separated by white space.
8215 This means that
8216 .cindex "tainted data" "sqlite file"
8217 the query cannot use any tainted values, as that taints
8218 the entire query including the filename - resulting in a refusal to open
8219 the file.
8220
8221 In all the above cases the filename must be an absolute path.
8222
8223 Here is a lookup expansion example:
8224 .code
8225 sqlite_dbfile = /some/thing/sqlitedb
8226 ...
8227 ${lookup sqlite {select name from aliases where id='userx';}}
8228 .endd
8229 In a list, the syntax is similar. For example:
8230 .code
8231 domainlist relay_to_domains = sqlite;\
8232    select * from relays where ip='$sender_host_address';
8233 .endd
8234 The only character affected by the &%quote_sqlite%& operator is a single
8235 quote, which it doubles.
8236
8237 .cindex timeout SQLite
8238 .cindex sqlite "lookup timeout"
8239 The SQLite library handles multiple simultaneous accesses to the database
8240 internally. Multiple readers are permitted, but only one process can
8241 update at once. Attempts to access the database while it is being updated
8242 are rejected after a timeout period, during which the SQLite library
8243 waits for the lock to be released. In Exim, the default timeout is set
8244 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8245 option.
8246
8247 .subsection "More about Redis" SECTredis
8248 .cindex "lookup" "Redis"
8249 .cindex "redis lookup type"
8250 Redis is a non-SQL database. Commands are simple get and set.
8251 Examples:
8252 .code
8253 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8254 ${lookup redis{get keyname}}
8255 .endd
8256
8257 As of release 4.91, "lightweight" support for Redis Cluster is available.
8258 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8259 of which must be reachable from the running exim instance. If the cluster has
8260 master/slave replication, the list must contain all the master and slave
8261 servers.
8262
8263 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8264 immediately follow the redirection but treats the response as a DEFER, moving on
8265 to the next server in the &%redis_servers%& list until the correct server is
8266 reached.
8267
8268 .ecindex IIDfidalo1
8269 .ecindex IIDfidalo2
8270
8271
8272 . ////////////////////////////////////////////////////////////////////////////
8273 . ////////////////////////////////////////////////////////////////////////////
8274
8275 .chapter "Domain, host, address, and local part lists" &&&
8276          "CHAPdomhosaddlists" &&&
8277          "Domain, host, and address lists"
8278 .scindex IIDdohoadli "lists of domains; hosts; etc."
8279 A number of Exim configuration options contain lists of domains, hosts,
8280 email addresses, or local parts. For example, the &%hold_domains%& option
8281 contains a list of domains whose delivery is currently suspended. These lists
8282 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8283 arguments to expansion conditions such as &%match_domain%&.
8284
8285 Each item in one of these lists is a pattern to be matched against a domain,
8286 host, email address, or local part, respectively. In the sections below, the
8287 different types of pattern for each case are described, but first we cover some
8288 general facilities that apply to all four kinds of list.
8289
8290 Note that other parts of Exim use a &'string list'& which does not
8291 support all the complexity available in
8292 domain, host, address and local part lists.
8293
8294
8295
8296 .section "Results of list checking" SECTlistresults
8297 The primary result of doing a list check is a truth value.
8298 In some contexts additional information is stored
8299 about the list element that matched:
8300 .vlist
8301 .vitem hosts
8302 A &%hosts%& ACL condition
8303 will store a result in the &$host_data$& variable.
8304 .vitem local_parts
8305 A &%local_parts%& router option or &%local_parts%& ACL condition
8306 will store a result in the &$local_part_data$& variable.
8307 .vitem domains
8308 A &%domains%& router option or &%domains%& ACL condition
8309 will store a result in the &$domain_data$& variable.
8310 .vitem senders
8311 A &%senders%& router option or &%senders%& ACL condition
8312 will store a result in the &$sender_data$& variable.
8313 .vitem recipients
8314 A &%recipients%& ACL condition
8315 will store a result in the &$recipient_data$& variable.
8316 .endlist
8317
8318 The detail of the additional information depends on the
8319 type of match and is given below as the &*value*& information.
8320
8321
8322
8323
8324 .section "Expansion of lists" "SECTlistexpand"
8325 .cindex "expansion" "of lists"
8326 Each list is expanded as a single string before it is used.
8327
8328 &'Exception: the router headers_remove option, where list-item
8329 splitting is done before string-expansion.'&
8330
8331 The result of
8332 expansion must be a list, possibly containing empty items, which is split up
8333 into separate items for matching. By default, colon is the separator character,
8334 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8335 &<<SECTempitelis>>& for details of the list syntax; the second of these
8336 discusses the way to specify empty list items.
8337
8338
8339 If the string expansion is forced to fail, Exim behaves as if the item it is
8340 testing (domain, host, address, or local part) is not in the list. Other
8341 expansion failures cause temporary errors.
8342
8343 If an item in a list is a regular expression, backslashes, dollars and possibly
8344 other special characters in the expression must be protected against
8345 misinterpretation by the string expander. The easiest way to do this is to use
8346 the &`\N`& expansion feature to indicate that the contents of the regular
8347 expression should not be expanded. For example, in an ACL you might have:
8348 .code
8349 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8350                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8351 .endd
8352 The first item is a regular expression that is protected from expansion by
8353 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8354 senders based on the receiving domain.
8355
8356
8357
8358
8359 .subsection "Negated items in lists" SECID76
8360 .cindex "list" "negation"
8361 .cindex "negation" "in lists"
8362 Items in a list may be positive or negative. Negative items are indicated by a
8363 leading exclamation mark, which may be followed by optional white space. A list
8364 defines a set of items (domains, etc). When Exim processes one of these lists,
8365 it is trying to find out whether a domain, host, address, or local part
8366 (respectively) is in the set that is defined by the list. It works like this:
8367
8368 The list is scanned from left to right. If a positive item is matched, the
8369 subject that is being checked is in the set; if a negative item is matched, the
8370 subject is not in the set. If the end of the list is reached without the
8371 subject having matched any of the patterns, it is in the set if the last item
8372 was a negative one, but not if it was a positive one. For example, the list in
8373 .code
8374 domainlist relay_to_domains = !a.b.c : *.b.c
8375 .endd
8376 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8377 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8378 list is positive. However, if the setting were
8379 .code
8380 domainlist relay_to_domains = !a.b.c
8381 .endd
8382 then all domains other than &'a.b.c'& would match because the last item in the
8383 list is negative. In other words, a list that ends with a negative item behaves
8384 as if it had an extra item &`:*`& on the end.
8385
8386 Another way of thinking about positive and negative items in lists is to read
8387 the connector as &"or"& after a positive item and as &"and"& after a negative
8388 item.
8389
8390
8391
8392 .subsection "File names in lists" SECTfilnamlis
8393 .cindex "list" "filename in"
8394 If an item in a domain, host, address, or local part list is an absolute
8395 filename (beginning with a slash character), each line of the file is read and
8396 processed as if it were an independent item in the list, except that further
8397 filenames are not allowed,
8398 and no expansion of the data from the file takes place.
8399 Empty lines in the file are ignored, and the file may also contain comment
8400 lines:
8401
8402 .ilist
8403 For domain and host lists, if a # character appears anywhere in a line of the
8404 file, it and all following characters are ignored.
8405 .next
8406 Because local parts may legitimately contain # characters, a comment in an
8407 address list or local part list file is recognized only if # is preceded by
8408 white space or the start of the line. For example:
8409 .code
8410 not#comment@x.y.z   # but this is a comment
8411 .endd
8412 .endlist
8413
8414 Putting a filename in a list has the same effect as inserting each line of the
8415 file as an item in the list (blank lines and comments excepted). However, there
8416 is one important difference: the file is read each time the list is processed,
8417 so if its contents vary over time, Exim's behaviour changes.
8418
8419 If a filename is preceded by an exclamation mark, the sense of any match
8420 within the file is inverted. For example, if
8421 .code
8422 hold_domains = !/etc/nohold-domains
8423 .endd
8424 and the file contains the lines
8425 .code
8426 !a.b.c
8427 *.b.c
8428 .endd
8429 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8430 any domain matching &`*.b.c`& is not.
8431
8432
8433
8434 .subsection "An lsearch file is not an out-of-line list" SECID77
8435 As will be described in the sections that follow, lookups can be used in lists
8436 to provide indexed methods of checking list membership. There has been some
8437 confusion about the way &(lsearch)& lookups work in lists. Because
8438 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8439 sometimes thought that it is allowed to contain wild cards and other kinds of
8440 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8441 always fixed strings, just as for any other single-key lookup type.
8442
8443 If you want to use a file to contain wild-card patterns that form part of a
8444 list, just give the filename on its own, without a search type, as described
8445 in the previous section. You could also use the &(wildlsearch)& or
8446 &(nwildlsearch)&, but there is no advantage in doing this.
8447
8448
8449
8450
8451 .subsection "Named lists" SECTnamedlists
8452 .cindex "named lists"
8453 .cindex "list" "named"
8454 A list of domains, hosts, email addresses, or local parts can be given a name
8455 which is then used to refer to the list elsewhere in the configuration. This is
8456 particularly convenient if the same list is required in several different
8457 places. It also allows lists to be given meaningful names, which can improve
8458 the readability of the configuration. For example, it is conventional to define
8459 a domain list called &'local_domains'& for all the domains that are handled
8460 locally on a host, using a configuration line such as
8461 .code
8462 domainlist local_domains = localhost:my.dom.example
8463 .endd
8464 Named lists are referenced by giving their name preceded by a plus sign, so,
8465 for example, a router that is intended to handle local domains would be
8466 configured with the line
8467 .code
8468 domains = +local_domains
8469 .endd
8470 The first router in a configuration is often one that handles all domains
8471 except the local ones, using a configuration with a negated item like this:
8472 .code
8473 dnslookup:
8474   driver = dnslookup
8475   domains = ! +local_domains
8476   transport = remote_smtp
8477   no_more
8478 .endd
8479 The four kinds of named list are created by configuration lines starting with
8480 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8481 respectively. Then there follows the name that you are defining, followed by an
8482 equals sign and the list itself. For example:
8483 .code
8484 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8485 addresslist bad_senders = cdb;/etc/badsenders
8486 .endd
8487 A named list may refer to other named lists:
8488 .code
8489 domainlist  dom1 = first.example : second.example
8490 domainlist  dom2 = +dom1 : third.example
8491 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8492 .endd
8493 &*Warning*&: If the last item in a referenced list is a negative one, the
8494 effect may not be what you intended, because the negation does not propagate
8495 out to the higher level. For example, consider:
8496 .code
8497 domainlist  dom1 = !a.b
8498 domainlist  dom2 = +dom1 : *.b
8499 .endd
8500 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8501 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8502 means it matches the second list as well. The effect is not the same as
8503 .code
8504 domainlist  dom2 = !a.b : *.b
8505 .endd
8506 where &'x.y'& does not match. It's best to avoid negation altogether in
8507 referenced lists if you can.
8508
8509 .cindex "hiding named list values"
8510 .cindex "named lists" "hiding value of"
8511 Some named list definitions may contain sensitive data, for example, passwords for
8512 accessing databases. To stop non-admin users from using the &%-bP%& command
8513 line option to read these values, you can precede the definition with the
8514 word &"hide"&. For example:
8515 .code
8516 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8517 .endd
8518
8519
8520 Named lists may have a performance advantage. When Exim is routing an
8521 address or checking an incoming message, it caches the result of tests on named
8522 lists. So, if you have a setting such as
8523 .code
8524 domains = +local_domains
8525 .endd
8526 on several of your routers
8527 or in several ACL statements,
8528 the actual test is done only for the first one. However, the caching works only
8529 if there are no expansions within the list itself or any sublists that it
8530 references. In other words, caching happens only for lists that are known to be
8531 the same each time they are referenced.
8532
8533 By default, there may be up to 16 named lists of each type. This limit can be
8534 extended by changing a compile-time variable. The use of domain and host lists
8535 is recommended for concepts such as local domains, relay domains, and relay
8536 hosts. The default configuration is set up like this.
8537
8538
8539
8540 .subsection "Named lists compared with macros" SECID78
8541 .cindex "list" "named compared with macro"
8542 .cindex "macro" "compared with named list"
8543 At first sight, named lists might seem to be no different from macros in the
8544 configuration file. However, macros are just textual substitutions. If you
8545 write
8546 .code
8547 ALIST = host1 : host2
8548 auth_advertise_hosts = !ALIST
8549 .endd
8550 it probably won't do what you want, because that is exactly the same as
8551 .code
8552 auth_advertise_hosts = !host1 : host2
8553 .endd
8554 Notice that the second host name is not negated. However, if you use a host
8555 list, and write
8556 .code
8557 hostlist alist = host1 : host2
8558 auth_advertise_hosts = ! +alist
8559 .endd
8560 the negation applies to the whole list, and so that is equivalent to
8561 .code
8562 auth_advertise_hosts = !host1 : !host2
8563 .endd
8564
8565
8566 .subsection "Named list caching" SECID79
8567 .cindex "list" "caching of named"
8568 .cindex "caching" "named lists"
8569 While processing a message, Exim caches the result of checking a named list if
8570 it is sure that the list is the same each time. In practice, this means that
8571 the cache operates only if the list contains no $ characters, which guarantees
8572 that it will not change when it is expanded. Sometimes, however, you may have
8573 an expanded list that you know will be the same each time within a given
8574 message. For example:
8575 .code
8576 domainlist special_domains = \
8577            ${lookup{$sender_host_address}cdb{/some/file}}
8578 .endd
8579 This provides a list of domains that depends only on the sending host's IP
8580 address. If this domain list is referenced a number of times (for example,
8581 in several ACL lines, or in several routers) the result of the check is not
8582 cached by default, because Exim does not know that it is going to be the
8583 same list each time.
8584
8585 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8586 cache the result anyway. For example:
8587 .code
8588 domainlist_cache special_domains = ${lookup{...
8589 .endd
8590 If you do this, you should be absolutely sure that caching is going to do
8591 the right thing in all cases. When in doubt, leave it out.
8592
8593
8594
8595 .section "Domain lists" "SECTdomainlist"
8596 .cindex "domain list" "patterns for"
8597 .cindex "list" "domain list"
8598 Domain lists contain patterns that are to be matched against a mail domain.
8599 The following types of item may appear in domain lists:
8600
8601 .ilist
8602 .cindex "primary host name"
8603 .cindex "host name" "matched in domain list"
8604 .oindex "&%primary_hostname%&"
8605 .cindex "domain list" "matching primary host name"
8606 .cindex "@ in a domain list"
8607 If a pattern consists of a single @ character, it matches the local host name,
8608 as set by the &%primary_hostname%& option (or defaulted). This makes it
8609 possible to use the same configuration file on several different hosts that
8610 differ only in their names.
8611
8612 The value for a match will be the primary host name.
8613
8614
8615 .next
8616 .cindex "@[] in a domain list"
8617 .cindex "domain list" "matching local IP interfaces"
8618 .cindex "domain literal"
8619 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8620 in square brackets (as in an email address that contains a domain literal), but
8621 only if that IP address is recognized as local for email routing purposes. The
8622 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8623 control which of a host's several IP addresses are treated as local.
8624 In today's Internet, the use of domain literals is controversial;
8625 see the &%allow_domain_literals%& main option.
8626
8627 The value for a match will be the string &`@[]`&.
8628
8629
8630 .next
8631 .cindex "@mx_any"
8632 .cindex "@mx_primary"
8633 .cindex "@mx_secondary"
8634 .cindex "domain list" "matching MX pointers to local host"
8635 If a pattern consists of the string &`@mx_any`& it matches any domain that
8636 has an MX record pointing to the local host or to any host that is listed in
8637 .oindex "&%hosts_treat_as_local%&"
8638 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8639 are similar, except that the first matches only when a primary MX target is the
8640 local host, and the second only when no primary MX target is the local host,
8641 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8642 preference value &-- there may of course be more than one of them.
8643
8644 The MX lookup that takes place when matching a pattern of this type is
8645 performed with the resolver options for widening names turned off. Thus, for
8646 example, a single-component domain will &'not'& be expanded by adding the
8647 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8648 options of the &(dnslookup)& router for a discussion of domain widening.
8649
8650 Sometimes you may want to ignore certain IP addresses when using one of these
8651 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8652 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8653 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8654 on a router). For example:
8655 .code
8656 domains = @mx_any/ignore=127.0.0.1
8657 .endd
8658 This example matches any domain that has an MX record pointing to one of
8659 the local host's IP addresses other than 127.0.0.1.
8660
8661 The list of IP addresses is in fact processed by the same code that processes
8662 host lists, so it may contain CIDR-coded network specifications and it may also
8663 contain negative items.
8664
8665 Because the list of IP addresses is a sublist within a domain list, you have to
8666 be careful about delimiters if there is more than one address. Like any other
8667 list, the default delimiter can be changed. Thus, you might have:
8668 .code
8669 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8670           an.other.domain : ...
8671 .endd
8672 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8673 involved, it is easiest to change the delimiter for the main list as well:
8674 .code
8675 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8676           an.other.domain ? ...
8677 .endd
8678 The value for a match will be the list element string (starting &`@mx_`&).
8679
8680
8681 .next
8682 .cindex "asterisk" "in domain list"
8683 .cindex "domain list" "asterisk in"
8684 .cindex "domain list" "matching &""ends with""&"
8685 If a pattern starts with an asterisk, the remaining characters of the pattern
8686 are compared with the terminating characters of the domain. The use of &"*"& in
8687 domain lists differs from its use in partial matching lookups. In a domain
8688 list, the character following the asterisk need not be a dot, whereas partial
8689 matching works only in terms of dot-separated components. For example, a domain
8690 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8691 &'cipher.key.ex'&.
8692
8693 The value for a match will be the list element string (starting with the asterisk).
8694 Additionally, &$0$& will be set to the matched string
8695 and &$1$& to the variable portion which the asterisk matched.
8696
8697 .next
8698 .cindex "regular expressions" "in domain list"
8699 .cindex "domain list" "matching regular expression"
8700 If a pattern starts with a circumflex character, it is treated as a regular
8701 expression, and matched against the domain using a regular expression matching
8702 function. The circumflex is treated as part of the regular expression.
8703 Email domains are case-independent, so this regular expression match is by
8704 default case-independent, but you can make it case-dependent by starting it
8705 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8706 are given in chapter &<<CHAPregexp>>&.
8707
8708 &*Warning*&: Because domain lists are expanded before being processed, you
8709 must escape any backslash and dollar characters in the regular expression, or
8710 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8711 it is not to be expanded (unless you really do want to build a regular
8712 expression by expansion, of course).
8713
8714 The value for a match will be the list element string (starting with the circumflex).
8715 Additionally, &$0$& will be set to the string matching the regular expression,
8716 and &$1$& (onwards) to any submatches identified by parentheses.
8717
8718
8719
8720 .next
8721 .cindex "lookup" "in domain list"
8722 .cindex "domain list" "matching by lookup"
8723 If a pattern starts with the name of a single-key lookup type followed by a
8724 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8725 must be a filename in a suitable format for the lookup type. For example, for
8726 &"cdb;"& it must be an absolute path:
8727 .code
8728 domains = cdb;/etc/mail/local_domains.cdb
8729 .endd
8730 The appropriate type of lookup is done on the file using the domain name as the
8731 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8732 only in whether or not the key is present in the file. However, when a lookup
8733 is used for the &%domains%& option on a router
8734 or a &%domains%& condition in an ACL statement, the value is preserved in the
8735 &$domain_data$& variable and can be referred to in other router options or
8736 other statements in the same ACL.
8737 .cindex "tainted data" "de-tainting"
8738 .cindex "de-tainting" "using ACL domains condition"
8739 The value will be untainted.
8740
8741 &*Note*&: If the data result of the lookup (as opposed to the key)
8742 is empty, then this empty value is stored in &$domain_data$&.
8743 The option to return the key for the lookup, as the value,
8744 may be what is wanted.
8745
8746
8747 .next
8748 Any of the single-key lookup type names may be preceded by
8749 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8750 .code
8751 domains = partial-dbm;/partial/domains
8752 .endd
8753 This causes partial matching logic to be invoked; a description of how this
8754 works is given in section &<<SECTpartiallookup>>&.
8755
8756 .next
8757 .cindex "asterisk" "in lookup type"
8758 Any of the single-key lookup types may be followed by an asterisk. This causes
8759 a default lookup for a key consisting of a single asterisk to be done if the
8760 original lookup fails. This is not a useful feature when using a domain list to
8761 select particular domains (because any domain would match), but it might have
8762 value if the result of the lookup is being used via the &$domain_data$&
8763 expansion variable.
8764
8765 .next
8766 If the pattern starts with the name of a query-style lookup type followed by a
8767 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8768 pattern must be an appropriate query for the lookup type, as described in
8769 chapter &<<CHAPfdlookup>>&. For example:
8770 .code
8771 hold_domains = mysql;select domain from holdlist \
8772   where domain = '${quote_mysql:$domain}';
8773 .endd
8774 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8775 example, it doesn't matter what field you select). Exim is interested only in
8776 whether or not the query succeeds. However, when a lookup is used for the
8777 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8778 variable and can be referred to in other options.
8779 .cindex "tainted data" "de-tainting"
8780 .cindex "de-tainting" "using router domains option"
8781 The value will be untainted.
8782
8783 .next
8784 If the pattern starts with the name of a lookup type
8785 of either kind (single-key or query-style) it may be
8786 followed by a comma and options,
8787 The options are lookup-type specific and consist of a comma-separated list.
8788 Each item starts with a tag and and equals "=" sign.
8789
8790 .next
8791 .cindex "domain list" "matching literal domain name"
8792 If none of the above cases apply, a caseless textual comparison is made
8793 between the pattern and the domain.
8794
8795 The value for a match will be the list element string.
8796 .cindex "tainted data" "de-tainting"
8797 Note that this is commonly untainted
8798 (depending on the way the list was created).
8799 Specifically, explicit text in the configuration file in not tainted.
8800 This is a useful way of obtaining an untainted equivalent to
8801 the domain, for later operations.
8802
8803 However if the list (including one-element lists)
8804 is created by expanding a variable containing tainted data,
8805 it is tainted and so will the match value be.
8806 .endlist
8807
8808
8809 Here is an example that uses several different kinds of pattern:
8810 .code
8811 domainlist funny_domains = \
8812   @ : \
8813   lib.unseen.edu : \
8814   *.foundation.fict.example : \
8815   \N^[1-2]\d{3}\.fict\.example$\N : \
8816   partial-dbm;/opt/data/penguin/book : \
8817   nis;domains.byname : \
8818   nisplus;[name=$domain,status=local],domains.org_dir
8819 .endd
8820 There are obvious processing trade-offs among the various matching modes. Using
8821 an asterisk is faster than a regular expression, and listing a few names
8822 explicitly probably is too. The use of a file or database lookup is expensive,
8823 but may be the only option if hundreds of names are required. Because the
8824 patterns are tested in order, it makes sense to put the most commonly matched
8825 patterns earlier.
8826
8827
8828
8829 .section "Host lists" "SECThostlist"
8830 .cindex "host list" "patterns in"
8831 .cindex "list" "host list"
8832 Host lists are used to control what remote hosts are allowed to do. For
8833 example, some hosts may be allowed to use the local host as a relay, and some
8834 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8835 two different ways, by name or by IP address. In a host list, some types of
8836 pattern are matched to a host name, and some are matched to an IP address.
8837 You need to be particularly careful with this when single-key lookups are
8838 involved, to ensure that the right value is being used as the key.
8839
8840
8841 .subsection "Special host list patterns" SECID80
8842 .cindex "empty item in hosts list"
8843 .cindex "host list" "empty string in"
8844 If a host list item is the empty string, it matches only when no remote host is
8845 involved. This is the case when a message is being received from a local
8846 process using SMTP on the standard input, that is, when a TCP/IP connection is
8847 not used.
8848
8849 .cindex "asterisk" "in host list"
8850 The special pattern &"*"& in a host list matches any host or no host. Neither
8851 the IP address nor the name is actually inspected.
8852
8853
8854
8855 .subsection "Host list patterns that match by IP address" SECThoslispatip
8856 .cindex "host list" "matching IP addresses"
8857 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8858 the incoming address actually appears in the IPv6 host as
8859 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8860 list, it is converted into a traditional IPv4 address first. (Not all operating
8861 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8862 concerns.)
8863
8864 The following types of pattern in a host list check the remote host by
8865 inspecting its IP address:
8866
8867 .ilist
8868 If the pattern is a plain domain name (not a regular expression, not starting
8869 with *, not a lookup of any kind), Exim calls the operating system function
8870 to find the associated IP address(es). Exim uses the newer
8871 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8872 This typically causes a forward DNS lookup of the name. The result is compared
8873 with the IP address of the subject host.
8874
8875 If there is a temporary problem (such as a DNS timeout) with the host name
8876 lookup, a temporary error occurs. For example, if the list is being used in an
8877 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8878 temporary SMTP error code. If no IP address can be found for the host name,
8879 what happens is described in section &<<SECTbehipnot>>& below.
8880
8881 .next
8882 .cindex "@ in a host list"
8883 If the pattern is &"@"&, the primary host name is substituted and used as a
8884 domain name, as just described.
8885
8886 .next
8887 If the pattern is an IP address, it is matched against the IP address of the
8888 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8889 IPv6 addresses can be given in colon-separated format, but the colons have to
8890 be doubled so as not to be taken as item separators when the default list
8891 separator is used. IPv6 addresses are recognized even when Exim is compiled
8892 without IPv6 support. This means that if they appear in a host list on an
8893 IPv4-only host, Exim will not treat them as host names. They are just addresses
8894 that can never match a client host.
8895
8896 .next
8897 .cindex "@[] in a host list"
8898 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8899 the local host. For example, if the local host is an IPv4 host with one
8900 interface address 10.45.23.56, these two ACL statements have the same effect:
8901 .code
8902 accept hosts = 127.0.0.1 : 10.45.23.56
8903 accept hosts = @[]
8904 .endd
8905 .next
8906 .cindex "CIDR notation"
8907 If the pattern is an IP address followed by a slash and a mask length, for
8908 example
8909 .code
8910 10.11.42.0/24
8911 .endd
8912 , it is matched against the IP address of the subject
8913 host under the given mask. This allows an entire network of hosts to be
8914 included (or excluded) by a single item. The mask uses CIDR notation; it
8915 specifies the number of address bits that must match, starting from the most
8916 significant end of the address.
8917
8918 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8919 of a range of addresses. It is the number of bits in the network portion of the
8920 address. The above example specifies a 24-bit netmask, so it matches all 256
8921 addresses in the 10.11.42.0 network. An item such as
8922 .code
8923 192.168.23.236/31
8924 .endd
8925 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8926 32 for an IPv4 address is the same as no mask at all; just a single address
8927 matches.
8928
8929 Here is another example which shows an IPv4 and an IPv6 network:
8930 .code
8931 recipient_unqualified_hosts = 192.168.0.0/16: \
8932                               3ffe::ffff::836f::::/48
8933 .endd
8934 The doubling of list separator characters applies only when these items
8935 appear inline in a host list. It is not required when indirecting via a file.
8936 For example:
8937 .code
8938 recipient_unqualified_hosts = /opt/exim/unqualnets
8939 .endd
8940 could make use of a file containing
8941 .code
8942 172.16.0.0/12
8943 3ffe:ffff:836f::/48
8944 .endd
8945 to have exactly the same effect as the previous example. When listing IPv6
8946 addresses inline, it is usually more convenient to use the facility for
8947 changing separator characters. This list contains the same two networks:
8948 .code
8949 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8950                                  3ffe:ffff:836f::/48
8951 .endd
8952 The separator is changed to semicolon by the leading &"<;"& at the start of the
8953 list.
8954 .endlist
8955
8956
8957
8958 .subsection "Host list patterns for single-key lookups by host address" &&&
8959          SECThoslispatsikey
8960 .cindex "host list" "lookup of IP address"
8961 When a host is to be identified by a single-key lookup of its complete IP
8962 address, the pattern takes this form:
8963 .display
8964 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8965 .endd
8966 For example:
8967 .code
8968 hosts_lookup = net-cdb;/hosts-by-ip.db
8969 .endd
8970 The text form of the IP address of the subject host is used as the lookup key.
8971 IPv6 addresses are converted to an unabbreviated form, using lower case
8972 letters, with dots as separators because colon is the key terminator in
8973 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8974 quoting the keys, but this is a facility that was added later.] The data
8975 returned by the lookup is not used.
8976
8977 .cindex "IP address" "masking"
8978 .cindex "host list" "masked IP address"
8979 Single-key lookups can also be performed using masked IP addresses, using
8980 patterns of this form:
8981 .display
8982 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8983 .endd
8984 For example:
8985 .code
8986 net24-dbm;/networks.db
8987 .endd
8988 The IP address of the subject host is masked using <&'number'&> as the mask
8989 length. A textual string is constructed from the masked value, followed by the
8990 mask, and this is used as the lookup key. For example, if the host's IP address
8991 is 192.168.34.6, the key that is looked up for the above example is
8992 &"192.168.34.0/24"&.
8993
8994 When an IPv6 address is converted to a string, dots are normally used instead
8995 of colons, so that keys in &(lsearch)& files need not contain colons (which
8996 terminate &(lsearch)& keys). This was implemented some time before the ability
8997 to quote keys was made available in &(lsearch)& files. However, the more
8998 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8999 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9000 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9001 converted using colons and not dots.
9002 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9003 addresses are always used.
9004 The latter are converted to IPv4 addresses, in dotted-quad form.
9005
9006 Ideally, it would be nice to tidy up this anomalous situation by changing to
9007 colons in all cases, given that quoting is now available for &(lsearch)&.
9008 However, this would be an incompatible change that might break some existing
9009 configurations.
9010
9011 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9012 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9013 the former case the key strings include the mask value, whereas in the latter
9014 case the IP address is used on its own.
9015
9016
9017
9018 .subsection "Host list patterns that match by host name" SECThoslispatnam
9019 .cindex "host" "lookup failures"
9020 .cindex "unknown host name"
9021 .cindex "host list" "matching host name"
9022 There are several types of pattern that require Exim to know the name of the
9023 remote host. These are either wildcard patterns or lookups by name. (If a
9024 complete hostname is given without any wildcarding, it is used to find an IP
9025 address to match against, as described in section &<<SECThoslispatip>>&
9026 above.)
9027
9028 If the remote host name is not already known when Exim encounters one of these
9029 patterns, it has to be found from the IP address.
9030 Although many sites on the Internet are conscientious about maintaining reverse
9031 DNS data for their hosts, there are also many that do not do this.
9032 Consequently, a name cannot always be found, and this may lead to unwanted
9033 effects. Take care when configuring host lists with wildcarded name patterns.
9034 Consider what will happen if a name cannot be found.
9035
9036 Because of the problems of determining host names from IP addresses, matching
9037 against host names is not as common as matching against IP addresses.
9038
9039 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9040 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9041 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9042 are done can be changed by setting the &%host_lookup_order%& option. For
9043 security, once Exim has found one or more names, it looks up the IP addresses
9044 for these names and compares them with the IP address that it started with.
9045 Only those names whose IP addresses match are accepted. Any other names are
9046 discarded. If no names are left, Exim behaves as if the host name cannot be
9047 found. In the most common case there is only one name and one IP address.
9048
9049 There are some options that control what happens if a host name cannot be
9050 found. These are described in section &<<SECTbehipnot>>& below.
9051
9052 .cindex "host" "alias for"
9053 .cindex "alias for host"
9054 As a result of aliasing, hosts may have more than one name. When processing any
9055 of the following types of pattern, all the host's names are checked:
9056
9057 .ilist
9058 .cindex "asterisk" "in host list"
9059 If a pattern starts with &"*"& the remainder of the item must match the end of
9060 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9061 &'.b.c'&. This special simple form is provided because this is a very common
9062 requirement. Other kinds of wildcarding require the use of a regular
9063 expression.
9064 .next
9065 .cindex "regular expressions" "in host list"
9066 .cindex "host list" "regular expression in"
9067 If the item starts with &"^"& it is taken to be a regular expression which is
9068 matched against the host name. Host names are case-independent, so this regular
9069 expression match is by default case-independent, but you can make it
9070 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9071 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9072 example,
9073 .code
9074 ^(a|b)\.c\.d$
9075 .endd
9076 is a regular expression that matches either of the two hosts &'a.c.d'& or
9077 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9078 that backslash and dollar characters are not misinterpreted as part of the
9079 string expansion. The simplest way to do this is to use &`\N`& to mark that
9080 part of the string as non-expandable. For example:
9081 .code
9082 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9083 .endd
9084 &*Warning*&: If you want to match a complete host name, you must include the
9085 &`$`& terminating metacharacter in the regular expression, as in the above
9086 example. Without it, a match at the start of the host name is all that is
9087 required.
9088 .endlist
9089
9090
9091
9092
9093 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9094 .cindex "host" "lookup failures, permanent"
9095 While processing a host list, Exim may need to look up an IP address from a
9096 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9097 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9098 behaviour when it fails to find the information it is seeking is the same.
9099
9100 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9101 apply to temporary DNS errors, whose handling is described in the next section.
9102
9103 .cindex "&`+include_unknown`&"
9104 .cindex "&`+ignore_unknown`&"
9105 Exim parses a host list from left to right. If it encounters a permanent
9106 lookup failure in any item in the host list before it has found a match,
9107 Exim treats it as a failure and the default behavior is as if the host
9108 does not match the list. This may not always be what you want to happen.
9109 To change Exim's behaviour, the special items &`+include_unknown`& or
9110 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9111 not recognized in an indirected file).
9112
9113 .ilist
9114 If any item that follows &`+include_unknown`& requires information that
9115 cannot found, Exim behaves as if the host does match the list. For example,
9116 .code
9117 host_reject_connection = +include_unknown:*.enemy.ex
9118 .endd
9119 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9120 any hosts whose name it cannot find.
9121
9122 .next
9123 If any item that follows &`+ignore_unknown`& requires information that cannot
9124 be found, Exim ignores that item and proceeds to the rest of the list. For
9125 example:
9126 .code
9127 accept hosts = +ignore_unknown : friend.example : \
9128                192.168.4.5
9129 .endd
9130 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9131 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9132 name can be found for 192.168.4.5, it is rejected.
9133 .endlist
9134
9135 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9136 list. The effect of each one lasts until the next, or until the end of the
9137 list.
9138
9139 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9140          SECTmixwilhos
9141 .cindex "host list" "mixing names and addresses in"
9142
9143 This section explains the host/ip processing logic with the same concepts
9144 as the previous section, but specifically addresses what happens when a
9145 wildcarded hostname is one of the items in the hostlist.
9146
9147 .ilist
9148 If you have name lookups or wildcarded host names and
9149 IP addresses in the same host list, you should normally put the IP
9150 addresses first. For example, in an ACL you could have:
9151 .code
9152 accept hosts = 10.9.8.7 : *.friend.example
9153 .endd
9154 The reason you normally would order it this way lies in the
9155 left-to-right way that Exim processes lists.  It can test IP addresses
9156 without doing any DNS lookups, but when it reaches an item that requires
9157 a host name, it fails if it cannot find a host name to compare with the
9158 pattern. If the above list is given in the opposite order, the
9159 &%accept%& statement fails for a host whose name cannot be found, even
9160 if its IP address is 10.9.8.7.
9161
9162 .next
9163 If you really do want to do the name check first, and still recognize the IP
9164 address, you can rewrite the ACL like this:
9165 .code
9166 accept hosts = *.friend.example
9167 accept hosts = 10.9.8.7
9168 .endd
9169 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9170 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9171 &`+ignore_unknown`&, which was discussed in depth in the first example in
9172 this section.
9173 .endlist
9174
9175
9176 .subsection "Temporary DNS errors when looking up host information" &&&
9177          SECTtemdnserr
9178 .cindex "host" "lookup failures, temporary"
9179 .cindex "&`+include_defer`&"
9180 .cindex "&`+ignore_defer`&"
9181 A temporary DNS lookup failure normally causes a defer action (except when
9182 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9183 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9184 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9185 section. These options should be used with care, probably only in non-critical
9186 host lists such as whitelists.
9187
9188
9189
9190 .subsection "Host list patterns for single-key lookups by host name" &&&
9191          SECThoslispatnamsk
9192 .cindex "unknown host name"
9193 .cindex "host list" "matching host name"
9194 If a pattern is of the form
9195 .display
9196 <&'single-key-search-type'&>;<&'search-data'&>
9197 .endd
9198 for example
9199 .code
9200 dbm;/host/accept/list
9201 .endd
9202 a single-key lookup is performed, using the host name as its key. If the
9203 lookup succeeds, the host matches the item. The actual data that is looked up
9204 is not used.
9205
9206 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9207 keys in the file, not IP addresses. If you want to do lookups based on IP
9208 addresses, you must precede the search type with &"net-"& (see section
9209 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9210 two items in the same list, one doing an address lookup and one doing a name
9211 lookup, both using the same file.
9212
9213
9214
9215 .subsection "Host list patterns for query-style lookups" SECID81
9216 If a pattern is of the form
9217 .display
9218 <&'query-style-search-type'&>;<&'query'&>
9219 .endd
9220 the query is obeyed, and if it succeeds, the host matches the item. The actual
9221 data that is looked up is not used. The variables &$sender_host_address$& and
9222 &$sender_host_name$& can be used in the query. For example:
9223 .code
9224 hosts_lookup = pgsql;\
9225   select ip from hostlist where ip='$sender_host_address'
9226 .endd
9227 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9228 can use the &%sg%& expansion item to change this if you need to. If you want to
9229 use masked IP addresses in database queries, you can use the &%mask%& expansion
9230 operator.
9231
9232 If the query contains a reference to &$sender_host_name$&, Exim automatically
9233 looks up the host name if it has not already done so. (See section
9234 &<<SECThoslispatnam>>& for comments on finding host names.)
9235
9236 Historical note: prior to release 4.30, Exim would always attempt to find a
9237 host name before running the query, unless the search type was preceded by
9238 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9239 still recognized for query-style lookups, but its presence or absence has no
9240 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9241 See section &<<SECThoslispatsikey>>&.)
9242
9243
9244
9245
9246
9247 .section "Address lists" "SECTaddresslist"
9248 .cindex "list" "address list"
9249 .cindex "address list" "empty item"
9250 .cindex "address list" "patterns"
9251 Address lists contain patterns that are matched against mail addresses. There
9252 is one special case to be considered: the sender address of a bounce message is
9253 always empty. You can test for this by providing an empty item in an address
9254 list. For example, you can set up a router to process bounce messages by
9255 using this option setting:
9256 .code
9257 senders = :
9258 .endd
9259 The presence of the colon creates an empty item. If you do not provide any
9260 data, the list is empty and matches nothing. The empty sender can also be
9261 detected by a regular expression that matches an empty string,
9262 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9263
9264 Non-empty items in an address list can be straightforward email addresses. For
9265 example:
9266 .code
9267 senders = jbc@askone.example : hs@anacreon.example
9268 .endd
9269 A certain amount of wildcarding is permitted. If a pattern contains an @
9270 character, but is not a regular expression and does not begin with a
9271 semicolon-terminated lookup type (described below), the local part of the
9272 subject address is compared with the local part of the pattern, which may start
9273 with an asterisk. If the local parts match, the domain is checked in exactly
9274 the same way as for a pattern in a domain list. For example, the domain can be
9275 wildcarded, refer to a named list, or be a lookup:
9276 .code
9277 deny senders = *@*.spamming.site:\
9278                *@+hostile_domains:\
9279                bozo@partial-lsearch;/list/of/dodgy/sites:\
9280                *@dbm;/bad/domains.db
9281 .endd
9282 .cindex "local part" "starting with !"
9283 .cindex "address list" "local part starting with !"
9284 If a local part that begins with an exclamation mark is required, it has to be
9285 specified using a regular expression, because otherwise the exclamation mark is
9286 treated as a sign of negation, as is standard in lists.
9287
9288 If a non-empty pattern that is not a regular expression or a lookup does not
9289 contain an @ character, it is matched against the domain part of the subject
9290 address. The only two formats that are recognized this way are a literal
9291 domain, or a domain pattern that starts with *. In both these cases, the effect
9292 is the same as if &`*@`& preceded the pattern. For example:
9293 .code
9294 deny senders = enemy.domain : *.enemy.domain
9295 .endd
9296
9297 The following kinds of more complicated address list pattern can match any
9298 address, including the empty address that is characteristic of bounce message
9299 senders:
9300
9301 .ilist
9302 .cindex "regular expressions" "in address list"
9303 .cindex "address list" "regular expression in"
9304 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9305 done against the complete address, with the pattern as the regular expression.
9306 You must take care that backslash and dollar characters are not misinterpreted
9307 as part of the string expansion. The simplest way to do this is to use &`\N`&
9308 to mark that part of the string as non-expandable. For example:
9309 .code
9310 deny senders = \N^.*this.*@example\.com$\N : \
9311                \N^\d{8}.+@spamhaus.example$\N : ...
9312 .endd
9313 The &`\N`& sequences are removed by the expansion, so these items do indeed
9314 start with &"^"& by the time they are being interpreted as address patterns.
9315
9316 .next
9317 .cindex "address list" "lookup for complete address"
9318 Complete addresses can be looked up by using a pattern that starts with a
9319 lookup type terminated by a semicolon, followed by the data for the lookup. For
9320 example:
9321 .code
9322 deny senders = cdb;/etc/blocked.senders : \
9323   mysql;select address from blocked where \
9324   address='${quote_mysql:$sender_address}'
9325 .endd
9326 Both query-style and single-key lookup types can be used. For a single-key
9327 lookup type, Exim uses the complete address as the key. However, empty keys are
9328 not supported for single-key lookups, so a match against the empty address
9329 always fails. This restriction does not apply to query-style lookups.
9330
9331 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9332 cannot be used, and is ignored if specified, with an entry being written to the
9333 panic log.
9334 .cindex "*@ with single-key lookup"
9335 However, you can configure lookup defaults, as described in section
9336 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9337 default. For example, with this lookup:
9338 .code
9339 accept senders = lsearch*@;/some/file
9340 .endd
9341 the file could contains lines like this:
9342 .code
9343 user1@domain1.example
9344 *@domain2.example
9345 .endd
9346 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9347 that are tried is:
9348 .code
9349 nimrod@jaeger.example
9350 *@jaeger.example
9351 *
9352 .endd
9353 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9354 would mean that every address matches, thus rendering the test useless.
9355
9356 &*Warning 2*&: Do not confuse these two kinds of item:
9357 .code
9358 deny recipients = dbm*@;/some/file
9359 deny recipients = *@dbm;/some/file
9360 .endd
9361 The first does a whole address lookup, with defaulting, as just described,
9362 because it starts with a lookup type. The second matches the local part and
9363 domain independently, as described in a bullet point below.
9364 .endlist
9365
9366
9367 The following kinds of address list pattern can match only non-empty addresses.
9368 If the subject address is empty, a match against any of these pattern types
9369 always fails.
9370
9371
9372 .ilist
9373 .cindex "@@ with single-key lookup"
9374 .cindex "address list" "@@ lookup type"
9375 .cindex "address list" "split local part and domain"
9376 If a pattern starts with &"@@"& followed by a single-key lookup item
9377 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9378 split into a local part and a domain. The domain is looked up in the file. If
9379 it is not found, there is no match. If it is found, the data that is looked up
9380 from the file is treated as a colon-separated list of local part patterns, each
9381 of which is matched against the subject local part in turn.
9382
9383 .cindex "asterisk" "in address list"
9384 The lookup may be a partial one, and/or one involving a search for a default
9385 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9386 patterns that are looked up can be regular expressions or begin with &"*"&, or
9387 even be further lookups. They may also be independently negated. For example,
9388 with
9389 .code
9390 deny senders = @@dbm;/etc/reject-by-domain
9391 .endd
9392 the data from which the DBM file is built could contain lines like
9393 .code
9394 baddomain.com:  !postmaster : *
9395 .endd
9396 to reject all senders except &%postmaster%& from that domain.
9397
9398 .cindex "local part" "starting with !"
9399 If a local part that actually begins with an exclamation mark is required, it
9400 has to be specified using a regular expression. In &(lsearch)& files, an entry
9401 may be split over several lines by indenting the second and subsequent lines,
9402 but the separating colon must still be included at line breaks. White space
9403 surrounding the colons is ignored. For example:
9404 .code
9405 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9406   spammer3 : spammer4
9407 .endd
9408 As in all colon-separated lists in Exim, a colon can be included in an item by
9409 doubling.
9410
9411 If the last item in the list starts with a right angle-bracket, the remainder
9412 of the item is taken as a new key to look up in order to obtain a continuation
9413 list of local parts. The new key can be any sequence of characters. Thus one
9414 might have entries like
9415 .code
9416 aol.com: spammer1 : spammer 2 : >*
9417 xyz.com: spammer3 : >*
9418 *:       ^\d{8}$
9419 .endd
9420 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9421 local parts for all domains, in addition to the specific local parts listed for
9422 each domain. Of course, using this feature costs another lookup each time a
9423 chain is followed, but the effort needed to maintain the data is reduced.
9424
9425 .cindex "loop" "in lookups"
9426 It is possible to construct loops using this facility, and in order to catch
9427 them, the chains may be no more than fifty items long.
9428
9429 .next
9430 The @@<&'lookup'&> style of item can also be used with a query-style
9431 lookup, but in this case, the chaining facility is not available. The lookup
9432 can only return a single list of local parts.
9433 .endlist
9434
9435 &*Warning*&: There is an important difference between the address list items
9436 in these two examples:
9437 .code
9438 senders = +my_list
9439 senders = *@+my_list
9440 .endd
9441 In the first one, &`my_list`& is a named address list, whereas in the second
9442 example it is a named domain list.
9443
9444
9445
9446
9447 .subsection "Case of letters in address lists" SECTcasletadd
9448 .cindex "case of local parts"
9449 .cindex "address list" "case forcing"
9450 .cindex "case forcing in address lists"
9451 Domains in email addresses are always handled caselessly, but for local parts
9452 case may be significant on some systems (see &%caseful_local_part%& for how
9453 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9454 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9455 blocking lists should be done in a case-independent manner. Since most address
9456 lists in Exim are used for this kind of control, Exim attempts to do this by
9457 default.
9458
9459 The domain portion of an address is always lowercased before matching it to an
9460 address list. The local part is lowercased by default, and any string
9461 comparisons that take place are done caselessly. This means that the data in
9462 the address list itself, in files included as plain filenames, and in any file
9463 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9464 keys in files that are looked up by a search type other than &(lsearch)& (which
9465 works caselessly) must be in lower case, because these lookups are not
9466 case-independent.
9467
9468 .cindex "&`+caseful`&"
9469 To allow for the possibility of caseful address list matching, if an item in
9470 an address list is the string &"+caseful"&, the original case of the local
9471 part is restored for any comparisons that follow, and string comparisons are no
9472 longer case-independent. This does not affect the domain, which remains in
9473 lower case. However, although independent matches on the domain alone are still
9474 performed caselessly, regular expressions that match against an entire address
9475 become case-sensitive after &"+caseful"& has been seen.
9476
9477
9478
9479 .section "Local part lists" "SECTlocparlis"
9480 .cindex "list" "local part list"
9481 .cindex "local part" "list"
9482 These behave in the same way as domain and host lists, with the following
9483 changes:
9484
9485 Case-sensitivity in local part lists is handled in the same way as for address
9486 lists, as just described. The &"+caseful"& item can be used if required. In a
9487 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9488 set false, the subject is lowercased and the matching is initially
9489 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9490 matching in the local part list, but not elsewhere in the router. If
9491 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9492 option is case-sensitive from the start.
9493
9494 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9495 comments are handled in the same way as address lists &-- they are recognized
9496 only if the # is preceded by white space or the start of the line.
9497 Otherwise, local part lists are matched in the same way as domain lists, except
9498 that the special items that refer to the local host (&`@`&, &`@[]`&,
9499 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9500 Refer to section &<<SECTdomainlist>>& for details of the other available item
9501 types.
9502 .ecindex IIDdohoadli
9503
9504
9505
9506
9507 . ////////////////////////////////////////////////////////////////////////////
9508 . ////////////////////////////////////////////////////////////////////////////
9509
9510 .chapter "String expansions" "CHAPexpand"
9511 .scindex IIDstrexp "expansion" "of strings"
9512 Many strings in Exim's runtime configuration are expanded before use. Some of
9513 them are expanded every time they are used; others are expanded only once.
9514
9515 When a string is being expanded it is copied verbatim from left to right except
9516 .cindex expansion "string concatenation"
9517 when a dollar or backslash character is encountered. A dollar specifies the
9518 start of a portion of the string that is interpreted and replaced as described
9519 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9520 escape character, as described in the following section.
9521
9522 Whether a string is expanded depends upon the context.  Usually this is solely
9523 dependent upon the option for which a value is sought; in this documentation,
9524 options for which string expansion is performed are marked with &dagger; after
9525 the data type.  ACL rules always expand strings.  A couple of expansion
9526 conditions do not expand some of the brace-delimited branches, for security
9527 reasons,
9528 .cindex "tainted data" expansion
9529 .cindex "tainted data" definition
9530 .cindex expansion "tainted data"
9531 and expansion of data deriving from the sender (&"tainted data"&)
9532 is not permitted (including acessing a file using a tainted name).
9533
9534 Common ways of obtaining untainted equivalents of variables with
9535 tainted values
9536 .cindex "tainted data" "de-tainting"
9537 come down to using the tainted value as a lookup key in a trusted database.
9538 This database could be the filesystem structure,
9539 or the password file,
9540 or accessed via a DBMS.
9541 Specific methods are indexed under &"de-tainting"&.
9542
9543
9544
9545 .section "Literal text in expanded strings" "SECTlittext"
9546 .cindex "expansion" "including literal text"
9547 An uninterpreted dollar can be included in an expanded string by putting a
9548 backslash in front of it. A backslash can be used to prevent any special
9549 character being treated specially in an expansion, including backslash itself.
9550 If the string appears in quotes in the configuration file, two backslashes are
9551 required because the quotes themselves cause interpretation of backslashes when
9552 the string is read in (see section &<<SECTstrings>>&).
9553
9554 .cindex "expansion" "non-expandable substrings"
9555 A portion of the string can specified as non-expandable by placing it between
9556 two occurrences of &`\N`&. This is particularly useful for protecting regular
9557 expressions, which often contain backslashes and dollar signs. For example:
9558 .code
9559 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9560 .endd
9561 On encountering the first &`\N`&, the expander copies subsequent characters
9562 without interpretation until it reaches the next &`\N`& or the end of the
9563 string.
9564
9565
9566
9567 .section "Character escape sequences in expanded strings" "SECID82"
9568 .cindex "expansion" "escape sequences"
9569 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9570 expanded string is recognized as an escape sequence for the character newline,
9571 carriage return, or tab, respectively. A backslash followed by up to three
9572 octal digits is recognized as an octal encoding for a single character, and a
9573 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9574 encoding.
9575
9576 These escape sequences are also recognized in quoted strings when they are read
9577 in. Their interpretation in expansions as well is useful for unquoted strings,
9578 and for other cases such as looked-up strings that are then expanded.
9579
9580
9581 .section "Testing string expansions" "SECID83"
9582 .cindex "expansion" "testing"
9583 .cindex "testing" "string expansion"
9584 .oindex "&%-be%&"
9585 Many expansions can be tested by calling Exim with the &%-be%& option. This
9586 takes the command arguments, or lines from the standard input if there are no
9587 arguments, runs them through the string expansion code, and writes the results
9588 to the standard output. Variables based on configuration values are set up, but
9589 since no message is being processed, variables such as &$local_part$& have no
9590 value. Nevertheless the &%-be%& option can be useful for checking out file and
9591 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9592 and &%nhash%&.
9593
9594 .new
9595 When reading lines from the standard input,
9596 macros can be defined and ACL variables can be set.
9597 For example:
9598 .code
9599 MY_MACRO = foo
9600 set acl_m_myvar = bar
9601 .endd
9602 Such macros and variables can then be used in later input lines.
9603 .wen
9604
9605 Exim gives up its root privilege when it is called with the &%-be%& option, and
9606 instead runs under the uid and gid it was called with, to prevent users from
9607 using &%-be%& for reading files to which they do not have access.
9608
9609 .oindex "&%-bem%&"
9610 If you want to test expansions that include variables whose values are taken
9611 from a message, there are two other options that can be used. The &%-bem%&
9612 option is like &%-be%& except that it is followed by a filename. The file is
9613 read as a message before doing the test expansions. For example:
9614 .code
9615 exim -bem /tmp/test.message '$h_subject:'
9616 .endd
9617 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9618 Exim message identifier. For example:
9619 .code
9620 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9621 .endd
9622 This loads the message from Exim's spool before doing the test expansions, and
9623 is therefore restricted to admin users.
9624
9625
9626 .section "Forced expansion failure" "SECTforexpfai"
9627 .cindex "expansion" "forced failure"
9628 A number of expansions that are described in the following section have
9629 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9630 (which are sometimes called &"curly brackets"&). Which of the two strings is
9631 used depends on some condition that is evaluated as part of the expansion. If,
9632 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9633 the entire string expansion fails in a way that can be detected by the code
9634 that requested the expansion. This is called &"forced expansion failure"&, and
9635 its consequences depend on the circumstances. In some cases it is no different
9636 from any other expansion failure, but in others a different action may be
9637 taken. Such variations are mentioned in the documentation of the option that is
9638 being expanded.
9639
9640
9641
9642
9643 .section "Expansion items" "SECTexpansionitems"
9644 The following items are recognized in expanded strings. White space may be used
9645 between sub-items that are keywords or substrings enclosed in braces inside an
9646 outer set of braces, to improve readability. &*Warning*&: Within braces,
9647 white space is significant.
9648
9649 .vlist
9650 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9651 .cindex "expansion" "variables"
9652 Substitute the contents of the named variable, for example:
9653 .code
9654 $local_part
9655 ${domain}
9656 .endd
9657 The second form can be used to separate the name from subsequent alphanumeric
9658 characters. This form (using braces) is available only for variables; it does
9659 &'not'& apply to message headers. The names of the variables are given in
9660 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9661 given, the expansion fails.
9662
9663 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9664 .cindex "expansion" "operators"
9665 The string is first itself expanded, and then the operation specified by
9666 <&'op'&> is applied to it. For example:
9667 .code
9668 ${lc:$local_part}
9669 .endd
9670 The string starts with the first character after the colon, which may be
9671 leading white space. A list of operators is given in section &<<SECTexpop>>&
9672 below. The operator notation is used for simple expansion items that have just
9673 one argument, because it reduces the number of braces and therefore makes the
9674 string easier to understand.
9675
9676 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9677 This item inserts &"basic"& header lines. It is described with the &%header%&
9678 expansion item below.
9679
9680
9681 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9682 .cindex "expansion" "calling an acl"
9683 .cindex "&%acl%&" "call from expansion"
9684 The name and zero to nine argument strings are first expanded separately.  The expanded
9685 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9686 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9687 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9688 and may use the variables; if another acl expansion is used the values
9689 are restored after it returns.  If the ACL sets
9690 a value using a "message =" modifier and returns accept or deny, the value becomes
9691 the result of the expansion.
9692 If no message is set and the ACL returns accept or deny
9693 the expansion result is an empty string.
9694 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9695
9696
9697 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9698 .cindex authentication "results header"
9699 .chindex Authentication-Results:
9700 .cindex authentication "expansion item"
9701 This item returns a string suitable for insertion as an
9702 &'Authentication-Results:'&
9703 header line.
9704 The given <&'authserv-id'&> is included in the result; typically this
9705 will be a domain name identifying the system performing the authentications.
9706 Methods that might be present in the result include:
9707 .code
9708 none
9709 iprev
9710 auth
9711 spf
9712 dkim
9713 .endd
9714
9715 Example use (as an ACL modifier):
9716 .code
9717       add_header = :at_start:${authresults {$primary_hostname}}
9718 .endd
9719 This is safe even if no authentication results are available
9720 .new
9721 and would generally be placed in the DATA ACL.
9722 .wen
9723
9724
9725 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9726        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9727 .cindex "expansion" "extracting certificate fields"
9728 .cindex "&%certextract%&" "certificate fields"
9729 .cindex "certificate" "extracting fields"
9730 The <&'certificate'&> must be a variable of type certificate.
9731 The field name is expanded and used to retrieve the relevant field from
9732 the certificate.  Supported fields are:
9733 .display
9734 &`version        `&
9735 &`serial_number  `&
9736 &`subject        `& RFC4514 DN
9737 &`issuer         `& RFC4514 DN
9738 &`notbefore      `& time
9739 &`notafter       `& time
9740 &`sig_algorithm  `&
9741 &`signature      `&
9742 &`subj_altname   `& tagged list
9743 &`ocsp_uri       `& list
9744 &`crl_uri        `& list
9745 .endd
9746 If the field is found,
9747 <&'string2'&> is expanded, and replaces the whole item;
9748 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9749 variable &$value$& contains the value that has been extracted. Afterwards, it
9750 is restored to any previous value it might have had.
9751
9752 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9753 key is not found. If {<&'string2'&>} is also omitted, the value that was
9754 extracted is used.
9755
9756 Some field names take optional modifiers, appended and separated by commas.
9757
9758 The field selectors marked as "RFC4514" above
9759 output a Distinguished Name string which is
9760 not quite
9761 parseable by Exim as a comma-separated tagged list
9762 (the exceptions being elements containing commas).
9763 RDN elements of a single type may be selected by
9764 a modifier of the type label; if so the expansion
9765 result is a list (newline-separated by default).
9766 The separator may be changed by another modifier of
9767 a right angle-bracket followed immediately by the new separator.
9768 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9769
9770 The field selectors marked as "time" above
9771 take an optional modifier of "int"
9772 for which the result is the number of seconds since epoch.
9773 Otherwise the result is a human-readable string
9774 in the timezone selected by the main "timezone" option.
9775
9776 The field selectors marked as "list" above return a list,
9777 newline-separated by default,
9778 (embedded separator characters in elements are doubled).
9779 The separator may be changed by a modifier of
9780 a right angle-bracket followed immediately by the new separator.
9781
9782 The field selectors marked as "tagged" above
9783 prefix each list element with a type string and an equals sign.
9784 Elements of only one type may be selected by a modifier
9785 which is one of "dns", "uri" or "mail";
9786 if so the element tags are omitted.
9787
9788 If not otherwise noted field values are presented in human-readable form.
9789
9790 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9791        {*&<&'arg'&>&*}...}*&"
9792 .cindex &%dlfunc%&
9793 This expansion dynamically loads and then calls a locally-written C function.
9794 This functionality is available only if Exim is compiled with
9795 .code
9796 EXPAND_DLFUNC=yes
9797 .endd
9798 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9799 object so that it doesn't reload the same object file in the same Exim process
9800 (but of course Exim does start new processes frequently).
9801
9802 There may be from zero to eight arguments to the function.
9803
9804 When compiling
9805 a local function that is to be called in this way,
9806 first &_DLFUNC_IMPL_& should be defined,
9807 and second &_local_scan.h_& should be included.
9808 The Exim variables and functions that are defined by that API
9809 are also available for dynamically loaded functions. The function itself
9810 must have the following type:
9811 .code
9812 int dlfunction(uschar **yield, int argc, uschar *argv[])
9813 .endd
9814 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9815 function should return one of the following values:
9816
9817 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9818 into the expanded string that is being built.
9819
9820 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9821 from &'yield'&, if it is set.
9822
9823 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9824 taken from &'yield'& if it is set.
9825
9826 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9827
9828 When compiling a function that is to be used in this way with gcc,
9829 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9830 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9831
9832
9833 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9834 .cindex "expansion" "extracting value from environment"
9835 .cindex "environment" "values from"
9836 The key is first expanded separately, and leading and trailing white space
9837 removed.
9838 This is then searched for as a name in the environment.
9839 If a variable is found then its value is placed in &$value$&
9840 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9841
9842 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9843 appear, for example:
9844 .code
9845 ${env{USER}{$value} fail }
9846 .endd
9847 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9848 {<&'string1'&>} must be present for &"fail"& to be recognized.
9849
9850 If {<&'string2'&>} is omitted an empty string is substituted on
9851 search failure.
9852 If {<&'string1'&>} is omitted the search result is substituted on
9853 search success.
9854
9855 The environment is adjusted by the &%keep_environment%& and
9856 &%add_environment%& main section options.
9857
9858
9859 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9860        {*&<&'string3'&>&*}}*&"
9861 .cindex "expansion" "extracting substrings by key"
9862 .cindex "&%extract%&" "substrings by key"
9863 The key and <&'string1'&> are first expanded separately. Leading and trailing
9864 white space is removed from the key (but not from any of the strings). The key
9865 must not be empty and must not consist entirely of digits.
9866 The expanded <&'string1'&> must be of the form:
9867 .display
9868 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9869 .endd
9870 .vindex "&$value$&"
9871 where the equals signs and spaces (but not both) are optional. If any of the
9872 values contain white space, they must be enclosed in double quotes, and any
9873 values that are enclosed in double quotes are subject to escape processing as
9874 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9875 for the value that corresponds to the key. The search is case-insensitive. If
9876 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9877 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9878 variable &$value$& contains the value that has been extracted. Afterwards, it
9879 is restored to any previous value it might have had.
9880
9881 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9882 key is not found. If {<&'string2'&>} is also omitted, the value that was
9883 extracted is used. Thus, for example, these two expansions are identical, and
9884 yield &"2001"&:
9885 .code
9886 ${extract{gid}{uid=1984 gid=2001}}
9887 ${extract{gid}{uid=1984 gid=2001}{$value}}
9888 .endd
9889 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9890 appear, for example:
9891 .code
9892 ${extract{Z}{A=... B=...}{$value} fail }
9893 .endd
9894 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9895 {<&'string2'&>} must be present for &"fail"& to be recognized.
9896
9897 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9898        {*&<&'string3'&>&*}}*&" &&&
9899        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9900        {*&<&'string3'&>&*}}*&"
9901 .cindex "expansion" "extracting from JSON object"
9902 .cindex JSON expansions
9903 The key and <&'string1'&> are first expanded separately. Leading and trailing
9904 white space is removed from the key (but not from any of the strings). The key
9905 must not be empty and must not consist entirely of digits.
9906 The expanded <&'string1'&> must be of the form:
9907 .display
9908 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9909 .endd
9910 .vindex "&$value$&"
9911 The braces, commas and colons, and the quoting of the member name are required;
9912 the spaces are optional.
9913 Matching of the key against the member names is done case-sensitively.
9914 For the &"json"& variant,
9915 if a returned value is a JSON string, it retains its leading and
9916 trailing quotes.
9917 For the &"jsons"& variant, which is intended for use with JSON strings, the
9918 leading and trailing quotes are removed from the returned value.
9919 . XXX should be a UTF-8 compare
9920
9921 The results of matching are handled as above.
9922
9923
9924 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9925         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9926 .cindex "expansion" "extracting substrings by number"
9927 .cindex "&%extract%&" "substrings by number"
9928 The <&'number'&> argument must consist entirely of decimal digits,
9929 apart from leading and trailing white space, which is ignored.
9930 This is what distinguishes this form of &%extract%& from the previous kind. It
9931 behaves in the same way, except that, instead of extracting a named field, it
9932 extracts from <&'string1'&> the field whose number is given as the first
9933 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9934 <&'string3'&> as before.
9935
9936 The fields in the string are separated by any one of the characters in the
9937 separator string. These may include space or tab characters.
9938 The first field is numbered one. If the number is negative, the fields are
9939 counted from the end of the string, with the rightmost one numbered -1. If the
9940 number given is zero, the entire string is returned. If the modulus of the
9941 number is greater than the number of fields in the string, the result is the
9942 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9943 provided. For example:
9944 .code
9945 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9946 .endd
9947 yields &"42"&, and
9948 .code
9949 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9950 .endd
9951 yields &"99"&. Two successive separators mean that the field between them is
9952 empty (for example, the fifth field above).
9953
9954
9955 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9956         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9957        "&*${extract jsons{*&<&'number'&>&*}}&&&
9958         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9959 .cindex "expansion" "extracting from JSON array"
9960 .cindex JSON expansions
9961 The <&'number'&> argument must consist entirely of decimal digits,
9962 apart from leading and trailing white space, which is ignored.
9963
9964 Field selection and result handling is as above;
9965 there is no choice of field separator.
9966 For the &"json"& variant,
9967 if a returned value is a JSON string, it retains its leading and
9968 trailing quotes.
9969 For the &"jsons"& variant, which is intended for use with JSON strings, the
9970 leading and trailing quotes are removed from the returned value.
9971
9972
9973 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9974 .cindex "list" "selecting by condition"
9975 .cindex "expansion" "selecting from list by condition"
9976 .vindex "&$item$&"
9977 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9978 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9979 For each item
9980 in this list, its value is placed in &$item$&, and then the condition is
9981 evaluated.
9982 .new
9983 Any modification of &$value$& by this evaluation is discarded.
9984 .wen
9985 If the condition is true, &$item$& is added to the output as an
9986 item in a new list; if the condition is false, the item is discarded. The
9987 separator used for the output list is the same as the one used for the
9988 input, but a separator setting is not included in the output. For example:
9989 .code
9990 ${filter{a:b:c}{!eq{$item}{b}}}
9991 .endd
9992 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9993 to what it was before.
9994 See also the &%map%& and &%reduce%& expansion items.
9995
9996
9997 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9998 .cindex "hash function" "textual"
9999 .cindex "expansion" "textual hash"
10000 This is a textual hashing function, and was the first to be implemented in
10001 early versions of Exim. In current releases, there are other hashing functions
10002 (numeric, MD5, and SHA-1), which are described below.
10003
10004 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10005 <&'n'&>. If you are using fixed values for these numbers, that is, if
10006 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10007 use the simpler operator notation that avoids some of the braces:
10008 .code
10009 ${hash_<n>_<m>:<string>}
10010 .endd
10011 The second number is optional (in both notations). If <&'n'&> is greater than
10012 or equal to the length of the string, the expansion item returns the string.
10013 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10014 function to the string. The new string consists of characters taken from the
10015 first <&'m'&> characters of the string
10016 .code
10017 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10018 .endd
10019 If <&'m'&> is not present the value 26 is used, so that only lower case
10020 letters appear. For example:
10021 .display
10022 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10023 &`$hash{5}{monty}}           `&   yields  &`monty`&
10024 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10025 .endd
10026
10027 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10028         &*$h_*&<&'header&~name'&>&*:*&" &&&
10029        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10030         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10031        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10032         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10033        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10034         &*$rh_*&<&'header&~name'&>&*:*&"
10035 .cindex "expansion" "header insertion"
10036 .vindex "&$header_$&"
10037 .vindex "&$bheader_$&"
10038 .vindex "&$lheader_$&"
10039 .vindex "&$rheader_$&"
10040 .cindex "header lines" "in expansion strings"
10041 .cindex "header lines" "character sets"
10042 .cindex "header lines" "decoding"
10043 Substitute the contents of the named message header line, for example
10044 .code
10045 $header_reply-to:
10046 .endd
10047 The newline that terminates a header line is not included in the expansion, but
10048 internal newlines (caused by splitting the header line over several physical
10049 lines) may be present.
10050
10051 The difference between the four pairs of expansions is in the way
10052 the data in the header line is interpreted.
10053
10054 .ilist
10055 .cindex "white space" "in header lines"
10056 &%rheader%& gives the original &"raw"& content of the header line, with no
10057 processing at all, and without the removal of leading and trailing white space.
10058
10059 .next
10060 .cindex "list" "of header lines"
10061 &%lheader%& gives a colon-separated list, one element per header when there
10062 are multiple headers with a given name.
10063 Any embedded colon characters within an element are doubled, so normal Exim
10064 list-processing facilities can be used.
10065 The terminating newline of each element is removed; in other respects
10066 the content is &"raw"&.
10067
10068 .next
10069 .cindex "base64 encoding" "in header lines"
10070 &%bheader%& removes leading and trailing white space, and then decodes base64
10071 or quoted-printable MIME &"words"& within the header text, but does no
10072 character set translation. If decoding of what looks superficially like a MIME
10073 &"word"& fails, the raw string is returned. If decoding
10074 .cindex "binary zero" "in header line"
10075 produces a binary zero character, it is replaced by a question mark &-- this is
10076 what Exim does for binary zeros that are actually received in header lines.
10077
10078 .next
10079 &%header%& tries to translate the string as decoded by &%bheader%& to a
10080 standard character set. This is an attempt to produce the same string as would
10081 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10082 returned. Translation is attempted only on operating systems that support the
10083 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10084 a system Makefile or in &_Local/Makefile_&.
10085 .endlist ilist
10086
10087 In a filter file, the target character set for &%header%& can be specified by a
10088 command of the following form:
10089 .code
10090 headers charset "UTF-8"
10091 .endd
10092 This command affects all references to &$h_$& (or &$header_$&) expansions in
10093 subsequently obeyed filter commands. In the absence of this command, the target
10094 character set in a filter is taken from the setting of the &%headers_charset%&
10095 option in the runtime configuration. The value of this option defaults to the
10096 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10097 ISO-8859-1.
10098
10099 Header names follow the syntax of RFC 2822, which states that they may contain
10100 any printing characters except space and colon. Consequently, curly brackets
10101 &'do not'& terminate header names, and should not be used to enclose them as
10102 if they were variables. Attempting to do so causes a syntax error.
10103
10104 Only header lines that are common to all copies of a message are visible to
10105 this mechanism. These are the original header lines that are received with the
10106 message, and any that are added by an ACL statement or by a system
10107 filter. Header lines that are added to a particular copy of a message by a
10108 router or transport are not accessible.
10109
10110 For incoming SMTP messages, no header lines are visible in
10111 ACLs that are obeyed before the data phase completes,
10112 because the header structure is not set up until the message is received.
10113 They are visible in DKIM, PRDR and DATA ACLs.
10114 Header lines that are added in a RCPT ACL (for example)
10115 are saved until the message's incoming header lines are available, at which
10116 point they are added.
10117 When any of the above ACLs are
10118 running, however, header lines added by earlier ACLs are visible.
10119
10120 Upper case and lower case letters are synonymous in header names. If the
10121 following character is white space, the terminating colon may be omitted, but
10122 this is not recommended, because you may then forget it when it is needed. When
10123 white space terminates the header name, this white space is included in the
10124 expanded string.  If the message does not contain the given header, the
10125 expansion item is replaced by an empty string. (See the &%def%& condition in
10126 section &<<SECTexpcond>>& for a means of testing for the existence of a
10127 header.)
10128
10129 If there is more than one header with the same name, they are all concatenated
10130 to form the substitution string, up to a maximum length of 64K. Unless
10131 &%rheader%& is being used, leading and trailing white space is removed from
10132 each header before concatenation, and a completely empty header is ignored. A
10133 newline character is then inserted between non-empty headers, but there is no
10134 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10135 those headers that contain lists of addresses, a comma is also inserted at the
10136 junctions between headers. This does not happen for the &%rheader%& expansion.
10137
10138 .cindex "tainted data" "message headers"
10139 When the headers are from an incoming message,
10140 the result of expanding any of these variables is tainted.
10141
10142
10143 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10144 .cindex "expansion" "hmac hashing"
10145 .cindex &%hmac%&
10146 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10147 shared secret and some text into a message authentication code, as specified in
10148 RFC 2104. This differs from &`${md5:secret_text...}`& or
10149 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10150 cryptographic hash, allowing for authentication that is not possible with MD5
10151 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10152 present. For example:
10153 .code
10154 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10155 .endd
10156 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10157 produces:
10158 .code
10159 dd97e3ba5d1a61b5006108f8c8252953
10160 .endd
10161 As an example of how this might be used, you might put in the main part of
10162 an Exim configuration:
10163 .code
10164 SPAMSCAN_SECRET=cohgheeLei2thahw
10165 .endd
10166 In a router or a transport you could then have:
10167 .code
10168 headers_add = \
10169   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10170   ${hmac{md5}{SPAMSCAN_SECRET}\
10171   {${primary_hostname},${message_exim_id},$h_message-id:}}
10172 .endd
10173 Then given a message, you can check where it was scanned by looking at the
10174 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10175 this header line is authentic by recomputing the authentication code from the
10176 host name, message ID and the &'Message-id:'& header line. This can be done
10177 using Exim's &%-be%& option, or by other means, for example, by using the
10178 &'hmac_md5_hex()'& function in Perl.
10179
10180
10181 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10182 .cindex "expansion" "conditional"
10183 .cindex "&%if%&, expansion item"
10184 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10185 item; otherwise <&'string2'&> is used. The available conditions are described
10186 in section &<<SECTexpcond>>& below. For example:
10187 .code
10188 ${if eq {$local_part}{postmaster} {yes}{no} }
10189 .endd
10190 The second string need not be present; if it is not and the condition is not
10191 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10192 be present instead of the second string (without any curly brackets). In this
10193 case, the expansion is forced to fail if the condition is not true (see section
10194 &<<SECTforexpfai>>&).
10195
10196 If both strings are omitted, the result is the string &`true`& if the condition
10197 is true, and the empty string if the condition is false. This makes it less
10198 cumbersome to write custom ACL and router conditions. For example, instead of
10199 .code
10200 condition = ${if >{$acl_m4}{3}{true}{false}}
10201 .endd
10202 you can use
10203 .code
10204 condition = ${if >{$acl_m4}{3}}
10205 .endd
10206
10207
10208
10209 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10210 .cindex expansion "imap folder"
10211 .cindex "&%imapfolder%& expansion item"
10212 This item converts a (possibly multilevel, or with non-ASCII characters)
10213 folder specification to a Maildir name for filesystem use.
10214 For information on internationalisation support see &<<SECTi18nMDA>>&.
10215
10216
10217
10218 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10219 .cindex "expansion" "string truncation"
10220 .cindex "&%length%& expansion item"
10221 The &%length%& item is used to extract the initial portion of a string. Both
10222 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10223 you are using a fixed value for the number, that is, if <&'string1'&> does not
10224 change when expanded, you can use the simpler operator notation that avoids
10225 some of the braces:
10226 .code
10227 ${length_<n>:<string>}
10228 .endd
10229 The result of this item is either the first <&'n'&> bytes or the whole
10230 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10231 &%strlen%&, which gives the length of a string.
10232 All measurement is done in bytes and is not UTF-8 aware.
10233
10234
10235 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10236         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10237 .cindex "expansion" "extracting list elements by number"
10238 .cindex "&%listextract%&" "extract list elements by number"
10239 .cindex "list" "extracting elements by number"
10240 The <&'number'&> argument must consist entirely of decimal digits,
10241 apart from an optional leading minus,
10242 and leading and trailing white space (which is ignored).
10243
10244 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10245 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10246
10247 The first field of the list is numbered one.
10248 If the number is negative, the fields are
10249 counted from the end of the list, with the rightmost one numbered -1.
10250 The numbered element of the list is extracted and placed in &$value$&,
10251 then <&'string2'&> is expanded as the result.
10252
10253 If the modulus of the
10254 number is zero or greater than the number of fields in the string,
10255 the result is the expansion of <&'string3'&>.
10256
10257 For example:
10258 .code
10259 ${listextract{2}{x:42:99}}
10260 .endd
10261 yields &"42"&, and
10262 .code
10263 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10264 .endd
10265 yields &"result: 42"&.
10266
10267 If {<&'string3'&>} is omitted, an empty string is used for string3.
10268 If {<&'string2'&>} is also omitted, the value that was
10269 extracted is used.
10270 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10271
10272
10273 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10274 .cindex quoting "for list"
10275 .cindex list quoting
10276 This item doubles any occurrence of the separator character
10277 in the given string.
10278 An empty string is replaced with a single space.
10279 This converts the string into a safe form for use as a list element,
10280 in a list using the given separator.
10281
10282
10283 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10284         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10285        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10286         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10287 .cindex "expansion" "lookup in"
10288 .cindex "file" "lookups"
10289 .cindex "lookup" "in expanded string"
10290 The two forms of lookup item specify data lookups in files and databases, as
10291 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10292 lookups, and the second is used for query-style lookups. The <&'key'&>,
10293 <&'file'&>, and <&'query'&> strings are expanded before use.
10294
10295 If there is any white space in a lookup item which is part of a filter command,
10296 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10297 other place where white space is significant, the lookup item must be enclosed
10298 in double quotes. The use of data lookups in users' filter files may be locked
10299 out by the system administrator.
10300
10301 .vindex "&$value$&"
10302 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10303 During its expansion, the variable &$value$& contains the data returned by the
10304 lookup. Afterwards it reverts to the value it had previously (at the outer
10305 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10306 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10307 string on failure. If <&'string2'&> is provided, it can itself be a nested
10308 lookup, thus providing a mechanism for looking up a default value when the
10309 original lookup fails.
10310
10311 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10312 data for the outer lookup while the parameters of the second lookup are
10313 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10314 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10315 appear, and in this case, if the lookup fails, the entire expansion is forced
10316 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10317 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10318 successful lookup, and nothing in the case of failure.
10319
10320 For single-key lookups, the string &"partial"& is permitted to precede the
10321 search type in order to do partial matching, and * or *@ may follow a search
10322 type to request default lookups if the key does not match (see sections
10323 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10324
10325 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10326 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10327 and non-wild parts of the key during the expansion of the replacement text.
10328 They return to their previous values at the end of the lookup item.
10329
10330 This example looks up the postmaster alias in the conventional alias file:
10331 .code
10332 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10333 .endd
10334 This example uses NIS+ to look up the full name of the user corresponding to
10335 the local part of an address, forcing the expansion to fail if it is not found:
10336 .code
10337 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10338   {$value}fail}
10339 .endd
10340
10341
10342 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10343 .cindex "expansion" "list creation"
10344 .vindex "&$item$&"
10345 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10346 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10347 For each item
10348 in this list, its value is place in &$item$&, and then <&'string2'&> is
10349 expanded and added to the output as an item in a new list. The separator used
10350 for the output list is the same as the one used for the input, but a separator
10351 setting is not included in the output. For example:
10352 .code
10353 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10354 .endd
10355 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10356 value of &$item$& is restored to what it was before. See also the &%filter%&
10357 and &%reduce%& expansion items.
10358
10359 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10360 .cindex "expansion" "numeric hash"
10361 .cindex "hash function" "numeric"
10362 The three strings are expanded; the first two must yield numbers. Call them
10363 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10364 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10365 can use the simpler operator notation that avoids some of the braces:
10366 .code
10367 ${nhash_<n>_<m>:<string>}
10368 .endd
10369 The second number is optional (in both notations). If there is only one number,
10370 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10371 processed by a div/mod hash function that returns two numbers, separated by a
10372 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10373 example,
10374 .code
10375 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10376 .endd
10377 returns the string &"6/33"&.
10378
10379
10380
10381 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10382 .cindex "Perl" "use in expanded string"
10383 .cindex "expansion" "calling Perl from"
10384 This item is available only if Exim has been built to include an embedded Perl
10385 interpreter. The subroutine name and the arguments are first separately
10386 expanded, and then the Perl subroutine is called with those arguments. No
10387 additional arguments need be given; the maximum number permitted, including the
10388 name of the subroutine, is nine.
10389
10390 The return value of the subroutine is inserted into the expanded string, unless
10391 the return value is &%undef%&. In that case, the entire expansion is
10392 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10393 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10394 in a scalar context, thus the return value is a scalar.  For example, if you
10395 return a Perl vector, the return value is the size of the vector,
10396 not its contents.
10397
10398 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10399 with the error message that was passed to &%die%&. More details of the embedded
10400 Perl facility are given in chapter &<<CHAPperl>>&.
10401
10402 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10403 out the use of this expansion item in filter files.
10404
10405
10406 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10407 .cindex "&%prvs%& expansion item"
10408 The first argument is a complete email address and the second is secret
10409 keystring. The third argument, specifying a key number, is optional. If absent,
10410 it defaults to 0. The result of the expansion is a prvs-signed email address,
10411 to be typically used with the &%return_path%& option on an &(smtp)& transport
10412 as part of a bounce address tag validation (BATV) scheme. For more discussion
10413 and an example, see section &<<SECTverifyPRVS>>&.
10414
10415 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10416         {*&<&'string'&>&*}}*&"
10417 .cindex "&%prvscheck%& expansion item"
10418 This expansion item is the complement of the &%prvs%& item. It is used for
10419 checking prvs-signed addresses. If the expansion of the first argument does not
10420 yield a syntactically valid prvs-signed address, the whole item expands to the
10421 empty string. When the first argument does expand to a syntactically valid
10422 prvs-signed address, the second argument is expanded, with the prvs-decoded
10423 version of the address and the key number extracted from the address in the
10424 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10425
10426 These two variables can be used in the expansion of the second argument to
10427 retrieve the secret. The validity of the prvs-signed address is then checked
10428 against the secret. The result is stored in the variable &$prvscheck_result$&,
10429 which is empty for failure or &"1"& for success.
10430
10431 The third argument is optional; if it is missing, it defaults to an empty
10432 string. This argument is now expanded. If the result is an empty string, the
10433 result of the expansion is the decoded version of the address. This is the case
10434 whether or not the signature was valid. Otherwise, the result of the expansion
10435 is the expansion of the third argument.
10436
10437 All three variables can be used in the expansion of the third argument.
10438 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10439 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10440
10441 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10442 .cindex "expansion" "inserting an entire file"
10443 .cindex "file" "inserting into expansion"
10444 .cindex "&%readfile%& expansion item"
10445 The filename and end-of-line (eol) string are first expanded separately. The file is
10446 then read, and its contents replace the entire item. All newline characters in
10447 the file are replaced by the end-of-line string if it is present. Otherwise,
10448 newlines are left in the string.
10449 String expansion is not applied to the contents of the file. If you want this,
10450 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10451 the string expansion fails.
10452
10453 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10454 locks out the use of this expansion item in filter files.
10455
10456
10457
10458 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10459         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10460 .cindex "expansion" "inserting from a socket"
10461 .cindex "socket, use of in expansion"
10462 .cindex "&%readsocket%& expansion item"
10463 This item inserts data from a Unix domain or TCP socket into the expanded
10464 string. The minimal way of using it uses just two arguments, as in these
10465 examples:
10466 .code
10467 ${readsocket{/socket/name}{request string}}
10468 ${readsocket{inet:some.host:1234}{request string}}
10469 .endd
10470 For a Unix domain socket, the first substring must be the path to the socket.
10471 For an Internet socket, the first substring must contain &`inet:`& followed by
10472 a host name or IP address, followed by a colon and a port, which can be a
10473 number or the name of a TCP port in &_/etc/services_&. An IP address may
10474 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10475 example:
10476 .code
10477 ${readsocket{inet:[::1]:1234}{request string}}
10478 .endd
10479 Only a single host name may be given, but if looking it up yields more than
10480 one IP address, they are each tried in turn until a connection is made. For
10481 both kinds of socket, Exim makes a connection, writes the request string
10482 (unless it is an empty string; no terminating NUL is ever sent)
10483 and reads from the socket until an end-of-file
10484 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10485 extend what can be done. Firstly, you can vary the timeout. For example:
10486 .code
10487 ${readsocket{/socket/name}{request string}{3s}}
10488 .endd
10489
10490 The third argument is a list of options, of which the first element is the timeout
10491 and must be present if any options are given.
10492 Further elements are options of form &'name=value'&.
10493 Example:
10494 .code
10495 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10496 .endd
10497
10498 The following option names are recognised:
10499 .ilist
10500 &*cache*&
10501 Defines if the result data can be cached for use by a later identical
10502 request in the same process.
10503 Values are &"yes"& or &"no"& (the default).
10504 If not, all cached results for this connection specification
10505 will be invalidated.
10506
10507 .next
10508 &*shutdown*&
10509 Defines whether or not a write-shutdown is done on the connection after
10510 sending the request. Values are &"yes"& (the default) or &"no"&
10511 (preferred, eg. by some webservers).
10512
10513 .next
10514 &*sni*&
10515 Controls the use of Server Name Identification on the connection.
10516 Any nonempty value will be the SNI sent; TLS will be forced.
10517
10518 .next
10519 &*tls*&
10520 Controls the use of TLS on the connection.
10521 Values are &"yes"& or &"no"& (the default).
10522 If it is enabled, a shutdown as described above is never done.
10523 .endlist
10524
10525
10526 A fourth argument allows you to change any newlines that are in the data
10527 that is read, in the same way as for &%readfile%& (see above). This example
10528 turns them into spaces:
10529 .code
10530 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10531 .endd
10532 As with all expansions, the substrings are expanded before the processing
10533 happens. Errors in these sub-expansions cause the expansion to fail. In
10534 addition, the following errors can occur:
10535
10536 .ilist
10537 Failure to create a socket file descriptor;
10538 .next
10539 Failure to connect the socket;
10540 .next
10541 Failure to write the request string;
10542 .next
10543 Timeout on reading from the socket.
10544 .endlist
10545
10546 By default, any of these errors causes the expansion to fail. However, if
10547 you supply a fifth substring, it is expanded and used when any of the above
10548 errors occurs. For example:
10549 .code
10550 ${readsocket{/socket/name}{request string}{3s}{\n}\
10551   {socket failure}}
10552 .endd
10553 You can test for the existence of a Unix domain socket by wrapping this
10554 expansion in &`${if exists`&, but there is a race condition between that test
10555 and the actual opening of the socket, so it is safer to use the fifth argument
10556 if you want to be absolutely sure of avoiding an expansion error for a
10557 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10558
10559 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10560 locks out the use of this expansion item in filter files.
10561
10562
10563 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10564 .cindex "expansion" "reducing a list to a scalar"
10565 .cindex "list" "reducing to a scalar"
10566 .vindex "&$value$&"
10567 .vindex "&$item$&"
10568 This operation reduces a list to a single, scalar string. After expansion,
10569 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10570 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10571 Then <&'string2'&> is expanded and
10572 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10573 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10574 them. The result of that expansion is assigned to &$value$& before the next
10575 iteration. When the end of the list is reached, the final value of &$value$& is
10576 added to the expansion output. The &%reduce%& expansion item can be used in a
10577 number of ways. For example, to add up a list of numbers:
10578 .code
10579 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10580 .endd
10581 The result of that expansion would be &`6`&. The maximum of a list of numbers
10582 can be found:
10583 .code
10584 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10585 .endd
10586 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10587 restored to what they were before. See also the &%filter%& and &%map%&
10588 expansion items.
10589
10590 . A bit of a special-case logic error in writing an expansion;
10591 . probably not worth including in the mainline of documentation.
10592 . If only we had footnotes (the html output variant is the problem).
10593 .
10594 . .new
10595 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10596 . and that condition modifies &$value$&,
10597 . then the string expansions dependent on the condition cannot use
10598 . the &$value$& of the reduce iteration.
10599 . .wen
10600
10601 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10602 This item inserts &"raw"& header lines. It is described with the &%header%&
10603 expansion item in section &<<SECTexpansionitems>>& above.
10604
10605 .vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10606         {*&<&'string2'&>&*}}*&"
10607 .cindex "expansion" "running a command"
10608 .cindex "&%run%& expansion item"
10609 This item runs an external command, as a subprocess.
10610 One option is supported after the word &'run'&, comma-separated
10611 and without whitespace.
10612
10613 If the option &'preexpand'& is not used,
10614 the command string is split into individual arguments by spaces
10615 and then each argument is expanded.
10616 Then the command is run
10617 in a separate process, but under the same uid and gid.  As in other command
10618 executions from Exim, a shell is not used by default. If the command requires
10619 a shell, you must explicitly code it.
10620 The command name may not be tainted, but the remaining arguments can be.
10621
10622 &*Note*&: if tainted arguments are used, they are supplied by a
10623 potential attacker;
10624 a careful assessment for security vulnerabilities should be done.
10625
10626 If the option &'preexpand'& is used,
10627 the command and its arguments are first expanded as one string. The result is
10628 split apart into individual arguments by spaces, and then the command is run
10629 as above.
10630 Since the arguments are split by spaces, when there is a variable expansion
10631 which has an empty result, it will cause the situation that the argument will
10632 simply be omitted when the program is actually executed by Exim. If the
10633 script/program requires a specific number of arguments and the expanded
10634 variable could possibly result in this empty expansion, the variable must be
10635 quoted. This is more difficult if the expanded variable itself could result
10636 in a string containing quotes, because it would interfere with the quotes
10637 around the command arguments. A possible guard against this is to wrap the
10638 variable in the &%sg%& operator to change any quote marks to some other
10639 character.
10640 Neither the command nor any argument may be tainted.
10641
10642 The standard input for the command exists, but is empty. The standard output
10643 and standard error are set to the same file descriptor.
10644 .cindex "return code" "from &%run%& expansion"
10645 .vindex "&$value$&"
10646 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10647 and replaces the entire item; during this expansion, the standard output/error
10648 from the command is in the variable &$value$&. If the command fails,
10649 <&'string2'&>, if present, is expanded and used. Once again, during the
10650 expansion, the standard output/error from the command is in the variable
10651 &$value$&.
10652
10653 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10654 can be the word &"fail"& (not in braces) to force expansion failure if the
10655 command does not succeed. If both strings are omitted, the result is contents
10656 of the standard output/error on success, and nothing on failure.
10657
10658 .vindex "&$run_in_acl$&"
10659 The standard output/error of the command is put in the variable &$value$&.
10660 In this ACL example, the output of a command is logged for the admin to
10661 troubleshoot:
10662 .code
10663 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10664       log_message  = Output of id: $value
10665 .endd
10666 If the command requires shell idioms, such as the > redirect operator, the
10667 shell must be invoked directly, such as with:
10668 .code
10669 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10670 .endd
10671
10672 .vindex "&$runrc$&"
10673 The return code from the command is put in the variable &$runrc$&, and this
10674 remains set afterwards, so in a filter file you can do things like this:
10675 .code
10676 if "${run{x y z}{}}$runrc" is 1 then ...
10677   elif $runrc is 2 then ...
10678   ...
10679 endif
10680 .endd
10681 If execution of the command fails (for example, the command does not exist),
10682 the return code is 127 &-- the same code that shells use for non-existent
10683 commands.
10684
10685 &*Warning*&: In a router or transport, you cannot assume the order in which
10686 option values are expanded, except for those preconditions whose order of
10687 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10688 by the expansion of one option, and use it in another.
10689
10690 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10691 out the use of this expansion item in filter files.
10692
10693
10694 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10695 .cindex "expansion" "string substitution"
10696 .cindex "&%sg%& expansion item"
10697 This item works like Perl's substitution operator (s) with the global (/g)
10698 option; hence its name. However, unlike the Perl equivalent, Exim does not
10699 modify the subject string; instead it returns the modified string for insertion
10700 into the overall expansion. The item takes three arguments: the subject string,
10701 a regular expression, and a substitution string. For example:
10702 .code
10703 ${sg{abcdefabcdef}{abc}{xyz}}
10704 .endd
10705 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10706 if any $, } or \ characters are required in the regular expression or in the
10707 substitution string, they have to be escaped. For example:
10708 .code
10709 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10710 .endd
10711 yields &"defabc"&, and
10712 .code
10713 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10714 .endd
10715 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10716 the regular expression from string expansion.
10717
10718 The regular expression is compiled in 8-bit mode, working against bytes
10719 rather than any Unicode-aware character handling.
10720
10721
10722 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10723 .cindex sorting "a list"
10724 .cindex list sorting
10725 .cindex expansion "list sorting"
10726 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10727 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10728 The <&'comparator'&> argument is interpreted as the operator
10729 of a two-argument expansion condition.
10730 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10731 The comparison should return true when applied to two values
10732 if the first value should sort before the second value.
10733 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10734 the element being placed in &$item$&,
10735 to give values for comparison.
10736
10737 The item result is a sorted list,
10738 with the original list separator,
10739 of the list elements (in full) of the original.
10740
10741 Examples:
10742 .code
10743 ${sort{3:2:1:4}{<}{$item}}
10744 .endd
10745 sorts a list of numbers, and
10746 .code
10747 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10748 .endd
10749 will sort an MX lookup into priority order.
10750
10751
10752
10753 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10754 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10755
10756
10757
10758 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10759 .cindex "&%substr%& expansion item"
10760 .cindex "substring extraction"
10761 .cindex "expansion" "substring extraction"
10762 The three strings are expanded; the first two must yield numbers. Call them
10763 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10764 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10765 can use the simpler operator notation that avoids some of the braces:
10766 .code
10767 ${substr_<n>_<m>:<subject>}
10768 .endd
10769 The second number is optional (in both notations).
10770 If it is absent in the simpler format, the preceding underscore must also be
10771 omitted.
10772
10773 The &%substr%& item can be used to extract more general substrings than
10774 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10775 length required. For example
10776 .code
10777 ${substr{3}{2}{$local_part}}
10778 .endd
10779 If the starting offset is greater than the string length the result is the
10780 null string; if the length plus starting offset is greater than the string
10781 length, the result is the right-hand part of the string, starting from the
10782 given offset. The first byte (character) in the string has offset zero.
10783
10784 The &%substr%& expansion item can take negative offset values to count
10785 from the right-hand end of its operand. The last byte (character) is offset -1,
10786 the second-last is offset -2, and so on. Thus, for example,
10787 .code
10788 ${substr{-5}{2}{1234567}}
10789 .endd
10790 yields &"34"&. If the absolute value of a negative offset is greater than the
10791 length of the string, the substring starts at the beginning of the string, and
10792 the length is reduced by the amount of overshoot. Thus, for example,
10793 .code
10794 ${substr{-5}{2}{12}}
10795 .endd
10796 yields an empty string, but
10797 .code
10798 ${substr{-3}{2}{12}}
10799 .endd
10800 yields &"1"&.
10801
10802 When the second number is omitted from &%substr%&, the remainder of the string
10803 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10804 string preceding the offset point are taken. For example, an offset of -1 and
10805 no length, as in these semantically identical examples:
10806 .code
10807 ${substr_-1:abcde}
10808 ${substr{-1}{abcde}}
10809 .endd
10810 yields all but the last character of the string, that is, &"abcd"&.
10811
10812 All measurement is done in bytes and is not UTF-8 aware.
10813
10814
10815
10816 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10817         {*&<&'replacements'&>&*}}*&"
10818 .cindex "expansion" "character translation"
10819 .cindex "&%tr%& expansion item"
10820 This item does single-character (in bytes) translation on its subject string. The second
10821 argument is a list of characters to be translated in the subject string. Each
10822 matching character is replaced by the corresponding character from the
10823 replacement list. For example
10824 .code
10825 ${tr{abcdea}{ac}{13}}
10826 .endd
10827 yields &`1b3de1`&. If there are duplicates in the second character string, the
10828 last occurrence is used. If the third string is shorter than the second, its
10829 last character is replicated. However, if it is empty, no translation takes
10830 place.
10831
10832 All character handling is done in bytes and is not UTF-8 aware.
10833
10834 .endlist
10835
10836
10837
10838 .section "Expansion operators" "SECTexpop"
10839 .cindex "expansion" "operators"
10840 For expansion items that perform transformations on a single argument string,
10841 the &"operator"& notation is used because it is simpler and uses fewer braces.
10842 The substring is first expanded before the operation is applied to it. The
10843 following operations can be performed:
10844
10845 .vlist
10846 .vitem &*${address:*&<&'string'&>&*}*&
10847 .cindex "expansion" "RFC 2822 address handling"
10848 .cindex "&%address%& expansion item"
10849 The string is interpreted as an RFC 2822 address, as it might appear in a
10850 header line, and the effective address is extracted from it. If the string does
10851 not parse successfully, the result is empty.
10852
10853 The parsing correctly handles SMTPUTF8 Unicode in the string.
10854
10855
10856 .vitem &*${addresses:*&<&'string'&>&*}*&
10857 .cindex "expansion" "RFC 2822 address handling"
10858 .cindex "&%addresses%& expansion item"
10859 The string (after expansion) is interpreted as a list of addresses in RFC
10860 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10861 operative address (&'local-part@domain'&) is extracted from each item, and the
10862 result of the expansion is a colon-separated list, with appropriate
10863 doubling of colons should any happen to be present in the email addresses.
10864 Syntactically invalid RFC2822 address items are omitted from the output.
10865
10866 It is possible to specify a character other than colon for the output
10867 separator by starting the string with > followed by the new separator
10868 character. For example:
10869 .code
10870 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10871 .endd
10872 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10873 first, so if the expanded string starts with >, it may change the output
10874 separator unintentionally. This can be avoided by setting the output
10875 separator explicitly:
10876 .code
10877 ${addresses:>:$h_from:}
10878 .endd
10879
10880 Compare the &%address%& (singular)
10881 expansion item, which extracts the working address from a single RFC2822
10882 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10883 processing lists.
10884
10885 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10886 a strict interpretation of header line formatting.  Exim parses the bare,
10887 unquoted portion of an email address and if it finds a comma, treats it as an
10888 email address separator. For the example header line:
10889 .code
10890 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10891 .endd
10892 The first example below demonstrates that Q-encoded email addresses are parsed
10893 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10894 It does not see the comma because it's still encoded as "=2C".  The second
10895 example below is passed the contents of &`$header_from:`&, meaning it gets
10896 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10897 The third example shows that the presence of a comma is skipped when it is
10898 quoted.  The fourth example shows SMTPUTF8 handling.
10899 .code
10900 # exim -be '${addresses:From: \
10901 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10902 user@example.com
10903 # exim -be '${addresses:From: Last, First <user@example.com>}'
10904 Last:user@example.com
10905 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10906 user@example.com
10907 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10908 フィリップ@example.jp
10909 .endd
10910
10911 .vitem &*${base32:*&<&'digits'&>&*}*&
10912 .cindex "&%base32%& expansion item"
10913 .cindex "expansion" "conversion to base 32"
10914 The string must consist entirely of decimal digits. The number is converted to
10915 base 32 and output as a (empty, for zero) string of characters.
10916 Only lowercase letters are used.
10917
10918 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10919 .cindex "&%base32d%& expansion item"
10920 .cindex "expansion" "conversion to base 32"
10921 The string must consist entirely of base-32 digits.
10922 The number is converted to decimal and output as a string.
10923
10924 .vitem &*${base62:*&<&'digits'&>&*}*&
10925 .cindex "&%base62%& expansion item"
10926 .cindex "expansion" "conversion to base 62"
10927 The string must consist entirely of decimal digits. The number is converted to
10928 base 62 and output as a string of six characters, including leading zeros. In
10929 the few operating environments where Exim uses base 36 instead of base 62 for
10930 its message identifiers (because those systems do not have case-sensitive
10931 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10932 to be absolutely clear: this is &'not'& base64 encoding.
10933
10934 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10935 .cindex "&%base62d%& expansion item"
10936 .cindex "expansion" "conversion to base 62"
10937 The string must consist entirely of base-62 digits, or, in operating
10938 environments where Exim uses base 36 instead of base 62 for its message
10939 identifiers, base-36 digits. The number is converted to decimal and output as a
10940 string.
10941
10942 .vitem &*${base64:*&<&'string'&>&*}*&
10943 .cindex "expansion" "base64 encoding"
10944 .cindex "base64 encoding" "in string expansion"
10945 .cindex "&%base64%& expansion item"
10946 .cindex certificate "base64 of DER"
10947 This operator converts a string into one that is base64 encoded.
10948
10949 If the string is a single variable of type certificate,
10950 returns the base64 encoding of the DER form of the certificate.
10951
10952
10953 .vitem &*${base64d:*&<&'string'&>&*}*&
10954 .cindex "expansion" "base64 decoding"
10955 .cindex "base64 decoding" "in string expansion"
10956 .cindex "&%base64d%& expansion item"
10957 This operator converts a base64-encoded string into the un-coded form.
10958
10959
10960 .vitem &*${domain:*&<&'string'&>&*}*&
10961 .cindex "domain" "extraction"
10962 .cindex "expansion" "domain extraction"
10963 The string is interpreted as an RFC 2822 address and the domain is extracted
10964 from it. If the string does not parse successfully, the result is empty.
10965
10966
10967 .vitem &*${escape:*&<&'string'&>&*}*&
10968 .cindex "expansion" "escaping non-printing characters"
10969 .cindex "&%escape%& expansion item"
10970 If the string contains any non-printing characters, they are converted to
10971 escape sequences starting with a backslash. Whether characters with the most
10972 significant bit set (so-called &"8-bit characters"&) count as printing or not
10973 is controlled by the &%print_topbitchars%& option.
10974
10975 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10976 .cindex "expansion" "escaping 8-bit characters"
10977 .cindex "&%escape8bit%& expansion item"
10978 If the string contains any characters with the most significant bit set,
10979 they are converted to escape sequences starting with a backslash.
10980 Backslashes and DEL characters are also converted.
10981
10982
10983 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10984 .cindex "expansion" "expression evaluation"
10985 .cindex "expansion" "arithmetic expression"
10986 .cindex "&%eval%& expansion item"
10987 These items supports simple arithmetic and bitwise logical operations in
10988 expansion strings. The string (after expansion) must be a conventional
10989 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10990 logical operators, and parentheses. All operations are carried out using
10991 integer arithmetic. The operator priorities are as follows (the same as in the
10992 C programming language):
10993 .table2 70pt 300pt
10994 .irow &'highest:'& "not (~), negate (-)"
10995 .irow ""   "multiply (*), divide (/), remainder (%)"
10996 .irow ""   "plus (+), minus (-)"
10997 .irow ""   "shift-left (<<), shift-right (>>)"
10998 .irow ""   "and (&&)"
10999 .irow ""   "xor (^)"
11000 .irow &'lowest:'&  "or (|)"
11001 .endtable
11002 Binary operators with the same priority are evaluated from left to right. White
11003 space is permitted before or after operators.
11004
11005 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11006 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11007 decimal, even if they start with a leading zero; hexadecimal numbers are not
11008 permitted. This can be useful when processing numbers extracted from dates or
11009 times, which often do have leading zeros.
11010
11011 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11012 or 1024*1024*1024,
11013 respectively. Negative numbers are supported. The result of the computation is
11014 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11015
11016 .display
11017 &`${eval:1+1}            `&  yields 2
11018 &`${eval:1+2*3}          `&  yields 7
11019 &`${eval:(1+2)*3}        `&  yields 9
11020 &`${eval:2+42%5}         `&  yields 4
11021 &`${eval:0xc&amp;5}          `&  yields 4
11022 &`${eval:0xc|5}          `&  yields 13
11023 &`${eval:0xc^5}          `&  yields 9
11024 &`${eval:0xc>>1}         `&  yields 6
11025 &`${eval:0xc<<1}         `&  yields 24
11026 &`${eval:~255&amp;0x1234}    `&  yields 4608
11027 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11028 .endd
11029
11030 As a more realistic example, in an ACL you might have
11031 .code
11032 deny   condition =                    \
11033          ${if and {                   \
11034            {>{$rcpt_count}{10}}       \
11035            {                          \
11036            <                          \
11037              {$recipients_count}      \
11038              {${eval:$rcpt_count/2}}  \
11039            }                          \
11040          }{yes}{no}}
11041        message = Too many bad recipients
11042 .endd
11043 The condition is true if there have been more than 10 RCPT commands and
11044 fewer than half of them have resulted in a valid recipient.
11045
11046
11047 .vitem &*${expand:*&<&'string'&>&*}*&
11048 .cindex "expansion" "re-expansion of substring"
11049 The &%expand%& operator causes a string to be expanded for a second time. For
11050 example,
11051 .code
11052 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11053 .endd
11054 first looks up a string in a file while expanding the operand for &%expand%&,
11055 and then re-expands what it has found.
11056
11057
11058 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11059 .cindex "Unicode"
11060 .cindex "UTF-8" "conversion from"
11061 .cindex "expansion" "UTF-8 conversion"
11062 .cindex "&%from_utf8%& expansion item"
11063 The world is slowly moving towards Unicode, although there are no standards for
11064 email yet. However, other applications (including some databases) are starting
11065 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11066 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11067 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11068 the result is an undefined sequence of bytes.
11069
11070 Unicode code points with values less than 256 are compatible with ASCII and
11071 ISO-8859-1 (also known as Latin-1).
11072 For example, character 169 is the copyright symbol in both cases, though the
11073 way it is encoded is different. In UTF-8, more than one byte is needed for
11074 characters with code values greater than 127, whereas ISO-8859-1 is a
11075 single-byte encoding (but thereby limited to 256 characters). This makes
11076 translation from UTF-8 to ISO-8859-1 straightforward.
11077
11078
11079 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11080 .cindex "hash function" "textual"
11081 .cindex "expansion" "textual hash"
11082 The &%hash%& operator is a simpler interface to the hashing function that can
11083 be used when the two parameters are fixed numbers (as opposed to strings that
11084 change when expanded). The effect is the same as
11085 .code
11086 ${hash{<n>}{<m>}{<string>}}
11087 .endd
11088 See the description of the general &%hash%& item above for details. The
11089 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11090
11091
11092
11093 .new
11094 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11095 .cindex header "wrapping operator"
11096 .cindex expansion "header wrapping"
11097 This operator line-wraps its argument in a way useful for headers.
11098 The &'cols'& value gives the column number to wrap after,
11099 the &'limit'& gives a limit number of result characters to truncate at.
11100 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11101 the defaults are 80 and 998.
11102 Wrapping will be inserted at a space if possible before the
11103 column number is reached.
11104 Whitespace at a chosen wrap point is removed.
11105 A line-wrap consists of a newline followed by a tab,
11106 and the tab is counted as 8 columns.
11107 .wen
11108
11109
11110
11111 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11112 .cindex "base64 encoding" "conversion from hex"
11113 .cindex "expansion" "hex to base64"
11114 .cindex "&%hex2b64%& expansion item"
11115 This operator converts a hex string into one that is base64 encoded. This can
11116 be useful for processing the output of the various hashing functions.
11117
11118
11119
11120 .vitem &*${hexquote:*&<&'string'&>&*}*&
11121 .cindex "quoting" "hex-encoded unprintable characters"
11122 .cindex "&%hexquote%& expansion item"
11123 This operator converts non-printable characters in a string into a hex
11124 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11125 as is, and other byte values are converted to &`\xNN`&, for example, a
11126 byte value 127 is converted to &`\x7f`&.
11127
11128
11129 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11130 .cindex "&%ipv6denorm%& expansion item"
11131 .cindex "IP address" normalisation
11132 This expands an IPv6 address to a full eight-element colon-separated set
11133 of hex digits including leading zeroes.
11134 A trailing ipv4-style dotted-decimal set is converted to hex.
11135 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11136
11137 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11138 .cindex "&%ipv6norm%& expansion item"
11139 .cindex "IP address" normalisation
11140 .cindex "IP address" "canonical form"
11141 This converts an IPv6 address to canonical form.
11142 Leading zeroes of groups are omitted, and the longest
11143 set of zero-valued groups is replaced with a double colon.
11144 A trailing ipv4-style dotted-decimal set is converted to hex.
11145 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11146
11147
11148 .vitem &*${lc:*&<&'string'&>&*}*&
11149 .cindex "case forcing in strings"
11150 .cindex "string" "case forcing"
11151 .cindex "lower casing"
11152 .cindex "expansion" "case forcing"
11153 .cindex "&%lc%& expansion item"
11154 This forces the letters in the string into lower-case, for example:
11155 .code
11156 ${lc:$local_part}
11157 .endd
11158 Case is defined per the system C locale.
11159
11160 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11161 .cindex "expansion" "string truncation"
11162 .cindex "&%length%& expansion item"
11163 The &%length%& operator is a simpler interface to the &%length%& function that
11164 can be used when the parameter is a fixed number (as opposed to a string that
11165 changes when expanded). The effect is the same as
11166 .code
11167 ${length{<number>}{<string>}}
11168 .endd
11169 See the description of the general &%length%& item above for details. Note that
11170 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11171 when &%length%& is used as an operator.
11172 All measurement is done in bytes and is not UTF-8 aware.
11173
11174
11175 .vitem &*${listcount:*&<&'string'&>&*}*&
11176 .cindex "expansion" "list item count"
11177 .cindex "list" "item count"
11178 .cindex "list" "count of items"
11179 .cindex "&%listcount%& expansion item"
11180 The string is interpreted as a list and the number of items is returned.
11181
11182
11183 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11184 .cindex "expansion" "named list"
11185 .cindex "&%listnamed%& expansion item"
11186 The name is interpreted as a named list and the content of the list is returned,
11187 expanding any referenced lists, re-quoting as needed for colon-separation.
11188 If the optional type is given it must be one of "a", "d", "h" or "l"
11189 and selects address-, domain-, host- or localpart- lists to search among respectively.
11190 Otherwise all types are searched in an undefined order and the first
11191 matching list is returned.
11192 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11193 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11194
11195
11196 .vitem &*${local_part:*&<&'string'&>&*}*&
11197 .cindex "expansion" "local part extraction"
11198 .cindex "&%local_part%& expansion item"
11199 The string is interpreted as an RFC 2822 address and the local part is
11200 extracted from it. If the string does not parse successfully, the result is
11201 empty.
11202 The parsing correctly handles SMTPUTF8 Unicode in the string.
11203
11204
11205 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11206        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11207 .cindex "masked IP address"
11208 .cindex "IP address" "masking"
11209 .cindex "CIDR notation"
11210 .cindex "expansion" "IP address masking"
11211 .cindex "&%mask%& expansion item"
11212 If the form of the string to be operated on is not an IP address followed by a
11213 slash and an integer (that is, a network address in CIDR notation), the
11214 expansion fails. Otherwise, this operator converts the IP address to binary,
11215 masks off the least significant bits according to the bit count, and converts
11216 the result back to text, with mask appended. For example,
11217 .code
11218 ${mask:10.111.131.206/28}
11219 .endd
11220 returns the string &"10.111.131.192/28"&.
11221
11222 Since this operation is expected to
11223 be mostly used for looking up masked addresses in files, the
11224 normal
11225 result for an IPv6
11226 address uses dots to separate components instead of colons, because colon
11227 terminates a key string in lsearch files. So, for example,
11228 .code
11229 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11230 .endd
11231 returns the string
11232 .code
11233 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11234 .endd
11235 If the optional form &*mask_n*& is used, IPv6 address result are instead
11236 returned in normailsed form, using colons and with zero-compression.
11237 Letters in IPv6 addresses are always output in lower case.
11238
11239
11240 .vitem &*${md5:*&<&'string'&>&*}*&
11241 .cindex "MD5 hash"
11242 .cindex "expansion" "MD5 hash"
11243 .cindex certificate fingerprint
11244 .cindex "&%md5%& expansion item"
11245 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11246 as a 32-digit hexadecimal number, in which any letters are in lower case.
11247
11248 If the string is a single variable of type certificate,
11249 returns the MD5 hash fingerprint of the certificate.
11250
11251
11252 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11253 .cindex "expansion" "numeric hash"
11254 .cindex "hash function" "numeric"
11255 The &%nhash%& operator is a simpler interface to the numeric hashing function
11256 that can be used when the two parameters are fixed numbers (as opposed to
11257 strings that change when expanded). The effect is the same as
11258 .code
11259 ${nhash{<n>}{<m>}{<string>}}
11260 .endd
11261 See the description of the general &%nhash%& item above for details.
11262
11263
11264 .vitem &*${quote:*&<&'string'&>&*}*&
11265 .cindex "quoting" "in string expansions"
11266 .cindex "expansion" "quoting"
11267 .cindex "&%quote%& expansion item"
11268 The &%quote%& operator puts its argument into double quotes if it
11269 is an empty string or
11270 contains anything other than letters, digits, underscores, dots, and hyphens.
11271 Any occurrences of double quotes and backslashes are escaped with a backslash.
11272 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11273 respectively For example,
11274 .code
11275 ${quote:ab"*"cd}
11276 .endd
11277 becomes
11278 .code
11279 "ab\"*\"cd"
11280 .endd
11281 The place where this is useful is when the argument is a substitution from a
11282 variable or a message header.
11283
11284 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11285 .cindex "&%quote_local_part%& expansion item"
11286 This operator is like &%quote%&, except that it quotes the string only if
11287 required to do so by the rules of RFC 2822 for quoting local parts. For
11288 example, a plus sign would not cause quoting (but it would for &%quote%&).
11289 If you are creating a new email address from the contents of &$local_part$&
11290 (or any other unknown data), you should always use this operator.
11291
11292 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11293 will likely use the quoting form.
11294 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11295
11296
11297 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11298 .cindex "quoting" "lookup-specific"
11299 This operator applies lookup-specific quoting rules to the string. Each
11300 query-style lookup type has its own quoting rules which are described with
11301 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11302 .code
11303 ${quote_ldap:two * two}
11304 .endd
11305 returns
11306 .code
11307 two%20%5C2A%20two
11308 .endd
11309 For single-key lookup types, no quoting is ever necessary and this operator
11310 yields an unchanged string.
11311
11312
11313 .vitem &*${randint:*&<&'n'&>&*}*&
11314 .cindex "random number"
11315 This operator returns a somewhat random number which is less than the
11316 supplied number and is at least 0.  The quality of this randomness depends
11317 on how Exim was built; the values are not suitable for keying material.
11318 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11319 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11320 for versions of GnuTLS with that function.
11321 Otherwise, the implementation may be arc4random(), random() seeded by
11322 srandomdev() or srandom(), or a custom implementation even weaker than
11323 random().
11324
11325
11326 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11327 .cindex "expansion" "IP address"
11328 This operator reverses an IP address; for IPv4 addresses, the result is in
11329 dotted-quad decimal form, while for IPv6 addresses the result is in
11330 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11331 for DNS.  For example,
11332 .code
11333 ${reverse_ip:192.0.2.4}
11334 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11335 .endd
11336 returns
11337 .code
11338 4.2.0.192
11339 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
11340 .endd
11341
11342
11343 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11344 .cindex "expansion" "RFC 2047"
11345 .cindex "RFC 2047" "expansion operator"
11346 .cindex "&%rfc2047%& expansion item"
11347 This operator encodes text according to the rules of RFC 2047. This is an
11348 encoding that is used in header lines to encode non-ASCII characters. It is
11349 assumed that the input string is in the encoding specified by the
11350 &%headers_charset%& option, which gets its default at build time. If the string
11351 contains only characters in the range 33&--126, and no instances of the
11352 characters
11353 .code
11354 ? = ( ) < > @ , ; : \ " . [ ] _
11355 .endd
11356 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11357 string, using as many &"encoded words"& as necessary to encode all the
11358 characters.
11359
11360
11361 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11362 .cindex "expansion" "RFC 2047"
11363 .cindex "RFC 2047" "decoding"
11364 .cindex "&%rfc2047d%& expansion item"
11365 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11366 bytes are replaced by question marks. Characters are converted into the
11367 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11368 not recognized unless &%check_rfc2047_length%& is set false.
11369
11370 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11371 access a header line, RFC 2047 decoding is done automatically. You do not need
11372 to use this operator as well.
11373
11374
11375
11376 .vitem &*${rxquote:*&<&'string'&>&*}*&
11377 .cindex "quoting" "in regular expressions"
11378 .cindex "regular expressions" "quoting"
11379 .cindex "&%rxquote%& expansion item"
11380 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11381 characters in its argument. This is useful when substituting the values of
11382 variables or headers inside regular expressions.
11383
11384
11385 .vitem &*${sha1:*&<&'string'&>&*}*&
11386 .cindex "SHA-1 hash"
11387 .cindex "expansion" "SHA-1 hashing"
11388 .cindex certificate fingerprint
11389 .cindex "&%sha1%& expansion item"
11390 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11391 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11392
11393 If the string is a single variable of type certificate,
11394 returns the SHA-1 hash fingerprint of the certificate.
11395
11396
11397 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11398        &*${sha2:*&<&'string'&>&*}*& &&&
11399        &*${sha2_<n>:*&<&'string'&>&*}*&
11400 .cindex "SHA-256 hash"
11401 .cindex "SHA-2 hash"
11402 .cindex certificate fingerprint
11403 .cindex "expansion" "SHA-256 hashing"
11404 .cindex "&%sha256%& expansion item"
11405 .cindex "&%sha2%& expansion item"
11406 The &%sha256%& operator computes the SHA-256 hash value of the string
11407 and returns
11408 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11409
11410 If the string is a single variable of type certificate,
11411 returns the SHA-256 hash fingerprint of the certificate.
11412
11413 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11414 (except for certificates, which are not supported).
11415 Finally, if an underbar
11416 and a number is appended it specifies the output length, selecting a
11417 member of the SHA-2 family of hash functions.
11418 Values of 256, 384 and 512 are accepted, with 256 being the default.
11419
11420
11421 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11422        &*${sha3_<n>:*&<&'string'&>&*}*&
11423 .cindex "SHA3 hash"
11424 .cindex "expansion" "SHA3 hashing"
11425 .cindex "&%sha3%& expansion item"
11426 The &%sha3%& operator computes the SHA3-256 hash value of the string
11427 and returns
11428 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11429
11430 If a number is appended, separated by an underbar, it specifies
11431 the output length.  Values of 224, 256, 384 and 512 are accepted;
11432 with 256 being the default.
11433
11434 The &%sha3%& expansion item is only supported if Exim has been
11435 compiled with GnuTLS 3.5.0 or later,
11436 or OpenSSL 1.1.1 or later.
11437 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11438
11439
11440 .vitem &*${stat:*&<&'string'&>&*}*&
11441 .cindex "expansion" "statting a file"
11442 .cindex "file" "extracting characteristics"
11443 .cindex "&%stat%& expansion item"
11444 The string, after expansion, must be a file path. A call to the &[stat()]&
11445 function is made for this path. If &[stat()]& fails, an error occurs and the
11446 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11447 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11448 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11449 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11450 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11451 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11452 can extract individual fields using the &%extract%& expansion item.
11453
11454 The use of the &%stat%& expansion in users' filter files can be locked out by
11455 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11456 systems for files larger than 2GB.
11457
11458 .vitem &*${str2b64:*&<&'string'&>&*}*&
11459 .cindex "&%str2b64%& expansion item"
11460 Now deprecated, a synonym for the &%base64%& expansion operator.
11461
11462
11463
11464 .vitem &*${strlen:*&<&'string'&>&*}*&
11465 .cindex "expansion" "string length"
11466 .cindex "string" "length in expansion"
11467 .cindex "&%strlen%& expansion item"
11468 The item is replaced by the length of the expanded string, expressed as a
11469 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11470 All measurement is done in bytes and is not UTF-8 aware.
11471
11472
11473 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11474 .cindex "&%substr%& expansion item"
11475 .cindex "substring extraction"
11476 .cindex "expansion" "substring expansion"
11477 The &%substr%& operator is a simpler interface to the &%substr%& function that
11478 can be used when the two parameters are fixed numbers (as opposed to strings
11479 that change when expanded). The effect is the same as
11480 .code
11481 ${substr{<start>}{<length>}{<string>}}
11482 .endd
11483 See the description of the general &%substr%& item above for details. The
11484 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11485 All measurement is done in bytes and is not UTF-8 aware.
11486
11487 .vitem &*${time_eval:*&<&'string'&>&*}*&
11488 .cindex "&%time_eval%& expansion item"
11489 .cindex "time interval" "decoding"
11490 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11491 seconds.
11492
11493 .vitem &*${time_interval:*&<&'string'&>&*}*&
11494 .cindex "&%time_interval%& expansion item"
11495 .cindex "time interval" "formatting"
11496 The argument (after sub-expansion) must be a sequence of decimal digits that
11497 represents an interval of time as a number of seconds. It is converted into a
11498 number of larger units and output in Exim's normal time format, for example,
11499 &`1w3d4h2m6s`&.
11500
11501 .vitem &*${uc:*&<&'string'&>&*}*&
11502 .cindex "case forcing in strings"
11503 .cindex "string" "case forcing"
11504 .cindex "upper casing"
11505 .cindex "expansion" "case forcing"
11506 .cindex "&%uc%& expansion item"
11507 This forces the letters in the string into upper-case.
11508 Case is defined per the system C locale.
11509
11510 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11511 .cindex "correction of invalid utf-8 sequences in strings"
11512 .cindex "utf-8" "utf-8 sequences"
11513 .cindex "incorrect utf-8"
11514 .cindex "expansion" "utf-8 forcing"
11515 .cindex "&%utf8clean%& expansion item"
11516 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11517 In versions of Exim before 4.92, this did not correctly do so for a truncated
11518 final codepoint's encoding, and the character would be silently dropped.
11519 If you must handle detection of this scenario across both sets of Exim behavior,
11520 the complexity will depend upon the task.
11521 For instance, to detect if the first character is multibyte and a 1-byte
11522 extraction can be successfully used as a path component (as is common for
11523 dividing up delivery folders), you might use:
11524 .code
11525 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11526 .endd
11527 (which will false-positive if the first character of the local part is a
11528 literal question mark).
11529
11530 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11531        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11532        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11533        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11534 .cindex expansion UTF-8
11535 .cindex UTF-8 expansion
11536 .cindex EAI
11537 .cindex internationalisation
11538 .cindex "&%utf8_domain_to_alabel%& expansion item"
11539 .cindex "&%utf8_domain_from_alabel%& expansion item"
11540 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11541 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11542 These convert EAI mail name components between UTF-8 and a-label forms.
11543 For information on internationalisation support see &<<SECTi18nMTA>>&.
11544 .endlist
11545
11546
11547
11548
11549
11550
11551 .section "Expansion conditions" "SECTexpcond"
11552 .scindex IIDexpcond "expansion" "conditions"
11553 The following conditions are available for testing by the &%${if%& construct
11554 while expanding strings:
11555
11556 .vlist
11557 .vitem &*!*&<&'condition'&>
11558 .cindex "expansion" "negating a condition"
11559 .cindex "negation" "in expansion condition"
11560 Preceding any condition with an exclamation mark negates the result of the
11561 condition.
11562
11563 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11564 .cindex "numeric comparison"
11565 .cindex "expansion" "numeric comparison"
11566 There are a number of symbolic operators for doing numeric comparisons. They
11567 are:
11568 .itable none 0 0 2 10* left 90* left
11569 .irow "=   " "equal"
11570 .irow "==  " "equal"
11571 .irow ">   " "greater"
11572 .irow ">=  " "greater or equal"
11573 .irow "<   " "less"
11574 .irow "<=  " "less or equal"
11575 .endtable
11576 For example:
11577 .code
11578 ${if >{$message_size}{10M} ...
11579 .endd
11580 Note that the general negation operator provides for inequality testing. The
11581 two strings must take the form of optionally signed decimal integers,
11582 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11583 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11584 As a special case, the numerical value of an empty string is taken as
11585 zero.
11586
11587 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11588 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11589 10M, not if 10M is larger than &$message_size$&.
11590
11591
11592 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11593         {*&<&'arg2'&>&*}...}*&
11594 .cindex "expansion" "calling an acl"
11595 .cindex "&%acl%&" "expansion condition"
11596 The name and zero to nine argument strings are first expanded separately.  The expanded
11597 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11598 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11599 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11600 and may use the variables; if another acl expansion is used the values
11601 are restored after it returns.  If the ACL sets
11602 a value using a "message =" modifier the variable $value becomes
11603 the result of the expansion, otherwise it is empty.
11604 If the ACL returns accept the condition is true; if deny, false.
11605 If the ACL returns defer the result is a forced-fail.
11606
11607 .vitem &*bool&~{*&<&'string'&>&*}*&
11608 .cindex "expansion" "boolean parsing"
11609 .cindex "&%bool%& expansion condition"
11610 This condition turns a string holding a true or false representation into
11611 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11612 (case-insensitively); also integer numbers map to true if non-zero,
11613 false if zero.
11614 An empty string is treated as false.
11615 Leading and trailing whitespace is ignored;
11616 thus a string consisting only of whitespace is false.
11617 All other string values will result in expansion failure.
11618
11619 When combined with ACL variables, this expansion condition will let you
11620 make decisions in one place and act on those decisions in another place.
11621 For example:
11622 .code
11623 ${if bool{$acl_m_privileged_sender} ...
11624 .endd
11625
11626
11627 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11628 .cindex "expansion" "boolean parsing"
11629 .cindex "&%bool_lax%& expansion condition"
11630 Like &%bool%&, this condition turns a string into a boolean state.  But
11631 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11632 loose definition that the Router &%condition%& option uses.  The empty string
11633 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11634 true.  Leading and trailing whitespace is ignored.
11635
11636 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11637
11638 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11639 .cindex "expansion" "encrypted comparison"
11640 .cindex "encrypted strings, comparing"
11641 .cindex "&%crypteq%& expansion condition"
11642 This condition is included in the Exim binary if it is built to support any
11643 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11644 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11645 included in the binary.
11646
11647 The &%crypteq%& condition has two arguments. The first is encrypted and
11648 compared against the second, which is already encrypted. The second string may
11649 be in the LDAP form for storing encrypted strings, which starts with the
11650 encryption type in curly brackets, followed by the data. If the second string
11651 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11652 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11653 Typically this will be a field from a password file. An example of an encrypted
11654 string in LDAP form is:
11655 .code
11656 {md5}CY9rzUYh03PK3k6DJie09g==
11657 .endd
11658 If such a string appears directly in an expansion, the curly brackets have to
11659 be quoted, because they are part of the expansion syntax. For example:
11660 .code
11661 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11662 .endd
11663 The following encryption types (whose names are matched case-independently) are
11664 supported:
11665
11666 .ilist
11667 .cindex "MD5 hash"
11668 .cindex "base64 encoding" "in encrypted password"
11669 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11670 printable characters to compare with the remainder of the second string. If the
11671 length of the comparison string is 24, Exim assumes that it is base64 encoded
11672 (as in the above example). If the length is 32, Exim assumes that it is a
11673 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11674 comparison fails.
11675
11676 .next
11677 .cindex "SHA-1 hash"
11678 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11679 printable characters to compare with the remainder of the second string. If the
11680 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11681 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11682 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11683
11684 .next
11685 .cindex "&[crypt()]&"
11686 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11687 only the first eight characters of the password. However, in modern operating
11688 systems this is no longer true, and in many cases the entire password is used,
11689 whatever its length.
11690
11691 .next
11692 .cindex "&[crypt16()]&"
11693 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11694 use up to 16 characters of the password in some operating systems. Again, in
11695 modern operating systems, more characters may be used.
11696 .endlist
11697 Exim has its own version of &[crypt16()]&, which is just a double call to
11698 &[crypt()]&. For operating systems that have their own version, setting
11699 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11700 operating system version instead of its own. This option is set by default in
11701 the OS-dependent &_Makefile_& for those operating systems that are known to
11702 support &[crypt16()]&.
11703
11704 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11705 it was not using the same algorithm as some operating systems' versions. It
11706 turns out that as well as &[crypt16()]& there is a function called
11707 &[bigcrypt()]& in some operating systems. This may or may not use the same
11708 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11709
11710 However, since there is now a move away from the traditional &[crypt()]&
11711 functions towards using SHA1 and other algorithms, tidying up this area of
11712 Exim is seen as very low priority.
11713
11714 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11715 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11716 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11717 default is &`{crypt}`&. Whatever the default, you can always use either
11718 function by specifying it explicitly in curly brackets.
11719
11720 .vitem &*def:*&<&'variable&~name'&>
11721 .cindex "expansion" "checking for empty variable"
11722 .cindex "&%def%& expansion condition"
11723 The &%def%& condition must be followed by the name of one of the expansion
11724 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11725 variable does not contain the empty string. For example:
11726 .code
11727 ${if def:sender_ident {from $sender_ident}}
11728 .endd
11729 Note that the variable name is given without a leading &%$%& character. If the
11730 variable does not exist, the expansion fails.
11731
11732 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11733         &~&*def:h_*&<&'header&~name'&>&*:*&"
11734 .cindex "expansion" "checking header line existence"
11735 This condition is true if a message is being processed and the named header
11736 exists in the message. For example,
11737 .code
11738 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11739 .endd
11740 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11741 the header name must be terminated by a colon if white space does not follow.
11742
11743 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11744        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11745 .cindex "string" "comparison"
11746 .cindex "expansion" "string comparison"
11747 .cindex "&%eq%& expansion condition"
11748 .cindex "&%eqi%& expansion condition"
11749 The two substrings are first expanded. The condition is true if the two
11750 resulting strings are identical. For &%eq%& the comparison includes the case of
11751 letters, whereas for &%eqi%& the comparison is case-independent, where
11752 case is defined per the system C locale.
11753
11754 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11755 .cindex "expansion" "file existence test"
11756 .cindex "file" "existence test"
11757 .cindex "&%exists%&, expansion condition"
11758 The substring is first expanded and then interpreted as an absolute path. The
11759 condition is true if the named file (or directory) exists. The existence test
11760 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11761 users' filter files may be locked out by the system administrator.
11762
11763 &*Note:*& Testing a path using this condition is not a sufficient way of
11764 de-tainting it.
11765 Consider using a dsearch lookup.
11766
11767 .vitem &*first_delivery*&
11768 .cindex "delivery" "first"
11769 .cindex "first delivery"
11770 .cindex "expansion" "first delivery test"
11771 .cindex "&%first_delivery%& expansion condition"
11772 .cindex retry condition
11773 This condition, which has no data, is true during a message's first delivery
11774 attempt. It is false during any subsequent delivery attempts.
11775
11776
11777 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11778        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11779 .cindex "list" "iterative conditions"
11780 .cindex "expansion" "&*forall*& condition"
11781 .cindex "expansion" "&*forany*& condition"
11782 .vindex "&$item$&"
11783 These conditions iterate over a list. The first argument is expanded to form
11784 the list. By default, the list separator is a colon, but it can be changed by
11785 the normal method (&<<SECTlistsepchange>>&).
11786 The second argument is interpreted as a condition that is to
11787 be applied to each item in the list in turn. During the interpretation of the
11788 condition, the current list item is placed in a variable called &$item$&.
11789 .ilist
11790 For &*forany*&, interpretation stops if the condition is true for any item, and
11791 the result of the whole condition is true. If the condition is false for all
11792 items in the list, the overall condition is false.
11793 .next
11794 For &*forall*&, interpretation stops if the condition is false for any item,
11795 and the result of the whole condition is false. If the condition is true for
11796 all items in the list, the overall condition is true.
11797 .endlist
11798 Note that negation of &*forany*& means that the condition must be false for all
11799 items for the overall condition to succeed, and negation of &*forall*& means
11800 that the condition must be false for at least one item. In this example, the
11801 list separator is changed to a comma:
11802 .code
11803 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11804 .endd
11805 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11806 being processed, to enable these expansion items to be nested.
11807
11808 To scan a named list, expand it with the &*listnamed*& operator.
11809
11810 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11811        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11812        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11813        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11814 .cindex JSON "iterative conditions"
11815 .cindex JSON expansions
11816 .cindex expansion "&*forall_json*& condition"
11817 .cindex expansion "&*forany_json*& condition"
11818 .cindex expansion "&*forall_jsons*& condition"
11819 .cindex expansion "&*forany_jsons*& condition"
11820 As for the above, except that the first argument must, after expansion,
11821 be a JSON array.
11822 The array separator is not changeable.
11823 For the &"jsons"& variants the elements are expected to be JSON strings
11824 and have their quotes removed before the evaluation of the condition.
11825
11826
11827
11828 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11829        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11830 .cindex "string" "comparison"
11831 .cindex "expansion" "string comparison"
11832 .cindex "&%ge%& expansion condition"
11833 .cindex "&%gei%& expansion condition"
11834 The two substrings are first expanded. The condition is true if the first
11835 string is lexically greater than or equal to the second string. For &%ge%& the
11836 comparison includes the case of letters, whereas for &%gei%& the comparison is
11837 case-independent.
11838 Case and collation order are defined per the system C locale.
11839
11840 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11841        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11842 .cindex "string" "comparison"
11843 .cindex "expansion" "string comparison"
11844 .cindex "&%gt%& expansion condition"
11845 .cindex "&%gti%& expansion condition"
11846 The two substrings are first expanded. The condition is true if the first
11847 string is lexically greater than the second string. For &%gt%& the comparison
11848 includes the case of letters, whereas for &%gti%& the comparison is
11849 case-independent.
11850 Case and collation order are defined per the system C locale.
11851
11852
11853 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11854 SRS decode.  See SECT &<<SECTSRS>>& for details.
11855
11856
11857 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11858        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11859 .cindex "string" "comparison"
11860 .cindex "list" "iterative conditions"
11861 Both strings are expanded; the second string is treated as a list of simple
11862 strings; if the first string is a member of the second, then the condition
11863 is true.
11864 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11865
11866 These are simpler to use versions of the more powerful &*forany*& condition.
11867 Examples, and the &*forany*& equivalents:
11868 .code
11869 ${if inlist{needle}{foo:needle:bar}}
11870   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11871 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11872   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11873 .endd
11874
11875 The variable &$value$& will be set for a successful match and can be
11876 used in the success clause of an &%if%& expansion item using the condition.
11877 .cindex "tainted data" "de-tainting"
11878 .cindex "de-tainting" "using an inlist expansion condition"
11879 It will have the same taint status as the list; expansions such as
11880 .code
11881 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11882 .endd
11883 can be used for de-tainting.
11884 Any previous &$value$& is restored after the if.
11885
11886
11887 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11888        &*isip4&~{*&<&'string'&>&*}*& &&&
11889        &*isip6&~{*&<&'string'&>&*}*&
11890 .cindex "IP address" "testing string format"
11891 .cindex "string" "testing for IP address"
11892 .cindex "&%isip%& expansion condition"
11893 .cindex "&%isip4%& expansion condition"
11894 .cindex "&%isip6%& expansion condition"
11895 The substring is first expanded, and then tested to see if it has the form of
11896 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11897 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11898
11899 For an IPv4 address, the test is for four dot-separated components, each of
11900 which consists of from one to three digits. For an IPv6 address, up to eight
11901 colon-separated components are permitted, each containing from one to four
11902 hexadecimal digits. There may be fewer than eight components if an empty
11903 component (adjacent colons) is present. Only one empty component is permitted.
11904
11905 &*Note*&: The checks used to be just on the form of the address; actual numerical
11906 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11907 check.
11908 This is no longer the case.
11909
11910 The main use of these tests is to distinguish between IP addresses and
11911 host names, or between IPv4 and IPv6 addresses. For example, you could use
11912 .code
11913 ${if isip4{$sender_host_address}...
11914 .endd
11915 to test which IP version an incoming SMTP connection is using.
11916
11917 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11918 .cindex "LDAP" "use for authentication"
11919 .cindex "expansion" "LDAP authentication test"
11920 .cindex "&%ldapauth%& expansion condition"
11921 This condition supports user authentication using LDAP. See section
11922 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11923 queries. For this use, the query must contain a user name and password. The
11924 query itself is not used, and can be empty. The condition is true if the
11925 password is not empty, and the user name and password are accepted by the LDAP
11926 server. An empty password is rejected without calling LDAP because LDAP binds
11927 with an empty password are considered anonymous regardless of the username, and
11928 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11929 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11930 this can be used.
11931
11932
11933 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11934        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11935 .cindex "string" "comparison"
11936 .cindex "expansion" "string comparison"
11937 .cindex "&%le%& expansion condition"
11938 .cindex "&%lei%& expansion condition"
11939 The two substrings are first expanded. The condition is true if the first
11940 string is lexically less than or equal to the second string. For &%le%& the
11941 comparison includes the case of letters, whereas for &%lei%& the comparison is
11942 case-independent.
11943 Case and collation order are defined per the system C locale.
11944
11945 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11946        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11947 .cindex "string" "comparison"
11948 .cindex "expansion" "string comparison"
11949 .cindex "&%lt%& expansion condition"
11950 .cindex "&%lti%& expansion condition"
11951 The two substrings are first expanded. The condition is true if the first
11952 string is lexically less than the second string. For &%lt%& the comparison
11953 includes the case of letters, whereas for &%lti%& the comparison is
11954 case-independent.
11955 Case and collation order are defined per the system C locale.
11956
11957
11958 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11959 .cindex "expansion" "regular expression comparison"
11960 .cindex "regular expressions" "match in expanded string"
11961 .cindex "&%match%& expansion condition"
11962 The two substrings are first expanded. The second is then treated as a regular
11963 expression and applied to the first. Because of the pre-expansion, if the
11964 regular expression contains dollar, or backslash characters, they must be
11965 escaped. Care must also be taken if the regular expression contains braces
11966 (curly brackets). A closing brace must be escaped so that it is not taken as a
11967 premature termination of <&'string2'&>. The easiest approach is to use the
11968 &`\N`& feature to disable expansion of the regular expression.
11969 For example,
11970 .code
11971 ${if match {$local_part}{\N^\d{3}\N} ...
11972 .endd
11973 If the whole expansion string is in double quotes, further escaping of
11974 backslashes is also required.
11975
11976 The condition is true if the regular expression match succeeds.
11977 The regular expression is not required to begin with a circumflex
11978 metacharacter, but if there is no circumflex, the expression is not anchored,
11979 and it may match anywhere in the subject, not just at the start. If you want
11980 the pattern to match at the end of the subject, you must include the &`$`&
11981 metacharacter at an appropriate point.
11982 All character handling is done in bytes and is not UTF-8 aware,
11983 but we might change this in a future Exim release.
11984
11985 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11986 At the start of an &%if%& expansion the values of the numeric variable
11987 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11988 succeeds causes them to be reset to the substrings of that condition and they
11989 will have these values during the expansion of the success string. At the end
11990 of the &%if%& expansion, the previous values are restored. After testing a
11991 combination of conditions using &%or%&, the subsequent values of the numeric
11992 variables are those of the condition that succeeded.
11993
11994 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11995 .cindex "&%match_address%& expansion condition"
11996 See &*match_local_part*&.
11997
11998 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11999 .cindex "&%match_domain%& expansion condition"
12000 See &*match_local_part*&.
12001
12002 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12003 .cindex "&%match_ip%& expansion condition"
12004 This condition matches an IP address to a list of IP address patterns. It must
12005 be followed by two argument strings. The first (after expansion) must be an IP
12006 address or an empty string. The second (not expanded) is a restricted host
12007 list that can match only an IP address, not a host name. For example:
12008 .code
12009 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12010 .endd
12011 The specific types of host list item that are permitted in the list are:
12012
12013 .ilist
12014 An IP address, optionally with a CIDR mask.
12015 .next
12016 A single asterisk, which matches any IP address.
12017 .next
12018 An empty item, which matches only if the IP address is empty. This could be
12019 useful for testing for a locally submitted message or one from specific hosts
12020 in a single test such as
12021 . ==== As this is a nested list, any displays it contains must be indented
12022 . ==== as otherwise they are too far to the left. This comment applies to
12023 . ==== the use of xmlto plus fop. There's no problem when formatting with
12024 . ==== sdop, with or without the extra indent.
12025 .code
12026   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12027 .endd
12028 where the first item in the list is the empty string.
12029 .next
12030 The item @[] matches any of the local host's interface addresses.
12031 .next
12032 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12033 even if &`net-`& is not specified. There is never any attempt to turn the IP
12034 address into a host name. The most common type of linear search for
12035 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12036 masks. For example:
12037 .code
12038   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12039 .endd
12040 It is of course possible to use other kinds of lookup, and in such a case, you
12041 do need to specify the &`net-`& prefix if you want to specify a specific
12042 address mask, for example:
12043 .code
12044   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12045 .endd
12046 However, unless you are combining a &%match_ip%& condition with others, it is
12047 just as easy to use the fact that a lookup is itself a condition, and write:
12048 .code
12049   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12050 .endd
12051 .endlist ilist
12052
12053 Note that <&'string2'&> is not itself subject to string expansion, unless
12054 Exim was built with the EXPAND_LISTMATCH_RHS option.
12055
12056 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12057
12058 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12059 .cindex "domain list" "in expansion condition"
12060 .cindex "address list" "in expansion condition"
12061 .cindex "local part" "list, in expansion condition"
12062 .cindex "&%match_local_part%& expansion condition"
12063 This condition, together with &%match_address%& and &%match_domain%&, make it
12064 possible to test domain, address, and local part lists within expansions. Each
12065 condition requires two arguments: an item and a list to match. A trivial
12066 example is:
12067 .code
12068 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12069 .endd
12070 In each case, the second argument may contain any of the allowable items for a
12071 list of the appropriate type. Also, because the second argument
12072 is a standard form of list, it is possible to refer to a named list.
12073 Thus, you can use conditions like this:
12074 .code
12075 ${if match_domain{$domain}{+local_domains}{...
12076 .endd
12077 .cindex "&`+caseful`&"
12078 For address lists, the matching starts off caselessly, but the &`+caseful`&
12079 item can be used, as in all address lists, to cause subsequent items to
12080 have their local parts matched casefully. Domains are always matched
12081 caselessly.
12082
12083 The variable &$value$& will be set for a successful match and can be
12084 used in the success clause of an &%if%& expansion item using the condition.
12085 .cindex "tainted data" "de-tainting"
12086 .cindex "de-tainting" "using a match_local_part expansion condition"
12087 It will have the same taint status as the list; expansions such as
12088 .code
12089 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12090 .endd
12091 can be used for de-tainting.
12092 Any previous &$value$& is restored after the if.
12093
12094 Note that <&'string2'&> is not itself subject to string expansion, unless
12095 Exim was built with the EXPAND_LISTMATCH_RHS option.
12096
12097 &*Note*&: Host lists are &'not'& supported in this way. This is because
12098 hosts have two identities: a name and an IP address, and it is not clear
12099 how to specify cleanly how such a test would work. However, IP addresses can be
12100 matched using &%match_ip%&.
12101
12102 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12103 .cindex "PAM authentication"
12104 .cindex "AUTH" "with PAM"
12105 .cindex "Solaris" "PAM support"
12106 .cindex "expansion" "PAM authentication test"
12107 .cindex "&%pam%& expansion condition"
12108 &'Pluggable Authentication Modules'&
12109 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12110 available in Solaris
12111 and in some GNU/Linux distributions.
12112 The Exim support, which is intended for use in conjunction with
12113 the SMTP AUTH command, is available only if Exim is compiled with
12114 .code
12115 SUPPORT_PAM=yes
12116 .endd
12117 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12118 in some releases of GNU/Linux &%-ldl%& is also needed.
12119
12120 The argument string is first expanded, and the result must be a
12121 colon-separated list of strings. Leading and trailing white space is ignored.
12122 The PAM module is initialized with the service name &"exim"& and the user name
12123 taken from the first item in the colon-separated data string (<&'string1'&>).
12124 The remaining items in the data string are passed over in response to requests
12125 from the authentication function. In the simple case there will only be one
12126 request, for a password, so the data consists of just two strings.
12127
12128 There can be problems if any of the strings are permitted to contain colon
12129 characters. In the usual way, these have to be doubled to avoid being taken as
12130 separators.
12131 The &%listquote%& expansion item can be used for this.
12132 For example, the configuration
12133 of a LOGIN authenticator might contain this setting:
12134 .code
12135 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12136 .endd
12137 In some operating systems, PAM authentication can be done only from a process
12138 running as root. Since Exim is running as the Exim user when receiving
12139 messages, this means that PAM cannot be used directly in those systems.
12140 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12141
12142
12143 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12144 .cindex "&'pwcheck'& daemon"
12145 .cindex "Cyrus"
12146 .cindex "expansion" "&'pwcheck'& authentication test"
12147 .cindex "&%pwcheck%& expansion condition"
12148 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12149 This is one way of making it possible for passwords to be checked by a process
12150 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12151 deprecated. Its replacement is &'saslauthd'& (see below).
12152
12153 The pwcheck support is not included in Exim by default. You need to specify
12154 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12155 building Exim. For example:
12156 .code
12157 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12158 .endd
12159 You do not need to install the full Cyrus software suite in order to use
12160 the pwcheck daemon. You can compile and install just the daemon alone
12161 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12162 access to the &_/var/pwcheck_& directory.
12163
12164 The &%pwcheck%& condition takes one argument, which must be the user name and
12165 password, separated by a colon. For example, in a LOGIN authenticator
12166 configuration, you might have this:
12167 .code
12168 server_condition = ${if pwcheck{$auth1:$auth2}}
12169 .endd
12170 Again, for a PLAIN authenticator configuration, this would be:
12171 .code
12172 server_condition = ${if pwcheck{$auth2:$auth3}}
12173 .endd
12174 .vitem &*queue_running*&
12175 .cindex "queue runner" "detecting when delivering from"
12176 .cindex "expansion" "queue runner test"
12177 .cindex "&%queue_running%& expansion condition"
12178 This condition, which has no data, is true during delivery attempts that are
12179 initiated by queue runner processes, and false otherwise.
12180
12181
12182 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12183 .cindex "Radius"
12184 .cindex "expansion" "Radius authentication"
12185 .cindex "&%radius%& expansion condition"
12186 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12187 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12188 the Radius client configuration file in order to build Exim with Radius
12189 support.
12190
12191 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12192 library, using the original API. If you are using release 0.4.0 or later of
12193 this library, you need to set
12194 .code
12195 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12196 .endd
12197 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12198 &%libradius%& library that comes with FreeBSD. To do this, set
12199 .code
12200 RADIUS_LIB_TYPE=RADLIB
12201 .endd
12202 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12203 You may also have to supply a suitable setting in EXTRALIBS so that the
12204 Radius library can be found when Exim is linked.
12205
12206 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12207 Radius client library, which calls the Radius server. The condition is true if
12208 the authentication is successful. For example:
12209 .code
12210 server_condition = ${if radius{<arguments>}}
12211 .endd
12212
12213
12214 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12215         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12216 .cindex "&'saslauthd'& daemon"
12217 .cindex "Cyrus"
12218 .cindex "expansion" "&'saslauthd'& authentication test"
12219 .cindex "&%saslauthd%& expansion condition"
12220 This condition supports user authentication using the Cyrus &'saslauthd'&
12221 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12222 Using this daemon is one way of making it possible for passwords to be checked
12223 by a process that is not running as root.
12224
12225 The saslauthd support is not included in Exim by default. You need to specify
12226 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12227 building Exim. For example:
12228 .code
12229 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12230 .endd
12231 You do not need to install the full Cyrus software suite in order to use
12232 the saslauthd daemon. You can compile and install just the daemon alone
12233 from the Cyrus SASL library.
12234
12235 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12236 two are mandatory. For example:
12237 .code
12238 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12239 .endd
12240 The service and the realm are optional (which is why the arguments are enclosed
12241 in their own set of braces). For details of the meaning of the service and
12242 realm, and how to run the daemon, consult the Cyrus documentation.
12243 .endlist vlist
12244
12245
12246
12247 .section "Combining expansion conditions" "SECID84"
12248 .cindex "expansion" "combining conditions"
12249 Several conditions can be tested at once by combining them using the &%and%&
12250 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12251 conditions on their own, and precede their lists of sub-conditions. Each
12252 sub-condition must be enclosed in braces within the overall braces that contain
12253 the list. No repetition of &%if%& is used.
12254
12255
12256 .vlist
12257 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12258 .cindex "&""or""& expansion condition"
12259 .cindex "expansion" "&""or""& of conditions"
12260 The sub-conditions are evaluated from left to right. The condition is true if
12261 any one of the sub-conditions is true.
12262 For example,
12263 .code
12264 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12265 .endd
12266 When a true sub-condition is found, the following ones are parsed but not
12267 evaluated. If there are several &"match"& sub-conditions the values of the
12268 numeric variables afterwards are taken from the first one that succeeds.
12269
12270 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12271 .cindex "&""and""& expansion condition"
12272 .cindex "expansion" "&""and""& of conditions"
12273 The sub-conditions are evaluated from left to right. The condition is true if
12274 all of the sub-conditions are true. If there are several &"match"&
12275 sub-conditions, the values of the numeric variables afterwards are taken from
12276 the last one. When a false sub-condition is found, the following ones are
12277 parsed but not evaluated.
12278 .endlist
12279 .ecindex IIDexpcond
12280
12281
12282
12283
12284 .section "Expansion variables" "SECTexpvar"
12285 .cindex "expansion" "variables, list of"
12286 This section contains an alphabetical list of all the expansion variables. Some
12287 of them are available only when Exim is compiled with specific options such as
12288 support for TLS or the content scanning extension.
12289 .cindex "tainted data"
12290 Variables marked as &'tainted'& are likely to carry data supplied by
12291 a potential attacker.
12292 Variables without such marking may also, depending on how their
12293 values are created.
12294 Such variables should not be further expanded,
12295 used as filenames
12296 or used as command-line arguments for external commands.
12297
12298 .vlist
12299 .vitem "&$0$&, &$1$&, etc"
12300 .cindex "numerical variables (&$1$& &$2$& etc)"
12301 When a &%match%& expansion condition succeeds, these variables contain the
12302 captured substrings identified by the regular expression during subsequent
12303 processing of the success string of the containing &%if%& expansion item.
12304 In the expansion condition case
12305 they do not retain their values afterwards; in fact, their previous
12306 values are restored at the end of processing an &%if%& item. The numerical
12307 variables may also be set externally by some other matching process which
12308 precedes the expansion of the string. For example, the commands available in
12309 Exim filter files include an &%if%& command with its own regular expression
12310 matching condition.
12311 If the subject string was tainted then any captured substring will also be.
12312
12313 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12314 Within an acl condition, expansion condition or expansion item
12315 any arguments are copied to these variables,
12316 any unused variables being made empty.
12317
12318 .vitem "&$acl_c...$&"
12319 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12320 can be given any name that starts with &$acl_c$& and is at least six characters
12321 long, but the sixth character must be either a digit or an underscore. For
12322 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12323 variables persist throughout the lifetime of an SMTP connection. They can be
12324 used to pass information between ACLs and between different invocations of the
12325 same ACL. When a message is received, the values of these variables are saved
12326 with the message, and can be accessed by filters, routers, and transports
12327 during subsequent delivery.
12328
12329 .vitem "&$acl_m...$&"
12330 These variables are like the &$acl_c...$& variables, except that their values
12331 are reset after a message has been received. Thus, if several messages are
12332 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12333 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12334 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12335 message is received, the values of these variables are saved with the message,
12336 and can be accessed by filters, routers, and transports during subsequent
12337 delivery.
12338
12339 .vitem &$acl_narg$&
12340 Within an acl condition, expansion condition or expansion item
12341 this variable has the number of arguments.
12342
12343 .vitem &$acl_verify_message$&
12344 .vindex "&$acl_verify_message$&"
12345 After an address verification has failed, this variable contains the failure
12346 message. It retains its value for use in subsequent modifiers of the verb.
12347 The message can be preserved by coding like this:
12348 .code
12349 warn !verify = sender
12350      set acl_m0 = $acl_verify_message
12351 .endd
12352 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12353 &%log_message%& modifiers, to include information about the verification
12354 failure.
12355 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12356
12357 .vitem &$address_data$&
12358 .vindex "&$address_data$&"
12359 This variable is set by means of the &%address_data%& option in routers. The
12360 value then remains with the address while it is processed by subsequent routers
12361 and eventually a transport. If the transport is handling multiple addresses,
12362 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12363 for more details. &*Note*&: The contents of &$address_data$& are visible in
12364 user filter files.
12365
12366 If &$address_data$& is set when the routers are called from an ACL to verify
12367 a recipient address, the final value is still in the variable for subsequent
12368 conditions and modifiers of the ACL statement. If routing the address caused it
12369 to be redirected to just one address, the child address is also routed as part
12370 of the verification, and in this case the final value of &$address_data$& is
12371 from the child's routing.
12372
12373 If &$address_data$& is set when the routers are called from an ACL to verify a
12374 sender address, the final value is also preserved, but this time in
12375 &$sender_address_data$&, to distinguish it from data from a recipient
12376 address.
12377
12378 In both cases (recipient and sender verification), the value does not persist
12379 after the end of the current ACL statement. If you want to preserve
12380 these values for longer, you can save them in ACL variables.
12381
12382 .vitem &$address_file$&
12383 .vindex "&$address_file$&"
12384 When, as a result of aliasing, forwarding, or filtering, a message is directed
12385 to a specific file, this variable holds the name of the file when the transport
12386 is running. At other times, the variable is empty. For example, using the
12387 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12388 .code
12389 /home/r2d2/savemail
12390 .endd
12391 then when the &(address_file)& transport is running, &$address_file$&
12392 contains the text string &`/home/r2d2/savemail`&.
12393 .cindex "Sieve filter" "value of &$address_file$&"
12394 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12395 then up to the transport configuration to generate an appropriate absolute path
12396 to the relevant file.
12397
12398 .vitem &$address_pipe$&
12399 .vindex "&$address_pipe$&"
12400 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12401 this variable holds the pipe command when the transport is running.
12402
12403 .vitem "&$auth1$& &-- &$auth4$&"
12404 .vindex "&$auth1$&, &$auth2$&, etc"
12405 These variables are used in SMTP authenticators (see chapters
12406 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12407
12408 .vitem &$authenticated_id$&
12409 .cindex "authentication" "id"
12410 .vindex "&$authenticated_id$&"
12411 When a server successfully authenticates a client it may be configured to
12412 preserve some of the authentication information in the variable
12413 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12414 user/password authenticator configuration might preserve the user name for use
12415 in the routers. Note that this is not the same information that is saved in
12416 &$sender_host_authenticated$&.
12417
12418 When a message is submitted locally (that is, not over a TCP connection)
12419 the value of &$authenticated_id$& is normally the login name of the calling
12420 process. However, a trusted user can override this by means of the &%-oMai%&
12421 command line option.
12422 This second case also sets up information used by the
12423 &$authresults$& expansion item.
12424
12425 .vitem &$authenticated_fail_id$&
12426 .cindex "authentication" "fail" "id"
12427 .vindex "&$authenticated_fail_id$&"
12428 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12429 will contain the failed authentication id. If more than one authentication
12430 id is attempted, it will contain only the last one. The variable is
12431 available for processing in the ACL's, generally the quit or notquit ACL.
12432 A message to a local recipient could still be accepted without requiring
12433 authentication, which means this variable could also be visible in all of
12434 the ACL's as well.
12435
12436
12437 .tvar &$authenticated_sender$&
12438 .cindex "sender" "authenticated"
12439 .cindex "authentication" "sender"
12440 .cindex "AUTH" "on MAIL command"
12441 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12442 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12443 described in section &<<SECTauthparamail>>&. Unless the data is the string
12444 &"<>"&, it is set as the authenticated sender of the message, and the value is
12445 available during delivery in the &$authenticated_sender$& variable. If the
12446 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12447
12448 .vindex "&$qualify_domain$&"
12449 When a message is submitted locally (that is, not over a TCP connection), the
12450 value of &$authenticated_sender$& is an address constructed from the login
12451 name of the calling process and &$qualify_domain$&, except that a trusted user
12452 can override this by means of the &%-oMas%& command line option.
12453
12454
12455 .vitem &$authentication_failed$&
12456 .cindex "authentication" "failure"
12457 .vindex "&$authentication_failed$&"
12458 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12459 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12460 possible to distinguish between &"did not try to authenticate"&
12461 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12462 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12463 is empty and &$authentication_failed$& is set to &"1"&).
12464 Failure includes cancellation of a authentication attempt,
12465 and any negative response to an AUTH command,
12466 (including, for example, an attempt to use an undefined mechanism).
12467
12468 .vitem &$av_failed$&
12469 .cindex "content scanning" "AV scanner failure"
12470 This variable is available when Exim is compiled with the content-scanning
12471 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12472 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12473 the ACL malware condition.
12474
12475 .vitem &$body_linecount$&
12476 .cindex "message body" "line count"
12477 .cindex "body of message" "line count"
12478 .vindex "&$body_linecount$&"
12479 When a message is being received or delivered, this variable contains the
12480 number of lines in the message's body. See also &$message_linecount$&.
12481
12482 .vitem &$body_zerocount$&
12483 .cindex "message body" "binary zero count"
12484 .cindex "body of message" "binary zero count"
12485 .cindex "binary zero" "in message body"
12486 .vindex "&$body_zerocount$&"
12487 When a message is being received or delivered, this variable contains the
12488 number of binary zero bytes (ASCII NULs) in the message's body.
12489
12490 .vitem &$bounce_recipient$&
12491 .vindex "&$bounce_recipient$&"
12492 This is set to the recipient address of a bounce message while Exim is creating
12493 it. It is useful if a customized bounce message text file is in use (see
12494 chapter &<<CHAPemsgcust>>&).
12495
12496 .vitem &$bounce_return_size_limit$&
12497 .vindex "&$bounce_return_size_limit$&"
12498 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12499 up to a multiple of 1000. It is useful when a customized error message text
12500 file is in use (see chapter &<<CHAPemsgcust>>&).
12501
12502 .vitem &$caller_gid$&
12503 .cindex "gid (group id)" "caller"
12504 .vindex "&$caller_gid$&"
12505 The real group id under which the process that called Exim was running. This is
12506 not the same as the group id of the originator of a message (see
12507 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12508 incarnation normally contains the Exim gid.
12509
12510 .vitem &$caller_uid$&
12511 .cindex "uid (user id)" "caller"
12512 .vindex "&$caller_uid$&"
12513 The real user id under which the process that called Exim was running. This is
12514 not the same as the user id of the originator of a message (see
12515 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12516 incarnation normally contains the Exim uid.
12517
12518 .vitem &$callout_address$&
12519 .vindex "&$callout_address$&"
12520 After a callout for verification, spamd or malware daemon service, the
12521 address that was connected to.
12522
12523 .vitem &$compile_number$&
12524 .vindex "&$compile_number$&"
12525 The building process for Exim keeps a count of the number
12526 of times it has been compiled. This serves to distinguish different
12527 compilations of the same version of Exim.
12528
12529 .vitem &$config_dir$&
12530 .vindex "&$config_dir$&"
12531 The directory name of the main configuration file. That is, the content of
12532 &$config_file$& with the last component stripped. The value does not
12533 contain the trailing slash. If &$config_file$& does not contain a slash,
12534 &$config_dir$& is ".".
12535
12536 .vitem &$config_file$&
12537 .vindex "&$config_file$&"
12538 The name of the main configuration file Exim is using.
12539
12540 .vitem &$dkim_verify_status$&
12541 Results of DKIM verification.
12542 For details see section &<<SECDKIMVFY>>&.
12543
12544 .vitem &$dkim_cur_signer$& &&&
12545        &$dkim_verify_reason$& &&&
12546        &$dkim_domain$& &&&
12547        &$dkim_identity$& &&&
12548        &$dkim_selector$& &&&
12549        &$dkim_algo$& &&&
12550        &$dkim_canon_body$& &&&
12551        &$dkim_canon_headers$& &&&
12552        &$dkim_copiedheaders$& &&&
12553        &$dkim_bodylength$& &&&
12554        &$dkim_created$& &&&
12555        &$dkim_expires$& &&&
12556        &$dkim_headernames$& &&&
12557        &$dkim_key_testing$& &&&
12558        &$dkim_key_nosubdomains$& &&&
12559        &$dkim_key_srvtype$& &&&
12560        &$dkim_key_granularity$& &&&
12561        &$dkim_key_notes$& &&&
12562        &$dkim_key_length$&
12563 These variables are only available within the DKIM ACL.
12564 For details see section &<<SECDKIMVFY>>&.
12565
12566 .vitem &$dkim_signers$&
12567 .vindex &$dkim_signers$&
12568 When a message has been received this variable contains
12569 a colon-separated list of signer domains and identities for the message.
12570 For details see section &<<SECDKIMVFY>>&.
12571
12572 .vitem &$dmarc_domain_policy$& &&&
12573        &$dmarc_status$& &&&
12574        &$dmarc_status_text$& &&&
12575        &$dmarc_used_domains$&
12576 Results of DMARC verification.
12577 For details see section &<<SECDMARC>>&.
12578
12579 .vitem &$dnslist_domain$& &&&
12580        &$dnslist_matched$& &&&
12581        &$dnslist_text$& &&&
12582        &$dnslist_value$&
12583 .vindex "&$dnslist_domain$&"
12584 .vindex "&$dnslist_matched$&"
12585 .vindex "&$dnslist_text$&"
12586 .vindex "&$dnslist_value$&"
12587 .cindex "black list (DNS)"
12588 When a DNS (black) list lookup succeeds, these variables are set to contain
12589 the following data from the lookup: the list's domain name, the key that was
12590 looked up, the contents of any associated TXT record, and the value from the
12591 main A record. See section &<<SECID204>>& for more details.
12592
12593 .tvar &$domain$&
12594 When an address is being routed, or delivered on its own, this variable
12595 contains the domain. Uppercase letters in the domain are converted into lower
12596 case for &$domain$&.
12597
12598 Global address rewriting happens when a message is received, so the value of
12599 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12600 is set during user filtering, but not during system filtering, because a
12601 message may have many recipients and the system filter is called just once.
12602
12603 When more than one address is being delivered at once (for example, several
12604 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12605 have the same domain. Transports can be restricted to handling only one domain
12606 at a time if the value of &$domain$& is required at transport time &-- this is
12607 the default for local transports. For further details of the environment in
12608 which local transports are run, see chapter &<<CHAPenvironment>>&.
12609
12610 .oindex "&%delay_warning_condition%&"
12611 At the end of a delivery, if all deferred addresses have the same domain, it is
12612 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12613
12614 The &$domain$& variable is also used in some other circumstances:
12615
12616 .ilist
12617 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12618 the recipient address. The domain of the &'sender'& address is in
12619 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12620 normally set during the running of the MAIL ACL. However, if the sender address
12621 is verified with a callout during the MAIL ACL, the sender domain is placed in
12622 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12623 the &(smtp)& transport.
12624
12625 .next
12626 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12627 &$domain$& contains the domain portion of the address that is being rewritten;
12628 it can be used in the expansion of the replacement address, for example, to
12629 rewrite domains by file lookup.
12630
12631 .next
12632 With one important exception, whenever a domain list is being scanned,
12633 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12634 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12635 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12636 that, in a RCPT ACL, the sender domain list can be dependent on the
12637 recipient domain (which is what is in &$domain$& at this time).
12638
12639 .next
12640 .cindex "ETRN" "value of &$domain$&"
12641 .oindex "&%smtp_etrn_command%&"
12642 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12643 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12644 .endlist
12645
12646 .cindex "tainted data"
12647 If the origin of the data is an incoming message,
12648 the result of expanding this variable is tainted and may not
12649 be further expanded or used as a filename.
12650 When an untainted version is needed, one should be obtained from
12651 looking up the value in a local (therefore trusted) database.
12652 Often &$domain_data$& is usable in this role.
12653
12654
12655 .vitem &$domain_data$&
12656 .vindex "&$domain_data$&"
12657 When the &%domains%& condition on a router
12658 or an ACL
12659 matches a domain
12660 against a list, the match value is copied to &$domain_data$&.
12661 This is an enhancement over previous versions of Exim, when it only
12662 applied to the data read by a lookup.
12663 For details on match values see section &<<SECTlistresults>>& et. al.
12664
12665 If the router routes the
12666 address to a transport, the value is available in that transport. If the
12667 transport is handling multiple addresses, the value from the first address is
12668 used.
12669
12670 &$domain_data$& set in an ACL is available during
12671 the rest of the ACL statement.
12672
12673 .vitem &$exim_gid$&
12674 .vindex "&$exim_gid$&"
12675 This variable contains the numerical value of the Exim group id.
12676
12677 .vitem &$exim_path$&
12678 .vindex "&$exim_path$&"
12679 This variable contains the path to the Exim binary.
12680
12681 .vitem &$exim_uid$&
12682 .vindex "&$exim_uid$&"
12683 This variable contains the numerical value of the Exim user id.
12684
12685 .vitem &$exim_version$&
12686 .vindex "&$exim_version$&"
12687 This variable contains the version string of the Exim build.
12688 The first character is a major version number, currently 4.
12689 Then after a dot, the next group of digits is a minor version number.
12690 There may be other characters following the minor version.
12691 This value may be overridden by the &%exim_version%& main config option.
12692
12693 .vitem &$header_$&<&'name'&>
12694 .tmark
12695 This is not strictly an expansion variable. It is expansion syntax for
12696 inserting the message header line with the given name. Note that the name must
12697 be terminated by colon or white space, because it may contain a wide variety of
12698 characters. Note also that braces must &'not'& be used.
12699 See the full description in section &<<SECTexpansionitems>>& above.
12700
12701 .vitem &$headers_added$&
12702 .vindex "&$headers_added$&"
12703 Within an ACL this variable contains the headers added so far by
12704 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12705 The headers are a newline-separated list.
12706
12707 .vitem &$home$&
12708 .vindex "&$home$&"
12709 When the &%check_local_user%& option is set for a router, the user's home
12710 directory is placed in &$home$& when the check succeeds. In particular, this
12711 means it is set during the running of users' filter files. A router may also
12712 explicitly set a home directory for use by a transport; this can be overridden
12713 by a setting on the transport itself.
12714
12715 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12716 of the environment variable HOME, which is subject to the
12717 &%keep_environment%& and &%add_environment%& main config options.
12718
12719 .vitem &$host$&
12720 .vindex "&$host$&"
12721 If a router assigns an address to a transport (any transport), and passes a
12722 list of hosts with the address, the value of &$host$& when the transport starts
12723 to run is the name of the first host on the list. Note that this applies both
12724 to local and remote transports.
12725
12726 .cindex "transport" "filter"
12727 .cindex "filter" "transport filter"
12728 For the &(smtp)& transport, if there is more than one host, the value of
12729 &$host$& changes as the transport works its way through the list. In
12730 particular, when the &(smtp)& transport is expanding its options for encryption
12731 using TLS, or for specifying a transport filter (see chapter
12732 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12733 is connected.
12734
12735 When used in the client part of an authenticator configuration (see chapter
12736 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12737 client is connected.
12738
12739
12740 .vitem &$host_address$&
12741 .vindex "&$host_address$&"
12742 This variable is set to the remote host's IP address whenever &$host$& is set
12743 for a remote connection. It is also set to the IP address that is being checked
12744 when the &%ignore_target_hosts%& option is being processed.
12745
12746 .vitem &$host_data$&
12747 .vindex "&$host_data$&"
12748 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12749 result of the lookup is made available in the &$host_data$& variable. This
12750 allows you, for example, to do things like this:
12751 .code
12752 deny  hosts = net-lsearch;/some/file
12753       message = $host_data
12754 .endd
12755
12756 .vitem &$host_lookup_deferred$&
12757 .cindex "host name" "lookup, failure of"
12758 .vindex "&$host_lookup_deferred$&"
12759 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12760 message comes from a remote host and there is an attempt to look up the host's
12761 name from its IP address, and the attempt is not successful, one of these
12762 variables is set to &"1"&.
12763
12764 .ilist
12765 If the lookup receives a definite negative response (for example, a DNS lookup
12766 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12767
12768 .next
12769 If there is any kind of problem during the lookup, such that Exim cannot
12770 tell whether or not the host name is defined (for example, a timeout for a DNS
12771 lookup), &$host_lookup_deferred$& is set to &"1"&.
12772 .endlist ilist
12773
12774 Looking up a host's name from its IP address consists of more than just a
12775 single reverse lookup. Exim checks that a forward lookup of at least one of the
12776 names it receives from a reverse lookup yields the original IP address. If this
12777 is not the case, Exim does not accept the looked up name(s), and
12778 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12779 IP address (for example, the existence of a PTR record in the DNS) is not
12780 sufficient on its own for the success of a host name lookup. If the reverse
12781 lookup succeeds, but there is a lookup problem such as a timeout when checking
12782 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12783 &"1"&. See also &$sender_host_name$&.
12784
12785 .cindex authentication "expansion item"
12786 Performing these checks sets up information used by the
12787 &%authresults%& expansion item.
12788
12789
12790 .vitem &$host_lookup_failed$&
12791 .vindex "&$host_lookup_failed$&"
12792 See &$host_lookup_deferred$&.
12793
12794 .vitem &$host_port$&
12795 .vindex "&$host_port$&"
12796 This variable is set to the remote host's TCP port whenever &$host$& is set
12797 for an outbound connection.
12798
12799 .vitem &$initial_cwd$&
12800 .vindex "&$initial_cwd$&
12801 This variable contains the full path name of the initial working
12802 directory of the current Exim process. This may differ from the current
12803 working directory, as Exim changes this to "/" during early startup, and
12804 to &$spool_directory$& later.
12805
12806 .vitem &$inode$&
12807 .vindex "&$inode$&"
12808 The only time this variable is set is while expanding the &%directory_file%&
12809 option in the &(appendfile)& transport. The variable contains the inode number
12810 of the temporary file which is about to be renamed. It can be used to construct
12811 a unique name for the file.
12812
12813 .vitem &$interface_address$& &&&
12814        &$interface_port$&
12815 .vindex "&$interface_address$&"
12816 .vindex "&$interface_port$&"
12817 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12818
12819 .vitem &$item$&
12820 .vindex "&$item$&"
12821 This variable is used during the expansion of &*forall*& and &*forany*&
12822 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12823 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12824 empty.
12825
12826 .vitem &$ldap_dn$&
12827 .vindex "&$ldap_dn$&"
12828 This variable, which is available only when Exim is compiled with LDAP support,
12829 contains the DN from the last entry in the most recently successful LDAP
12830 lookup.
12831
12832 .vitem &$load_average$&
12833 .vindex "&$load_average$&"
12834 This variable contains the system load average, multiplied by 1000 so that it
12835 is an integer. For example, if the load average is 0.21, the value of the
12836 variable is 210. The value is recomputed every time the variable is referenced.
12837
12838 .tvar &$local_part$&
12839 When an address is being routed, or delivered on its own, this
12840 variable contains the local part. When a number of addresses are being
12841 delivered together (for example, multiple RCPT commands in an SMTP
12842 session), &$local_part$& is not set.
12843
12844 Global address rewriting happens when a message is received, so the value of
12845 &$local_part$& during routing and delivery is the value after rewriting.
12846 &$local_part$& is set during user filtering, but not during system filtering,
12847 because a message may have many recipients and the system filter is called just
12848 once.
12849
12850 .cindex "tainted data"
12851 If the origin of the data is an incoming message,
12852 the result of expanding this variable is tainted and
12853 may not be further expanded or used as a filename.
12854
12855 &*Warning*&: the content of this variable is usually provided by a potential
12856 attacker.
12857 Consider carefully the implications of using it unvalidated as a name
12858 for file access.
12859 This presents issues for users' &_.forward_& and filter files.
12860 For traditional full user accounts, use &%check_local_users%& and the
12861 &$local_part_data$& variable rather than this one.
12862 For virtual users, store a suitable pathname component in the database
12863 which is used for account name validation, and use that retrieved value
12864 rather than this variable.
12865 Often &$local_part_data$& is usable in this role.
12866 If needed, use a router &%address_data%& or &%set%& option for
12867 the retrieved data.
12868
12869 When a message is being delivered to a file, pipe, or autoreply transport as a
12870 result of aliasing or forwarding, &$local_part$& is set to the local part of
12871 the parent address, not to the filename or command (see &$address_file$& and
12872 &$address_pipe$&).
12873
12874 When an ACL is running for a RCPT command, &$local_part$& contains the
12875 local part of the recipient address.
12876
12877 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12878 &$local_part$& contains the local part of the address that is being rewritten;
12879 it can be used in the expansion of the replacement address, for example.
12880
12881 In all cases, all quoting is removed from the local part. For example, for both
12882 the addresses
12883 .code
12884 "abc:xyz"@test.example
12885 abc\:xyz@test.example
12886 .endd
12887 the value of &$local_part$& is
12888 .code
12889 abc:xyz
12890 .endd
12891 If you use &$local_part$& to create another address, you should always wrap it
12892 inside a quoting operator. For example, in a &(redirect)& router you could
12893 have:
12894 .code
12895 data = ${quote_local_part:$local_part}@new.domain.example
12896 .endd
12897 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12898 to process local parts in a case-dependent manner in a router, you can set the
12899 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12900
12901 .vitem &$local_part_data$&
12902 .vindex "&$local_part_data$&"
12903 When the &%local_parts%& condition on a router or ACL
12904 matches a local part list
12905 the match value is copied to &$local_part_data$&.
12906 This is an enhancement over previous versions of Exim, when it only
12907 applied to the data read by a lookup.
12908 For details on match values see section &<<SECTlistresults>>& et. al.
12909
12910 The &%check_local_user%& router option also sets this variable.
12911
12912 .vindex &$local_part_prefix$& &&&
12913         &$local_part_prefix_v$& &&&
12914         &$local_part_suffix$& &&&
12915         &$local_part_suffix_v$&
12916 .cindex affix variables
12917 If a local part prefix or suffix has been recognized, it is not included in the
12918 value of &$local_part$& during routing and subsequent delivery. The values of
12919 any prefix or suffix are in &$local_part_prefix$& and
12920 &$local_part_suffix$&, respectively.
12921 .cindex "tainted data"
12922 If the specification did not include a wildcard then
12923 the affix variable value is not tainted.
12924
12925 If the affix specification included a wildcard then the portion of
12926 the affix matched by the wildcard is in
12927 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12928 and both the whole and varying values are tainted.
12929
12930 .vitem &$local_scan_data$&
12931 .vindex "&$local_scan_data$&"
12932 This variable contains the text returned by the &[local_scan()]& function when
12933 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12934
12935 .vitem &$local_user_gid$&
12936 .vindex "&$local_user_gid$&"
12937 See &$local_user_uid$&.
12938
12939 .vitem &$local_user_uid$&
12940 .vindex "&$local_user_uid$&"
12941 This variable and &$local_user_gid$& are set to the uid and gid after the
12942 &%check_local_user%& router precondition succeeds. This means that their values
12943 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12944 and &%condition%&), for the &%address_data%& expansion, and for any
12945 router-specific expansions. At all other times, the values in these variables
12946 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12947
12948 .vitem &$localhost_number$&
12949 .vindex "&$localhost_number$&"
12950 This contains the expanded value of the
12951 &%localhost_number%& option. The expansion happens after the main options have
12952 been read.
12953
12954 .vitem &$log_inodes$&
12955 .vindex "&$log_inodes$&"
12956 The number of free inodes in the disk partition where Exim's
12957 log files are being written. The value is recalculated whenever the variable is
12958 referenced. If the relevant file system does not have the concept of inodes,
12959 the value of is -1. See also the &%check_log_inodes%& option.
12960
12961 .vitem &$log_space$&
12962 .vindex "&$log_space$&"
12963 The amount of free space (as a number of kilobytes) in the disk
12964 partition where Exim's log files are being written. The value is recalculated
12965 whenever the variable is referenced. If the operating system does not have the
12966 ability to find the amount of free space (only true for experimental systems),
12967 the space value is -1. See also the &%check_log_space%& option.
12968
12969
12970 .vitem &$lookup_dnssec_authenticated$&
12971 .vindex "&$lookup_dnssec_authenticated$&"
12972 This variable is set after a DNS lookup done by
12973 a dnsdb lookup expansion, dnslookup router or smtp transport.
12974 .cindex "DNS" "DNSSEC"
12975 It will be empty if &(DNSSEC)& was not requested,
12976 &"no"& if the result was not labelled as authenticated data
12977 and &"yes"& if it was.
12978 Results that are labelled as authoritative answer that match
12979 the &%dns_trust_aa%& configuration variable count also
12980 as authenticated data.
12981
12982 .vitem &$mailstore_basename$&
12983 .vindex "&$mailstore_basename$&"
12984 This variable is set only when doing deliveries in &"mailstore"& format in the
12985 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12986 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12987 contains the basename of the files that are being written, that is, the name
12988 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12989 variable is empty.
12990
12991 .vitem &$malware_name$&
12992 .vindex "&$malware_name$&"
12993 This variable is available when Exim is compiled with the
12994 content-scanning extension. It is set to the name of the virus that was found
12995 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12996
12997 .vitem &$max_received_linelength$&
12998 .vindex "&$max_received_linelength$&"
12999 .cindex "maximum" "line length"
13000 .cindex "line length" "maximum"
13001 This variable contains the number of bytes in the longest line that was
13002 received as part of the message, not counting the line termination
13003 character(s).
13004 It is not valid if the &%spool_wireformat%& option is used.
13005
13006 .vitem &$message_age$&
13007 .cindex "message" "age of"
13008 .vindex "&$message_age$&"
13009 This variable is set at the start of a delivery attempt to contain the number
13010 of seconds since the message was received. It does not change during a single
13011 delivery attempt.
13012
13013 .tvar &$message_body$&
13014 .cindex "body of message" "expansion variable"
13015 .cindex "message body" "in expansion"
13016 .cindex "binary zero" "in message body"
13017 .oindex "&%message_body_visible%&"
13018 This variable contains the initial portion of a message's body while it is
13019 being delivered, and is intended mainly for use in filter files. The maximum
13020 number of characters of the body that are put into the variable is set by the
13021 &%message_body_visible%& configuration option; the default is 500.
13022
13023 .oindex "&%message_body_newlines%&"
13024 By default, newlines are converted into spaces in &$message_body$&, to make it
13025 easier to search for phrases that might be split over a line break. However,
13026 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13027 zeros are always converted into spaces.
13028
13029 .tvar &$message_body_end$&
13030 .cindex "body of message" "expansion variable"
13031 .cindex "message body" "in expansion"
13032 This variable contains the final portion of a message's
13033 body while it is being delivered. The format and maximum size are as for
13034 &$message_body$&.
13035
13036 .vitem &$message_body_size$&
13037 .cindex "body of message" "size"
13038 .cindex "message body" "size"
13039 .vindex "&$message_body_size$&"
13040 When a message is being delivered, this variable contains the size of the body
13041 in bytes. The count starts from the character after the blank line that
13042 separates the body from the header. Newlines are included in the count. See
13043 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13044
13045 If the spool file is wireformat
13046 (see the &%spool_wireformat%& main option)
13047 the CRLF line-terminators are included in the count.
13048
13049 .vitem &$message_exim_id$&
13050 .vindex "&$message_exim_id$&"
13051 When a message is being received or delivered, this variable contains the
13052 unique message id that is generated and used by Exim to identify the message.
13053 An id is not created for a message until after its header has been successfully
13054 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13055 line; it is the local id that Exim assigns to the message, for example:
13056 &`1BXTIK-0001yO-VA`&.
13057
13058 .tvar &$message_headers$&
13059 This variable contains a concatenation of all the header lines when a message
13060 is being processed, except for lines added by routers or transports. The header
13061 lines are separated by newline characters. Their contents are decoded in the
13062 same way as a header line that is inserted by &%bheader%&.
13063
13064 .tvar &$message_headers_raw$&
13065 This variable is like &$message_headers$& except that no processing of the
13066 contents of header lines is done.
13067
13068 .vitem &$message_id$&
13069 This is an old name for &$message_exim_id$&. It is now deprecated.
13070
13071 .vitem &$message_linecount$&
13072 .vindex "&$message_linecount$&"
13073 This variable contains the total number of lines in the header and body of the
13074 message. Compare &$body_linecount$&, which is the count for the body only.
13075 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13076 number of lines received. Before delivery happens (that is, before filters,
13077 routers, and transports run) the count is increased to include the
13078 &'Received:'& header line that Exim standardly adds, and also any other header
13079 lines that are added by ACLs. The blank line that separates the message header
13080 from the body is not counted.
13081
13082 As with the special case of &$message_size$&, during the expansion of the
13083 appendfile transport's maildir_tag option in maildir format, the value of
13084 &$message_linecount$& is the precise size of the number of newlines in the
13085 file that has been written (minus one for the blank line between the
13086 header and the body).
13087
13088 Here is an example of the use of this variable in a DATA ACL:
13089 .code
13090 deny condition = \
13091       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13092      message   = Too many lines in message header
13093 .endd
13094 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13095 message has not yet been received.
13096
13097 This variable is not valid if the &%spool_wireformat%& option is used.
13098
13099 .vitem &$message_size$&
13100 .cindex "size" "of message"
13101 .cindex "message" "size"
13102 .vindex "&$message_size$&"
13103 When a message is being processed, this variable contains its size in bytes. In
13104 most cases, the size includes those headers that were received with the
13105 message, but not those (such as &'Envelope-to:'&) that are added to individual
13106 deliveries as they are written. However, there is one special case: during the
13107 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13108 doing a delivery in maildir format, the value of &$message_size$& is the
13109 precise size of the file that has been written. See also
13110 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13111
13112 .cindex "RCPT" "value of &$message_size$&"
13113 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13114 contains the size supplied on the MAIL command, or -1 if no size was given. The
13115 value may not, of course, be truthful.
13116
13117 .vitem &$mime_anomaly_level$& &&&
13118        &$mime_anomaly_text$& &&&
13119        &$mime_boundary$& &&&
13120        &$mime_charset$& &&&
13121        &$mime_content_description$& &&&
13122        &$mime_content_disposition$& &&&
13123        &$mime_content_id$& &&&
13124        &$mime_content_size$& &&&
13125        &$mime_content_transfer_encoding$& &&&
13126        &$mime_content_type$& &&&
13127        &$mime_decoded_filename$& &&&
13128        &$mime_filename$& &&&
13129        &$mime_is_coverletter$& &&&
13130        &$mime_is_multipart$& &&&
13131        &$mime_is_rfc822$& &&&
13132        &$mime_part_count$&
13133 A number of variables whose names start with &$mime$& are
13134 available when Exim is compiled with the content-scanning extension. For
13135 details, see section &<<SECTscanmimepart>>&.
13136
13137 .vitem "&$n0$& &-- &$n9$&"
13138 These variables are counters that can be incremented by means
13139 of the &%add%& command in filter files.
13140
13141 .tvar &$original_domain$&
13142 .vindex "&$domain$&"
13143 When a top-level address is being processed for delivery, this contains the
13144 same value as &$domain$&. However, if a &"child"& address (for example,
13145 generated by an alias, forward, or filter file) is being processed, this
13146 variable contains the domain of the original address (lower cased). This
13147 differs from &$parent_domain$& only when there is more than one level of
13148 aliasing or forwarding. When more than one address is being delivered in a
13149 single transport run, &$original_domain$& is not set.
13150
13151 If a new address is created by means of a &%deliver%& command in a system
13152 filter, it is set up with an artificial &"parent"& address. This has the local
13153 part &'system-filter'& and the default qualify domain.
13154
13155 .tvar &$original_local_part$&
13156 .vindex "&$local_part$&"
13157 When a top-level address is being processed for delivery, this contains the
13158 same value as &$local_part$&, unless a prefix or suffix was removed from the
13159 local part, because &$original_local_part$& always contains the full local
13160 part. When a &"child"& address (for example, generated by an alias, forward, or
13161 filter file) is being processed, this variable contains the full local part of
13162 the original address.
13163
13164 If the router that did the redirection processed the local part
13165 case-insensitively, the value in &$original_local_part$& is in lower case.
13166 This variable differs from &$parent_local_part$& only when there is more than
13167 one level of aliasing or forwarding. When more than one address is being
13168 delivered in a single transport run, &$original_local_part$& is not set.
13169
13170 If a new address is created by means of a &%deliver%& command in a system
13171 filter, it is set up with an artificial &"parent"& address. This has the local
13172 part &'system-filter'& and the default qualify domain.
13173
13174 .vitem &$originator_gid$&
13175 .cindex "gid (group id)" "of originating user"
13176 .cindex "sender" "gid"
13177 .vindex "&$caller_gid$&"
13178 .vindex "&$originator_gid$&"
13179 This variable contains the value of &$caller_gid$& that was set when the
13180 message was received. For messages received via the command line, this is the
13181 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13182 normally the gid of the Exim user.
13183
13184 .vitem &$originator_uid$&
13185 .cindex "uid (user id)" "of originating user"
13186 .cindex "sender" "uid"
13187 .vindex "&$caller_uid$&"
13188 .vindex "&$originator_uid$&"
13189 The value of &$caller_uid$& that was set when the message was received. For
13190 messages received via the command line, this is the uid of the sending user.
13191 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13192 user.
13193
13194 .tvar &$parent_domain$&
13195 This variable is similar to &$original_domain$& (see
13196 above), except that it refers to the immediately preceding parent address.
13197
13198 .tvar &$parent_local_part$&
13199 This variable is similar to &$original_local_part$&
13200 (see above), except that it refers to the immediately preceding parent address.
13201
13202 .vitem &$pid$&
13203 .cindex "pid (process id)" "of current process"
13204 .vindex "&$pid$&"
13205 This variable contains the current process id.
13206
13207 .vitem &$pipe_addresses$&
13208 .cindex "filter" "transport filter"
13209 .cindex "transport" "filter"
13210 .vindex "&$pipe_addresses$&"
13211 This is not an expansion variable, but is mentioned here because the string
13212 &`$pipe_addresses`& is handled specially in the command specification for the
13213 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13214 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13215 It cannot be used in general expansion strings, and provokes an &"unknown
13216 variable"& error if encountered.
13217 &*Note*&: This value permits data supplied by a potential attacker to
13218 be used in the command for a &(pipe)& transport.
13219 Such configurations should be carefully assessed for security vulnerbilities.
13220
13221 .vitem &$primary_hostname$&
13222 .vindex "&$primary_hostname$&"
13223 This variable contains the value set by &%primary_hostname%& in the
13224 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13225 a single-component name, Exim calls &[gethostbyname()]& (or
13226 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13227 qualified host name. See also &$smtp_active_hostname$&.
13228
13229
13230 .vitem &$proxy_external_address$& &&&
13231        &$proxy_external_port$& &&&
13232        &$proxy_local_address$& &&&
13233        &$proxy_local_port$& &&&
13234        &$proxy_session$&
13235 These variables are only available when built with Proxy Protocol
13236 or SOCKS5 support.
13237 For details see chapter &<<SECTproxyInbound>>&.
13238
13239 .vitem &$prdr_requested$&
13240 .cindex "PRDR" "variable for"
13241 This variable is set to &"yes"& if PRDR was requested by the client for the
13242 current message, otherwise &"no"&.
13243
13244 .vitem &$prvscheck_address$& &&&
13245        &$prvscheck_keynum$& &&&
13246        &$prvscheck_result$&
13247 These variables are used in conjunction with the &%prvscheck%& expansion item,
13248 which is described in sections &<<SECTexpansionitems>>& and
13249 &<<SECTverifyPRVS>>&.
13250
13251 .vitem &$qualify_domain$&
13252 .vindex "&$qualify_domain$&"
13253 The value set for the &%qualify_domain%& option in the configuration file.
13254
13255 .vitem &$qualify_recipient$&
13256 .vindex "&$qualify_recipient$&"
13257 The value set for the &%qualify_recipient%& option in the configuration file,
13258 or if not set, the value of &$qualify_domain$&.
13259
13260 .vitem &$queue_name$&
13261 .vindex &$queue_name$&
13262 .cindex "named queues" variable
13263 .cindex queues named
13264 The name of the spool queue in use; empty for the default queue.
13265
13266 .vitem &$queue_size$&
13267 .vindex "&$queue_size$&"
13268 .cindex "queue" "size of"
13269 .cindex "spool" "number of messages"
13270 This variable contains the number of messages queued.
13271 It is evaluated on demand, but no more often than once every minute.
13272 If there is no daemon notifier socket open, the value will be
13273 an empty string.
13274
13275 .vitem &$r_...$&
13276 .vindex &$r_...$&
13277 .cindex router variables
13278 Values can be placed in these variables by the &%set%& option of a router.
13279 They can be given any name that starts with &$r_$&.
13280 The values persist for the address being handled through subsequent routers
13281 and the eventual transport.
13282
13283 .vitem &$rcpt_count$&
13284 .vindex "&$rcpt_count$&"
13285 When a message is being received by SMTP, this variable contains the number of
13286 RCPT commands received for the current message. If this variable is used in a
13287 RCPT ACL, its value includes the current command.
13288
13289 .vitem &$rcpt_defer_count$&
13290 .vindex "&$rcpt_defer_count$&"
13291 .cindex "4&'xx'& responses" "count of"
13292 When a message is being received by SMTP, this variable contains the number of
13293 RCPT commands in the current message that have previously been rejected with a
13294 temporary (4&'xx'&) response.
13295
13296 .vitem &$rcpt_fail_count$&
13297 .vindex "&$rcpt_fail_count$&"
13298 When a message is being received by SMTP, this variable contains the number of
13299 RCPT commands in the current message that have previously been rejected with a
13300 permanent (5&'xx'&) response.
13301
13302 .vitem &$received_count$&
13303 .vindex "&$received_count$&"
13304 This variable contains the number of &'Received:'& header lines in the message,
13305 including the one added by Exim (so its value is always greater than zero). It
13306 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13307 delivering.
13308
13309 .tvar &$received_for$&
13310 If there is only a single recipient address in an incoming message, this
13311 variable contains that address when the &'Received:'& header line is being
13312 built. The value is copied after recipient rewriting has happened, but before
13313 the &[local_scan()]& function is run.
13314
13315 .vitem &$received_ip_address$& &&&
13316        &$received_port$&
13317 .vindex "&$received_ip_address$&"
13318 .vindex "&$received_port$&"
13319 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13320 variables are set to the address and port on the local IP interface.
13321 (The remote IP address and port are in
13322 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13323 the port value is -1 unless it has been set using the &%-oMi%& command line
13324 option.
13325
13326 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13327 could be used, for example, to make the filename for a TLS certificate depend
13328 on which interface and/or port is being used for the incoming connection. The
13329 values of &$received_ip_address$& and &$received_port$& are saved with any
13330 messages that are received, thus making these variables available at delivery
13331 time.
13332 For outbound connections see &$sending_ip_address$&.
13333
13334 .vitem &$received_protocol$&
13335 .vindex "&$received_protocol$&"
13336 When a message is being processed, this variable contains the name of the
13337 protocol by which it was received. Most of the names used by Exim are defined
13338 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13339 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13340 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13341 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13342 connection and the client was successfully authenticated.
13343
13344 Exim uses the protocol name &"smtps"& for the case when encryption is
13345 automatically set up on connection without the use of STARTTLS (see
13346 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13347 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13348 where the client initially uses EHLO, sets up an encrypted connection using
13349 STARTTLS, and then uses HELO afterwards.
13350
13351 The &%-oMr%& option provides a way of specifying a custom protocol name for
13352 messages that are injected locally by trusted callers. This is commonly used to
13353 identify messages that are being re-injected after some kind of scanning.
13354
13355 .vitem &$received_time$&
13356 .vindex "&$received_time$&"
13357 This variable contains the date and time when the current message was received,
13358 as a number of seconds since the start of the Unix epoch.
13359
13360 .vitem &$recipient_data$&
13361 .vindex "&$recipient_data$&"
13362 This variable is set after an indexing lookup success in an ACL &%recipients%&
13363 condition. It contains the data from the lookup, and the value remains set
13364 until the next &%recipients%& test. Thus, you can do things like this:
13365 .display
13366 &`require recipients  = cdb*@;/some/file`&
13367 &`deny    `&&'some further test involving'& &`$recipient_data`&
13368 .endd
13369 &*Warning*&: This variable is set only when a lookup is used as an indexing
13370 method in the address list, using the semicolon syntax as in the example above.
13371 The variable is not set for a lookup that is used as part of the string
13372 expansion that all such lists undergo before being interpreted.
13373
13374 .vitem &$recipient_verify_failure$&
13375 .vindex "&$recipient_verify_failure$&"
13376 In an ACL, when a recipient verification fails, this variable contains
13377 information about the failure. It is set to one of the following words:
13378
13379 .ilist
13380 &"qualify"&: The address was unqualified (no domain), and the message
13381 was neither local nor came from an exempted host.
13382
13383 .next
13384 &"route"&: Routing failed.
13385
13386 .next
13387 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13388 or before the MAIL command (that is, on initial connection, HELO, or
13389 MAIL).
13390
13391 .next
13392 &"recipient"&: The RCPT command in a callout was rejected.
13393 .next
13394
13395 &"postmaster"&: The postmaster check in a callout was rejected.
13396 .endlist
13397
13398 The main use of this variable is expected to be to distinguish between
13399 rejections of MAIL and rejections of RCPT.
13400
13401 .tvar &$recipients$&
13402 This variable contains a list of envelope recipients for a message. A comma and
13403 a space separate the addresses in the replacement text. However, the variable
13404 is not generally available, to prevent exposure of Bcc recipients in
13405 unprivileged users' filter files. You can use &$recipients$& only in these
13406 cases:
13407
13408 .olist
13409 In a system filter file.
13410 .next
13411 In the ACLs associated with the DATA command and with non-SMTP messages, that
13412 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13413 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13414 &%acl_not_smtp_mime%&.
13415 .next
13416 From within a &[local_scan()]& function.
13417 .endlist
13418
13419
13420 .vitem &$recipients_count$&
13421 .vindex "&$recipients_count$&"
13422 When a message is being processed, this variable contains the number of
13423 envelope recipients that came with the message. Duplicates are not excluded
13424 from the count. While a message is being received over SMTP, the number
13425 increases for each accepted recipient. It can be referenced in an ACL.
13426
13427
13428 .vitem &$regex_match_string$&
13429 .vindex "&$regex_match_string$&"
13430 This variable is set to contain the matching regular expression after a
13431 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13432
13433 .vitem "&$regex1$&, &$regex2$&, etc"
13434 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13435 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13436 these variables contain the
13437 captured substrings identified by the regular expression.
13438 If the subject string was tainted then so will any captured substring.
13439
13440
13441 .tvar &$reply_address$&
13442 When a message is being processed, this variable contains the contents of the
13443 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13444 contents of the &'From:'& header line. Apart from the removal of leading
13445 white space, the value is not processed in any way. In particular, no RFC 2047
13446 decoding or character code translation takes place.
13447
13448 .vitem &$return_path$&
13449 .vindex "&$return_path$&"
13450 When a message is being delivered, this variable contains the return path &--
13451 the sender field that will be sent as part of the envelope. It is not enclosed
13452 in <> characters. At the start of routing an address, &$return_path$& has the
13453 same value as &$sender_address$&, but if, for example, an incoming message to a
13454 mailing list has been expanded by a router which specifies a different address
13455 for bounce messages, &$return_path$& subsequently contains the new bounce
13456 address, whereas &$sender_address$& always contains the original sender address
13457 that was received with the message. In other words, &$sender_address$& contains
13458 the incoming envelope sender, and &$return_path$& contains the outgoing
13459 envelope sender.
13460
13461 .vitem &$return_size_limit$&
13462 .vindex "&$return_size_limit$&"
13463 This is an obsolete name for &$bounce_return_size_limit$&.
13464
13465 .vitem &$router_name$&
13466 .cindex "router" "name"
13467 .cindex "name" "of router"
13468 .vindex "&$router_name$&"
13469 During the running of a router, or a transport called,
13470 this variable contains the router name.
13471
13472 .vitem &$runrc$&
13473 .cindex "return code" "from &%run%& expansion"
13474 .vindex "&$runrc$&"
13475 This variable contains the return code from a command that is run by the
13476 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13477 assume the order in which option values are expanded, except for those
13478 preconditions whose order of testing is documented. Therefore, you cannot
13479 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13480 another.
13481
13482 .vitem &$self_hostname$&
13483 .oindex "&%self%&" "value of host name"
13484 .vindex "&$self_hostname$&"
13485 When an address is routed to a supposedly remote host that turns out to be the
13486 local host, what happens is controlled by the &%self%& generic router option.
13487 One of its values causes the address to be passed to another router. When this
13488 happens, &$self_hostname$& is set to the name of the local host that the
13489 original router encountered. In other circumstances its contents are null.
13490
13491 .tvar &$sender_address$&
13492 When a message is being processed, this variable contains the sender's address
13493 that was received in the message's envelope. The case of letters in the address
13494 is retained, in both the local part and the domain. For bounce messages, the
13495 value of this variable is the empty string. See also &$return_path$&.
13496
13497 .vitem &$sender_address_data$&
13498 .vindex "&$address_data$&"
13499 .vindex "&$sender_address_data$&"
13500 If &$address_data$& is set when the routers are called from an ACL to verify a
13501 sender address, the final value is preserved in &$sender_address_data$&, to
13502 distinguish it from data from a recipient address. The value does not persist
13503 after the end of the current ACL statement. If you want to preserve it for
13504 longer, you can save it in an ACL variable.
13505
13506 .tvar &$sender_address_domain$&
13507 The domain portion of &$sender_address$&.
13508
13509 .tvar &$sender_address_local_part$&
13510 The local part portion of &$sender_address$&.
13511
13512 .vitem &$sender_data$&
13513 .vindex "&$sender_data$&"
13514 This variable is set after a lookup success in an ACL &%senders%& condition or
13515 in a router &%senders%& option. It contains the data from the lookup, and the
13516 value remains set until the next &%senders%& test. Thus, you can do things like
13517 this:
13518 .display
13519 &`require senders      = cdb*@;/some/file`&
13520 &`deny    `&&'some further test involving'& &`$sender_data`&
13521 .endd
13522 &*Warning*&: This variable is set only when a lookup is used as an indexing
13523 method in the address list, using the semicolon syntax as in the example above.
13524 The variable is not set for a lookup that is used as part of the string
13525 expansion that all such lists undergo before being interpreted.
13526
13527 .vitem &$sender_fullhost$&
13528 .vindex "&$sender_fullhost$&"
13529 When a message is received from a remote host, this variable contains the host
13530 name and IP address in a single string. It ends with the IP address in square
13531 brackets, followed by a colon and a port number if the logging of ports is
13532 enabled. The format of the rest of the string depends on whether the host
13533 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13534 looking up its IP address. (Looking up the IP address can be forced by the
13535 &%host_lookup%& option, independent of verification.) A plain host name at the
13536 start of the string is a verified host name; if this is not present,
13537 verification either failed or was not requested. A host name in parentheses is
13538 the argument of a HELO or EHLO command. This is omitted if it is identical to
13539 the verified host name or to the host's IP address in square brackets.
13540
13541 .vitem &$sender_helo_dnssec$&
13542 .vindex "&$sender_helo_dnssec$&"
13543 This boolean variable is true if a successful HELO verification was
13544 .cindex "DNS" "DNSSEC"
13545 done using DNS information the resolver library stated was authenticated data.
13546
13547 .tvar &$sender_helo_name$&
13548 When a message is received from a remote host that has issued a HELO or EHLO
13549 command, the argument of that command is placed in this variable. It is also
13550 set if HELO or EHLO is used when a message is received using SMTP locally via
13551 the &%-bs%& or &%-bS%& options.
13552
13553 .vitem &$sender_host_address$&
13554 .vindex "&$sender_host_address$&"
13555 When a message is received from a remote host using SMTP,
13556 this variable contains that
13557 host's IP address. For locally non-SMTP submitted messages, it is empty.
13558
13559 .vitem &$sender_host_authenticated$&
13560 .vindex "&$sender_host_authenticated$&"
13561 This variable contains the name (not the public name) of the authenticator
13562 driver that successfully authenticated the client from which the message was
13563 received. It is empty if there was no successful authentication. See also
13564 &$authenticated_id$&.
13565
13566 .vitem &$sender_host_dnssec$&
13567 .vindex "&$sender_host_dnssec$&"
13568 If an attempt to populate &$sender_host_name$& has been made
13569 (by reference, &%hosts_lookup%& or
13570 otherwise) then this boolean will have been set true if, and only if, the
13571 resolver library states that both
13572 the reverse and forward DNS were authenticated data.  At all
13573 other times, this variable is false.
13574
13575 .cindex "DNS" "DNSSEC"
13576 It is likely that you will need to coerce DNSSEC support on in the resolver
13577 library, by setting:
13578 .code
13579 dns_dnssec_ok = 1
13580 .endd
13581
13582 In addition, on Linux with glibc 2.31 or newer the resolver library will
13583 default to stripping out a successful validation status.
13584 This will break a previously working Exim installation.
13585 Provided that you do trust the resolver (ie, is on localhost) you can tell
13586 glibc to pass through any successful validation with a new option in
13587 &_/etc/resolv.conf_&:
13588 .code
13589 options trust-ad
13590 .endd
13591
13592 Exim does not perform DNSSEC validation itself, instead leaving that to a
13593 validating resolver (e.g. unbound, or bind with suitable configuration).
13594
13595 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13596 mechanism in the list, then this variable will be false.
13597
13598 This requires that your system resolver library support EDNS0 (and that
13599 DNSSEC flags exist in the system headers).  If the resolver silently drops
13600 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13601 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13602
13603
13604 .tvar &$sender_host_name$&
13605 When a message is received from a remote host, this variable contains the
13606 host's name as obtained by looking up its IP address. For messages received by
13607 other means, this variable is empty.
13608
13609 .vindex "&$host_lookup_failed$&"
13610 If the host name has not previously been looked up, a reference to
13611 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13612 A looked up name is accepted only if it leads back to the original IP address
13613 via a forward lookup. If either the reverse or the forward lookup fails to find
13614 any data, or if the forward lookup does not yield the original IP address,
13615 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13616
13617 .vindex "&$host_lookup_deferred$&"
13618 However, if either of the lookups cannot be completed (for example, there is a
13619 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13620 &$host_lookup_failed$& remains set to &"0"&.
13621
13622 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13623 host name again if there is a subsequent reference to &$sender_host_name$&
13624 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13625 is set to &"1"&.
13626
13627 Exim does not automatically look up every calling host's name. If you want
13628 maximum efficiency, you should arrange your configuration so that it avoids
13629 these lookups altogether. The lookup happens only if one or more of the
13630 following are true:
13631
13632 .ilist
13633 A string containing &$sender_host_name$& is expanded.
13634 .next
13635 The calling host matches the list in &%host_lookup%&. In the default
13636 configuration, this option is set to *, so it must be changed if lookups are
13637 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13638 .next
13639 Exim needs the host name in order to test an item in a host list. The items
13640 that require this are described in sections &<<SECThoslispatnam>>& and
13641 &<<SECThoslispatnamsk>>&.
13642 .next
13643 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13644 In this case, the host name is required to compare with the name quoted in any
13645 EHLO or HELO commands that the client issues.
13646 .next
13647 The remote host issues a EHLO or HELO command that quotes one of the
13648 domains in &%helo_lookup_domains%&. The default value of this option is
13649 . ==== As this is a nested list, any displays it contains must be indented
13650 . ==== as otherwise they are too far to the left.
13651 .code
13652   helo_lookup_domains = @ : @[]
13653 .endd
13654 which causes a lookup if a remote host (incorrectly) gives the server's name or
13655 IP address in an EHLO or HELO command.
13656 .endlist
13657
13658
13659 .vitem &$sender_host_port$&
13660 .vindex "&$sender_host_port$&"
13661 When a message is received from a remote host, this variable contains the port
13662 number that was used on the remote host.
13663
13664 .vitem &$sender_ident$&
13665 .vindex "&$sender_ident$&"
13666 When a message is received from a remote host, this variable contains the
13667 identification received in response to an RFC 1413 request. When a message has
13668 been received locally, this variable contains the login name of the user that
13669 called Exim.
13670
13671 .vitem &$sender_rate_$&&'xxx'&
13672 A number of variables whose names begin &$sender_rate_$& are set as part of the
13673 &%ratelimit%& ACL condition. Details are given in section
13674 &<<SECTratelimiting>>&.
13675
13676 .vitem &$sender_rcvhost$&
13677 .cindex "DNS" "reverse lookup"
13678 .cindex "reverse DNS lookup"
13679 .vindex "&$sender_rcvhost$&"
13680 This is provided specifically for use in &'Received:'& headers. It starts with
13681 either the verified host name (as obtained from a reverse DNS lookup) or, if
13682 there is no verified host name, the IP address in square brackets. After that
13683 there may be text in parentheses. When the first item is a verified host name,
13684 the first thing in the parentheses is the IP address in square brackets,
13685 followed by a colon and a port number if port logging is enabled. When the
13686 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13687 the parentheses.
13688
13689 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13690 was used and its argument was not identical to the real host name or IP
13691 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13692 all three items are present in the parentheses, a newline and tab are inserted
13693 into the string, to improve the formatting of the &'Received:'& header.
13694
13695 .vitem &$sender_verify_failure$&
13696 .vindex "&$sender_verify_failure$&"
13697 In an ACL, when a sender verification fails, this variable contains information
13698 about the failure. The details are the same as for
13699 &$recipient_verify_failure$&.
13700
13701 .vitem &$sending_ip_address$&
13702 .vindex "&$sending_ip_address$&"
13703 This variable is set whenever an outgoing SMTP connection to another host has
13704 been set up. It contains the IP address of the local interface that is being
13705 used. This is useful if a host that has more than one IP address wants to take
13706 on different personalities depending on which one is being used. For incoming
13707 connections, see &$received_ip_address$&.
13708
13709 .vitem &$sending_port$&
13710 .vindex "&$sending_port$&"
13711 This variable is set whenever an outgoing SMTP connection to another host has
13712 been set up. It contains the local port that is being used. For incoming
13713 connections, see &$received_port$&.
13714
13715 .vitem &$smtp_active_hostname$&
13716 .vindex "&$smtp_active_hostname$&"
13717 During an incoming SMTP session, this variable contains the value of the active
13718 host name, as specified by the &%smtp_active_hostname%& option. The value of
13719 &$smtp_active_hostname$& is saved with any message that is received, so its
13720 value can be consulted during routing and delivery.
13721
13722 .tvar &$smtp_command$&
13723 During the processing of an incoming SMTP command, this variable contains the
13724 entire command. This makes it possible to distinguish between HELO and EHLO in
13725 the HELO ACL, and also to distinguish between commands such as these:
13726 .code
13727 MAIL FROM:<>
13728 MAIL FROM: <>
13729 .endd
13730 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13731 command, the address in &$smtp_command$& is the original address before any
13732 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13733 the address after SMTP-time rewriting.
13734
13735 .tvar &$smtp_command_argument$&
13736 .cindex "SMTP" "command, argument for"
13737 While an ACL is running to check an SMTP command, this variable contains the
13738 argument, that is, the text that follows the command name, with leading white
13739 space removed. Following the introduction of &$smtp_command$&, this variable is
13740 somewhat redundant, but is retained for backwards compatibility.
13741
13742 .vitem &$smtp_command_history$&
13743 .cindex SMTP "command history"
13744 .vindex "&$smtp_command_history$&"
13745 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13746 received, in time-order left to right.  Only a limited number of commands
13747 are remembered.
13748
13749 .vitem &$smtp_count_at_connection_start$&
13750 .vindex "&$smtp_count_at_connection_start$&"
13751 This variable is set greater than zero only in processes spawned by the Exim
13752 daemon for handling incoming SMTP connections. The name is deliberately long,
13753 in order to emphasize what the contents are. When the daemon accepts a new
13754 connection, it increments this variable. A copy of the variable is passed to
13755 the child process that handles the connection, but its value is fixed, and
13756 never changes. It is only an approximation of how many incoming connections
13757 there actually are, because many other connections may come and go while a
13758 single connection is being processed. When a child process terminates, the
13759 daemon decrements its copy of the variable.
13760
13761 .vitem &$smtp_notquit_reason$&
13762 .vindex "&$smtp_notquit_reason$&"
13763 When the not-QUIT ACL is running, this variable is set to a string
13764 that indicates the reason for the termination of the SMTP connection.
13765
13766 .vitem "&$sn0$& &-- &$sn9$&"
13767 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13768 that were current at the end of the system filter file. This allows a system
13769 filter file to set values that can be tested in users' filter files. For
13770 example, a system filter could set a value indicating how likely it is that a
13771 message is junk mail.
13772
13773 .vitem &$spam_score$& &&&
13774        &$spam_score_int$& &&&
13775        &$spam_bar$& &&&
13776        &$spam_report$& &&&
13777        &$spam_action$&
13778 A number of variables whose names start with &$spam$& are available when Exim
13779 is compiled with the content-scanning extension. For details, see section
13780 &<<SECTscanspamass>>&.
13781
13782 .vitem &$spf_header_comment$& &&&
13783        &$spf_received$& &&&
13784        &$spf_result$& &&&
13785        &$spf_result_guessed$& &&&
13786        &$spf_smtp_comment$&
13787 These variables are only available if Exim is built with SPF support.
13788 For details see section &<<SECSPF>>&.
13789
13790 .vitem &$spool_directory$&
13791 .vindex "&$spool_directory$&"
13792 The name of Exim's spool directory.
13793
13794 .vitem &$spool_inodes$&
13795 .vindex "&$spool_inodes$&"
13796 The number of free inodes in the disk partition where Exim's spool files are
13797 being written. The value is recalculated whenever the variable is referenced.
13798 If the relevant file system does not have the concept of inodes, the value of
13799 is -1. See also the &%check_spool_inodes%& option.
13800
13801 .vitem &$spool_space$&
13802 .vindex "&$spool_space$&"
13803 The amount of free space (as a number of kilobytes) in the disk partition where
13804 Exim's spool files are being written. The value is recalculated whenever the
13805 variable is referenced. If the operating system does not have the ability to
13806 find the amount of free space (only true for experimental systems), the space
13807 value is -1. For example, to check in an ACL that there is at least 50
13808 megabytes free on the spool, you could write:
13809 .code
13810 condition = ${if > {$spool_space}{50000}}
13811 .endd
13812 See also the &%check_spool_space%& option.
13813
13814
13815 .vitem &$thisaddress$&
13816 .vindex "&$thisaddress$&"
13817 This variable is set only during the processing of the &%foranyaddress%&
13818 command in a filter file. Its use is explained in the description of that
13819 command, which can be found in the separate document entitled &'Exim's
13820 interfaces to mail filtering'&.
13821
13822 .vitem &$tls_in_bits$&
13823 .vindex "&$tls_in_bits$&"
13824 Contains an approximation of the TLS cipher's bit-strength
13825 on the inbound connection; the meaning of
13826 this depends upon the TLS implementation used.
13827 If TLS has not been negotiated, the value will be 0.
13828 The value of this is automatically fed into the Cyrus SASL authenticator
13829 when acting as a server, to specify the "external SSF" (a SASL term).
13830
13831 The deprecated &$tls_bits$& variable refers to the inbound side
13832 except when used in the context of an outbound SMTP delivery, when it refers to
13833 the outbound.
13834
13835 .vitem &$tls_out_bits$&
13836 .vindex "&$tls_out_bits$&"
13837 Contains an approximation of the TLS cipher's bit-strength
13838 on an outbound SMTP connection; the meaning of
13839 this depends upon the TLS implementation used.
13840 If TLS has not been negotiated, the value will be 0.
13841
13842 .vitem &$tls_in_ourcert$&
13843 .vindex "&$tls_in_ourcert$&"
13844 .cindex certificate variables
13845 This variable refers to the certificate presented to the peer of an
13846 inbound connection when the message was received.
13847 It is only useful as the argument of a
13848 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13849 or a &%def%& condition.
13850
13851 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13852 when a list of more than one
13853 file is used for &%tls_certificate%&, this variable is not reliable.
13854 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13855
13856 .vitem &$tls_in_peercert$&
13857 .vindex "&$tls_in_peercert$&"
13858 This variable refers to the certificate presented by the peer of an
13859 inbound connection when the message was received.
13860 It is only useful as the argument of a
13861 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13862 or a &%def%& condition.
13863 If certificate verification fails it may refer to a failing chain element
13864 which is not the leaf.
13865
13866 .vitem &$tls_out_ourcert$&
13867 .vindex "&$tls_out_ourcert$&"
13868 This variable refers to the certificate presented to the peer of an
13869 outbound connection.  It is only useful as the argument of a
13870 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13871 or a &%def%& condition.
13872
13873 .vitem &$tls_out_peercert$&
13874 .vindex "&$tls_out_peercert$&"
13875 This variable refers to the certificate presented by the peer of an
13876 outbound connection.  It is only useful as the argument of a
13877 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13878 or a &%def%& condition.
13879 If certificate verification fails it may refer to a failing chain element
13880 which is not the leaf.
13881
13882 .vitem &$tls_in_certificate_verified$&
13883 .vindex "&$tls_in_certificate_verified$&"
13884 This variable is set to &"1"& if a TLS certificate was verified when the
13885 message was received, and &"0"& otherwise.
13886
13887 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13888 except when used in the context of an outbound SMTP delivery, when it refers to
13889 the outbound.
13890
13891 .vitem &$tls_out_certificate_verified$&
13892 .vindex "&$tls_out_certificate_verified$&"
13893 This variable is set to &"1"& if a TLS certificate was verified when an
13894 outbound SMTP connection was made,
13895 and &"0"& otherwise.
13896
13897 .vitem &$tls_in_cipher$&
13898 .vindex "&$tls_in_cipher$&"
13899 .vindex "&$tls_cipher$&"
13900 When a message is received from a remote host over an encrypted SMTP
13901 connection, this variable is set to the cipher suite that was negotiated, for
13902 example DES-CBC3-SHA. In other circumstances, in particular, for message
13903 received over unencrypted connections, the variable is empty. Testing
13904 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13905 non-encrypted connections during ACL processing.
13906
13907 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13908 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13909 becomes the same as &$tls_out_cipher$&.
13910
13911 .vitem &$tls_in_cipher_std$&
13912 .vindex "&$tls_in_cipher_std$&"
13913 As above, but returning the RFC standard name for the cipher suite.
13914
13915 .vitem &$tls_out_cipher$&
13916 .vindex "&$tls_out_cipher$&"
13917 This variable is
13918 cleared before any outgoing SMTP connection is made,
13919 and then set to the outgoing cipher suite if one is negotiated. See chapter
13920 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13921 details of the &(smtp)& transport.
13922
13923 .vitem &$tls_out_cipher_std$&
13924 .vindex "&$tls_out_cipher_std$&"
13925 As above, but returning the RFC standard name for the cipher suite.
13926
13927 .vitem &$tls_out_dane$&
13928 .vindex &$tls_out_dane$&
13929 DANE active status.  See section &<<SECDANE>>&.
13930
13931 .vitem &$tls_in_ocsp$&
13932 .vindex "&$tls_in_ocsp$&"
13933 When a message is received from a remote client connection
13934 the result of any OCSP request from the client is encoded in this variable:
13935 .code
13936 0 OCSP proof was not requested (default value)
13937 1 No response to request
13938 2 Response not verified
13939 3 Verification failed
13940 4 Verification succeeded
13941 .endd
13942
13943 .vitem &$tls_out_ocsp$&
13944 .vindex "&$tls_out_ocsp$&"
13945 When a message is sent to a remote host connection
13946 the result of any OCSP request made is encoded in this variable.
13947 See &$tls_in_ocsp$& for values.
13948
13949 .vitem &$tls_in_peerdn$&
13950 .vindex "&$tls_in_peerdn$&"
13951 .vindex "&$tls_peerdn$&"
13952 .cindex certificate "extracting fields"
13953 When a message is received from a remote host over an encrypted SMTP
13954 connection, and Exim is configured to request a certificate from the client,
13955 the value of the Distinguished Name of the certificate is made available in the
13956 &$tls_in_peerdn$& during subsequent processing.
13957 If certificate verification fails it may refer to a failing chain element
13958 which is not the leaf.
13959
13960 The deprecated &$tls_peerdn$& variable refers to the inbound side
13961 except when used in the context of an outbound SMTP delivery, when it refers to
13962 the outbound.
13963
13964 .vitem &$tls_out_peerdn$&
13965 .vindex "&$tls_out_peerdn$&"
13966 When a message is being delivered to a remote host over an encrypted SMTP
13967 connection, and Exim is configured to request a certificate from the server,
13968 the value of the Distinguished Name of the certificate is made available in the
13969 &$tls_out_peerdn$& during subsequent processing.
13970 If certificate verification fails it may refer to a failing chain element
13971 which is not the leaf.
13972
13973
13974 .vitem &$tls_in_resumption$& &&&
13975        &$tls_out_resumption$&
13976 .vindex &$tls_in_resumption$&
13977 .vindex &$tls_out_resumption$&
13978 .cindex TLS resumption
13979 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13980
13981
13982 .tvar &$tls_in_sni$&
13983 .vindex "&$tls_sni$&"
13984 .cindex "TLS" "Server Name Indication"
13985 .cindex "TLS" SNI
13986 .cindex SNI "observability on server"
13987 When a TLS session is being established, if the client sends the Server
13988 Name Indication extension, the value will be placed in this variable.
13989 If the variable appears in &%tls_certificate%& then this option and
13990 some others, described in &<<SECTtlssni>>&,
13991 will be re-expanded early in the TLS session, to permit
13992 a different certificate to be presented (and optionally a different key to be
13993 used) to the client, based upon the value of the SNI extension.
13994
13995 The deprecated &$tls_sni$& variable refers to the inbound side
13996 except when used in the context of an outbound SMTP delivery, when it refers to
13997 the outbound.
13998
13999 .vitem &$tls_out_sni$&
14000 .vindex "&$tls_out_sni$&"
14001 .cindex "TLS" "Server Name Indication"
14002 .cindex "TLS" SNI
14003 .cindex SNI "observability in client"
14004 During outbound
14005 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14006 the transport.
14007
14008 .vitem &$tls_out_tlsa_usage$&
14009 .vindex &$tls_out_tlsa_usage$&
14010 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14011
14012 .vitem &$tls_in_ver$&
14013 .vindex "&$tls_in_ver$&"
14014 When a message is received from a remote host over an encrypted SMTP connection
14015 this variable is set to the protocol version, eg &'TLS1.2'&.
14016
14017 .vitem &$tls_out_ver$&
14018 .vindex "&$tls_out_ver$&"
14019 When a message is being delivered to a remote host over an encrypted SMTP connection
14020 this variable is set to the protocol version.
14021
14022
14023 .vitem &$tod_bsdinbox$&
14024 .vindex "&$tod_bsdinbox$&"
14025 The time of day and the date, in the format required for BSD-style mailbox
14026 files, for example: Thu Oct 17 17:14:09 1995.
14027
14028 .vitem &$tod_epoch$&
14029 .vindex "&$tod_epoch$&"
14030 The time and date as a number of seconds since the start of the Unix epoch.
14031
14032 .vitem &$tod_epoch_l$&
14033 .vindex "&$tod_epoch_l$&"
14034 The time and date as a number of microseconds since the start of the Unix epoch.
14035
14036 .vitem &$tod_full$&
14037 .vindex "&$tod_full$&"
14038 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14039 +0100. The timezone is always given as a numerical offset from UTC, with
14040 positive values used for timezones that are ahead (east) of UTC, and negative
14041 values for those that are behind (west).
14042
14043 .vitem &$tod_log$&
14044 .vindex "&$tod_log$&"
14045 The time and date in the format used for writing Exim's log files, for example:
14046 1995-10-12 15:32:29, but without a timezone.
14047
14048 .vitem &$tod_logfile$&
14049 .vindex "&$tod_logfile$&"
14050 This variable contains the date in the format yyyymmdd. This is the format that
14051 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14052 flag.
14053
14054 .vitem &$tod_zone$&
14055 .vindex "&$tod_zone$&"
14056 This variable contains the numerical value of the local timezone, for example:
14057 -0500.
14058
14059 .vitem &$tod_zulu$&
14060 .vindex "&$tod_zulu$&"
14061 This variable contains the UTC date and time in &"Zulu"& format, as specified
14062 by ISO 8601, for example: 20030221154023Z.
14063
14064 .vitem &$transport_name$&
14065 .cindex "transport" "name"
14066 .cindex "name" "of transport"
14067 .vindex "&$transport_name$&"
14068 During the running of a transport, this variable contains its name.
14069
14070 .vitem &$value$&
14071 .vindex "&$value$&"
14072 This variable contains the result of an expansion lookup, extraction operation,
14073 or external command, as described above. It is also used during a
14074 &*reduce*& expansion.
14075
14076 .vitem &$verify_mode$&
14077 .vindex "&$verify_mode$&"
14078 While a router or transport is being run in verify mode or for cutthrough delivery,
14079 contains "S" for sender-verification or "R" for recipient-verification.
14080 Otherwise, empty.
14081
14082 .vitem &$version_number$&
14083 .vindex "&$version_number$&"
14084 The version number of Exim. Same as &$exim_version$&, may be overridden
14085 by the &%exim_version%& main config option.
14086
14087 .vitem &$warn_message_delay$&
14088 .vindex "&$warn_message_delay$&"
14089 This variable is set only during the creation of a message warning about a
14090 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14091
14092 .vitem &$warn_message_recipients$&
14093 .vindex "&$warn_message_recipients$&"
14094 This variable is set only during the creation of a message warning about a
14095 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14096 .endlist
14097 .ecindex IIDstrexp
14098
14099
14100
14101 . ////////////////////////////////////////////////////////////////////////////
14102 . ////////////////////////////////////////////////////////////////////////////
14103
14104 .chapter "Embedded Perl" "CHAPperl"
14105 .scindex IIDperl "Perl" "calling from Exim"
14106 Exim can be built to include an embedded Perl interpreter. When this is done,
14107 Perl subroutines can be called as part of the string expansion process. To make
14108 use of the Perl support, you need version 5.004 or later of Perl installed on
14109 your system. To include the embedded interpreter in the Exim binary, include
14110 the line
14111 .code
14112 EXIM_PERL = perl.o
14113 .endd
14114 in your &_Local/Makefile_& and then build Exim in the normal way.
14115
14116
14117 .section "Setting up so Perl can be used" "SECID85"
14118 .oindex "&%perl_startup%&"
14119 Access to Perl subroutines is via a global configuration option called
14120 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14121 no &%perl_startup%& option in the Exim configuration file then no Perl
14122 interpreter is started and there is almost no overhead for Exim (since none of
14123 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14124 option then the associated value is taken to be Perl code which is executed in
14125 a newly created Perl interpreter.
14126
14127 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14128 need backslashes before any characters to escape special meanings. The option
14129 should usually be something like
14130 .code
14131 perl_startup = do '/etc/exim.pl'
14132 .endd
14133 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14134 use from Exim. Exim can be configured either to start up a Perl interpreter as
14135 soon as it is entered, or to wait until the first time it is needed. Starting
14136 the interpreter at the beginning ensures that it is done while Exim still has
14137 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14138 fact used in a particular run. Also, note that this does not mean that Exim is
14139 necessarily running as root when Perl is called at a later time. By default,
14140 the interpreter is started only when it is needed, but this can be changed in
14141 two ways:
14142
14143 .ilist
14144 .oindex "&%perl_at_start%&"
14145 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14146 a startup when Exim is entered.
14147 .next
14148 The command line option &%-ps%& also requests a startup when Exim is entered,
14149 overriding the setting of &%perl_at_start%&.
14150 .endlist
14151
14152 There is also a command line option &%-pd%& (for delay) which suppresses the
14153 initial startup, even if &%perl_at_start%& is set.
14154
14155 .ilist
14156 .oindex "&%perl_taintmode%&"
14157 .cindex "Perl" "taintmode"
14158 To provide more security executing Perl code via the embedded Perl
14159 interpreter, the &%perl_taintmode%& option can be set. This enables the
14160 taint mode of the Perl interpreter. You are encouraged to set this
14161 option to a true value. To avoid breaking existing installations, it
14162 defaults to false.
14163
14164 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14165
14166
14167 .section "Calling Perl subroutines" "SECID86"
14168 When the configuration file includes a &%perl_startup%& option you can make use
14169 of the string expansion item to call the Perl subroutines that are defined
14170 by the &%perl_startup%& code. The operator is used in any of the following
14171 forms:
14172 .code
14173 ${perl{foo}}
14174 ${perl{foo}{argument}}
14175 ${perl{foo}{argument1}{argument2} ... }
14176 .endd
14177 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14178 arguments may be passed. Passing more than this results in an expansion failure
14179 with an error message of the form
14180 .code
14181 Too many arguments passed to Perl subroutine "foo" (max is 8)
14182 .endd
14183 The return value of the Perl subroutine is evaluated in a scalar context before
14184 it is passed back to Exim to be inserted into the expanded string. If the
14185 return value is &'undef'&, the expansion is forced to fail in the same way as
14186 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14187 by obeying Perl's &%die%& function, the expansion fails with the error message
14188 that was passed to &%die%&.
14189
14190
14191 .section "Calling Exim functions from Perl" "SECID87"
14192 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14193 is available to call back into Exim's string expansion function. For example,
14194 the Perl code
14195 .code
14196 my $lp = Exim::expand_string('$local_part');
14197 .endd
14198 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14199 Note those are single quotes and not double quotes to protect against
14200 &$local_part$& being interpolated as a Perl variable.
14201
14202 If the string expansion is forced to fail by a &"fail"& item, the result of
14203 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14204 expansion string, the Perl call from the original expansion string fails with
14205 an appropriate error message, in the same way as if &%die%& were used.
14206
14207 .cindex "debugging" "from embedded Perl"
14208 .cindex "log" "writing from embedded Perl"
14209 Two other Exim functions are available for use from within Perl code.
14210 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14211 debugging is enabled. If you want a newline at the end, you must supply it.
14212 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14213 timestamp. In this case, you should not supply a terminating newline.
14214
14215
14216 .section "Use of standard output and error by Perl" "SECID88"
14217 .cindex "Perl" "standard output and error"
14218 You should not write to the standard error or output streams from within your
14219 Perl code, as it is not defined how these are set up. In versions of Exim
14220 before 4.50, it is possible for the standard output or error to refer to the
14221 SMTP connection during message reception via the daemon. Writing to this stream
14222 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14223 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14224 avoided, but the output is lost.
14225
14226 .cindex "Perl" "use of &%warn%&"
14227 The Perl &%warn%& statement writes to the standard error stream by default.
14228 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14229 you have no control. When Exim starts up the Perl interpreter, it arranges for
14230 output from the &%warn%& statement to be written to the Exim main log. You can
14231 change this by including appropriate Perl magic somewhere in your Perl code.
14232 For example, to discard &%warn%& output completely, you need this:
14233 .code
14234 $SIG{__WARN__} = sub { };
14235 .endd
14236 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14237 example, the code for the subroutine is empty, so it does nothing, but you can
14238 include any Perl code that you like. The text of the &%warn%& message is passed
14239 as the first subroutine argument.
14240 .ecindex IIDperl
14241
14242
14243 . ////////////////////////////////////////////////////////////////////////////
14244 . ////////////////////////////////////////////////////////////////////////////
14245
14246 .chapter "Starting the daemon and the use of network interfaces" &&&
14247          "CHAPinterfaces" &&&
14248          "Starting the daemon"
14249 .cindex "daemon" "starting"
14250 .cindex "interface" "listening"
14251 .cindex "network interface"
14252 .cindex "interface" "network"
14253 .cindex "IP address" "for listening"
14254 .cindex "daemon" "listening IP addresses"
14255 .cindex "TCP/IP" "setting listening interfaces"
14256 .cindex "TCP/IP" "setting listening ports"
14257 A host that is connected to a TCP/IP network may have one or more physical
14258 hardware network interfaces. Each of these interfaces may be configured as one
14259 or more &"logical"& interfaces, which are the entities that a program actually
14260 works with. Each of these logical interfaces is associated with an IP address.
14261 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14262 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14263 knowledge about the host's interfaces for use in three different circumstances:
14264
14265 .olist
14266 When a listening daemon is started, Exim needs to know which interfaces
14267 and ports to listen on.
14268 .next
14269 When Exim is routing an address, it needs to know which IP addresses
14270 are associated with local interfaces. This is required for the correct
14271 processing of MX lists by removing the local host and others with the
14272 same or higher priority values. Also, Exim needs to detect cases
14273 when an address is routed to an IP address that in fact belongs to the
14274 local host. Unless the &%self%& router option or the &%allow_localhost%&
14275 option of the smtp transport is set (as appropriate), this is treated
14276 as an error situation.
14277 .next
14278 When Exim connects to a remote host, it may need to know which interface to use
14279 for the outgoing connection.
14280 .endlist
14281
14282
14283 Exim's default behaviour is likely to be appropriate in the vast majority
14284 of cases. If your host has only one interface, and you want all its IP
14285 addresses to be treated in the same way, and you are using only the
14286 standard SMTP port, you should not need to take any special action. The
14287 rest of this chapter does not apply to you.
14288
14289 In a more complicated situation you may want to listen only on certain
14290 interfaces, or on different ports, and for this reason there are a number of
14291 options that can be used to influence Exim's behaviour. The rest of this
14292 chapter describes how they operate.
14293
14294 When a message is received over TCP/IP, the interface and port that were
14295 actually used are set in &$received_ip_address$& and &$received_port$&.
14296
14297
14298
14299 .section "Starting a listening daemon" "SECID89"
14300 When a listening daemon is started (by means of the &%-bd%& command line
14301 option), the interfaces and ports on which it listens are controlled by the
14302 following options:
14303
14304 .ilist
14305 &%daemon_smtp_ports%& contains a list of default ports
14306 or service names.
14307 (For backward compatibility, this option can also be specified in the singular.)
14308 .next
14309 &%local_interfaces%& contains list of interface IP addresses on which to
14310 listen. Each item may optionally also specify a port.
14311 .endlist
14312
14313 The default list separator in both cases is a colon, but this can be changed as
14314 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14315 it is usually best to change the separator to avoid having to double all the
14316 colons. For example:
14317 .code
14318 local_interfaces = <; 127.0.0.1 ; \
14319                       192.168.23.65 ; \
14320                       ::1 ; \
14321                       3ffe:ffff:836f::fe86:a061
14322 .endd
14323 There are two different formats for specifying a port along with an IP address
14324 in &%local_interfaces%&:
14325
14326 .olist
14327 The port is added onto the address with a dot separator. For example, to listen
14328 on port 1234 on two different IP addresses:
14329 .code
14330 local_interfaces = <; 192.168.23.65.1234 ; \
14331                       3ffe:ffff:836f::fe86:a061.1234
14332 .endd
14333 .next
14334 The IP address is enclosed in square brackets, and the port is added
14335 with a colon separator, for example:
14336 .code
14337 local_interfaces = <; [192.168.23.65]:1234 ; \
14338                       [3ffe:ffff:836f::fe86:a061]:1234
14339 .endd
14340 .endlist
14341
14342 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14343 default setting contains just one port:
14344 .code
14345 daemon_smtp_ports = smtp
14346 .endd
14347 If more than one port is listed, each interface that does not have its own port
14348 specified listens on all of them. Ports that are listed in
14349 &%daemon_smtp_ports%& can be identified either by name (defined in
14350 &_/etc/services_&) or by number. However, when ports are given with individual
14351 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14352
14353
14354
14355 .section "Special IP listening addresses" "SECID90"
14356 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14357 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14358 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14359 instead of setting up separate listening sockets for each interface. The
14360 default value of &%local_interfaces%& is
14361 .code
14362 local_interfaces = 0.0.0.0
14363 .endd
14364 when Exim is built without IPv6 support; otherwise it is:
14365 .code
14366 local_interfaces = <; ::0 ; 0.0.0.0
14367 .endd
14368 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14369
14370
14371
14372 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14373 The &%-oX%& command line option can be used to override the values of
14374 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14375 instance. Another way of doing this would be to use macros and the &%-D%&
14376 option. However, &%-oX%& can be used by any admin user, whereas modification of
14377 the runtime configuration by &%-D%& is allowed only when the caller is root or
14378 exim.
14379
14380 The value of &%-oX%& is a list of items. The default colon separator can be
14381 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14382 If there are any items that do not
14383 contain dots or colons (that is, are not IP addresses), the value of
14384 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14385 items that do contain dots or colons, the value of &%local_interfaces%& is
14386 replaced by those items. Thus, for example,
14387 .code
14388 -oX 1225
14389 .endd
14390 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14391 whereas
14392 .code
14393 -oX 192.168.34.5.1125
14394 .endd
14395 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14396 (However, since &%local_interfaces%& now contains no items without ports, the
14397 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14398
14399
14400
14401 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14402 .cindex "submissions protocol"
14403 .cindex "ssmtp protocol"
14404 .cindex "smtps protocol"
14405 .cindex "SMTP" "ssmtp protocol"
14406 .cindex "SMTP" "smtps protocol"
14407 Exim supports the use of TLS-on-connect, used by mail clients in the
14408 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14409 For some years, IETF Standards Track documents only blessed the
14410 STARTTLS-based Submission service (port 587) while common practice was to support
14411 the same feature set on port 465, but using TLS-on-connect.
14412 If your installation needs to provide service to mail clients
14413 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14414 the 465 TCP ports.
14415
14416 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14417 service names, connections to those ports must first establish TLS, before
14418 proceeding to the application layer use of the SMTP protocol.
14419
14420 The common use of this option is expected to be
14421 .code
14422 tls_on_connect_ports = 465
14423 .endd
14424 per RFC 8314.
14425 There is also a command line option &%-tls-on-connect%&, which forces all ports
14426 to behave in this way when a daemon is started.
14427
14428 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14429 daemon to listen on those ports. You must still specify them in
14430 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14431 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14432 connections via the daemon.)
14433
14434
14435
14436
14437 .section "IPv6 address scopes" "SECID92"
14438 .cindex "IPv6" "address scopes"
14439 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14440 can, in principle, have the same link-local IPv6 address on different
14441 interfaces. Thus, additional information is needed, over and above the IP
14442 address, to distinguish individual interfaces. A convention of using a
14443 percent sign followed by something (often the interface name) has been
14444 adopted in some cases, leading to addresses like this:
14445 .code
14446 fe80::202:b3ff:fe03:45c1%eth0
14447 .endd
14448 To accommodate this usage, a percent sign followed by an arbitrary string is
14449 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14450 to convert a textual IPv6 address for actual use. This function recognizes the
14451 percent convention in operating systems that support it, and it processes the
14452 address appropriately. Unfortunately, some older libraries have problems with
14453 &[getaddrinfo()]&. If
14454 .code
14455 IPV6_USE_INET_PTON=yes
14456 .endd
14457 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14458 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14459 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14460 function.) Of course, this means that the additional functionality of
14461 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14462
14463 .section "Disabling IPv6" "SECID93"
14464 .cindex "IPv6" "disabling"
14465 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14466 run on a host whose kernel does not support IPv6. The binary will fall back to
14467 using IPv4, but it may waste resources looking up AAAA records, and trying to
14468 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14469 .oindex "&%disable_ipv6%&"
14470 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14471 activities take place. AAAA records are never looked up, and any IPv6 addresses
14472 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14473 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14474 to handle IPv6 literal addresses.
14475
14476 On the other hand, when IPv6 is in use, there may be times when you want to
14477 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14478 option to globally suppress the lookup of AAAA records for specified domains,
14479 and you can use the &%ignore_target_hosts%& generic router option to ignore
14480 IPv6 addresses in an individual router.
14481
14482
14483
14484 .section "Examples of starting a listening daemon" "SECID94"
14485 The default case in an IPv6 environment is
14486 .code
14487 daemon_smtp_ports = smtp
14488 local_interfaces = <; ::0 ; 0.0.0.0
14489 .endd
14490 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14491 Either one or two sockets may be used, depending on the characteristics of
14492 the TCP/IP stack. (This is complicated and messy; for more information,
14493 read the comments in the &_daemon.c_& source file.)
14494
14495 To specify listening on ports 25 and 26 on all interfaces:
14496 .code
14497 daemon_smtp_ports = 25 : 26
14498 .endd
14499 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14500 .code
14501 local_interfaces = <; ::0.25     ; ::0.26 \
14502                       0.0.0.0.25 ; 0.0.0.0.26
14503 .endd
14504 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14505 IPv4 loopback address only:
14506 .code
14507 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14508 .endd
14509 To specify listening on the default port on specific interfaces only:
14510 .code
14511 local_interfaces = 10.0.0.67 : 192.168.34.67
14512 .endd
14513 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14514
14515
14516
14517 .section "Recognizing the local host" "SECTreclocipadd"
14518 The &%local_interfaces%& option is also used when Exim needs to determine
14519 whether or not an IP address refers to the local host. That is, the IP
14520 addresses of all the interfaces on which a daemon is listening are always
14521 treated as local.
14522
14523 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14524 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14525 available interfaces from the operating system, and extracts the relevant
14526 (that is, IPv4 or IPv6) addresses to use for checking.
14527
14528 Some systems set up large numbers of virtual interfaces in order to provide
14529 many virtual web servers. In this situation, you may want to listen for
14530 email on only a few of the available interfaces, but nevertheless treat all
14531 interfaces as local when routing. You can do this by setting
14532 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14533 &"all"& wildcard values. These addresses are recognized as local, but are not
14534 used for listening. Consider this example:
14535 .code
14536 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14537                       192.168.53.235 ; \
14538                       3ffe:2101:12:1:a00:20ff:fe86:a061
14539
14540 extra_local_interfaces = <; ::0 ; 0.0.0.0
14541 .endd
14542 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14543 address, but all available interface addresses are treated as local when
14544 Exim is routing.
14545
14546 In some environments the local host name may be in an MX list, but with an IP
14547 address that is not assigned to any local interface. In other cases it may be
14548 desirable to treat other host names as if they referred to the local host. Both
14549 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14550 This contains host names rather than IP addresses. When a host is referenced
14551 during routing, either via an MX record or directly, it is treated as the local
14552 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14553 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14554
14555
14556
14557 .section "Delivering to a remote host" "SECID95"
14558 Delivery to a remote host is handled by the smtp transport. By default, it
14559 allows the system's TCP/IP functions to choose which interface to use (if
14560 there is more than one) when connecting to a remote host. However, the
14561 &%interface%& option can be set to specify which interface is used. See the
14562 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14563 details.
14564
14565
14566
14567
14568 . ////////////////////////////////////////////////////////////////////////////
14569 . ////////////////////////////////////////////////////////////////////////////
14570
14571 .chapter "Main configuration" "CHAPmainconfig"
14572 .scindex IIDconfima "configuration file" "main section"
14573 .scindex IIDmaiconf "main configuration"
14574 The first part of the runtime configuration file contains three types of item:
14575
14576 .ilist
14577 Macro definitions: These lines start with an upper case letter. See section
14578 &<<SECTmacrodefs>>& for details of macro processing.
14579 .next
14580 Named list definitions: These lines start with one of the words &"domainlist"&,
14581 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14582 section &<<SECTnamedlists>>&.
14583 .next
14584 Main configuration settings: Each setting occupies one line of the file
14585 (with possible continuations). If any setting is preceded by the word
14586 &"hide"&, the &%-bP%& command line option displays its value to admin users
14587 only. See section &<<SECTcos>>& for a description of the syntax of these option
14588 settings.
14589 .endlist
14590
14591 This chapter specifies all the main configuration options, along with their
14592 types and default values. For ease of finding a particular option, they appear
14593 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14594 are now so many options, they are first listed briefly in functional groups, as
14595 an aid to finding the name of the option you are looking for. Some options are
14596 listed in more than one group.
14597
14598 .section "Miscellaneous" "SECID96"
14599 .table2
14600 .row &%add_environment%&             "environment variables"
14601 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14602 .row &%debug_store%&                 "do extra internal checks"
14603 .row &%disable_ipv6%&                "do no IPv6 processing"
14604 .row &%keep_environment%&            "environment variables"
14605 .row &%keep_malformed%&              "for broken files &-- should not happen"
14606 .row &%localhost_number%&            "for unique message ids in clusters"
14607 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14608 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14609 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14610 .row &%print_topbitchars%&           "top-bit characters are printing"
14611 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14612 .row &%timezone%&                    "force time zone"
14613 .endtable
14614
14615
14616 .section "Exim parameters" "SECID97"
14617 .table2
14618 .row &%exim_group%&                  "override compiled-in value"
14619 .row &%exim_path%&                   "override compiled-in value"
14620 .row &%exim_user%&                   "override compiled-in value"
14621 .row &%primary_hostname%&            "default from &[uname()]&"
14622 .row &%split_spool_directory%&       "use multiple directories"
14623 .row &%spool_directory%&             "override compiled-in value"
14624 .endtable
14625
14626
14627
14628 .section "Privilege controls" "SECID98"
14629 .table2
14630 .row &%admin_groups%&                "groups that are Exim admin users"
14631 .row &%commandline_checks_require_admin%& "require admin for various checks"
14632 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14633 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14634 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14635 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14636 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14637 .row &%never_users%&                 "do not run deliveries as these"
14638 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14639 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14640 .row &%trusted_groups%&              "groups that are trusted"
14641 .row &%trusted_users%&               "users that are trusted"
14642 .endtable
14643
14644
14645
14646 .section "Logging" "SECID99"
14647 .table2
14648 .row &%event_action%&                "custom logging"
14649 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14650 .row &%log_file_path%&               "override compiled-in value"
14651 .row &%log_selector%&                "set/unset optional logging"
14652 .row &%log_timezone%&                "add timezone to log lines"
14653 .row &%message_logs%&                "create per-message logs"
14654 .row &%preserve_message_logs%&       "after message completion"
14655 .row &%panic_coredump%&              "request coredump on fatal errors"
14656 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14657 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14658 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14659 .row &%syslog_facility%&             "set syslog &""facility""& field"
14660 .row &%syslog_pid%&                  "pid in syslog lines"
14661 .row &%syslog_processname%&          "set syslog &""ident""& field"
14662 .row &%syslog_timestamp%&            "timestamp syslog lines"
14663 .row &%write_rejectlog%&             "control use of message log"
14664 .endtable
14665
14666
14667
14668 .section "Frozen messages" "SECID100"
14669 .table2
14670 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14671 .row &%freeze_tell%&                 "send message when freezing"
14672 .row &%move_frozen_messages%&        "to another directory"
14673 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14674 .endtable
14675
14676
14677
14678 .section "Data lookups" "SECID101"
14679 .table2
14680 .row &%ibase_servers%&               "InterBase servers"
14681 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14682 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14683 .row &%ldap_cert_file%&              "client cert file for LDAP"
14684 .row &%ldap_cert_key%&               "client key file for LDAP"
14685 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14686 .row &%ldap_default_servers%&        "used if no server in query"
14687 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14688 .row &%ldap_start_tls%&              "require TLS within LDAP"
14689 .row &%ldap_version%&                "set protocol version"
14690 .row &%lookup_open_max%&             "lookup files held open"
14691 .row &%mysql_servers%&               "default MySQL servers"
14692 .row &%oracle_servers%&              "Oracle servers"
14693 .row &%pgsql_servers%&               "default PostgreSQL servers"
14694 .row &%sqlite_lock_timeout%&         "as it says"
14695 .endtable
14696
14697
14698
14699 .section "Message ids" "SECID102"
14700 .table2
14701 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14702 .row &%message_id_header_text%&      "ditto"
14703 .endtable
14704
14705
14706
14707 .section "Embedded Perl Startup" "SECID103"
14708 .table2
14709 .row &%perl_at_start%&               "always start the interpreter"
14710 .row &%perl_startup%&                "code to obey when starting Perl"
14711 .row &%perl_taintmode%&              "enable taint mode in Perl"
14712 .endtable
14713
14714
14715
14716 .section "Daemon" "SECID104"
14717 .table2
14718 .row &%daemon_smtp_ports%&           "default ports"
14719 .row &%daemon_startup_retries%&      "number of times to retry"
14720 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14721 .row &%extra_local_interfaces%&      "not necessarily listened on"
14722 .row &%local_interfaces%&            "on which to listen, with optional ports"
14723 .row &%notifier_socket%&             "override compiled-in value"
14724 .row &%pid_file_path%&               "override compiled-in value"
14725 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14726 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14727 .endtable
14728
14729
14730
14731 .section "Resource control" "SECID105"
14732 .table2
14733 .row &%check_log_inodes%&            "before accepting a message"
14734 .row &%check_log_space%&             "before accepting a message"
14735 .row &%check_spool_inodes%&          "before accepting a message"
14736 .row &%check_spool_space%&           "before accepting a message"
14737 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14738 .row &%queue_only_load%&             "queue incoming if load high"
14739 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14740 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14741 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14742 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14743 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14744 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14745 .row &%smtp_accept_max_per_connection%& "messages per connection"
14746 .row &%smtp_accept_max_per_host%&    "connections from one host"
14747 .row &%smtp_accept_queue%&           "queue mail if more connections"
14748 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14749                                            connection"
14750 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14751 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14752 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14753 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14754 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14755 .endtable
14756
14757
14758
14759 .section "Policy controls" "SECID106"
14760 .table2
14761 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14762 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14763 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14764 .row &%acl_smtp_auth%&               "ACL for AUTH"
14765 .row &%acl_smtp_connect%&            "ACL for connection"
14766 .row &%acl_smtp_data%&               "ACL for DATA"
14767 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14768 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14769 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14770 .row &%acl_smtp_expn%&               "ACL for EXPN"
14771 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14772 .row &%acl_smtp_mail%&               "ACL for MAIL"
14773 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14774 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14775 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14776 .row &%acl_smtp_predata%&            "ACL for start of data"
14777 .row &%acl_smtp_quit%&               "ACL for QUIT"
14778 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14779 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14780 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14781 .row &%av_scanner%&                  "specify virus scanner"
14782 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14783                                       words""&"
14784 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14785 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14786 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14787 .row &%header_maxsize%&              "total size of message header"
14788 .row &%header_line_maxsize%&         "individual header line limit"
14789 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14790 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14791 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14792 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14793 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14794 .row &%host_lookup%&                 "host name looked up for these hosts"
14795 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14796 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14797 .row &%host_reject_connection%&      "reject connection from these hosts"
14798 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14799 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14800 .row &%message_size_limit%&          "for all messages"
14801 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14802 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14803 .row &%spamd_address%&               "set interface to SpamAssassin"
14804 .row &%strict_acl_vars%&             "object to unset ACL variables"
14805 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14806 .endtable
14807
14808
14809
14810 .section "Callout cache" "SECID107"
14811 .table2
14812 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14813                                          item"
14814 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14815                                          item"
14816 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14817 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14818 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14819 .endtable
14820
14821
14822
14823 .section "TLS" "SECID108"
14824 .table2
14825 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14826 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14827 .row &%hosts_require_alpn%&          "mandatory ALPN"
14828 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14829 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14830 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14831 .row &%tls_alpn%&                    "acceptable protocol names"
14832 .row &%tls_certificate%&             "location of server certificate"
14833 .row &%tls_crl%&                     "certificate revocation list"
14834 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14835 .row &%tls_dhparam%&                 "DH parameters for server"
14836 .row &%tls_eccurve%&                 "EC curve selection for server"
14837 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14838 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14839 .row &%tls_privatekey%&              "location of server private key"
14840 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14841 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14842 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14843 .row &%tls_verify_certificates%&     "expected client certificates"
14844 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14845 .endtable
14846
14847
14848
14849 .section "Local user handling" "SECID109"
14850 .table2
14851 .row &%finduser_retries%&            "useful in NIS environments"
14852 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14853 .row &%gecos_pattern%&               "ditto"
14854 .row &%max_username_length%&         "for systems that truncate"
14855 .row &%unknown_login%&               "used when no login name found"
14856 .row &%unknown_username%&            "ditto"
14857 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14858 .row &%uucp_from_sender%&            "ditto"
14859 .endtable
14860
14861
14862
14863 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14864 .table2
14865 .row &%header_maxsize%&              "total size of message header"
14866 .row &%header_line_maxsize%&         "individual header line limit"
14867 .row &%message_size_limit%&          "applies to all messages"
14868 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14869 .row &%received_header_text%&        "expanded to make &'Received:'&"
14870 .row &%received_headers_max%&        "for mail loop detection"
14871 .row &%recipients_max%&              "limit per message"
14872 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14873 .endtable
14874
14875
14876
14877
14878 .section "Non-SMTP incoming messages" "SECID111"
14879 .table2
14880 .row &%receive_timeout%&             "for non-SMTP messages"
14881 .endtable
14882
14883
14884
14885
14886
14887 .section "Incoming SMTP messages" "SECID112"
14888 See also the &'Policy controls'& section above.
14889
14890 .table2
14891 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14892 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14893 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14894 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14895 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14896 .row &%dmarc_history_file%&          "DMARC results log"
14897 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14898 .row &%host_lookup%&                 "host name looked up for these hosts"
14899 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14900 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14901 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14902 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14903 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14904 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14905 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14906 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14907 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14908 .row &%smtp_accept_max_per_connection%& "messages per connection"
14909 .row &%smtp_accept_max_per_host%&    "connections from one host"
14910 .row &%smtp_accept_queue%&           "queue mail if more connections"
14911 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14912                                            connection"
14913 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14914 .row &%smtp_active_hostname%&        "host name to use in messages"
14915 .row &%smtp_banner%&                 "text for welcome banner"
14916 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14917 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14918 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14919 .row &%smtp_etrn_command%&           "what to run for ETRN"
14920 .row &%smtp_etrn_serialize%&         "only one at once"
14921 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14922 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14923 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14924 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14925 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14926 .row &%smtp_receive_timeout%&        "per command or data line"
14927 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14928 .row &%smtp_return_error_details%&   "give detail on rejections"
14929 .endtable
14930
14931
14932
14933 .section "SMTP extensions" "SECID113"
14934 .table2
14935 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14936 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14937 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14938 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14939 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14940 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14941 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14942 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14943 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14944 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14945 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14946 .endtable
14947
14948
14949
14950 .section "Processing messages" "SECID114"
14951 .table2
14952 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14953 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14954 .row &%allow_utf8_domains%&          "in addresses"
14955 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14956                                       words""&"
14957 .row &%delivery_date_remove%&        "from incoming messages"
14958 .row &%envelope_to_remove%&          "from incoming messages"
14959 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14960 .row &%headers_charset%&             "default for translations"
14961 .row &%qualify_domain%&              "default for senders"
14962 .row &%qualify_recipient%&           "default for recipients"
14963 .row &%return_path_remove%&          "from incoming messages"
14964 .row &%strip_excess_angle_brackets%& "in addresses"
14965 .row &%strip_trailing_dot%&          "at end of addresses"
14966 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14967 .endtable
14968
14969
14970
14971 .section "System filter" "SECID115"
14972 .table2
14973 .row &%system_filter%&               "locate system filter"
14974 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14975                                             directory"
14976 .row &%system_filter_file_transport%& "transport for delivery to a file"
14977 .row &%system_filter_group%&         "group for filter running"
14978 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14979 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14980 .row &%system_filter_user%&          "user for filter running"
14981 .endtable
14982
14983
14984
14985 .section "Routing and delivery" "SECID116"
14986 .table2
14987 .row &%disable_ipv6%&                "do no IPv6 processing"
14988 .row &%dns_again_means_nonexist%&    "for broken domains"
14989 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14990 .row &%dns_dnssec_ok%&               "parameter for resolver"
14991 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14992 .row &%dns_retrans%&                 "parameter for resolver"
14993 .row &%dns_retry%&                   "parameter for resolver"
14994 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14995 .row &%dns_use_edns0%&               "parameter for resolver"
14996 .row &%hold_domains%&                "hold delivery for these domains"
14997 .row &%local_interfaces%&            "for routing checks"
14998 .row &%queue_domains%&               "no immediate delivery for these"
14999 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15000 .row &%queue_only%&                  "no immediate delivery at all"
15001 .row &%queue_only_file%&             "no immediate delivery if file exists"
15002 .row &%queue_only_load%&             "no immediate delivery if load is high"
15003 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15004 .row &%queue_only_override%&         "allow command line to override"
15005 .row &%queue_run_in_order%&          "order of arrival"
15006 .row &%queue_run_max%&               "of simultaneous queue runners"
15007 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15008 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15009 .row &%remote_sort_domains%&         "order of remote deliveries"
15010 .row &%retry_data_expire%&           "timeout for retry data"
15011 .row &%retry_interval_max%&          "safety net for retry rules"
15012 .endtable
15013
15014
15015
15016 .section "Bounce and warning messages" "SECID117"
15017 .table2
15018 .row &%bounce_message_file%&         "content of bounce"
15019 .row &%bounce_message_text%&         "content of bounce"
15020 .row &%bounce_return_body%&          "include body if returning message"
15021 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15022 .row &%bounce_return_message%&       "include original message in bounce"
15023 .row &%bounce_return_size_limit%&    "limit on returned message"
15024 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15025 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15026 .row &%errors_copy%&                 "copy bounce messages"
15027 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15028 .row &%delay_warning%&               "time schedule"
15029 .row &%delay_warning_condition%&     "condition for warning messages"
15030 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15031 .row &%smtp_return_error_details%&   "give detail on rejections"
15032 .row &%warn_message_file%&           "content of warning message"
15033 .endtable
15034
15035
15036
15037 .section "Alphabetical list of main options" "SECTalomo"
15038 Those options that undergo string expansion before use are marked with
15039 &dagger;.
15040
15041 .option accept_8bitmime main boolean true
15042 .cindex "8BITMIME"
15043 .cindex "8-bit characters"
15044 .cindex "log" "selectors"
15045 .cindex "log" "8BITMIME"
15046 .cindex "ESMTP extensions" 8BITMIME
15047 This option causes Exim to send 8BITMIME in its response to an SMTP
15048 EHLO command, and to accept the BODY= parameter on MAIL commands.
15049 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15050 takes no steps to do anything special with messages received by this route.
15051
15052 Historically Exim kept this option off by default, but the maintainers
15053 feel that in today's Internet, this causes more problems than it solves.
15054 It now defaults to true.
15055 A more detailed analysis of the issues is provided by Dan Bernstein:
15056 .display
15057 &url(https://cr.yp.to/smtp/8bitmime.html)
15058 .endd
15059
15060 To log received 8BITMIME status use
15061 .code
15062 log_selector = +8bitmime
15063 .endd
15064
15065 .option acl_not_smtp main string&!! unset
15066 .cindex "&ACL;" "for non-SMTP messages"
15067 .cindex "non-SMTP messages" "ACLs for"
15068 This option defines the ACL that is run when a non-SMTP message has been
15069 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15070 further details.
15071
15072 .option acl_not_smtp_mime main string&!! unset
15073 This option defines the ACL that is run for individual MIME parts of non-SMTP
15074 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15075 SMTP messages.
15076
15077 .option acl_not_smtp_start main string&!! unset
15078 .cindex "&ACL;" "at start of non-SMTP message"
15079 .cindex "non-SMTP messages" "ACLs for"
15080 This option defines the ACL that is run before Exim starts reading a
15081 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15082
15083 .option acl_smtp_auth main string&!! unset
15084 .cindex "&ACL;" "setting up for SMTP commands"
15085 .cindex "AUTH" "ACL for"
15086 This option defines the ACL that is run when an SMTP AUTH command is
15087 received. See chapter &<<CHAPACL>>& for further details.
15088
15089 .option acl_smtp_connect main string&!! unset
15090 .cindex "&ACL;" "on SMTP connection"
15091 This option defines the ACL that is run when an SMTP connection is received.
15092 See chapter &<<CHAPACL>>& for further details.
15093
15094 .option acl_smtp_data main string&!! unset
15095 .cindex "DATA" "ACL for"
15096 This option defines the ACL that is run after an SMTP DATA command has been
15097 processed and the message itself has been received, but before the final
15098 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15099
15100 .option acl_smtp_data_prdr main string&!! accept
15101 .cindex "PRDR" "ACL for"
15102 .cindex "DATA" "PRDR ACL for"
15103 .cindex "&ACL;" "PRDR-related"
15104 .cindex "&ACL;" "per-user data processing"
15105 This option defines the ACL that,
15106 if the PRDR feature has been negotiated,
15107 is run for each recipient after an SMTP DATA command has been
15108 processed and the message itself has been received, but before the
15109 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15110
15111 .option acl_smtp_dkim main string&!! unset
15112 .cindex DKIM "ACL for"
15113 This option defines the ACL that is run for each DKIM signature
15114 (by default, or as specified in the dkim_verify_signers option)
15115 of a received message.
15116 See section &<<SECDKIMVFY>>& for further details.
15117
15118 .option acl_smtp_etrn main string&!! unset
15119 .cindex "ETRN" "ACL for"
15120 This option defines the ACL that is run when an SMTP ETRN command is
15121 received. See chapter &<<CHAPACL>>& for further details.
15122
15123 .option acl_smtp_expn main string&!! unset
15124 .cindex "EXPN" "ACL for"
15125 This option defines the ACL that is run when an SMTP EXPN command is
15126 received. See chapter &<<CHAPACL>>& for further details.
15127
15128 .option acl_smtp_helo main string&!! unset
15129 .cindex "EHLO" "ACL for"
15130 .cindex "HELO" "ACL for"
15131 This option defines the ACL that is run when an SMTP EHLO or HELO
15132 command is received. See chapter &<<CHAPACL>>& for further details.
15133
15134
15135 .option acl_smtp_mail main string&!! unset
15136 .cindex "MAIL" "ACL for"
15137 This option defines the ACL that is run when an SMTP MAIL command is
15138 received. See chapter &<<CHAPACL>>& for further details.
15139
15140 .option acl_smtp_mailauth main string&!! unset
15141 .cindex "AUTH" "on MAIL command"
15142 This option defines the ACL that is run when there is an AUTH parameter on
15143 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15144 &<<CHAPSMTPAUTH>>& for details of authentication.
15145
15146 .option acl_smtp_mime main string&!! unset
15147 .cindex "MIME content scanning" "ACL for"
15148 This option is available when Exim is built with the content-scanning
15149 extension. It defines the ACL that is run for each MIME part in a message. See
15150 section &<<SECTscanmimepart>>& for details.
15151
15152 .option acl_smtp_notquit main string&!! unset
15153 .cindex "not-QUIT, ACL for"
15154 This option defines the ACL that is run when an SMTP session
15155 ends without a QUIT command being received.
15156 See chapter &<<CHAPACL>>& for further details.
15157
15158 .option acl_smtp_predata main string&!! unset
15159 This option defines the ACL that is run when an SMTP DATA command is
15160 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15161 further details.
15162
15163 .option acl_smtp_quit main string&!! unset
15164 .cindex "QUIT, ACL for"
15165 This option defines the ACL that is run when an SMTP QUIT command is
15166 received. See chapter &<<CHAPACL>>& for further details.
15167
15168 .option acl_smtp_rcpt main string&!! unset
15169 .cindex "RCPT" "ACL for"
15170 This option defines the ACL that is run when an SMTP RCPT command is
15171 received. See chapter &<<CHAPACL>>& for further details.
15172
15173 .option acl_smtp_starttls main string&!! unset
15174 .cindex "STARTTLS, ACL for"
15175 This option defines the ACL that is run when an SMTP STARTTLS command is
15176 received. See chapter &<<CHAPACL>>& for further details.
15177
15178 .option acl_smtp_vrfy main string&!! unset
15179 .cindex "VRFY" "ACL for"
15180 This option defines the ACL that is run when an SMTP VRFY command is
15181 received. See chapter &<<CHAPACL>>& for further details.
15182
15183 .option add_environment main "string list" empty
15184 .cindex "environment" "set values"
15185 This option adds individual environment variables that the
15186 currently linked libraries and programs in child processes may use.
15187 Each list element should be of the form &"name=value"&.
15188
15189 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15190
15191 .option admin_groups main "string list&!!" unset
15192 .cindex "admin user"
15193 This option is expanded just once, at the start of Exim's processing. If the
15194 current group or any of the supplementary groups of an Exim caller is in this
15195 colon-separated list, the caller has admin privileges. If all your system
15196 programmers are in a specific group, for example, you can give them all Exim
15197 admin privileges by putting that group in &%admin_groups%&. However, this does
15198 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15199 To permit this, you have to add individuals to the Exim group.
15200
15201 .option allow_domain_literals main boolean false
15202 .cindex "domain literal"
15203 If this option is set, the RFC 2822 domain literal format is permitted in
15204 email addresses. The option is not set by default, because the domain literal
15205 format is not normally required these days, and few people know about it. It
15206 has, however, been exploited by mail abusers.
15207
15208 Unfortunately, it seems that some DNS black list maintainers are using this
15209 format to report black listing to postmasters. If you want to accept messages
15210 addressed to your hosts by IP address, you need to set
15211 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15212 domains (defined in the named domain list &%local_domains%& in the default
15213 configuration). This &"magic string"& matches the domain literal form of all
15214 the local host's IP addresses.
15215
15216 .option allow_mx_to_ip main boolean false
15217 .cindex "MX record" "pointing to IP address"
15218 It appears that more and more DNS zone administrators are breaking the rules
15219 and putting domain names that look like IP addresses on the right hand side of
15220 MX records. Exim follows the rules and rejects this, giving an error message
15221 that explains the misconfiguration. However, some other MTAs support this
15222 practice, so to avoid &"Why can't Exim do this?"& complaints,
15223 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15224 recommended, except when you have no other choice.
15225
15226 .option allow_utf8_domains main boolean false
15227 .cindex "domain" "UTF-8 characters in"
15228 .cindex "UTF-8" "in domain name"
15229 Lots of discussion is going on about internationalized domain names. One
15230 camp is strongly in favour of just using UTF-8 characters, and it seems
15231 that at least two other MTAs permit this.
15232 This option allows Exim users to experiment if they wish.
15233
15234 If it is set true, Exim's domain parsing function allows valid
15235 UTF-8 multicharacters to appear in domain name components, in addition to
15236 letters, digits, and hyphens.
15237
15238 If Exim is built with internationalization support
15239 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15240 this option can be left as default.
15241 Without that,
15242 if you want to look up such domain names in the DNS, you must also
15243 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15244 suitable setting is:
15245 .code
15246 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15247   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15248 .endd
15249 Alternatively, you can just disable this feature by setting
15250 .code
15251 dns_check_names_pattern =
15252 .endd
15253 That is, set the option to an empty string so that no check is done.
15254
15255
15256 .option auth_advertise_hosts main "host list&!!" *
15257 .cindex "authentication" "advertising"
15258 .cindex "AUTH" "advertising"
15259 .cindex "ESMTP extensions" AUTH
15260 If any server authentication mechanisms are configured, Exim advertises them in
15261 response to an EHLO command only if the calling host matches this list.
15262 Otherwise, Exim does not advertise AUTH.
15263 Exim does not accept AUTH commands from clients to which it has not
15264 advertised the availability of AUTH. The advertising of individual
15265 authentication mechanisms can be controlled by the use of the
15266 &%server_advertise_condition%& generic authenticator option on the individual
15267 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15268
15269 Certain mail clients (for example, Netscape) require the user to provide a name
15270 and password for authentication if AUTH is advertised, even though it may
15271 not be needed (the host may accept messages from hosts on its local LAN without
15272 authentication, for example). The &%auth_advertise_hosts%& option can be used
15273 to make these clients more friendly by excluding them from the set of hosts to
15274 which Exim advertises AUTH.
15275
15276 .cindex "AUTH" "advertising when encrypted"
15277 If you want to advertise the availability of AUTH only when the connection
15278 is encrypted using TLS, you can make use of the fact that the value of this
15279 option is expanded, with a setting like this:
15280 .code
15281 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15282 .endd
15283 .vindex "&$tls_in_cipher$&"
15284 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15285 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15286 expansion is *, which matches all hosts.
15287
15288
15289 .option auto_thaw main time 0s
15290 .cindex "thawing messages"
15291 .cindex "unfreezing messages"
15292 If this option is set to a time greater than zero, a queue runner will try a
15293 new delivery attempt on any frozen message, other than a bounce message, if
15294 this much time has passed since it was frozen. This may result in the message
15295 being re-frozen if nothing has changed since the last attempt. It is a way of
15296 saying &"keep on trying, even though there are big problems"&.
15297
15298 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15299 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15300 thought to be very useful any more, and its use should probably be avoided.
15301
15302
15303 .option av_scanner main string "see below"
15304 This option is available if Exim is built with the content-scanning extension.
15305 It specifies which anti-virus scanner to use. The default value is:
15306 .code
15307 sophie:/var/run/sophie
15308 .endd
15309 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15310 before use. See section &<<SECTscanvirus>>& for further details.
15311
15312
15313 .option bi_command main string unset
15314 .oindex "&%-bi%&"
15315 This option supplies the name of a command that is run when Exim is called with
15316 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15317 just the command name, it is not a complete command line. If an argument is
15318 required, it must come from the &%-oA%& command line option.
15319
15320
15321 .option bounce_message_file main string&!! unset
15322 .cindex "bounce message" "customizing"
15323 .cindex "customizing" "bounce message"
15324 This option defines a template file containing paragraphs of text to be used
15325 for constructing bounce messages.  Details of the file's contents are given in
15326 chapter &<<CHAPemsgcust>>&.
15327 .cindex bounce_message_file "tainted data"
15328 The option is expanded to give the file path, which must be
15329 absolute and untainted.
15330 See also &%warn_message_file%&.
15331
15332
15333 .option bounce_message_text main string unset
15334 When this option is set, its contents are included in the default bounce
15335 message immediately after &"This message was created automatically by mail
15336 delivery software."& It is not used if &%bounce_message_file%& is set.
15337
15338 .option bounce_return_body main boolean true
15339 .cindex "bounce message" "including body"
15340 This option controls whether the body of an incoming message is included in a
15341 bounce message when &%bounce_return_message%& is true. The default setting
15342 causes the entire message, both header and body, to be returned (subject to the
15343 value of &%bounce_return_size_limit%&). If this option is false, only the
15344 message header is included. In the case of a non-SMTP message containing an
15345 error that is detected during reception, only those header lines preceding the
15346 point at which the error was detected are returned.
15347 .cindex "bounce message" "including original"
15348
15349 .option bounce_return_linesize_limit main integer 998
15350 .cindex "size" "of bounce lines, limit"
15351 .cindex "bounce message" "line length limit"
15352 .cindex "limit" "bounce message line length"
15353 This option sets a limit in bytes on the line length of messages
15354 that are returned to senders due to delivery problems,
15355 when &%bounce_return_message%& is true.
15356 The default value corresponds to RFC limits.
15357 If the message being returned has lines longer than this value it is
15358 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15359
15360 The option also applies to bounces returned when an error is detected
15361 during reception of a message.
15362 In this case lines from the original are truncated.
15363
15364 The option does not apply to messages generated by an &(autoreply)& transport.
15365
15366
15367 .option bounce_return_message main boolean true
15368 If this option is set false, none of the original message is included in
15369 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15370 &%bounce_return_body%&.
15371
15372
15373 .option bounce_return_size_limit main integer 100K
15374 .cindex "size" "of bounce, limit"
15375 .cindex "bounce message" "size limit"
15376 .cindex "limit" "bounce message size"
15377 This option sets a limit in bytes on the size of messages that are returned to
15378 senders as part of bounce messages when &%bounce_return_message%& is true. The
15379 limit should be less than the value of the global &%message_size_limit%& and of
15380 any &%message_size_limit%& settings on transports, to allow for the bounce text
15381 that Exim generates. If this option is set to zero there is no limit.
15382
15383 When the body of any message that is to be included in a bounce message is
15384 greater than the limit, it is truncated, and a comment pointing this out is
15385 added at the top. The actual cutoff may be greater than the value given, owing
15386 to the use of buffering for transferring the message in chunks (typically 8K in
15387 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15388 messages.
15389
15390 .option bounce_sender_authentication main string unset
15391 .cindex "bounce message" "sender authentication"
15392 .cindex "authentication" "bounce message"
15393 .cindex "AUTH" "on bounce message"
15394 This option provides an authenticated sender address that is sent with any
15395 bounce messages generated by Exim that are sent over an authenticated SMTP
15396 connection. A typical setting might be:
15397 .code
15398 bounce_sender_authentication = mailer-daemon@my.domain.example
15399 .endd
15400 which would cause bounce messages to be sent using the SMTP command:
15401 .code
15402 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15403 .endd
15404 The value of &%bounce_sender_authentication%& must always be a complete email
15405 address.
15406
15407 .option callout_domain_negative_expire main time 3h
15408 .cindex "caching" "callout timeouts"
15409 .cindex "callout" "caching timeouts"
15410 This option specifies the expiry time for negative callout cache data for a
15411 domain. See section &<<SECTcallver>>& for details of callout verification, and
15412 section &<<SECTcallvercache>>& for details of the caching.
15413
15414
15415 .option callout_domain_positive_expire main time 7d
15416 This option specifies the expiry time for positive callout cache data for a
15417 domain. See section &<<SECTcallver>>& for details of callout verification, and
15418 section &<<SECTcallvercache>>& for details of the caching.
15419
15420
15421 .option callout_negative_expire main time 2h
15422 This option specifies the expiry time for negative callout cache data for an
15423 address. See section &<<SECTcallver>>& for details of callout verification, and
15424 section &<<SECTcallvercache>>& for details of the caching.
15425
15426
15427 .option callout_positive_expire main time 24h
15428 This option specifies the expiry time for positive callout cache data for an
15429 address. See section &<<SECTcallver>>& for details of callout verification, and
15430 section &<<SECTcallvercache>>& for details of the caching.
15431
15432
15433 .option callout_random_local_part main string&!! "see below"
15434 This option defines the &"random"& local part that can be used as part of
15435 callout verification. The default value is
15436 .code
15437 $primary_hostname-$tod_epoch-testing
15438 .endd
15439 See section &<<CALLaddparcall>>& for details of how this value is used.
15440
15441
15442 .option check_log_inodes main integer 100
15443 See &%check_spool_space%& below.
15444
15445
15446 .option check_log_space main integer 10M
15447 See &%check_spool_space%& below.
15448
15449 .oindex "&%check_rfc2047_length%&"
15450 .cindex "RFC 2047" "disabling length check"
15451 .option check_rfc2047_length main boolean true
15452 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15453 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15454 word; strings to be encoded that exceed this length are supposed to use
15455 multiple encoded words. By default, Exim does not recognize encoded words that
15456 exceed the maximum length. However, it seems that some software, in violation
15457 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15458 set false, Exim recognizes encoded words of any length.
15459
15460
15461 .option check_spool_inodes main integer 100
15462 See &%check_spool_space%& below.
15463
15464
15465 .option check_spool_space main integer 10M
15466 .cindex "checking disk space"
15467 .cindex "disk space, checking"
15468 .cindex "spool directory" "checking space"
15469 The four &%check_...%& options allow for checking of disk resources before a
15470 message is accepted.
15471
15472 .vindex "&$log_inodes$&"
15473 .vindex "&$log_space$&"
15474 .vindex "&$spool_inodes$&"
15475 .vindex "&$spool_space$&"
15476 When any of these options are nonzero, they apply to all incoming messages. If you
15477 want to apply different checks to different kinds of message, you can do so by
15478 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15479 &$spool_space$& in an ACL with appropriate additional conditions.
15480
15481
15482 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15483 either value is greater than zero, for example:
15484 .code
15485 check_spool_space = 100M
15486 check_spool_inodes = 100
15487 .endd
15488 The spool partition is the one that contains the directory defined by
15489 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15490 transit.
15491
15492 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15493 files are written if either is greater than zero. These should be set only if
15494 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15495
15496 If there is less space or fewer inodes than requested, Exim refuses to accept
15497 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15498 error response to the MAIL command. If ESMTP is in use and there was a
15499 SIZE parameter on the MAIL command, its value is added to the
15500 &%check_spool_space%& value, and the check is performed even if
15501 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15502
15503 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15504 number of kilobytes (though specified in bytes).
15505 If a non-multiple of 1024 is specified, it is rounded up.
15506
15507 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15508 failure a message is written to stderr and Exim exits with a non-zero code, as
15509 it obviously cannot send an error message of any kind.
15510
15511 There is a slight performance penalty for these checks.
15512 Versions of Exim preceding 4.88 had these disabled by default;
15513 high-rate installations confident they will never run out of resources
15514 may wish to deliberately disable them.
15515
15516 .option chunking_advertise_hosts main "host list&!!" *
15517 .cindex CHUNKING advertisement
15518 .cindex "RFC 3030" "CHUNKING"
15519 .cindex "ESMTP extensions" CHUNKING
15520 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15521 these hosts.
15522 Hosts may use the BDAT command as an alternate to DATA.
15523
15524 .option commandline_checks_require_admin main boolean &`false`&
15525 .cindex "restricting access to features"
15526 This option restricts various basic checking features to require an
15527 administrative user.
15528 This affects most of the &%-b*%& options, such as &%-be%&.
15529
15530 .option debug_store main boolean &`false`&
15531 .cindex debugging "memory corruption"
15532 .cindex memory debugging
15533 This option, when true, enables extra checking in Exim's internal memory
15534 management.  For use when a memory corruption issue is being investigated,
15535 it should normally be left as default.
15536
15537 .option daemon_smtp_ports main string &`smtp`&
15538 .cindex "port" "for daemon"
15539 .cindex "TCP/IP" "setting listening ports"
15540 This option specifies one or more default SMTP ports on which the Exim daemon
15541 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15542 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15543
15544 .option daemon_startup_retries main integer 9
15545 .cindex "daemon startup, retrying"
15546 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15547 the daemon at startup when it cannot immediately bind a listening socket
15548 (typically because the socket is already in use): &%daemon_startup_retries%&
15549 defines the number of retries after the first failure, and
15550 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15551
15552 .option daemon_startup_sleep main time 30s
15553 See &%daemon_startup_retries%&.
15554
15555 .option delay_warning main "time list" 24h
15556 .cindex "warning of delay"
15557 .cindex "delay warning, specifying"
15558 .cindex "queue" "delay warning"
15559 When a message is delayed, Exim sends a warning message to the sender at
15560 intervals specified by this option. The data is a colon-separated list of times
15561 after which to send warning messages. If the value of the option is an empty
15562 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15563 message has been in the queue for longer than the last time, the last interval
15564 between the times is used to compute subsequent warning times. For example,
15565 with
15566 .code
15567 delay_warning = 4h:8h:24h
15568 .endd
15569 the first message is sent after 4 hours, the second after 8 hours, and
15570 the third one after 24 hours. After that, messages are sent every 16 hours,
15571 because that is the interval between the last two times on the list. If you set
15572 just one time, it specifies the repeat interval. For example, with:
15573 .code
15574 delay_warning = 6h
15575 .endd
15576 messages are repeated every six hours. To stop warnings after a given time, set
15577 a very large time at the end of the list. For example:
15578 .code
15579 delay_warning = 2h:12h:99d
15580 .endd
15581 Note that the option is only evaluated at the time a delivery attempt fails,
15582 which depends on retry and queue-runner configuration.
15583 Typically retries will be configured more frequently than warning messages.
15584
15585 .option delay_warning_condition main string&!! "see below"
15586 .vindex "&$domain$&"
15587 The string is expanded at the time a warning message might be sent. If all the
15588 deferred addresses have the same domain, it is set in &$domain$& during the
15589 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15590 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15591 &"false"& (the comparison being done caselessly) then the warning message is
15592 not sent. The default is:
15593 .code
15594 delay_warning_condition = ${if or {\
15595   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15596   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15597   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15598   } {no}{yes}}
15599 .endd
15600 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15601 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15602 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15603 &"auto-replied"& in an &'Auto-Submitted:'& header.
15604
15605 .option deliver_drop_privilege main boolean false
15606 .cindex "unprivileged delivery"
15607 .cindex "delivery" "unprivileged"
15608 If this option is set true, Exim drops its root privilege at the start of a
15609 delivery process, and runs as the Exim user throughout. This severely restricts
15610 the kinds of local delivery that are possible, but is viable in certain types
15611 of configuration. There is a discussion about the use of root privilege in
15612 chapter &<<CHAPsecurity>>&.
15613
15614 .option deliver_queue_load_max main fixed-point unset
15615 .cindex "load average"
15616 .cindex "queue runner" "abandoning"
15617 When this option is set, a queue run is abandoned if the system load average
15618 becomes greater than the value of the option. The option has no effect on
15619 ancient operating systems on which Exim cannot determine the load average.
15620 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15621
15622
15623 .option delivery_date_remove main boolean true
15624 .cindex "&'Delivery-date:'& header line"
15625 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15626 message when it is delivered, in exactly the same way as &'Return-path:'& is
15627 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15628 should not be present in incoming messages, and this option causes them to be
15629 removed at the time the message is received, to avoid any problems that might
15630 occur when a delivered message is subsequently sent on to some other recipient.
15631
15632 .option disable_fsync main boolean false
15633 .cindex "&[fsync()]&, disabling"
15634 This option is available only if Exim was built with the compile-time option
15635 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15636 a runtime configuration generates an &"unknown option"& error. You should not
15637 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15638 really, really, really understand what you are doing. &'No pre-compiled
15639 distributions of Exim should ever make this option available.'&
15640
15641 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15642 updated files' data to be written to disc before continuing. Unexpected events
15643 such as crashes and power outages may cause data to be lost or scrambled.
15644 Here be Dragons. &*Beware.*&
15645
15646
15647 .option disable_ipv6 main boolean false
15648 .cindex "IPv6" "disabling"
15649 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15650 activities take place. AAAA records are never looked up, and any IPv6 addresses
15651 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15652 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15653 to handle IPv6 literal addresses.
15654
15655
15656 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15657 .cindex DKIM "selecting signature algorithms"
15658 This option gives a list of hash types which are acceptable in signatures,
15659 and an order of processing.
15660 Signatures with algorithms not in the list will be ignored.
15661
15662 Acceptable values include:
15663 .code
15664 sha1
15665 sha256
15666 sha512
15667 .endd
15668
15669 Note that the acceptance of sha1 violates RFC 8301.
15670
15671 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15672 This option gives a list of key types which are acceptable in signatures,
15673 and an order of processing.
15674 Signatures with algorithms not in the list will be ignored.
15675
15676
15677 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15678 This option gives a list of key sizes which are acceptable in signatures.
15679 The list is keyed by the algorithm type for the key; the values are in bits.
15680 Signatures with keys smaller than given by this option will fail verification.
15681
15682 The default enforces the RFC 8301 minimum key size for RSA signatures.
15683
15684 .option dkim_verify_minimal main boolean false
15685 If set to true, verification of signatures will terminate after the
15686 first success.
15687
15688 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15689 .cindex DKIM "controlling calls to the ACL"
15690 This option gives a list of DKIM domains for which the DKIM ACL is run.
15691 It is expanded after the message is received; by default it runs
15692 the ACL once for each signature in the message.
15693 See section &<<SECDKIMVFY>>&.
15694
15695
15696 .option dmarc_forensic_sender main string&!! unset
15697 .option dmarc_history_file main string unset
15698 .option dmarc_tld_file main string unset
15699 .cindex DMARC "main section options"
15700 These options control DMARC processing.
15701 See section &<<SECDMARC>>& for details.
15702
15703
15704 .option dns_again_means_nonexist main "domain list&!!" unset
15705 .cindex "DNS" "&""try again""& response; overriding"
15706 DNS lookups give a &"try again"& response for the DNS errors
15707 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15708 keep trying to deliver a message, or to give repeated temporary errors to
15709 incoming mail. Sometimes the effect is caused by a badly set up name server and
15710 may persist for a long time. If a domain which exhibits this problem matches
15711 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15712 This option should be used with care. You can make it apply to reverse lookups
15713 by a setting such as this:
15714 .code
15715 dns_again_means_nonexist = *.in-addr.arpa
15716 .endd
15717 This option applies to all DNS lookups that Exim does,
15718 .new
15719 except for TLSA lookups (where knowing about such failures
15720 is security-relevant).
15721 .wen
15722 It also applies when the
15723 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15724 since these are most likely to be caused by DNS lookup problems. The
15725 &(dnslookup)& router has some options of its own for controlling what happens
15726 when lookups for MX or SRV records give temporary errors. These more specific
15727 options are applied after this global option.
15728
15729 .option dns_check_names_pattern main string "see below"
15730 .cindex "DNS" "pre-check of name syntax"
15731 When this option is set to a non-empty string, it causes Exim to check domain
15732 names for characters that are not allowed in host names before handing them to
15733 the DNS resolver, because some resolvers give temporary errors for names that
15734 contain unusual characters. If a domain name contains any unwanted characters,
15735 a &"not found"& result is forced, and the resolver is not called. The check is
15736 done by matching the domain name against a regular expression, which is the
15737 value of this option. The default pattern is
15738 .code
15739 dns_check_names_pattern = \
15740   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15741 .endd
15742 which permits only letters, digits, slashes, and hyphens in components, but
15743 they must start and end with a letter or digit. Slashes are not, in fact,
15744 permitted in host names, but they are found in certain NS records (which can be
15745 accessed in Exim by using a &%dnsdb%& lookup). If you set
15746 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15747 empty string.
15748
15749 .option dns_csa_search_limit main integer 5
15750 This option controls the depth of parental searching for CSA SRV records in the
15751 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15752
15753 .option dns_csa_use_reverse main boolean true
15754 This option controls whether or not an IP address, given as a CSA domain, is
15755 reversed and looked up in the reverse DNS, as described in more detail in
15756 section &<<SECTverifyCSA>>&.
15757
15758 .option dns_cname_loops main integer 1
15759 .cindex DNS "CNAME following"
15760 This option controls the following of CNAME chains, needed if the resolver does
15761 not do it internally.
15762 As of 2018 most should, and the default can be left.
15763 If you have an ancient one, a value of 10 is likely needed.
15764
15765 The default value of one CNAME-follow is needed
15766 thanks to the observed return for an MX request,
15767 given no MX presence but a CNAME to an A, of the CNAME.
15768
15769
15770 .option dns_dnssec_ok main integer -1
15771 .cindex "DNS" "resolver options"
15772 .cindex "DNS" "DNSSEC"
15773 If this option is set to a non-negative number then Exim will initialise the
15774 DNS resolver library to either use or not use DNSSEC, overriding the system
15775 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15776
15777 If the resolver library does not support DNSSEC then this option has no effect.
15778
15779 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15780 will default to stripping out a successful validation status.
15781 This will break a previously working Exim installation.
15782 Provided that you do trust the resolver (ie, is on localhost) you can tell
15783 glibc to pass through any successful validation with a new option in
15784 &_/etc/resolv.conf_&:
15785 .code
15786 options trust-ad
15787 .endd
15788
15789
15790 .option dns_ipv4_lookup main "domain list&!!" unset
15791 .cindex "IPv6" "DNS lookup for AAAA records"
15792 .cindex "DNS" "IPv6 lookup for AAAA records"
15793 .cindex DNS "IPv6 disabling"
15794 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15795 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15796 (A records) when trying to find IP addresses for hosts, unless the host's
15797 domain matches this list.
15798
15799 This is a fudge to help with name servers that give big delays or otherwise do
15800 not work for the AAAA record type. In due course, when the world's name
15801 servers have all been upgraded, there should be no need for this option.
15802 Note that all lookups, including those done for verification, are affected;
15803 this will result in verify failure for IPv6 connections or ones using names
15804 only valid for IPv6 addresses.
15805
15806
15807 .option dns_retrans main time 0s
15808 .cindex "DNS" "resolver options"
15809 .cindex timeout "dns lookup"
15810 .cindex "DNS" timeout
15811 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15812 retransmission and retry parameters for DNS lookups. Values of zero (the
15813 defaults) leave the system default settings unchanged. The first value is the
15814 time between retries, and the second is the number of retries. It isn't
15815 totally clear exactly how these settings affect the total time a DNS lookup may
15816 take. I haven't found any documentation about timeouts on DNS lookups; these
15817 parameter values are available in the external resolver interface structure,
15818 but nowhere does it seem to describe how they are used or what you might want
15819 to set in them.
15820 See also the &%slow_lookup_log%& option.
15821
15822
15823 .option dns_retry main integer 0
15824 See &%dns_retrans%& above.
15825
15826
15827 .option dns_trust_aa main "domain list&!!" unset
15828 .cindex "DNS" "resolver options"
15829 .cindex "DNS" "DNSSEC"
15830 If this option is set then lookup results marked with the AA bit
15831 (Authoritative Answer) are trusted the same way as if they were
15832 DNSSEC-verified. The authority section's name of the answer must
15833 match with this expanded domain list.
15834
15835 Use this option only if you talk directly to a resolver that is
15836 authoritative for some zones and does not set the AD (Authentic Data)
15837 bit in the answer. Some DNS servers may have an configuration option to
15838 mark the answers from their own zones as verified (they set the AD bit).
15839 Others do not have this option. It is considered as poor practice using
15840 a resolver that is an authoritative server for some zones.
15841
15842 Use this option only if you really have to (e.g. if you want
15843 to use DANE for remote delivery to a server that is listed in the DNS
15844 zones that your resolver is authoritative for).
15845
15846 If the DNS answer packet has the AA bit set and contains resource record
15847 in the answer section, the name of the first NS record appearing in the
15848 authority section is compared against the list. If the answer packet is
15849 authoritative but the answer section is empty, the name of the first SOA
15850 record in the authoritative section is used instead.
15851
15852 .cindex "DNS" "resolver options"
15853 .option dns_use_edns0 main integer -1
15854 .cindex "DNS" "resolver options"
15855 .cindex "DNS" "EDNS0"
15856 .cindex "DNS" "OpenBSD
15857 If this option is set to a non-negative number then Exim will initialise the
15858 DNS resolver library to either use or not use EDNS0 extensions, overriding
15859 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15860 on.
15861
15862 If the resolver library does not support EDNS0 then this option has no effect.
15863
15864 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15865 means that DNSSEC will not work with Exim on that platform either, unless Exim
15866 is linked against an alternative DNS client library.
15867
15868
15869 .option drop_cr main boolean false
15870 This is an obsolete option that is now a no-op. It used to affect the way Exim
15871 handled CR and LF characters in incoming messages. What happens now is
15872 described in section &<<SECTlineendings>>&.
15873
15874 .option dsn_advertise_hosts main "host list&!!" unset
15875 .cindex "bounce messages" "success"
15876 .cindex "DSN" "success"
15877 .cindex "Delivery Status Notification" "success"
15878 .cindex "ESMTP extensions" DSN
15879 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15880 and accepted from, these hosts.
15881 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15882 and RET and ENVID options on MAIL FROM commands.
15883 A NOTIFY=SUCCESS option requests success-DSN messages.
15884 A NOTIFY= option with no argument requests that no delay or failure DSNs
15885 are sent.
15886 &*Note*&: Supplying success-DSN messages has been criticised
15887 on privacy grounds; it can leak details of internal forwarding.
15888
15889 .option dsn_from main "string&!!" "see below"
15890 .cindex "&'From:'& header line" "in bounces"
15891 .cindex "bounce messages" "&'From:'& line, specifying"
15892 This option can be used to vary the contents of &'From:'& header lines in
15893 bounces and other automatically generated messages (&"Delivery Status
15894 Notifications"& &-- hence the name of the option). The default setting is:
15895 .code
15896 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15897 .endd
15898 The value is expanded every time it is needed. If the expansion fails, a
15899 panic is logged, and the default value is used.
15900
15901 .option envelope_to_remove main boolean true
15902 .cindex "&'Envelope-to:'& header line"
15903 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15904 message when it is delivered, in exactly the same way as &'Return-path:'& is
15905 handled. &'Envelope-to:'& records the original recipient address from the
15906 message's envelope that caused the delivery to happen. Such headers should not
15907 be present in incoming messages, and this option causes them to be removed at
15908 the time the message is received, to avoid any problems that might occur when a
15909 delivered message is subsequently sent on to some other recipient.
15910
15911
15912 .option errors_copy main "string list&!!" unset
15913 .cindex "bounce message" "copy to other address"
15914 .cindex "copy of bounce message"
15915 Setting this option causes Exim to send bcc copies of bounce messages that it
15916 generates to other addresses. &*Note*&: This does not apply to bounce messages
15917 coming from elsewhere. The value of the option is a colon-separated list of
15918 items. Each item consists of a pattern, terminated by white space, followed by
15919 a comma-separated list of email addresses. If a pattern contains spaces, it
15920 must be enclosed in double quotes.
15921
15922 Each pattern is processed in the same way as a single item in an address list
15923 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15924 the bounce message, the message is copied to the addresses on the list. The
15925 items are scanned in order, and once a matching one is found, no further items
15926 are examined. For example:
15927 .code
15928 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15929               rqps@mydomain   hostmaster@mydomain.example,\
15930                               postmaster@mydomain.example
15931 .endd
15932 .vindex "&$domain$&"
15933 .vindex "&$local_part$&"
15934 The address list is expanded before use. The expansion variables &$local_part$&
15935 and &$domain$& are set from the original recipient of the error message, and if
15936 there was any wildcard matching in the pattern, the expansion
15937 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15938 variables &$0$&, &$1$&, etc. are set in the normal way.
15939
15940
15941 .option errors_reply_to main string unset
15942 .cindex "bounce message" "&'Reply-to:'& in"
15943 By default, Exim's bounce and delivery warning messages contain the header line
15944 .display
15945 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15946 .endd
15947 .oindex &%quota_warn_message%&
15948 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15949 A warning message that is generated by the &%quota_warn_message%& option in an
15950 &(appendfile)& transport may contain its own &'From:'& header line that
15951 overrides the default.
15952
15953 Experience shows that people reply to bounce messages. If the
15954 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15955 and warning messages. For example:
15956 .code
15957 errors_reply_to = postmaster@my.domain.example
15958 .endd
15959 The value of the option is not expanded. It must specify a valid RFC 2822
15960 address. However, if a warning message that is generated by the
15961 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15962 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15963 not used.
15964
15965
15966 .option event_action main string&!! unset
15967 .cindex events
15968 This option declares a string to be expanded for Exim's events mechanism.
15969 For details see chapter &<<CHAPevents>>&.
15970
15971
15972 .option exim_group main string "compile-time configured"
15973 .cindex "gid (group id)" "Exim's own"
15974 .cindex "Exim group"
15975 This option changes the gid under which Exim runs when it gives up root
15976 privilege. The default value is compiled into the binary. The value of this
15977 option is used only when &%exim_user%& is also set. Unless it consists entirely
15978 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15979 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15980 security issues.
15981
15982
15983 .option exim_path main string "see below"
15984 .cindex "Exim binary, path name"
15985 This option specifies the path name of the Exim binary, which is used when Exim
15986 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15987 the directory configured at compile time by the BIN_DIRECTORY setting. It
15988 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15989 other place.
15990 &*Warning*&: Do not use a macro to define the value of this option, because
15991 you will break those Exim utilities that scan the configuration file to find
15992 where the binary is. (They then use the &%-bP%& option to extract option
15993 settings such as the value of &%spool_directory%&.)
15994
15995
15996 .option exim_user main string "compile-time configured"
15997 .cindex "uid (user id)" "Exim's own"
15998 .cindex "Exim user"
15999 This option changes the uid under which Exim runs when it gives up root
16000 privilege. The default value is compiled into the binary. Ownership of the run
16001 time configuration file and the use of the &%-C%& and &%-D%& command line
16002 options is checked against the values in the binary, not what is set here.
16003
16004 Unless it consists entirely of digits, the string is looked up using
16005 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16006 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16007 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16008
16009
16010 .option exim_version main string "current version"
16011 .cindex "Exim version"
16012 .cindex customizing "version number"
16013 .cindex "version number of Exim" override
16014 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16015 various places.  Use with care; this may fool stupid security scanners.
16016
16017
16018 .option extra_local_interfaces main "string list" unset
16019 This option defines network interfaces that are to be considered local when
16020 routing, but which are not used for listening by the daemon. See section
16021 &<<SECTreclocipadd>>& for details.
16022
16023
16024 . Allow this long option name to split; give it unsplit as a fifth argument
16025 . for the automatic .oindex that is generated by .option.
16026
16027 .option "extract_addresses_remove_arguments" main boolean true &&&
16028          extract_addresses_remove_arguments
16029 .oindex "&%-t%&"
16030 .cindex "command line" "addresses with &%-t%&"
16031 .cindex "Sendmail compatibility" "&%-t%& option"
16032 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16033 are present on the command line when the &%-t%& option is used to build an
16034 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16035 line addresses are removed from the recipients list. This is also how Smail
16036 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16037 command line addresses are added to those obtained from the header lines. When
16038 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16039 argument headers. If it is set false, Exim adds rather than removes argument
16040 addresses.
16041
16042
16043 .option finduser_retries main integer 0
16044 .cindex "NIS, retrying user lookups"
16045 On systems running NIS or other schemes in which user and group information is
16046 distributed from a remote system, there can be times when &[getpwnam()]& and
16047 related functions fail, even when given valid data, because things time out.
16048 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16049 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16050 many extra times to find a user or a group, waiting for one second between
16051 retries.
16052
16053 .cindex "&_/etc/passwd_&" "multiple reading of"
16054 You should not set this option greater than zero if your user information is in
16055 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16056 search the file multiple times for non-existent users, and also cause delay.
16057
16058
16059
16060 .option freeze_tell main "string list, comma separated" unset
16061 .cindex "freezing messages" "sending a message when freezing"
16062 .cindex "frozen messages" "sending a message when freezing"
16063 On encountering certain errors, or when configured to do so in a system filter,
16064 ACL, or special router, Exim freezes a message. This means that no further
16065 delivery attempts take place until an administrator thaws the message, or the
16066 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16067 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16068 warning message whenever it freezes something, unless the message it is
16069 freezing is a locally-generated bounce message. (Without this exception there
16070 is the possibility of looping.) The warning message is sent to the addresses
16071 supplied as the comma-separated value of this option. If several of the
16072 message's addresses cause freezing, only a single message is sent. If the
16073 freezing was automatic, the reason(s) for freezing can be found in the message
16074 log. If you configure freezing in a filter or ACL, you must arrange for any
16075 logging that you require.
16076
16077
16078 .option gecos_name main string&!! unset
16079 .cindex "HP-UX"
16080 .cindex "&""gecos""& field, parsing"
16081 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16082 password file to hold other information in addition to users' real names. Exim
16083 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16084 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16085 of the field are used unchanged, except that, if an ampersand is encountered,
16086 it is replaced by the user's login name with the first character forced to
16087 upper case, since this is a convention that is observed on many systems.
16088
16089 When these options are set, &%gecos_pattern%& is treated as a regular
16090 expression that is to be applied to the field (again with && replaced by the
16091 login name), and if it matches, &%gecos_name%& is expanded and used as the
16092 user's name.
16093
16094 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16095 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16096 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16097 name terminates at the first comma, the following can be used:
16098 .code
16099 gecos_pattern = ([^,]*)
16100 gecos_name = $1
16101 .endd
16102
16103 .option gecos_pattern main string unset
16104 See &%gecos_name%& above.
16105
16106
16107 .option gnutls_compat_mode main boolean unset
16108 This option controls whether GnuTLS is used in compatibility mode in an Exim
16109 server. This reduces security slightly, but improves interworking with older
16110 implementations of TLS.
16111
16112
16113 .option gnutls_allow_auto_pkcs11 main boolean unset
16114 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16115 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16116
16117 See
16118 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16119 for documentation.
16120
16121
16122
16123 .option headers_charset main string "see below"
16124 This option sets a default character set for translating from encoded MIME
16125 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16126 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16127 ultimate default is ISO-8859-1. For more details see the description of header
16128 insertions in section &<<SECTexpansionitems>>&.
16129
16130
16131
16132 .option header_maxsize main integer "see below"
16133 .cindex "header section" "maximum size of"
16134 .cindex "limit" "size of message header section"
16135 This option controls the overall maximum size of a message's header
16136 section. The default is the value of HEADER_MAXSIZE in
16137 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16138 sections are rejected.
16139
16140
16141 .option header_line_maxsize main integer 0
16142 .cindex "header lines" "maximum size of"
16143 .cindex "limit" "size of one header line"
16144 This option limits the length of any individual header line in a message, after
16145 all the continuations have been joined together. Messages with individual
16146 header lines that are longer than the limit are rejected. The default value of
16147 zero means &"no limit"&.
16148
16149
16150
16151
16152 .option helo_accept_junk_hosts main "host list&!!" unset
16153 .cindex "HELO" "accepting junk data"
16154 .cindex "EHLO" "accepting junk data"
16155 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16156 mail, and gives an error response for invalid data. Unfortunately, there are
16157 some SMTP clients that send syntactic junk. They can be accommodated by setting
16158 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16159 if you want to do semantic checking.
16160 See also &%helo_allow_chars%& for a way of extending the permitted character
16161 set.
16162
16163
16164 .option helo_allow_chars main string unset
16165 .cindex "HELO" "underscores in"
16166 .cindex "EHLO" "underscores in"
16167 .cindex "underscore in EHLO/HELO"
16168 This option can be set to a string of rogue characters that are permitted in
16169 all EHLO and HELO names in addition to the standard letters, digits,
16170 hyphens, and dots. If you really must allow underscores, you can set
16171 .code
16172 helo_allow_chars = _
16173 .endd
16174 Note that the value is one string, not a list.
16175
16176
16177 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16178 .cindex "HELO" "forcing reverse lookup"
16179 .cindex "EHLO" "forcing reverse lookup"
16180 If the domain given by a client in a HELO or EHLO command matches this
16181 list, a reverse lookup is done in order to establish the host's true name. The
16182 default forces a lookup if the client host gives the server's name or any of
16183 its IP addresses (in brackets), something that broken clients have been seen to
16184 do.
16185
16186
16187 .option helo_try_verify_hosts main "host list&!!" unset
16188 .cindex "HELO verifying" "optional"
16189 .cindex "EHLO" "verifying, optional"
16190 By default, Exim just checks the syntax of HELO and EHLO commands (see
16191 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16192 to do more extensive checking of the data supplied by these commands. The ACL
16193 condition &`verify = helo`& is provided to make this possible.
16194 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16195 to force the check to occur. From release 4.53 onwards, this is no longer
16196 necessary. If the check has not been done before &`verify = helo`& is
16197 encountered, it is done at that time. Consequently, this option is obsolete.
16198 Its specification is retained here for backwards compatibility.
16199
16200 When an EHLO or HELO command is received, if the calling host matches
16201 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16202 EHLO command either:
16203
16204 .ilist
16205 is an IP literal matching the calling address of the host, or
16206 .next
16207 .cindex "DNS" "reverse lookup"
16208 .cindex "reverse DNS lookup"
16209 matches the host name that Exim obtains by doing a reverse lookup of the
16210 calling host address, or
16211 .next
16212 when looked up in DNS yields the calling host address.
16213 .endlist
16214
16215 However, the EHLO or HELO command is not rejected if any of the checks
16216 fail. Processing continues, but the result of the check is remembered, and can
16217 be detected later in an ACL by the &`verify = helo`& condition.
16218
16219 If DNS was used for successful verification, the variable
16220 .cindex "DNS" "DNSSEC"
16221 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16222
16223 .option helo_verify_hosts main "host list&!!" unset
16224 .cindex "HELO verifying" "mandatory"
16225 .cindex "EHLO" "verifying, mandatory"
16226 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16227 backwards compatibility. For hosts that match this option, Exim checks the host
16228 name given in the HELO or EHLO in the same way as for
16229 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16230 rejected with a 550 error, and entries are written to the main and reject logs.
16231 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16232 error.
16233
16234 .option hold_domains main "domain list&!!" unset
16235 .cindex "domain" "delaying delivery"
16236 .cindex "delivery" "delaying certain domains"
16237 This option allows mail for particular domains to be held in the queue
16238 manually. The option is overridden if a message delivery is forced with the
16239 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16240 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16241 item in &%hold_domains%&, no routing or delivery for that address is done, and
16242 it is deferred every time the message is looked at.
16243
16244 This option is intended as a temporary operational measure for delaying the
16245 delivery of mail while some problem is being sorted out, or some new
16246 configuration tested. If you just want to delay the processing of some
16247 domains until a queue run occurs, you should use &%queue_domains%& or
16248 &%queue_smtp_domains%&, not &%hold_domains%&.
16249
16250 A setting of &%hold_domains%& does not override Exim's code for removing
16251 messages from the queue if they have been there longer than the longest retry
16252 time in any retry rule. If you want to hold messages for longer than the normal
16253 retry times, insert a dummy retry rule with a long retry time.
16254
16255
16256 .option host_lookup main "host list&!!" unset
16257 .cindex "host name" "lookup, forcing"
16258 Exim does not look up the name of a calling host from its IP address unless it
16259 is required to compare against some host list, or the host matches
16260 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16261 option (which normally contains IP addresses rather than host names). The
16262 default configuration file contains
16263 .code
16264 host_lookup = *
16265 .endd
16266 which causes a lookup to happen for all hosts. If the expense of these lookups
16267 is felt to be too great, the setting can be changed or removed.
16268
16269 After a successful reverse lookup, Exim does a forward lookup on the name it
16270 has obtained, to verify that it yields the IP address that it started with. If
16271 this check fails, Exim behaves as if the name lookup failed.
16272
16273 .vindex "&$host_lookup_failed$&"
16274 .vindex "&$sender_host_name$&"
16275 After any kind of failure, the host name (in &$sender_host_name$&) remains
16276 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16277 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16278 &`verify = reverse_host_lookup`& in ACLs.
16279
16280
16281 .option host_lookup_order main "string list" &`bydns:byaddr`&
16282 This option specifies the order of different lookup methods when Exim is trying
16283 to find a host name from an IP address. The default is to do a DNS lookup
16284 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16285 if that fails. You can change the order of these lookups, or omit one entirely,
16286 if you want.
16287
16288 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16289 multiple PTR records in the DNS and the IP address is not listed in
16290 &_/etc/hosts_&. Different operating systems give different results in this
16291 case. That is why the default tries a DNS lookup first.
16292
16293
16294
16295 .option host_reject_connection main "host list&!!" unset
16296 .cindex "host" "rejecting connections from"
16297 If this option is set, incoming SMTP calls from the hosts listed are rejected
16298 as soon as the connection is made.
16299 This option is obsolete, and retained only for backward compatibility, because
16300 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16301 connections immediately.
16302
16303 .new
16304 If the connection is on a TLS-on-connect port then the TCP connection is
16305 just dropped.  Otherwise, an SMTP error is sent first.
16306 .wen
16307
16308 The ability to give an immediate rejection (either by this option or using an
16309 ACL) is provided for use in unusual cases. Many hosts will just try again,
16310 sometimes without much delay. Normally, it is better to use an ACL to reject
16311 incoming messages at a later stage, such as after RCPT commands. See
16312 chapter &<<CHAPACL>>&.
16313
16314
16315 .option hosts_connection_nolog main "host list&!!" unset
16316 .cindex "host" "not logging connections from"
16317 This option defines a list of hosts for which connection logging does not
16318 happen, even though the &%smtp_connection%& log selector is set. For example,
16319 you might want not to log SMTP connections from local processes, or from
16320 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16321 the daemon; you should therefore strive to restrict its value to a short inline
16322 list of IP addresses and networks. To disable logging SMTP connections from
16323 local processes, you must create a host list with an empty item. For example:
16324 .code
16325 hosts_connection_nolog = :
16326 .endd
16327 .new
16328 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16329 lines, as may commonly be produced by a monitoring system.
16330 .wen
16331
16332
16333 .option hosts_require_alpn main "host list&!!" unset
16334 .cindex ALPN "require negotiation in server"
16335 .cindex TLS ALPN
16336 .cindex TLS "Application Layer Protocol Names"
16337 If the TLS library supports ALPN
16338 then a successful negotiation of ALPN will be required for any client
16339 matching the list, for TLS to be used.
16340 See also the &%tls_alpn%& option.
16341
16342 &*Note*&: prevention of fallback to in-clear connection is not
16343 managed by this option, and should be done separately.
16344
16345
16346 .option hosts_require_helo main "host list&!!" *
16347 .cindex "HELO/EHLO" requiring
16348 Exim will require an accepted HELO or EHLO command from a host matching
16349 this list, before accepting a MAIL command.
16350
16351
16352 .option hosts_proxy main "host list&!!" unset
16353 .cindex proxy "proxy protocol"
16354 This option enables use of Proxy Protocol proxies for incoming
16355 connections.  For details see section &<<SECTproxyInbound>>&.
16356
16357
16358 .option hosts_treat_as_local main "domain list&!!" unset
16359 .cindex "local host" "domains treated as"
16360 .cindex "host" "treated as local"
16361 If this option is set, any host names that match the domain list are treated as
16362 if they were the local host when Exim is scanning host lists obtained from MX
16363 records
16364 or other sources. Note that the value of this option is a domain list, not a
16365 host list, because it is always used to check host names, not IP addresses.
16366
16367 This option also applies when Exim is matching the special items
16368 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16369 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16370 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16371 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16372 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16373 interfaces and recognizing the local host.
16374
16375
16376 .option ibase_servers main "string list" unset
16377 .cindex "InterBase" "server list"
16378 This option provides a list of InterBase servers and associated connection data,
16379 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16380 The option is available only if Exim has been built with InterBase support.
16381
16382
16383
16384 .option ignore_bounce_errors_after main time 10w
16385 .cindex "bounce message" "discarding"
16386 .cindex "discarding bounce message"
16387 This option affects the processing of bounce messages that cannot be delivered,
16388 that is, those that suffer a permanent delivery failure. (Bounce messages that
16389 suffer temporary delivery failures are of course retried in the usual way.)
16390
16391 After a permanent delivery failure, bounce messages are frozen,
16392 because there is no sender to whom they can be returned. When a frozen bounce
16393 message has been in the queue for more than the given time, it is unfrozen at
16394 the next queue run, and a further delivery is attempted. If delivery fails
16395 again, the bounce message is discarded. This makes it possible to keep failed
16396 bounce messages around for a shorter time than the normal maximum retry time
16397 for frozen messages. For example,
16398 .code
16399 ignore_bounce_errors_after = 12h
16400 .endd
16401 retries failed bounce message deliveries after 12 hours, discarding any further
16402 failures. If the value of this option is set to a zero time period, bounce
16403 failures are discarded immediately. Setting a very long time (as in the default
16404 value) has the effect of disabling this option. For ways of automatically
16405 dealing with other kinds of frozen message, see &%auto_thaw%& and
16406 &%timeout_frozen_after%&.
16407
16408
16409 .option ignore_fromline_hosts main "host list&!!" unset
16410 .cindex "&""From""& line"
16411 .cindex "UUCP" "&""From""& line"
16412 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16413 the headers of a message. By default this is treated as the start of the
16414 message's body, which means that any following headers are not recognized as
16415 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16416 match those hosts that insist on sending it. If the sender is actually a local
16417 process rather than a remote host, and is using &%-bs%& to inject the messages,
16418 &%ignore_fromline_local%& must be set to achieve this effect.
16419
16420
16421 .option ignore_fromline_local main boolean false
16422 See &%ignore_fromline_hosts%& above.
16423
16424 .option keep_environment main "string list" unset
16425 .cindex "environment" "values from"
16426 This option contains a string list of environment variables to keep.
16427 You have to trust these variables or you have to be sure that
16428 these variables do not impose any security risk. Keep in mind that
16429 during the startup phase Exim is running with an effective UID 0 in most
16430 installations. As the default value is an empty list, the default
16431 environment for using libraries, running embedded Perl code, or running
16432 external binaries is empty, and does not not even contain PATH or HOME.
16433
16434 Actually the list is interpreted as a list of patterns
16435 (&<<SECTlistexpand>>&), except that it is not expanded first.
16436
16437 WARNING: Macro substitution is still done first, so having a macro
16438 FOO and having FOO_HOME in your &%keep_environment%& option may have
16439 unexpected results. You may work around this using a regular expression
16440 that does not match the macro name: ^[F]OO_HOME$.
16441
16442 Current versions of Exim issue a warning during startup if you do not mention
16443 &%keep_environment%& in your runtime configuration file and if your
16444 current environment is not empty. Future versions may not issue that warning
16445 anymore.
16446
16447 See the &%add_environment%& main config option for a way to set
16448 environment variables to a fixed value.  The environment for &(pipe)&
16449 transports is handled separately, see section &<<SECTpipeenv>>& for
16450 details.
16451
16452
16453 .option keep_malformed main time 4d
16454 This option specifies the length of time to keep messages whose spool files
16455 have been corrupted in some way. This should, of course, never happen. At the
16456 next attempt to deliver such a message, it gets removed. The incident is
16457 logged.
16458
16459
16460 .option ldap_ca_cert_dir main string unset
16461 .cindex "LDAP", "TLS CA certificate directory"
16462 .cindex certificate "directory for LDAP"
16463 This option indicates which directory contains CA certificates for verifying
16464 a TLS certificate presented by an LDAP server.
16465 While Exim does not provide a default value, your SSL library may.
16466 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16467 and constrained to be a directory.
16468
16469
16470 .option ldap_ca_cert_file main string unset
16471 .cindex "LDAP", "TLS CA certificate file"
16472 .cindex certificate "file for LDAP"
16473 This option indicates which file contains CA certificates for verifying
16474 a TLS certificate presented by an LDAP server.
16475 While Exim does not provide a default value, your SSL library may.
16476 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16477 and constrained to be a file.
16478
16479
16480 .option ldap_cert_file main string unset
16481 .cindex "LDAP" "TLS client certificate file"
16482 .cindex certificate "file for LDAP"
16483 This option indicates which file contains an TLS client certificate which
16484 Exim should present to the LDAP server during TLS negotiation.
16485 Should be used together with &%ldap_cert_key%&.
16486
16487
16488 .option ldap_cert_key main string unset
16489 .cindex "LDAP" "TLS client key file"
16490 .cindex certificate "key for LDAP"
16491 This option indicates which file contains the secret/private key to use
16492 to prove identity to the LDAP server during TLS negotiation.
16493 Should be used together with &%ldap_cert_file%&, which contains the
16494 identity to be proven.
16495
16496
16497 .option ldap_cipher_suite main string unset
16498 .cindex "LDAP" "TLS cipher suite"
16499 This controls the TLS cipher-suite negotiation during TLS negotiation with
16500 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16501 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16502
16503
16504 .option ldap_default_servers main "string list" unset
16505 .cindex "LDAP" "default servers"
16506 This option provides a list of LDAP servers which are tried in turn when an
16507 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16508 details of LDAP queries. This option is available only when Exim has been built
16509 with LDAP support.
16510
16511
16512 .option ldap_require_cert main string unset.
16513 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16514 This should be one of the values "hard", "demand", "allow", "try" or "never".
16515 A value other than one of these is interpreted as "never".
16516 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16517 Although Exim does not set a default, the LDAP library probably defaults
16518 to hard/demand.
16519
16520
16521 .option ldap_start_tls main boolean false
16522 .cindex "LDAP" "whether or not to negotiate TLS"
16523 If set, Exim will attempt to negotiate TLS with the LDAP server when
16524 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16525 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16526 of SSL-on-connect.
16527 In the event of failure to negotiate TLS, the action taken is controlled
16528 by &%ldap_require_cert%&.
16529 This option is ignored for &`ldapi`& connections.
16530
16531
16532 .option ldap_version main integer unset
16533 .cindex "LDAP" "protocol version, forcing"
16534 This option can be used to force Exim to set a specific protocol version for
16535 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16536 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16537 the LDAP headers; otherwise it is 2. This option is available only when Exim
16538 has been built with LDAP support.
16539
16540
16541
16542 .option local_from_check main boolean true
16543 .cindex "&'Sender:'& header line" "disabling addition of"
16544 .cindex "&'From:'& header line" "disabling checking of"
16545 When a message is submitted locally (that is, not over a TCP/IP connection) by
16546 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16547 checks that the &'From:'& header line matches the login of the calling user and
16548 the domain specified by &%qualify_domain%&.
16549
16550 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16551 locally submitted message is automatically qualified by Exim, unless the
16552 &%-bnq%& command line option is used.
16553
16554 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16555 on the local part. If the &'From:'& header line does not match, Exim adds a
16556 &'Sender:'& header with an address constructed from the calling user's login
16557 and the default qualify domain.
16558
16559 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16560 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16561 &'Sender:'& header lines supplied by untrusted users, you must also set
16562 &%local_sender_retain%& to be true.
16563
16564 .cindex "envelope from"
16565 .cindex "envelope sender"
16566 These options affect only the header lines in the message. The envelope sender
16567 is still forced to be the login id at the qualify domain unless
16568 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16569
16570 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16571 request similar header line checking. See section &<<SECTthesenhea>>&, which
16572 has more details about &'Sender:'& processing.
16573
16574
16575
16576
16577 .option local_from_prefix main string unset
16578 When Exim checks the &'From:'& header line of locally submitted messages for
16579 matching the login id (see &%local_from_check%& above), it can be configured to
16580 ignore certain prefixes and suffixes in the local part of the address. This is
16581 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16582 appropriate lists, in the same form as the &%local_part_prefix%& and
16583 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16584 example, if
16585 .code
16586 local_from_prefix = *-
16587 .endd
16588 is set, a &'From:'& line containing
16589 .code
16590 From: anything-user@your.domain.example
16591 .endd
16592 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16593 matches the actual sender address that is constructed from the login name and
16594 qualify domain.
16595
16596
16597 .option local_from_suffix main string unset
16598 See &%local_from_prefix%& above.
16599
16600
16601 .option local_interfaces main "string list" "see below"
16602 This option controls which network interfaces are used by the daemon for
16603 listening; they are also used to identify the local host when routing. Chapter
16604 &<<CHAPinterfaces>>& contains a full description of this option and the related
16605 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16606 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16607 &%local_interfaces%& is
16608 .code
16609 local_interfaces = 0.0.0.0
16610 .endd
16611 when Exim is built without IPv6 support; otherwise it is
16612 .code
16613 local_interfaces = <; ::0 ; 0.0.0.0
16614 .endd
16615
16616 .option local_scan_timeout main time 5m
16617 .cindex "timeout" "for &[local_scan()]& function"
16618 .cindex "&[local_scan()]& function" "timeout"
16619 This timeout applies to the &[local_scan()]& function (see chapter
16620 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16621 the incoming message is rejected with a temporary error if it is an SMTP
16622 message. For a non-SMTP message, the message is dropped and Exim ends with a
16623 non-zero code. The incident is logged on the main and reject logs.
16624
16625
16626
16627 .option local_sender_retain main boolean false
16628 .cindex "&'Sender:'& header line" "retaining from local submission"
16629 When a message is submitted locally (that is, not over a TCP/IP connection) by
16630 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16631 do not want this to happen, you must set &%local_sender_retain%&, and you must
16632 also set &%local_from_check%& to be false (Exim will complain if you do not).
16633 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16634 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16635
16636
16637
16638
16639 .option localhost_number main string&!! unset
16640 .cindex "host" "locally unique number for"
16641 .cindex "message ids" "with multiple hosts"
16642 .vindex "&$localhost_number$&"
16643 Exim's message ids are normally unique only within the local host. If
16644 uniqueness among a set of hosts is required, each host must set a different
16645 value for the &%localhost_number%& option. The string is expanded immediately
16646 after reading the configuration file (so that a number can be computed from the
16647 host name, for example) and the result of the expansion must be a number in the
16648 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16649 systems). This is available in subsequent string expansions via the variable
16650 &$localhost_number$&. When &%localhost_number is set%&, the final two
16651 characters of the message id, instead of just being a fractional part of the
16652 time, are computed from the time and the local host number as described in
16653 section &<<SECTmessiden>>&.
16654
16655
16656
16657 .option log_file_path main "string list&!!" "set at compile time"
16658 .cindex "log" "file path for"
16659 This option sets the path which is used to determine the names of Exim's log
16660 files, or indicates that logging is to be to syslog, or both. It is expanded
16661 when Exim is entered, so it can, for example, contain a reference to the host
16662 name. If no specific path is set for the log files at compile or runtime,
16663 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16664 they are written in a sub-directory called &_log_& in Exim's spool directory.
16665 A path must start with a slash.
16666 To send to syslog, use the word &"syslog"&.
16667 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16668 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16669 used. If this string is fixed at your installation (contains no expansion
16670 variables) it is recommended that you do not set this option in the
16671 configuration file, but instead supply the path using LOG_FILE_PATH in
16672 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16673 early on &-- in particular, failure to read the configuration file.
16674
16675
16676 .option log_selector main string unset
16677 .cindex "log" "selectors"
16678 This option can be used to reduce or increase the number of things that Exim
16679 writes to its log files. Its argument is made up of names preceded by plus or
16680 minus characters. For example:
16681 .code
16682 log_selector = +arguments -retry_defer
16683 .endd
16684 A list of possible names and what they control is given in the chapter on
16685 logging, in section &<<SECTlogselector>>&.
16686
16687
16688 .option log_timezone main boolean false
16689 .cindex "log" "timezone for entries"
16690 .vindex "&$tod_log$&"
16691 .vindex "&$tod_zone$&"
16692 By default, the timestamps on log lines are in local time without the
16693 timezone. This means that if your timezone changes twice a year, the timestamps
16694 in log lines are ambiguous for an hour when the clocks go back. One way of
16695 avoiding this problem is to set the timezone to UTC. An alternative is to set
16696 &%log_timezone%& true. This turns on the addition of the timezone offset to
16697 timestamps in log lines. Turning on this option can add quite a lot to the size
16698 of log files because each line is extended by 6 characters. Note that the
16699 &$tod_log$& variable contains the log timestamp without the zone, but there is
16700 another variable called &$tod_zone$& that contains just the timezone offset.
16701
16702
16703 .option lookup_open_max main integer 25
16704 .cindex "too many open files"
16705 .cindex "open files, too many"
16706 .cindex "file" "too many open"
16707 .cindex "lookup" "maximum open files"
16708 .cindex "limit" "open files for lookups"
16709 This option limits the number of simultaneously open files for single-key
16710 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16711 Exim normally keeps these files open during routing, because often the same
16712 file is required several times. If the limit is reached, Exim closes the least
16713 recently used file. Note that if you are using the &'ndbm'& library, it
16714 actually opens two files for each logical DBM database, though it still counts
16715 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16716 open files"& errors with NDBM, you need to reduce the value of
16717 &%lookup_open_max%&.
16718
16719
16720 .option max_username_length main integer 0
16721 .cindex "length of login name"
16722 .cindex "user name" "maximum length"
16723 .cindex "limit" "user name length"
16724 Some operating systems are broken in that they truncate long arguments to
16725 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16726 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16727 an argument that is longer behaves as if &[getpwnam()]& failed.
16728
16729
16730 .option message_body_newlines main bool false
16731 .cindex "message body" "newlines in variables"
16732 .cindex "newline" "in message body variables"
16733 .vindex "&$message_body$&"
16734 .vindex "&$message_body_end$&"
16735 By default, newlines in the message body are replaced by spaces when setting
16736 the &$message_body$& and &$message_body_end$& expansion variables. If this
16737 option is set true, this no longer happens.
16738
16739
16740 .option message_body_visible main integer 500
16741 .cindex "body of message" "visible size"
16742 .cindex "message body" "visible size"
16743 .vindex "&$message_body$&"
16744 .vindex "&$message_body_end$&"
16745 This option specifies how much of a message's body is to be included in the
16746 &$message_body$& and &$message_body_end$& expansion variables.
16747
16748
16749 .option message_id_header_domain main string&!! unset
16750 .cindex "&'Message-ID:'& header line"
16751 If this option is set, the string is expanded and used as the right hand side
16752 (domain) of the &'Message-ID:'& header that Exim creates if a
16753 locally-originated incoming message does not have one. &"Locally-originated"&
16754 means &"not received over TCP/IP."&
16755 Otherwise, the primary host name is used.
16756 Only letters, digits, dot and hyphen are accepted; any other characters are
16757 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16758 empty string, the option is ignored.
16759
16760
16761 .option message_id_header_text main string&!! unset
16762 If this variable is set, the string is expanded and used to augment the text of
16763 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16764 message does not have one. The text of this header is required by RFC 2822 to
16765 take the form of an address. By default, Exim uses its internal message id as
16766 the local part, and the primary host name as the domain. If this option is set,
16767 it is expanded, and provided the expansion is not forced to fail, and does not
16768 yield an empty string, the result is inserted into the header immediately
16769 before the @, separated from the internal message id by a dot. Any characters
16770 that are illegal in an address are automatically converted into hyphens. This
16771 means that variables such as &$tod_log$& can be used, because the spaces and
16772 colons will become hyphens.
16773
16774
16775 .option message_logs main boolean true
16776 .cindex "message logs" "disabling"
16777 .cindex "log" "message log; disabling"
16778 If this option is turned off, per-message log files are not created in the
16779 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16780 Exim, by reducing the number of files involved in handling a message from a
16781 minimum of four (header spool file, body spool file, delivery journal, and
16782 per-message log) to three. The other major I/O activity is Exim's main log,
16783 which is not affected by this option.
16784
16785
16786 .option message_size_limit main string&!! 50M
16787 .cindex "message" "size limit"
16788 .cindex "limit" "message size"
16789 .cindex "size" "of message, limit"
16790 This option limits the maximum size of message that Exim will process. The
16791 value is expanded for each incoming connection so, for example, it can be made
16792 to depend on the IP address of the remote host for messages arriving via
16793 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16794 optionally followed by K or M.
16795
16796 .cindex "SIZE" "ESMTP extension, advertising"
16797 .cindex "ESMTP extensions" SIZE
16798 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16799 service extension keyword.
16800
16801 &*Note*&: This limit cannot be made to depend on a message's sender or any
16802 other properties of an individual message, because it has to be advertised in
16803 the server's response to EHLO. String expansion failure causes a temporary
16804 error. A value of zero means no limit, but its use is not recommended. See also
16805 &%bounce_return_size_limit%&.
16806
16807 Incoming SMTP messages are failed with a 552 error if the limit is
16808 exceeded; locally-generated messages either get a stderr message or a delivery
16809 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16810 an oversized message is logged in both the main and the reject logs. See also
16811 the generic transport option &%message_size_limit%&, which limits the size of
16812 message that an individual transport can process.
16813
16814 If you use a virus-scanner and set this option to to a value larger than the
16815 maximum size that your virus-scanner is configured to support, you may get
16816 failures triggered by large mails.  The right size to configure for the
16817 virus-scanner depends upon what data is passed and the options in use but it's
16818 probably safest to just set it to a little larger than this value.  E.g., with a
16819 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16820 some problems may result.
16821
16822 A value of 0 will disable size limit checking; Exim will still advertise the
16823 SIZE extension in an EHLO response, but without a limit, so as to permit
16824 SMTP clients to still indicate the message size along with the MAIL verb.
16825
16826
16827 .option move_frozen_messages main boolean false
16828 .cindex "frozen messages" "moving"
16829 This option, which is available only if Exim has been built with the setting
16830 .code
16831 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16832 .endd
16833 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16834 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16835 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16836 standard utilities for handling such moved messages, and they do not show up in
16837 lists generated by &%-bp%& or by the Exim monitor.
16838
16839
16840 .option mua_wrapper main boolean false
16841 Setting this option true causes Exim to run in a very restrictive mode in which
16842 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16843 contains a full description of this facility.
16844
16845
16846
16847 .option mysql_servers main "string list" unset
16848 .cindex "MySQL" "server list"
16849 This option provides a list of MySQL servers and associated connection data, to
16850 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16851 option is available only if Exim has been built with MySQL support.
16852
16853
16854 .option never_users main "string list&!!" unset
16855 This option is expanded just once, at the start of Exim's processing. Local
16856 message deliveries are normally run in processes that are setuid to the
16857 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16858 It is usually desirable to prevent any deliveries from running as root, as a
16859 safety precaution.
16860
16861 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16862 list of users that must not be used for local deliveries. This list is fixed in
16863 the binary and cannot be overridden by the configuration file. By default, it
16864 contains just the single user name &"root"&. The &%never_users%& runtime option
16865 can be used to add more users to the fixed list.
16866
16867 If a message is to be delivered as one of the users on the fixed list or the
16868 &%never_users%& list, an error occurs, and delivery is deferred. A common
16869 example is
16870 .code
16871 never_users = root:daemon:bin
16872 .endd
16873 Including root is redundant if it is also on the fixed list, but it does no
16874 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16875 transport driver.
16876
16877
16878 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16879 This option gives the name for a unix-domain socket on which the daemon
16880 listens for work and information-requests.
16881 Only installations running multiple daemons sharing a spool directory
16882 should need to modify the default.
16883
16884 The option is expanded before use.
16885 If the platform supports Linux-style abstract socket names, the result
16886 is used with a nul byte prefixed.
16887 Otherwise,
16888 it should be a full path name and use a directory accessible
16889 to Exim.
16890
16891 If this option is set as empty,
16892 or the command line &%-oY%& option is used, or
16893 the command line uses a &%-oX%& option and does not use &%-oP%&,
16894 then a notifier socket is not created.
16895
16896
16897 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16898 .cindex "OpenSSL "compatibility options"
16899 This option allows an administrator to adjust the SSL options applied
16900 by OpenSSL to connections.  It is given as a space-separated list of items,
16901 each one to be +added or -subtracted from the current value.
16902
16903 This option is only available if Exim is built against OpenSSL.  The values
16904 available for this option vary according to the age of your OpenSSL install.
16905 The &"all"& value controls a subset of flags which are available, typically
16906 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16907 list the values known on your system and Exim should support all the
16908 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16909 names lose the leading &"SSL_OP_"& and are lower-cased.
16910
16911 Note that adjusting the options can have severe impact upon the security of
16912 SSL as used by Exim.  It is possible to disable safety checks and shoot
16913 yourself in the foot in various unpleasant ways.  This option should not be
16914 adjusted lightly.  An unrecognised item will be detected at startup, by
16915 invoking Exim with the &%-bV%& flag.
16916
16917 The option affects Exim operating both as a server and as a client.
16918
16919 Historical note: prior to release 4.80, Exim defaulted this value to
16920 "+dont_insert_empty_fragments", which may still be needed for compatibility
16921 with some clients, but which lowers security by increasing exposure to
16922 some now infamous attacks.
16923
16924 Examples:
16925 .code
16926 # Make both old MS and old Eudora happy:
16927 openssl_options = -all +microsoft_big_sslv3_buffer \
16928                        +dont_insert_empty_fragments
16929
16930 # Disable older protocol versions:
16931 openssl_options = +no_sslv2 +no_sslv3
16932 .endd
16933
16934 Possible options may include:
16935 .ilist
16936 &`all`&
16937 .next
16938 &`allow_unsafe_legacy_renegotiation`&
16939 .next
16940 &`cipher_server_preference`&
16941 .next
16942 &`dont_insert_empty_fragments`&
16943 .next
16944 &`ephemeral_rsa`&
16945 .next
16946 &`legacy_server_connect`&
16947 .next
16948 &`microsoft_big_sslv3_buffer`&
16949 .next
16950 &`microsoft_sess_id_bug`&
16951 .next
16952 &`msie_sslv2_rsa_padding`&
16953 .next
16954 &`netscape_challenge_bug`&
16955 .next
16956 &`netscape_reuse_cipher_change_bug`&
16957 .next
16958 &`no_compression`&
16959 .next
16960 &`no_session_resumption_on_renegotiation`&
16961 .next
16962 &`no_sslv2`&
16963 .next
16964 &`no_sslv3`&
16965 .next
16966 &`no_ticket`&
16967 .next
16968 &`no_tlsv1`&
16969 .next
16970 &`no_tlsv1_1`&
16971 .next
16972 &`no_tlsv1_2`&
16973 .next
16974 &`safari_ecdhe_ecdsa_bug`&
16975 .next
16976 &`single_dh_use`&
16977 .next
16978 &`single_ecdh_use`&
16979 .next
16980 &`ssleay_080_client_dh_bug`&
16981 .next
16982 &`sslref2_reuse_cert_type_bug`&
16983 .next
16984 &`tls_block_padding_bug`&
16985 .next
16986 &`tls_d5_bug`&
16987 .next
16988 &`tls_rollback_bug`&
16989 .endlist
16990
16991 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16992 all clients connecting using the MacOS SecureTransport TLS facility prior
16993 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16994 to negotiate TLS then this option value might help, provided that your OpenSSL
16995 release is new enough to contain this work-around.  This may be a situation
16996 where you have to upgrade OpenSSL to get buggy clients working.
16997
16998
16999 .option oracle_servers main "string list" unset
17000 .cindex "Oracle" "server list"
17001 This option provides a list of Oracle servers and associated connection data,
17002 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17003 The option is available only if Exim has been built with Oracle support.
17004
17005
17006 .new
17007 .option panic_coredump main boolean false
17008 This option is rarely needed but can help for some debugging investigations.
17009 If set, when an internal error is detected by Exim which is sufficient
17010 to terminate the process
17011 (all such are logged in the paniclog)
17012 then a coredump is requested.
17013
17014 Note that most systems require additional administrative configuration
17015 to permit write a core file for a setuid program, which is Exim's
17016 common installed configuration.
17017 .wen
17018
17019 .option percent_hack_domains main "domain list&!!" unset
17020 .cindex "&""percent hack""&"
17021 .cindex "source routing" "in email address"
17022 .cindex "address" "source-routed"
17023 The &"percent hack"& is the convention whereby a local part containing a
17024 percent sign is re-interpreted as a new email address, with the percent
17025 replaced by @. This is sometimes called &"source routing"&, though that term is
17026 also applied to RFC 2822 addresses that begin with an @ character. If this
17027 option is set, Exim implements the percent facility for those domains listed,
17028 but no others. This happens before an incoming SMTP address is tested against
17029 an ACL.
17030
17031 &*Warning*&: The &"percent hack"& has often been abused by people who are
17032 trying to get round relaying restrictions. For this reason, it is best avoided
17033 if at all possible. Unfortunately, a number of less security-conscious MTAs
17034 implement it unconditionally. If you are running Exim on a gateway host, and
17035 routing mail through to internal MTAs without processing the local parts, it is
17036 a good idea to reject recipient addresses with percent characters in their
17037 local parts. Exim's default configuration does this.
17038
17039
17040 .option perl_at_start main boolean false
17041 .cindex "Perl"
17042 This option is available only when Exim is built with an embedded Perl
17043 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17044
17045
17046 .option perl_startup main string unset
17047 .cindex "Perl"
17048 This option is available only when Exim is built with an embedded Perl
17049 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17050
17051 .option perl_taintmode main boolean false
17052 .cindex "Perl"
17053 This option enables the taint mode of the embedded Perl interpreter.
17054
17055
17056 .option pgsql_servers main "string list" unset
17057 .cindex "PostgreSQL lookup type" "server list"
17058 This option provides a list of PostgreSQL servers and associated connection
17059 data, to be used in conjunction with &(pgsql)& lookups (see section
17060 &<<SECID72>>&). The option is available only if Exim has been built with
17061 PostgreSQL support.
17062
17063
17064 .option pid_file_path main string&!! "set at compile time"
17065 .cindex "daemon" "pid file path"
17066 .cindex "pid file, path for"
17067 This option sets the name of the file to which the Exim daemon writes its
17068 process id. The string is expanded, so it can contain, for example, references
17069 to the host name:
17070 .code
17071 pid_file_path = /var/log/$primary_hostname/exim.pid
17072 .endd
17073 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17074 spool directory.
17075 The value set by the option can be overridden by the &%-oP%& command line
17076 option. A pid file is not written if a &"non-standard"& daemon is run by means
17077 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17078
17079
17080 .option pipelining_advertise_hosts main "host list&!!" *
17081 .cindex "PIPELINING" "suppressing advertising"
17082 .cindex "ESMTP extensions" PIPELINING
17083 This option can be used to suppress the advertisement of the SMTP
17084 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17085 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17086 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17087 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17088 that clients will use it; &"out of order"& commands that are &"expected"& do
17089 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17090
17091 .option pipelining_connect_advertise_hosts main "host list&!!" *
17092 .cindex "pipelining" "early connection"
17093 .cindex "pipelining" PIPECONNECT
17094 .cindex "ESMTP extensions" PIPECONNECT
17095 If Exim is built without the DISABLE_PIPE_CONNECT build option
17096 this option controls which hosts the facility is advertised to
17097 and from which pipeline early-connection (before MAIL) SMTP
17098 commands are acceptable.
17099 When used, the pipelining saves on roundtrip times.
17100
17101 See also the &%hosts_pipe_connect%& smtp transport option.
17102
17103 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17104 it permits the client to pipeline
17105 TCP connection and hello command (inclear phase),
17106 or TLS-establishment and hello command (encrypted phase),
17107 on later connections to the same host.
17108
17109
17110 .option prdr_enable main boolean false
17111 .cindex "PRDR" "enabling on server"
17112 .cindex "ESMTP extensions" PRDR
17113 This option can be used to enable the Per-Recipient Data Response extension
17114 to SMTP, defined by Eric Hall.
17115 If the option is set, PRDR is advertised by Exim when operating as a server.
17116 If the client requests PRDR, and more than one recipient, for a message
17117 an additional ACL is called for each recipient after the message content
17118 is received.  See section &<<SECTPRDRACL>>&.
17119
17120 .option preserve_message_logs main boolean false
17121 .cindex "message logs" "preserving"
17122 If this option is set, message log files are not deleted when messages are
17123 completed. Instead, they are moved to a sub-directory of the spool directory
17124 called &_msglog.OLD_&, where they remain available for statistical or debugging
17125 purposes. This is a dangerous option to set on systems with any appreciable
17126 volume of mail. Use with care!
17127
17128
17129 .option primary_hostname main string "see below"
17130 .cindex "name" "of local host"
17131 .cindex "host" "name of local"
17132 .cindex "local host" "name of"
17133 .vindex "&$primary_hostname$&"
17134 This specifies the name of the current host. It is used in the default EHLO or
17135 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17136 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17137 The value is also used by default in some SMTP response messages from an Exim
17138 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17139
17140 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17141 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17142 contains only one component, Exim passes it to &[gethostbyname()]& (or
17143 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17144 version. The variable &$primary_hostname$& contains the host name, whether set
17145 explicitly by this option, or defaulted.
17146
17147
17148 .option print_topbitchars main boolean false
17149 .cindex "printing characters"
17150 .cindex "8-bit characters"
17151 By default, Exim considers only those characters whose codes lie in the range
17152 32&--126 to be printing characters. In a number of circumstances (for example,
17153 when writing log entries) non-printing characters are converted into escape
17154 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17155 is set, code values of 128 and above are also considered to be printing
17156 characters.
17157
17158 This option also affects the header syntax checks performed by the
17159 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17160 the user's full name when constructing From: and Sender: addresses (as
17161 described in section &<<SECTconstr>>&). Setting this option can cause
17162 Exim to generate eight bit message headers that do not conform to the
17163 standards.
17164
17165
17166 .option process_log_path main string unset
17167 .cindex "process log path"
17168 .cindex "log" "process log"
17169 .cindex "&'exiwhat'&"
17170 This option sets the name of the file to which an Exim process writes its
17171 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17172 utility script. If this option is unset, the file called &_exim-process.info_&
17173 in Exim's spool directory is used. The ability to specify the name explicitly
17174 can be useful in environments where two different Exims are running, using
17175 different spool directories.
17176
17177
17178 .option prod_requires_admin main boolean true
17179 .cindex "restricting access to features"
17180 .oindex "&%-M%&"
17181 .oindex "&%-R%&"
17182 .oindex "&%-q%&"
17183 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17184 admin user unless &%prod_requires_admin%& is set false. See also
17185 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17186
17187
17188 .option proxy_protocol_timeout main time 3s
17189 .cindex proxy "proxy protocol"
17190 This option sets the timeout for proxy protocol negotiation.
17191 For details see section &<<SECTproxyInbound>>&.
17192
17193
17194 .option qualify_domain main string "see below"
17195 .cindex "domain" "for qualifying addresses"
17196 .cindex "address" "qualification"
17197 This option specifies the domain name that is added to any envelope sender
17198 addresses that do not have a domain qualification. It also applies to
17199 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17200 are accepted by default only for locally-generated messages. Qualification is
17201 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17202 locally-generated messages, unless the &%-bnq%& command line option is used.
17203
17204 Messages from external sources must always contain fully qualified addresses,
17205 unless the sending host matches &%sender_unqualified_hosts%& or
17206 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17207 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17208 necessary. Internally, Exim always works with fully qualified envelope
17209 addresses. If &%qualify_domain%& is not set, it defaults to the
17210 &%primary_hostname%& value.
17211
17212
17213 .option qualify_recipient main string "see below"
17214 This option allows you to specify a different domain for qualifying recipient
17215 addresses to the one that is used for senders. See &%qualify_domain%& above.
17216
17217
17218
17219 .option queue_domains main "domain list&!!" unset
17220 .cindex "domain" "specifying non-immediate delivery"
17221 .cindex "queueing incoming messages"
17222 .cindex "message" "queueing certain domains"
17223 This option lists domains for which immediate delivery is not required.
17224 A delivery process is started whenever a message is received, but only those
17225 domains that do not match are processed. All other deliveries wait until the
17226 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17227
17228
17229 .option queue_fast_ramp main boolean true
17230 .cindex "queue runner" "two phase"
17231 .cindex "queue" "double scanning"
17232 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17233 command line, may start parallel delivery processes during their first
17234 phase.  This will be done when a threshold number of messages have been
17235 routed for a single host.
17236
17237
17238 .option queue_list_requires_admin main boolean true
17239 .cindex "restricting access to features"
17240 .oindex "&%-bp%&"
17241 The &%-bp%& command-line option, which lists the messages that are on the
17242 queue, requires the caller to be an admin user unless
17243 &%queue_list_requires_admin%& is set false.
17244 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17245
17246
17247 .option queue_only main boolean false
17248 .cindex "queueing incoming messages"
17249 .cindex "message" "queueing unconditionally"
17250 If &%queue_only%& is set, a delivery process is not automatically started
17251 whenever a message is received. Instead, the message waits in the queue for the
17252 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17253 delivered immediately when certain conditions (such as heavy load) occur.
17254
17255 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17256 and &%-odi%& command line options override &%queue_only%& unless
17257 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17258 &%queue_only_load%&, and &%smtp_accept_queue%&.
17259
17260
17261 .option queue_only_file main string unset
17262 .cindex "queueing incoming messages"
17263 .cindex "message" "queueing by file existence"
17264 This option can be set to a colon-separated list of absolute path names, each
17265 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17266 it tests for the existence of each listed path using a call to &[stat()]&. For
17267 each path that exists, the corresponding queueing option is set.
17268 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17269 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17270 .code
17271 queue_only_file = smtp/some/file
17272 .endd
17273 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17274 &_/some/file_& exists.
17275
17276
17277 .option queue_only_load main fixed-point unset
17278 .cindex "load average"
17279 .cindex "queueing incoming messages"
17280 .cindex "message" "queueing by load"
17281 If the system load average is higher than this value, incoming messages from
17282 all sources are queued, and no automatic deliveries are started. If this
17283 happens during local or remote SMTP input, all subsequent messages received on
17284 the same SMTP connection are queued by default, whatever happens to the load in
17285 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17286 false.
17287
17288 Deliveries will subsequently be performed by queue runner processes. This
17289 option has no effect on ancient operating systems on which Exim cannot
17290 determine the load average. See also &%deliver_queue_load_max%& and
17291 &%smtp_load_reserve%&.
17292
17293
17294 .option queue_only_load_latch main boolean true
17295 .cindex "load average" "re-evaluating per message"
17296 When this option is true (the default), once one message has been queued
17297 because the load average is higher than the value set by &%queue_only_load%&,
17298 all subsequent messages received on the same SMTP connection are also queued.
17299 This is a deliberate choice; even though the load average may fall below the
17300 threshold, it doesn't seem right to deliver later messages on the same
17301 connection when not delivering earlier ones. However, there are special
17302 circumstances such as very long-lived connections from scanning appliances
17303 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17304 should be set false. This causes the value of the load average to be
17305 re-evaluated for each message.
17306
17307
17308 .option queue_only_override main boolean true
17309 .cindex "queueing incoming messages"
17310 When this option is true, the &%-od%&&'x'& command line options override the
17311 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17312 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17313 to override; they are accepted, but ignored.
17314
17315
17316 .option queue_run_in_order main boolean false
17317 .cindex "queue runner" "processing messages in order"
17318 If this option is set, queue runs happen in order of message arrival instead of
17319 in an arbitrary order. For this to happen, a complete list of the entire queue
17320 must be set up before the deliveries start. When the queue is all held in a
17321 single directory (the default), a single list is created for both the ordered
17322 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17323 single list is not created when &%queue_run_in_order%& is false. In this case,
17324 the sub-directories are processed one at a time (in a random order), and this
17325 avoids setting up one huge list for the whole queue. Thus, setting
17326 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17327 when the queue is large, because of the extra work in setting up the single,
17328 large list. In most situations, &%queue_run_in_order%& should not be set.
17329
17330
17331
17332 .option queue_run_max main integer&!! 5
17333 .cindex "queue runner" "maximum number of"
17334 This controls the maximum number of queue runner processes that an Exim daemon
17335 can run simultaneously. This does not mean that it starts them all at once,
17336 but rather that if the maximum number are still running when the time comes to
17337 start another one, it refrains from starting another one. This can happen with
17338 very large queues and/or very sluggish deliveries. This option does not,
17339 however, interlock with other processes, so additional queue runners can be
17340 started by other means, or by killing and restarting the daemon.
17341
17342 Setting this option to zero does not suppress queue runs; rather, it disables
17343 the limit, allowing any number of simultaneous queue runner processes to be
17344 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17345 the daemon's command line.
17346
17347 .cindex queues named
17348 .cindex "named queues" "resource limit"
17349 To set limits for different named queues use
17350 an expansion depending on the &$queue_name$& variable.
17351
17352 .option queue_smtp_domains main "domain list&!!" unset
17353 .cindex "queueing incoming messages"
17354 .cindex "message" "queueing remote deliveries"
17355 .cindex "first pass routing"
17356 When this option is set, a delivery process is started whenever a message is
17357 received, routing is performed, and local deliveries take place.
17358 However, if any SMTP deliveries are required for domains that match
17359 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17360 message waits in the queue for the next queue run. Since routing of the message
17361 has taken place, Exim knows to which remote hosts it must be delivered, and so
17362 when the queue run happens, multiple messages for the same host are delivered
17363 over a single SMTP connection. The &%-odqs%& command line option causes all
17364 SMTP deliveries to be queued in this way, and is equivalent to setting
17365 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17366 &%queue_domains%&.
17367
17368
17369 .option receive_timeout main time 0s
17370 .cindex "timeout" "for non-SMTP input"
17371 This option sets the timeout for accepting a non-SMTP message, that is, the
17372 maximum time that Exim waits when reading a message on the standard input. If
17373 the value is zero, it will wait forever. This setting is overridden by the
17374 &%-or%& command line option. The timeout for incoming SMTP messages is
17375 controlled by &%smtp_receive_timeout%&.
17376
17377 .option received_header_text main string&!! "see below"
17378 .cindex "customizing" "&'Received:'& header"
17379 .cindex "&'Received:'& header line" "customizing"
17380 This string defines the contents of the &'Received:'& message header that is
17381 added to each message, except for the timestamp, which is automatically added
17382 on at the end (preceded by a semicolon). The string is expanded each time it is
17383 used. If the expansion yields an empty string, no &'Received:'& header line is
17384 added to the message. Otherwise, the string should start with the text
17385 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17386 header lines.
17387 The default setting is:
17388
17389 .code
17390 received_header_text = Received: \
17391   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17392     {${if def:sender_ident \
17393       {from ${quote_local_part:$sender_ident} }}\
17394         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17395   by $primary_hostname \
17396   ${if def:received_protocol {with $received_protocol }}\
17397   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17398   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17399   (Exim $version_number)\n\t\
17400   ${if def:sender_address \
17401   {(envelope-from <$sender_address>)\n\t}}\
17402   id $message_exim_id\
17403   ${if def:received_for {\n\tfor $received_for}}
17404 .endd
17405
17406 The references to the TLS version and cipher are
17407 omitted when Exim is built without TLS
17408 support. The use of conditional expansions ensures that this works for both
17409 locally generated messages and messages received from remote hosts, giving
17410 header lines such as the following:
17411 .code
17412 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17413 by marley.carol.example with esmtp (Exim 4.00)
17414 (envelope-from <bob@carol.example>)
17415 id 16IOWa-00019l-00
17416 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17417 Received: by scrooge.carol.example with local (Exim 4.00)
17418 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17419 .endd
17420 Until the body of the message has been received, the timestamp is the time when
17421 the message started to be received. Once the body has arrived, and all policy
17422 checks have taken place, the timestamp is updated to the time at which the
17423 message was accepted.
17424
17425
17426 .option received_headers_max main integer 30
17427 .cindex "loop" "prevention"
17428 .cindex "mail loop prevention"
17429 .cindex "&'Received:'& header line" "counting"
17430 When a message is to be delivered, the number of &'Received:'& headers is
17431 counted, and if it is greater than this parameter, a mail loop is assumed to
17432 have occurred, the delivery is abandoned, and an error message is generated.
17433 This applies to both local and remote deliveries.
17434
17435
17436 .option recipient_unqualified_hosts main "host list&!!" unset
17437 .cindex "unqualified addresses"
17438 .cindex "host" "unqualified addresses from"
17439 This option lists those hosts from which Exim is prepared to accept unqualified
17440 recipient addresses in message envelopes. The addresses are made fully
17441 qualified by the addition of the &%qualify_recipient%& value. This option also
17442 affects message header lines. Exim does not reject unqualified recipient
17443 addresses in headers, but it qualifies them only if the message came from a
17444 host that matches &%recipient_unqualified_hosts%&,
17445 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17446 option was not set.
17447
17448
17449 .option recipients_max main integer 50000
17450 .cindex "limit" "number of recipients"
17451 .cindex "recipient" "maximum number"
17452 If this option is set greater than zero, it specifies the maximum number of
17453 original recipients for any message. Additional recipients that are generated
17454 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17455 all recipients over the limit; earlier recipients are delivered as normal.
17456 Non-SMTP messages with too many recipients are failed, and no deliveries are
17457 done.
17458
17459 .cindex "RCPT" "maximum number of incoming"
17460 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17461 RCPT commands in a single message.
17462
17463
17464 .option recipients_max_reject main boolean false
17465 If this option is set true, Exim rejects SMTP messages containing too many
17466 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17467 error to the eventual DATA command. Otherwise (the default) it gives a 452
17468 error to the surplus RCPT commands and accepts the message on behalf of the
17469 initial set of recipients. The remote server should then re-send the message
17470 for the remaining recipients at a later time.
17471
17472
17473 .option remote_max_parallel main integer 4
17474 .cindex "delivery" "parallelism for remote"
17475 This option controls parallel delivery of one message to a number of remote
17476 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17477 does all the remote deliveries for a message one by one. Otherwise, if a single
17478 message has to be delivered to more than one remote host, or if several copies
17479 have to be sent to the same remote host, up to &%remote_max_parallel%&
17480 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17481 deliveries are required, the maximum number of processes are started, and as
17482 each one finishes, another is begun. The order of starting processes is the
17483 same as if sequential delivery were being done, and can be controlled by the
17484 &%remote_sort_domains%& option. If parallel delivery takes place while running
17485 with debugging turned on, the debugging output from each delivery process is
17486 tagged with its process id.
17487
17488 This option controls only the maximum number of parallel deliveries for one
17489 message in one Exim delivery process. Because Exim has no central queue
17490 manager, there is no way of controlling the total number of simultaneous
17491 deliveries if the configuration allows a delivery attempt as soon as a message
17492 is received.
17493
17494 See also the &%max_parallel%& generic transport option,
17495 and the &%serialize_hosts%& smtp transport option.
17496
17497 .cindex "number of deliveries"
17498 .cindex "delivery" "maximum number of"
17499 If you want to control the total number of deliveries on the system, you
17500 need to set the &%queue_only%& option. This ensures that all incoming messages
17501 are added to the queue without starting a delivery process. Then set up an Exim
17502 daemon to start queue runner processes at appropriate intervals (probably
17503 fairly often, for example, every minute), and limit the total number of queue
17504 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17505 delivers only one message at a time, the maximum number of deliveries that can
17506 then take place at once is &%queue_run_max%& multiplied by
17507 &%remote_max_parallel%&.
17508
17509 If it is purely remote deliveries you want to control, use
17510 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17511 doing the SMTP routing before queueing, so that several messages for the same
17512 host will eventually get delivered down the same connection.
17513
17514
17515 .option remote_sort_domains main "domain list&!!" unset
17516 .cindex "sorting remote deliveries"
17517 .cindex "delivery" "sorting remote"
17518 When there are a number of remote deliveries for a message, they are sorted by
17519 domain into the order given by this list. For example,
17520 .code
17521 remote_sort_domains = *.cam.ac.uk:*.uk
17522 .endd
17523 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17524 then to those in the &%uk%& domain, then to any others.
17525
17526
17527 .option retry_data_expire main time 7d
17528 .cindex "hints database" "data expiry"
17529 This option sets a &"use before"& time on retry information in Exim's hints
17530 database. Any older retry data is ignored. This means that, for example, once a
17531 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17532 past failures.
17533
17534
17535 .option retry_interval_max main time 24h
17536 .cindex "retry" "limit on interval"
17537 .cindex "limit" "on retry interval"
17538 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17539 intervals between delivery attempts for messages that cannot be delivered
17540 straight away. This option sets an overall limit to the length of time between
17541 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17542 the default value.
17543
17544
17545 .option return_path_remove main boolean true
17546 .cindex "&'Return-path:'& header line" "removing"
17547 RFC 2821, section 4.4, states that an SMTP server must insert a
17548 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17549 The &'Return-path:'& header preserves the sender address as received in the
17550 MAIL command. This description implies that this header should not be present
17551 in an incoming message. If &%return_path_remove%& is true, any existing
17552 &'Return-path:'& headers are removed from messages at the time they are
17553 received. Exim's transports have options for adding &'Return-path:'& headers at
17554 the time of delivery. They are normally used only for final local deliveries.
17555
17556
17557 .option return_size_limit main integer 100K
17558 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17559
17560
17561 .option rfc1413_hosts main "host list&!!" @[]
17562 .cindex "RFC 1413"
17563 .cindex "host" "for RFC 1413 calls"
17564 RFC 1413 identification calls are made to any client host which matches
17565 an item in the list.
17566 The default value specifies just this host, being any local interface
17567 for the system.
17568
17569 .option rfc1413_query_timeout main time 0s
17570 .cindex "RFC 1413" "query timeout"
17571 .cindex "timeout" "for RFC 1413 call"
17572 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17573 no RFC 1413 calls are ever made.
17574
17575
17576 .option sender_unqualified_hosts main "host list&!!" unset
17577 .cindex "unqualified addresses"
17578 .cindex "host" "unqualified addresses from"
17579 This option lists those hosts from which Exim is prepared to accept unqualified
17580 sender addresses. The addresses are made fully qualified by the addition of
17581 &%qualify_domain%&. This option also affects message header lines. Exim does
17582 not reject unqualified addresses in headers that contain sender addresses, but
17583 it qualifies them only if the message came from a host that matches
17584 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17585 using TCP/IP), and the &%-bnq%& option was not set.
17586
17587
17588 .option slow_lookup_log main integer 0
17589 .cindex "logging" "slow lookups"
17590 .cindex "dns" "logging slow lookups"
17591 This option controls logging of slow lookups.
17592 If the value is nonzero it is taken as a number of milliseconds
17593 and lookups taking longer than this are logged.
17594 Currently this applies only to DNS lookups.
17595
17596
17597
17598 .option smtp_accept_keepalive main boolean true
17599 .cindex "keepalive" "on incoming connection"
17600 This option controls the setting of the SO_KEEPALIVE option on incoming
17601 TCP/IP socket connections. When set, it causes the kernel to probe idle
17602 connections periodically, by sending packets with &"old"& sequence numbers. The
17603 other end of the connection should send an acknowledgment if the connection is
17604 still okay or a reset if the connection has been aborted. The reason for doing
17605 this is that it has the beneficial effect of freeing up certain types of
17606 connection that can get stuck when the remote host is disconnected without
17607 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17608 hours to detect unreachable hosts.
17609
17610
17611
17612 .option smtp_accept_max main integer 20
17613 .cindex "limit" "incoming SMTP connections"
17614 .cindex "SMTP" "incoming connection count"
17615 .cindex "inetd"
17616 This option specifies the maximum number of simultaneous incoming SMTP calls
17617 that Exim will accept. It applies only to the listening daemon; there is no
17618 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17619 value is set to zero, no limit is applied. However, it is required to be
17620 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17621 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17622
17623 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17624 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17625 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17626 and &%smtp_load_reserve%& are then checked before accepting the connection.
17627
17628
17629 .option smtp_accept_max_nonmail main integer 10
17630 .cindex "limit" "non-mail SMTP commands"
17631 .cindex "SMTP" "limiting non-mail commands"
17632 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17633 the connection if there are too many. This option defines &"too many"&. The
17634 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17635 client looping sending EHLO, for example. The check is applied only if the
17636 client host matches &%smtp_accept_max_nonmail_hosts%&.
17637
17638 When a new message is expected, one occurrence of RSET is not counted. This
17639 allows a client to send one RSET between messages (this is not necessary,
17640 but some clients do it). Exim also allows one uncounted occurrence of HELO
17641 or EHLO, and one occurrence of STARTTLS between messages. After
17642 starting up a TLS session, another EHLO is expected, and so it too is not
17643 counted. The first occurrence of AUTH in a connection, or immediately
17644 following STARTTLS is not counted. Otherwise, all commands other than
17645 MAIL, RCPT, DATA, and QUIT are counted.
17646
17647
17648 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17649 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17650 check by setting this option. The default value makes it apply to all hosts. By
17651 changing the value, you can exclude any badly-behaved hosts that you have to
17652 live with.
17653
17654
17655 . Allow this long option name to split; give it unsplit as a fifth argument
17656 . for the automatic .oindex that is generated by .option.
17657 . We insert " &~&~" which is both pretty nasty visually and results in
17658 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17659 . zero-width-space, which would be nicer visually and results in (at least)
17660 . html that Firefox will split on when it's forced to reflow (rather than
17661 . inserting a horizontal scrollbar).  However, the text is still not
17662 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17663 . the option name to split.
17664
17665 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17666          smtp_accept_max_per_connection
17667 .cindex "SMTP" "limiting incoming message count"
17668 .cindex "limit" "messages per SMTP connection"
17669 The value of this option limits the number of MAIL commands that Exim is
17670 prepared to accept over a single SMTP connection, whether or not each command
17671 results in the transfer of a message. After the limit is reached, a 421
17672 response is given to subsequent MAIL commands. This limit is a safety
17673 precaution against a client that goes mad (incidents of this type have been
17674 seen).
17675 The option is expanded after the HELO or EHLO is received
17676 and may depend on values available at that time.
17677 An empty or zero value after expansion removes the limit.
17678
17679
17680 .option smtp_accept_max_per_host main string&!! unset
17681 .cindex "limit" "SMTP connections from one host"
17682 .cindex "host" "limiting SMTP connections from"
17683 This option restricts the number of simultaneous IP connections from a single
17684 host (strictly, from a single IP address) to the Exim daemon. The option is
17685 expanded, to enable different limits to be applied to different hosts by
17686 reference to &$sender_host_address$&. Once the limit is reached, additional
17687 connection attempts from the same host are rejected with error code 421. This
17688 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17689 of zero imposes no limit. If this option is set greater than zero, it is
17690 required that &%smtp_accept_max%& be non-zero.
17691
17692 &*Warning*&: When setting this option you should not use any expansion
17693 constructions that take an appreciable amount of time. The expansion and test
17694 happen in the main daemon loop, in order to reject additional connections
17695 without forking additional processes (otherwise a denial-of-service attack
17696 could cause a vast number or processes to be created). While the daemon is
17697 doing this processing, it cannot accept any other incoming connections.
17698
17699
17700
17701 .option smtp_accept_queue main integer 0
17702 .cindex "SMTP" "incoming connection count"
17703 .cindex "queueing incoming messages"
17704 .cindex "message" "queueing by SMTP connection count"
17705 If the number of simultaneous incoming SMTP connections being handled via the
17706 listening daemon exceeds this value, messages received by SMTP are just placed
17707 in the queue; no delivery processes are started automatically. The count is
17708 fixed at the start of an SMTP connection. It cannot be updated in the
17709 subprocess that receives messages, and so the queueing or not queueing applies
17710 to all messages received in the same connection.
17711
17712 A value of zero implies no limit, and clearly any non-zero value is useful only
17713 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17714 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17715 various &%-od%&&'x'& command line options.
17716
17717
17718 . See the comment on smtp_accept_max_per_connection
17719
17720 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17721          smtp_accept_queue_per_connection
17722 .cindex "queueing incoming messages"
17723 .cindex "message" "queueing by message count"
17724 This option limits the number of delivery processes that Exim starts
17725 automatically when receiving messages via SMTP, whether via the daemon or by
17726 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17727 and the number of messages received in a single SMTP session exceeds this
17728 number, subsequent messages are placed in the queue, but no delivery processes
17729 are started. This helps to limit the number of Exim processes when a server
17730 restarts after downtime and there is a lot of mail waiting for it on other
17731 systems. On large systems, the default should probably be increased, and on
17732 dial-in client systems it should probably be set to zero (that is, disabled).
17733
17734
17735 .option smtp_accept_reserve main integer 0
17736 .cindex "SMTP" "incoming call count"
17737 .cindex "host" "reserved"
17738 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17739 number of SMTP connections that are reserved for connections from the hosts
17740 that are specified in &%smtp_reserve_hosts%&. The value set in
17741 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17742 restricted to this number of connections; the option specifies a minimum number
17743 of connection slots for them, not a maximum. It is a guarantee that this group
17744 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17745 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17746 individual host.
17747
17748 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17749 set to 5, once there are 45 active connections (from any hosts), new
17750 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17751 provided the other criteria for acceptance are met.
17752
17753
17754 .option smtp_active_hostname main string&!! unset
17755 .cindex "host" "name in SMTP responses"
17756 .cindex "SMTP" "host name in responses"
17757 .vindex "&$primary_hostname$&"
17758 This option is provided for multi-homed servers that want to masquerade as
17759 several different hosts. At the start of an incoming SMTP connection, its value
17760 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17761 responses. For example, it is used as domain name in the response to an
17762 incoming HELO or EHLO command.
17763
17764 .vindex "&$smtp_active_hostname$&"
17765 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17766 is saved with any messages that are received. It is therefore available for use
17767 in routers and transports when the message is later delivered.
17768
17769 If this option is unset, or if its expansion is forced to fail, or if the
17770 expansion results in an empty string, the value of &$primary_hostname$& is
17771 used. Other expansion failures cause a message to be written to the main and
17772 panic logs, and the SMTP command receives a temporary error. Typically, the
17773 value of &%smtp_active_hostname%& depends on the incoming interface address.
17774 For example:
17775 .code
17776 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17777   {cox.mydomain}{box.mydomain}}
17778 .endd
17779
17780 Although &$smtp_active_hostname$& is primarily concerned with incoming
17781 messages, it is also used as the default for HELO commands in callout
17782 verification if there is no remote transport from which to obtain a
17783 &%helo_data%& value.
17784
17785 .option smtp_backlog_monitor main integer 0
17786 .cindex "connection backlog" monitoring
17787 If this option is set to greater than zero, and the backlog of available
17788 TCP connections on a socket listening for SMTP is larger than it, a line
17789 is logged giving the value and the socket address and port.
17790 The value is retrived jsut before an accept call.
17791 This facility is only available on Linux.
17792
17793 .option smtp_banner main string&!! "see below"
17794 .cindex "SMTP" "welcome banner"
17795 .cindex "banner for SMTP"
17796 .cindex "welcome banner for SMTP"
17797 .cindex "customizing" "SMTP banner"
17798 If a connect ACL does not supply a message,
17799 this string (which is expanded every time it is used) is output as the initial
17800 positive response to an SMTP connection. The default setting is:
17801 .code
17802 smtp_banner = $smtp_active_hostname ESMTP Exim \
17803   $version_number $tod_full
17804 .endd
17805 .new
17806 Failure to expand the string causes a panic error;
17807 a forced fail just closes the connection.
17808 .wen
17809 If you want to create a
17810 multiline response to the initial SMTP connection, use &"\n"& in the string at
17811 appropriate points, but not at the end. Note that the 220 code is not included
17812 in this string. Exim adds it automatically (several times in the case of a
17813 multiline response).
17814
17815
17816 .option smtp_check_spool_space main boolean true
17817 .cindex "checking disk space"
17818 .cindex "disk space, checking"
17819 .cindex "spool directory" "checking space"
17820 When this option is set, if an incoming SMTP session encounters the SIZE
17821 option on a MAIL command, it checks that there is enough space in the
17822 spool directory's partition to accept a message of that size, while still
17823 leaving free the amount specified by &%check_spool_space%& (even if that value
17824 is zero). If there isn't enough space, a temporary error code is returned.
17825
17826
17827 .option smtp_connect_backlog main integer 20
17828 .cindex "connection backlog" "set maximum"
17829 .cindex "SMTP" "connection backlog"
17830 .cindex "backlog of connections"
17831 This option specifies a maximum number of waiting SMTP connections. Exim passes
17832 this value to the TCP/IP system when it sets up its listener. Once this number
17833 of connections are waiting for the daemon's attention, subsequent connection
17834 attempts are refused at the TCP/IP level. At least, that is what the manuals
17835 say; in some circumstances such connection attempts have been observed to time
17836 out instead. For large systems it is probably a good idea to increase the
17837 value (to 50, say). It also gives some protection against denial-of-service
17838 attacks by SYN flooding.
17839
17840
17841 .option smtp_enforce_sync main boolean true
17842 .cindex "SMTP" "synchronization checking"
17843 .cindex "synchronization checking in SMTP"
17844 The SMTP protocol specification requires the client to wait for a response from
17845 the server at certain points in the dialogue. Without PIPELINING these
17846 synchronization points are after every command; with PIPELINING they are
17847 fewer, but they still exist.
17848
17849 Some spamming sites send out a complete set of SMTP commands without waiting
17850 for any response. Exim protects against this by rejecting a message if the
17851 client has sent further input when it should not have. The error response &"554
17852 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17853 for this error cannot be perfect because of transmission delays (unexpected
17854 input may be on its way but not yet received when Exim checks). However, it
17855 does detect many instances.
17856
17857 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17858 If you want to disable the check selectively (for example, only for certain
17859 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17860 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17861
17862
17863
17864 .option smtp_etrn_command main string&!! unset
17865 .cindex "ETRN" "command to be run"
17866 .cindex "ESMTP extensions" ETRN
17867 .vindex "&$domain$&"
17868 If this option is set, the given command is run whenever an SMTP ETRN
17869 command is received from a host that is permitted to issue such commands (see
17870 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17871 are independently expanded. The expansion variable &$domain$& is set to the
17872 argument of the ETRN command, and no syntax checking is done on it. For
17873 example:
17874 .code
17875 smtp_etrn_command = /etc/etrn_command $domain \
17876                     $sender_host_address
17877 .endd
17878 If the option is not set, the argument for the ETRN command must
17879 be a &'#'& followed by an address string.
17880 In this case an &'exim -R <string>'& command is used;
17881 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17882
17883 A new process is created to run the command, but Exim does not wait for it to
17884 complete. Consequently, its status cannot be checked. If the command cannot be
17885 run, a line is written to the panic log, but the ETRN caller still receives
17886 a 250 success response. Exim is normally running under its own uid when
17887 receiving SMTP, so it is not possible for it to change the uid before running
17888 the command.
17889
17890
17891 .option smtp_etrn_serialize main boolean true
17892 .cindex "ETRN" "serializing"
17893 When this option is set, it prevents the simultaneous execution of more than
17894 one identical command as a result of ETRN in an SMTP connection. See
17895 section &<<SECTETRN>>& for details.
17896
17897
17898 .option smtp_load_reserve main fixed-point unset
17899 .cindex "load average"
17900 If the system load average ever gets higher than this, incoming SMTP calls are
17901 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17902 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17903 the load is over the limit. The option has no effect on ancient operating
17904 systems on which Exim cannot determine the load average. See also
17905 &%deliver_queue_load_max%& and &%queue_only_load%&.
17906
17907
17908
17909 .option smtp_max_synprot_errors main integer 3
17910 .cindex "SMTP" "limiting syntax and protocol errors"
17911 .cindex "limit" "SMTP syntax and protocol errors"
17912 Exim rejects SMTP commands that contain syntax or protocol errors. In
17913 particular, a syntactically invalid email address, as in this command:
17914 .code
17915 RCPT TO:<abc xyz@a.b.c>
17916 .endd
17917 causes immediate rejection of the command, before any other tests are done.
17918 (The ACL cannot be run if there is no valid address to set up for it.) An
17919 example of a protocol error is receiving RCPT before MAIL. If there are
17920 too many syntax or protocol errors in one SMTP session, the connection is
17921 dropped. The limit is set by this option.
17922
17923 .cindex "PIPELINING" "expected errors"
17924 When the PIPELINING extension to SMTP is in use, some protocol errors are
17925 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17926 Exim assumes that PIPELINING will be used if it advertises it (see
17927 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17928 not count towards the limit.
17929
17930
17931
17932 .option smtp_max_unknown_commands main integer 3
17933 .cindex "SMTP" "limiting unknown commands"
17934 .cindex "limit" "unknown SMTP commands"
17935 If there are too many unrecognized commands in an incoming SMTP session, an
17936 Exim server drops the connection. This is a defence against some kinds of abuse
17937 that subvert web
17938 clients
17939 into making connections to SMTP ports; in these circumstances, a number of
17940 non-SMTP command lines are sent first.
17941
17942
17943
17944 .option smtp_ratelimit_hosts main "host list&!!" unset
17945 .cindex "SMTP" "rate limiting"
17946 .cindex "limit" "rate of message arrival"
17947 .cindex "RCPT" "rate limiting"
17948 Some sites find it helpful to be able to limit the rate at which certain hosts
17949 can send them messages, and the rate at which an individual message can specify
17950 recipients.
17951
17952 Exim has two rate-limiting facilities. This section describes the older
17953 facility, which can limit rates within a single connection. The newer
17954 &%ratelimit%& ACL condition can limit rates across all connections. See section
17955 &<<SECTratelimiting>>& for details of the newer facility.
17956
17957 When a host matches &%smtp_ratelimit_hosts%&, the values of
17958 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17959 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17960 respectively. Each option, if set, must contain a set of four comma-separated
17961 values:
17962
17963 .ilist
17964 A threshold, before which there is no rate limiting.
17965 .next
17966 An initial time delay. Unlike other times in Exim, numbers with decimal
17967 fractional parts are allowed here.
17968 .next
17969 A factor by which to increase the delay each time.
17970 .next
17971 A maximum value for the delay. This should normally be less than 5 minutes,
17972 because after that time, the client is liable to timeout the SMTP command.
17973 .endlist
17974
17975 For example, these settings have been used successfully at the site which
17976 first suggested this feature, for controlling mail from their customers:
17977 .code
17978 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17979 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17980 .endd
17981 The first setting specifies delays that are applied to MAIL commands after
17982 two have been received over a single connection. The initial delay is 0.5
17983 seconds, increasing by a factor of 1.05 each time. The second setting applies
17984 delays to RCPT commands when more than four occur in a single message.
17985
17986
17987 .option smtp_ratelimit_mail main string unset
17988 See &%smtp_ratelimit_hosts%& above.
17989
17990
17991 .option smtp_ratelimit_rcpt main string unset
17992 See &%smtp_ratelimit_hosts%& above.
17993
17994
17995 .option smtp_receive_timeout main time&!! 5m
17996 .cindex "timeout" "for SMTP input"
17997 .cindex "SMTP" "input timeout"
17998 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17999 input, including batch SMTP. If a line of input (either an SMTP command or a
18000 data line) is not received within this time, the SMTP connection is dropped and
18001 the message is abandoned.
18002 A line is written to the log containing one of the following messages:
18003 .code
18004 SMTP command timeout on connection from...
18005 SMTP data timeout on connection from...
18006 .endd
18007 The former means that Exim was expecting to read an SMTP command; the latter
18008 means that it was in the DATA phase, reading the contents of a message.
18009
18010 If the first character of the option is a &"$"& the option is
18011 expanded before use and may depend on
18012 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18013
18014
18015 .oindex "&%-os%&"
18016 The value set by this option can be overridden by the
18017 &%-os%& command-line option. A setting of zero time disables the timeout, but
18018 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18019 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18020 timeout is controlled by &%receive_timeout%& and &%-or%&.
18021
18022
18023 .option smtp_reserve_hosts main "host list&!!" unset
18024 This option defines hosts for which SMTP connections are reserved; see
18025 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18026
18027
18028 .option smtp_return_error_details main boolean false
18029 .cindex "SMTP" "details policy failures"
18030 .cindex "policy control" "rejection, returning details"
18031 In the default state, Exim uses bland messages such as
18032 &"Administrative prohibition"& when it rejects SMTP commands for policy
18033 reasons. Many sysadmins like this because it gives away little information
18034 to spammers. However, some other sysadmins who are applying strict checking
18035 policies want to give out much fuller information about failures. Setting
18036 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18037 example, instead of &"Administrative prohibition"&, it might give:
18038 .code
18039 550-Rejected after DATA: '>' missing at end of address:
18040 550 failing address in "From" header is: <user@dom.ain
18041 .endd
18042
18043
18044 .option smtputf8_advertise_hosts main "host list&!!" *
18045 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18046 .cindex "ESMTP extensions" SMTPUTF8
18047 When Exim is built with support for internationalised mail names,
18048 the availability thereof is advertised in
18049 response to EHLO only to those client hosts that match this option. See
18050 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18051
18052
18053 .option spamd_address main string "127.0.0.1 783"
18054 This option is available when Exim is compiled with the content-scanning
18055 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18056 See section &<<SECTscanspamass>>& for more details.
18057
18058
18059
18060 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18061 This option is available when Exim is compiled with SPF support.
18062 See section &<<SECSPF>>& for more details.
18063
18064 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18065 This option is available when Exim is compiled with SPF support.  It
18066 allows the customisation of the SMTP comment that the SPF library
18067 generates.  You are strongly encouraged to link to your own explanative
18068 site. The template must not contain spaces. If you need spaces in the
18069 output, use the proper placeholder. If libspf2 can not parse the
18070 template, it uses a built-in default broken link. The following placeholders
18071 (along with Exim variables (but see below)) are allowed in the template:
18072 .ilist
18073 &*%_*&: A space.
18074 .next
18075 &*%{L}*&: Envelope sender's local part.
18076 .next
18077 &*%{S}*&: Envelope sender.
18078 .next
18079 &*%{O}*&: Envelope sender's domain.
18080 .next
18081 &*%{D}*&: Current(?) domain.
18082 .next
18083 &*%{I}*&: SMTP client Ip.
18084 .next
18085 &*%{C}*&: SMTP client pretty IP.
18086 .next
18087 &*%{T}*&: Epoch time (UTC).
18088 .next
18089 &*%{P}*&: SMTP client domain name.
18090 .next
18091 &*%{V}*&: IP version.
18092 .next
18093 &*%{H}*&: EHLO/HELO domain.
18094 .next
18095 &*%{R}*&: Receiving domain.
18096 .endlist
18097 The capitalized placeholders do proper URL encoding, if you use them
18098 lowercased, no encoding takes place.  This list was compiled from the
18099 libspf2 sources.
18100
18101 A note on using Exim variables: As
18102 currently the SPF library is initialized before the SMTP EHLO phase,
18103 the variables useful for expansion are quite limited.
18104
18105
18106 .option split_spool_directory main boolean false
18107 .cindex "multiple spool directories"
18108 .cindex "spool directory" "split"
18109 .cindex "directories, multiple"
18110 If this option is set, it causes Exim to split its input directory into 62
18111 subdirectories, each with a single alphanumeric character as its name. The
18112 sixth character of the message id is used to allocate messages to
18113 subdirectories; this is the least significant base-62 digit of the time of
18114 arrival of the message.
18115
18116 Splitting up the spool in this way may provide better performance on systems
18117 where there are long mail queues, by reducing the number of files in any one
18118 directory. The msglog directory is also split up in a similar way to the input
18119 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18120 are still placed in the single directory &_msglog.OLD_&.
18121
18122 It is not necessary to take any special action for existing messages when
18123 changing &%split_spool_directory%&. Exim notices messages that are in the
18124 &"wrong"& place, and continues to process them. If the option is turned off
18125 after a period of being on, the subdirectories will eventually empty and be
18126 automatically deleted.
18127
18128 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18129 changes. Instead of creating a list of all messages in the queue, and then
18130 trying to deliver each one, in turn, it constructs a list of those in one
18131 sub-directory and tries to deliver them, before moving on to the next
18132 sub-directory. The sub-directories are processed in a random order. This
18133 spreads out the scanning of the input directories, and uses less memory. It is
18134 particularly beneficial when there are lots of messages in the queue. However,
18135 if &%queue_run_in_order%& is set, none of this new processing happens. The
18136 entire queue has to be scanned and sorted before any deliveries can start.
18137
18138
18139 .option spool_directory main string&!! "set at compile time"
18140 .cindex "spool directory" "path to"
18141 This defines the directory in which Exim keeps its spool, that is, the messages
18142 it is waiting to deliver. The default value is taken from the compile-time
18143 configuration setting, if there is one. If not, this option must be set. The
18144 string is expanded, so it can contain, for example, a reference to
18145 &$primary_hostname$&.
18146
18147 If the spool directory name is fixed on your installation, it is recommended
18148 that you set it at build time rather than from this option, particularly if the
18149 log files are being written to the spool directory (see &%log_file_path%&).
18150 Otherwise log files cannot be used for errors that are detected early on, such
18151 as failures in the configuration file.
18152
18153 By using this option to override the compiled-in path, it is possible to run
18154 tests of Exim without using the standard spool.
18155
18156 .option spool_wireformat main boolean false
18157 .cindex "spool directory" "file formats"
18158 If this option is set, Exim may for some messages use an alternative format
18159 for data-files in the spool which matches the wire format.
18160 Doing this permits more efficient message reception and transmission.
18161 Currently it is only done for messages received using the ESMTP CHUNKING
18162 option.
18163
18164 The following variables will not have useful values:
18165 .code
18166 $max_received_linelength
18167 $body_linecount
18168 $body_zerocount
18169 .endd
18170
18171 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18172 and any external programs which are passed a reference to a message data file
18173 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18174 will need to be aware of the different formats potentially available.
18175
18176 Using any of the ACL conditions noted will negate the reception benefit
18177 (as a Unix-mbox-format file is constructed for them).
18178 The transmission benefit is maintained.
18179
18180 .option sqlite_lock_timeout main time 5s
18181 .cindex "sqlite lookup type" "lock timeout"
18182 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18183 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18184
18185 .option strict_acl_vars main boolean false
18186 .cindex "&ACL;" "variables, handling unset"
18187 This option controls what happens if a syntactically valid but undefined ACL
18188 variable is referenced. If it is false (the default), an empty string
18189 is substituted; if it is true, an error is generated. See section
18190 &<<SECTaclvariables>>& for details of ACL variables.
18191
18192 .option strip_excess_angle_brackets main boolean false
18193 .cindex "angle brackets, excess"
18194 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18195 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18196 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18197 passed on to another MTA, the excess angle brackets are not passed on. If this
18198 option is not set, multiple pairs of angle brackets cause a syntax error.
18199
18200
18201 .option strip_trailing_dot main boolean false
18202 .cindex "trailing dot on domain"
18203 .cindex "dot" "trailing on domain"
18204 If this option is set, a trailing dot at the end of a domain in an address is
18205 ignored. If this is in the envelope and the message is passed on to another
18206 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18207 domain causes a syntax error.
18208 However, addresses in header lines are checked only when an ACL requests header
18209 syntax checking.
18210
18211
18212 .option syslog_duplication main boolean true
18213 .cindex "syslog" "duplicate log lines; suppressing"
18214 When Exim is logging to syslog, it writes the log lines for its three
18215 separate logs at different syslog priorities so that they can in principle
18216 be separated on the logging hosts. Some installations do not require this
18217 separation, and in those cases, the duplication of certain log lines is a
18218 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18219 particular log line is written to syslog. For lines that normally go to
18220 both the main log and the reject log, the reject log version (possibly
18221 containing message header lines) is written, at LOG_NOTICE priority.
18222 Lines that normally go to both the main and the panic log are written at
18223 the LOG_ALERT priority.
18224
18225
18226 .option syslog_facility main string unset
18227 .cindex "syslog" "facility; setting"
18228 This option sets the syslog &"facility"& name, used when Exim is logging to
18229 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18230 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18231 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18232 details of Exim's logging.
18233
18234
18235 .option syslog_pid main boolean true
18236 .cindex "syslog" "pid"
18237 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18238 omitted when these lines are sent to syslog. (Syslog normally prefixes
18239 the log lines with the PID of the logging process automatically.) You need
18240 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18241 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18242
18243
18244
18245 .option syslog_processname main string &`exim`&
18246 .cindex "syslog" "process name; setting"
18247 This option sets the syslog &"ident"& name, used when Exim is logging to
18248 syslog. The value must be no longer than 32 characters. See chapter
18249 &<<CHAPlog>>& for details of Exim's logging.
18250
18251
18252
18253 .option syslog_timestamp main boolean true
18254 .cindex "syslog" "timestamps"
18255 .cindex timestamps syslog
18256 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18257 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18258 details of Exim's logging.
18259
18260
18261 .option system_filter main string&!! unset
18262 .cindex "filter" "system filter"
18263 .cindex "system filter" "specifying"
18264 .cindex "Sieve filter" "not available for system filter"
18265 This option specifies an Exim filter file that is applied to all messages at
18266 the start of each delivery attempt, before any routing is done. System filters
18267 must be Exim filters; they cannot be Sieve filters. If the system filter
18268 generates any deliveries to files or pipes, or any new mail messages, the
18269 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18270 which transports are to be used. Details of this facility are given in chapter
18271 &<<CHAPsystemfilter>>&.
18272 A forced expansion failure results in no filter operation.
18273
18274
18275 .option system_filter_directory_transport main string&!! unset
18276 .vindex "&$address_file$&"
18277 This sets the name of the transport driver that is to be used when the
18278 &%save%& command in a system message filter specifies a path ending in &"/"&,
18279 implying delivery of each message into a separate file in some directory.
18280 During the delivery, the variable &$address_file$& contains the path name.
18281
18282
18283 .option system_filter_file_transport main string&!! unset
18284 .cindex "file" "transport for system filter"
18285 This sets the name of the transport driver that is to be used when the &%save%&
18286 command in a system message filter specifies a path not ending in &"/"&. During
18287 the delivery, the variable &$address_file$& contains the path name.
18288
18289 .option system_filter_group main string unset
18290 .cindex "gid (group id)" "system filter"
18291 This option is used only when &%system_filter_user%& is also set. It sets the
18292 gid under which the system filter is run, overriding any gid that is associated
18293 with the user. The value may be numerical or symbolic.
18294
18295 .option system_filter_pipe_transport main string&!! unset
18296 .cindex "&(pipe)& transport" "for system filter"
18297 .vindex "&$address_pipe$&"
18298 This specifies the transport driver that is to be used when a &%pipe%& command
18299 is used in a system filter. During the delivery, the variable &$address_pipe$&
18300 contains the pipe command.
18301
18302
18303 .option system_filter_reply_transport main string&!! unset
18304 .cindex "&(autoreply)& transport" "for system filter"
18305 This specifies the transport driver that is to be used when a &%mail%& command
18306 is used in a system filter.
18307
18308
18309 .option system_filter_user main string unset
18310 .cindex "uid (user id)" "system filter"
18311 If this option is set to root, the system filter is run in the main Exim
18312 delivery process, as root.  Otherwise, the system filter runs in a separate
18313 process, as the given user, defaulting to the Exim run-time user.
18314 Unless the string consists entirely of digits, it
18315 is looked up in the password data. Failure to find the named user causes a
18316 configuration error. The gid is either taken from the password data, or
18317 specified by &%system_filter_group%&. When the uid is specified numerically,
18318 &%system_filter_group%& is required to be set.
18319
18320 If the system filter generates any pipe, file, or reply deliveries, the uid
18321 under which the filter is run is used when transporting them, unless a
18322 transport option overrides.
18323
18324
18325 .option tcp_nodelay main boolean true
18326 .cindex "daemon" "TCP_NODELAY on sockets"
18327 .cindex "Nagle algorithm"
18328 .cindex "TCP_NODELAY on listening sockets"
18329 If this option is set false, it stops the Exim daemon setting the
18330 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18331 turns off the &"Nagle algorithm"&, which is a way of improving network
18332 performance in interactive (character-by-character) situations. Turning it off
18333 should improve Exim's performance a bit, so that is what happens by default.
18334 However, it appears that some broken clients cannot cope, and time out. Hence
18335 this option. It affects only those sockets that are set up for listening by the
18336 daemon. Sockets created by the smtp transport for delivering mail always set
18337 TCP_NODELAY.
18338
18339
18340 .option timeout_frozen_after main time 0s
18341 .cindex "frozen messages" "timing out"
18342 .cindex "timeout" "frozen messages"
18343 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18344 message of any kind that has been in the queue for longer than the given time
18345 is automatically cancelled at the next queue run. If the frozen message is a
18346 bounce message, it is just discarded; otherwise, a bounce is sent to the
18347 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18348 If you want to timeout frozen bounce messages earlier than other kinds of
18349 frozen message, see &%ignore_bounce_errors_after%&.
18350
18351 &*Note:*& the default value of zero means no timeouts; with this setting,
18352 frozen messages remain in the queue forever (except for any frozen bounce
18353 messages that are released by &%ignore_bounce_errors_after%&).
18354
18355
18356 .option timezone main string unset
18357 .cindex "timezone, setting"
18358 .cindex "environment" "values from"
18359 The value of &%timezone%& is used to set the environment variable TZ while
18360 running Exim (if it is different on entry). This ensures that all timestamps
18361 created by Exim are in the required timezone. If you want all your timestamps
18362 to be in UTC (aka GMT) you should set
18363 .code
18364 timezone = UTC
18365 .endd
18366 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18367 or, if that is not set, from the value of the TZ environment variable when Exim
18368 is built. If &%timezone%& is set to the empty string, either at build or run
18369 time, any existing TZ variable is removed from the environment when Exim
18370 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18371 unfortunately not all, operating systems.
18372
18373
18374 .option tls_advertise_hosts main "host list&!!" *
18375 .cindex "TLS" "advertising"
18376 .cindex "encryption" "on SMTP connection"
18377 .cindex "SMTP" "encrypted connection"
18378 .cindex "ESMTP extensions" STARTTLS
18379 When Exim is built with support for TLS encrypted connections, the availability
18380 of the STARTTLS command to set up an encrypted session is advertised in
18381 response to EHLO only to those client hosts that match this option. See
18382 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18383 Note that the default value requires that a certificate be supplied
18384 using the &%tls_certificate%& option.  If TLS support for incoming connections
18385 is not required the &%tls_advertise_hosts%& option should be set empty.
18386
18387
18388 .option tls_alpn main "string list&!!" "smtp : esmtp"
18389 .cindex TLS "Application Layer Protocol Names"
18390 .cindex TLS ALPN
18391 .cindex ALPN "set acceptable names for server"
18392 If this option is set,
18393 the TLS library supports ALPN,
18394 and the client offers either more than
18395 ALPN name or a name which does not match the list,
18396 the TLS connection is declined.
18397
18398
18399 .option tls_certificate main "string list&!!" unset
18400 .cindex "TLS" "server certificate; location of"
18401 .cindex "certificate" "server, location of"
18402 The value of this option is expanded, and must then be a list of absolute paths to
18403 files which contain the server's certificates (in PEM format).
18404 Commonly only one file is needed.
18405 The server's private key is also
18406 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18407 &<<CHAPTLS>>& for further details.
18408
18409 &*Note*&: The certificates defined by this option are used only when Exim is
18410 receiving incoming messages as a server. If you want to supply certificates for
18411 use when sending messages as a client, you must set the &%tls_certificate%&
18412 option in the relevant &(smtp)& transport.
18413
18414 &*Note*&: If you use filenames based on IP addresses, change the list
18415 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18416
18417 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18418 when a list of more than one
18419 file is used, the &$tls_in_ourcert$& variable is unreliable.
18420 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18421
18422 .cindex SNI "selecting server certificate based on"
18423 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18424 if the OpenSSL build supports TLS extensions and the TLS client sends the
18425 Server Name Indication extension, then this option and others documented in
18426 &<<SECTtlssni>>& will be re-expanded.
18427
18428 If this option is unset or empty a self-signed certificate will be
18429 used.
18430 Under Linux this is generated at daemon startup; on other platforms it will be
18431 generated fresh for every connection.
18432
18433 .option tls_crl main string&!! unset
18434 .cindex "TLS" "server certificate revocation list"
18435 .cindex "certificate" "revocation list for server"
18436 This option specifies a certificate revocation list. The expanded value must
18437 be the name of a file that contains CRLs in PEM format.
18438
18439 Under OpenSSL the option can specify a directory with CRL files.
18440
18441 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18442 for each signing element of the certificate chain (i.e. all but the leaf).
18443 For the file variant this can be multiple PEM blocks in the one file.
18444
18445 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18446
18447
18448 .option tls_dh_max_bits main integer 2236
18449 .cindex "TLS" "D-H bit count"
18450 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18451 the chosen TLS library.  That value might prove to be too high for
18452 interoperability.  This option provides a maximum clamp on the value
18453 suggested, trading off security for interoperability.
18454
18455 The value must be at least 1024.
18456
18457 The value 2236 was chosen because, at time of adding the option, it was the
18458 hard-coded maximum value supported by the NSS cryptographic library, as used
18459 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18460
18461 If you prefer more security and are willing to break some clients, raise this
18462 number.
18463
18464 Note that the value passed to GnuTLS for *generating* a new prime may be a
18465 little less than this figure, because GnuTLS is inexact and may produce a
18466 larger prime than requested.
18467
18468
18469 .option tls_dhparam main string&!! unset
18470 .cindex "TLS" "D-H parameters for server"
18471 The value of this option is expanded and indicates the source of DH parameters
18472 to be used by Exim.
18473
18474 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18475 local DH parameters*&, which has been supported across all versions of Exim.  The
18476 other specific constants available are a fallback so that even when
18477 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18478
18479 If &%tls_dhparam%& is a filename starting with a &`/`&,
18480 then it names a file from which DH
18481 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18482 PKCS#3 representation of the DH prime.  If the file does not exist, for
18483 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18484 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18485 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18486 and treated as though the &%tls_dhparam%& were set to "none".
18487
18488 If this option expands to the string "none", then no DH parameters will be
18489 loaded by Exim.
18490
18491 If this option expands to the string "historic" and Exim is using GnuTLS, then
18492 Exim will attempt to load a file from inside the spool directory.  If the file
18493 does not exist, Exim will attempt to create it.
18494 See section &<<SECTgnutlsparam>>& for further details.
18495
18496 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18497 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18498
18499 In older versions of Exim the default was the 2048 bit prime described in section
18500 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18501 in IKE is assigned number 23.
18502
18503 Otherwise, the option must expand to the name used by Exim for any of a number
18504 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18505 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18506 the number used by IKE, or "default" which corresponds to
18507 &`exim.dev.20160529.3`&.
18508
18509 The available standard primes are:
18510 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18511 &`ike1`&, &`ike2`&, &`ike5`&,
18512 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18513 &`ike22`&, &`ike23`& and &`ike24`&.
18514
18515 The available additional primes are:
18516 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18517
18518 Some of these will be too small to be accepted by clients.
18519 Some may be too large to be accepted by clients.
18520 The open cryptographic community has suspicions about the integrity of some
18521 of the later IKE values, which led into RFC7919 providing new fixed constants
18522 (the "ffdhe" identifiers).
18523
18524 At this point, all of the "ike" values should be considered obsolete;
18525 they are still in Exim to avoid breaking unusual configurations, but are
18526 candidates for removal the next time we have backwards-incompatible changes.
18527 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18528 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18529 SHOULD NOT.
18530 Because of this, Exim regards them as deprecated; if either of the first pair
18531 are used, warnings will be logged in the paniclog, and if any are used then
18532 warnings will be logged in the mainlog.
18533 All four will be removed in a future Exim release.
18534
18535 The TLS protocol does not negotiate an acceptable size for this; clients tend
18536 to hard-drop connections if what is offered by the server is unacceptable,
18537 whether too large or too small, and there's no provision for the client to
18538 tell the server what these constraints are.  Thus, as a server operator, you
18539 need to make an educated guess as to what is most likely to work for your
18540 userbase.
18541
18542 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18543 is most likely to maximise interoperability.  The upper bound comes from
18544 applications using the Mozilla Network Security Services (NSS) library, which
18545 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18546 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18547 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18548 acceptable bound from 1024 to 2048.
18549
18550
18551 .option tls_eccurve main string list&!! &`auto`&
18552 .cindex TLS "EC cryptography"
18553 This option selects EC curves for use by Exim when used with OpenSSL.
18554 It has no effect when Exim is used with GnuTLS
18555 (the equivalent can be done using a priority string for the
18556 &%tls_require_ciphers%& option).
18557
18558 After expansion it must contain
18559 .new
18560 one or (only for OpenSSL versiona 1.1.1 onwards) more
18561 .wen
18562 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18563 Consult your OpenSSL manual for valid curve names.
18564
18565 For OpenSSL versions before (and not including) 1.0.2, the string
18566 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18567 &`auto`& tells the library to choose.
18568
18569 .new
18570 If the option expands to an empty string, the effect is undefined.
18571 .wen
18572
18573
18574 .option tls_ocsp_file main string&!! unset
18575 .cindex TLS "certificate status"
18576 .cindex TLS "OCSP proof file"
18577 This option
18578 must if set expand to the absolute path to a file which contains a current
18579 status proof for the server's certificate, as obtained from the
18580 Certificate Authority.
18581
18582 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18583 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18584
18585 For OpenSSL 1.1.0 or later, and
18586 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18587 of files, to match a list given for the &%tls_certificate%& option.
18588 The ordering of the two lists must match.
18589 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18590
18591 The file(s) should be in DER format,
18592 except for GnuTLS 3.6.3 or later
18593 or for OpenSSL,
18594 when an optional filetype prefix can be used.
18595 The prefix must be one of "DER" or "PEM", followed by
18596 a single space.  If one is used it sets the format for subsequent
18597 files in the list; the initial format is DER.
18598 If multiple proofs are wanted, for multiple chain elements
18599 (this only works under TLS1.3)
18600 they must be coded as a combined OCSP response.
18601
18602 Although GnuTLS will accept PEM files with multiple separate
18603 PEM blobs (ie. separate OCSP responses), it sends them in the
18604 TLS Certificate record interleaved with the certificates of the chain;
18605 although a GnuTLS client is happy with that, an OpenSSL client is not.
18606
18607 .option tls_on_connect_ports main "string list" unset
18608 .cindex SSMTP
18609 .cindex SMTPS
18610 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18611 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18612 set up without waiting for the client to issue a STARTTLS command. For
18613 further details, see section &<<SECTsupobssmt>>&.
18614
18615
18616
18617 .option tls_privatekey main "string list&!!" unset
18618 .cindex "TLS" "server private key; location of"
18619 The value of this option is expanded, and must then be a list of absolute paths to
18620 files which contains the server's private keys.
18621 If this option is unset, or if
18622 the expansion is forced to fail, or the result is an empty string, the private
18623 key is assumed to be in the same file as the server's certificates. See chapter
18624 &<<CHAPTLS>>& for further details.
18625
18626 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18627
18628
18629 .option tls_remember_esmtp main boolean false
18630 .cindex "TLS" "esmtp state; remembering"
18631 .cindex "TLS" "broken clients"
18632 If this option is set true, Exim violates the RFCs by remembering that it is in
18633 &"esmtp"& state after successfully negotiating a TLS session. This provides
18634 support for broken clients that fail to send a new EHLO after starting a
18635 TLS session.
18636
18637
18638 .option tls_require_ciphers main string&!! unset
18639 .cindex "TLS" "requiring specific ciphers"
18640 .cindex "cipher" "requiring specific"
18641 This option controls which ciphers can be used for incoming TLS connections.
18642 The &(smtp)& transport has an option of the same name for controlling outgoing
18643 connections. This option is expanded for each connection, so can be varied for
18644 different clients if required. The value of this option must be a list of
18645 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18646 in somewhat different ways. If GnuTLS is being used, the client controls the
18647 preference order of the available ciphers. Details are given in sections
18648 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18649
18650
18651 .option tls_resumption_hosts main "host list&!!" unset
18652 .cindex TLS resumption
18653 This option controls which connections to offer the TLS resumption feature.
18654 See &<<SECTresumption>>& for details.
18655
18656
18657 .option tls_try_verify_hosts main "host list&!!" unset
18658 .cindex "TLS" "client certificate verification"
18659 .cindex "certificate" "verification of client"
18660 See &%tls_verify_hosts%& below.
18661
18662
18663 .option tls_verify_certificates main string&!! system
18664 .cindex "TLS" "client certificate verification"
18665 .cindex "certificate" "verification of client"
18666 The value of this option is expanded, and must then be either the
18667 word "system"
18668 or the absolute path to
18669 a file or directory containing permitted certificates for clients that
18670 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18671
18672 The "system" value for the option will use a
18673 system default location compiled into the SSL library.
18674 This is not available for GnuTLS versions preceding 3.0.20,
18675 and will be taken as empty; an explicit location
18676 must be specified.
18677
18678 The use of a directory for the option value is not available for GnuTLS versions
18679 preceding 3.3.6 and a single file must be used.
18680
18681 With OpenSSL the certificates specified
18682 explicitly
18683 either by file or directory
18684 are added to those given by the system default location.
18685
18686 These certificates should be for the certificate authorities trusted, rather
18687 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18688 the value is a file then the certificates are sent by Exim as a server to
18689 connecting clients, defining the list of accepted certificate authorities.
18690 Thus the values defined should be considered public data.  To avoid this,
18691 use the explicit directory version. (If your peer is Exim up to 4.85,
18692 using GnuTLS, you may need to send the CAs (thus using the file
18693 variant). Otherwise the peer doesn't send its certificate.)
18694
18695 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18696
18697 A forced expansion failure or setting to an empty string is equivalent to
18698 being unset.
18699
18700
18701 .option tls_verify_hosts main "host list&!!" unset
18702 .cindex "TLS" "client certificate verification"
18703 .cindex "certificate" "verification of client"
18704 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18705 certificates from clients. The expected certificates are defined by
18706 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18707 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18708 &%tls_verify_certificates%& is not set.
18709
18710 Any client that matches &%tls_verify_hosts%& is constrained by
18711 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18712 present one of the listed certificates. If it does not, the connection is
18713 aborted.
18714 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18715 the host to use TLS. It can still send SMTP commands through unencrypted
18716 connections. Forcing a client to use TLS has to be done separately using an
18717 ACL to reject inappropriate commands when the connection is not encrypted.
18718
18719 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18720 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18721 certificate and checks it against &%tls_verify_certificates%&, but does not
18722 abort the connection if there is no certificate or if it does not match. This
18723 state can be detected in an ACL, which makes it possible to implement policies
18724 such as &"accept for relay only if a verified certificate has been received,
18725 but accept for local delivery if encrypted, even without a verified
18726 certificate"&.
18727
18728 Client hosts that match neither of these lists are not asked to present
18729 certificates.
18730
18731
18732 .option trusted_groups main "string list&!!" unset
18733 .cindex "trusted groups"
18734 .cindex "groups" "trusted"
18735 This option is expanded just once, at the start of Exim's processing. If this
18736 option is set, any process that is running in one of the listed groups, or
18737 which has one of them as a supplementary group, is trusted. The groups can be
18738 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18739 details of what trusted callers are permitted to do. If neither
18740 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18741 are trusted.
18742
18743 .option trusted_users main "string list&!!" unset
18744 .cindex "trusted users"
18745 .cindex "user" "trusted"
18746 This option is expanded just once, at the start of Exim's processing. If this
18747 option is set, any process that is running as one of the listed users is
18748 trusted. The users can be specified numerically or by name. See section
18749 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18750 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18751 Exim user are trusted.
18752
18753 .option unknown_login main string&!! unset
18754 .cindex "uid (user id)" "unknown caller"
18755 .vindex "&$caller_uid$&"
18756 This is a specialized feature for use in unusual configurations. By default, if
18757 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18758 gives up. The &%unknown_login%& option can be used to set a login name to be
18759 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18760 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18761 is used for the user's real name (gecos field), unless this has been set by the
18762 &%-F%& option.
18763
18764 .option unknown_username main string unset
18765 See &%unknown_login%&.
18766
18767 .option untrusted_set_sender main "address list&!!" unset
18768 .cindex "trusted users"
18769 .cindex "sender" "setting by untrusted user"
18770 .cindex "untrusted user setting sender"
18771 .cindex "user" "untrusted setting sender"
18772 .cindex "envelope from"
18773 .cindex "envelope sender"
18774 When an untrusted user submits a message to Exim using the standard input, Exim
18775 normally creates an envelope sender address from the user's login and the
18776 default qualification domain. Data from the &%-f%& option (for setting envelope
18777 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18778 is used) is ignored.
18779
18780 However, untrusted users are permitted to set an empty envelope sender address,
18781 to declare that a message should never generate any bounces. For example:
18782 .code
18783 exim -f '<>' user@domain.example
18784 .endd
18785 .vindex "&$sender_ident$&"
18786 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18787 other envelope sender addresses in a controlled way. When it is set, untrusted
18788 users are allowed to set envelope sender addresses that match any of the
18789 patterns in the list. Like all address lists, the string is expanded. The
18790 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18791 users to setting senders that start with their login ids
18792 followed by a hyphen
18793 by a setting like this:
18794 .code
18795 untrusted_set_sender = ^$sender_ident-
18796 .endd
18797 If you want to allow untrusted users to set envelope sender addresses without
18798 restriction, you can use
18799 .code
18800 untrusted_set_sender = *
18801 .endd
18802 The &%untrusted_set_sender%& option applies to all forms of local input, but
18803 only to the setting of the envelope sender. It does not permit untrusted users
18804 to use the other options which trusted user can use to override message
18805 parameters. Furthermore, it does not stop Exim from removing an existing
18806 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18807 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18808 overriding these actions. The handling of the &'Sender:'& header is also
18809 described in section &<<SECTthesenhea>>&.
18810
18811 The log line for a message's arrival shows the envelope sender following
18812 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18813 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18814 envelope sender address, the user's login is shown in parentheses after the
18815 sender address.
18816
18817
18818 .option uucp_from_pattern main string "see below"
18819 .cindex "&""From""& line"
18820 .cindex "UUCP" "&""From""& line"
18821 Some applications that pass messages to an MTA via a command line interface use
18822 an initial line starting with &"From&~"& to pass the envelope sender. In
18823 particular, this is used by UUCP software. Exim recognizes such a line by means
18824 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18825 matches, the sender address is constructed by expanding the contents of
18826 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18827 default pattern recognizes lines in the following two forms:
18828 .code
18829 From ph10 Fri Jan  5 12:35 GMT 1996
18830 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18831 .endd
18832 The pattern can be seen by running
18833 .code
18834 exim -bP uucp_from_pattern
18835 .endd
18836 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18837 year in the second case. The first word after &"From&~"& is matched in the
18838 regular expression by a parenthesized subpattern. The default value for
18839 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18840 (&"ph10"& in the example above) as the message's sender. See also
18841 &%ignore_fromline_hosts%&.
18842
18843
18844 .option uucp_from_sender main string&!! &`$1`&
18845 See &%uucp_from_pattern%& above.
18846
18847
18848 .option warn_message_file main string&!! unset
18849 .cindex "warning of delay" "customizing the message"
18850 .cindex "customizing" "warning message"
18851 This option defines a template file containing paragraphs of text to be used
18852 for constructing the warning message which is sent by Exim when a message has
18853 been in the queue for a specified amount of time, as specified by
18854 &%delay_warning%&. Details of the file's contents are given in chapter
18855 &<<CHAPemsgcust>>&.
18856 .cindex warn_message_file "tainted data"
18857 The option is expanded to give the file path, which must be
18858 absolute and untainted.
18859 See also &%bounce_message_file%&.
18860
18861
18862 .option write_rejectlog main boolean true
18863 .cindex "reject log" "disabling"
18864 If this option is set false, Exim no longer writes anything to the reject log.
18865 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18866 .ecindex IIDconfima
18867 .ecindex IIDmaiconf
18868
18869
18870
18871
18872 . ////////////////////////////////////////////////////////////////////////////
18873 . ////////////////////////////////////////////////////////////////////////////
18874
18875 .chapter "Generic options for routers" "CHAProutergeneric"
18876 .scindex IIDgenoprou1 "options" "generic; for routers"
18877 .scindex IIDgenoprou2 "generic options" "router"
18878 This chapter describes the generic options that apply to all routers.
18879 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18880
18881 For a general description of how a router operates, see sections
18882 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18883 which the preconditions are tested. The order of expansion of the options that
18884 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18885 &%headers_remove%&, &%transport%&.
18886
18887 The name of a router is limited to be &drivernamemax; ASCII characters long;
18888 prior to Exim 4.95 names would be silently truncated at this length, but now
18889 it is enforced.
18890
18891
18892 .option address_data routers string&!! unset
18893 .cindex "router" "data attached to address"
18894 The string is expanded just before the router is run, that is, after all the
18895 precondition tests have succeeded. If the expansion is forced to fail, the
18896 router declines, the value of &%address_data%& remains unchanged, and the
18897 &%more%& option controls what happens next. Other expansion failures cause
18898 delivery of the address to be deferred.
18899
18900 .vindex "&$address_data$&"
18901 When the expansion succeeds, the value is retained with the address, and can be
18902 accessed using the variable &$address_data$& in the current router, subsequent
18903 routers, and the eventual transport.
18904
18905 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18906 that runs a user's filter file, the contents of &$address_data$& are accessible
18907 in the filter. This is not normally a problem, because such data is usually
18908 either not confidential or it &"belongs"& to the current user, but if you do
18909 put confidential data into &$address_data$& you need to remember this point.
18910
18911 Even if the router declines or passes, the value of &$address_data$& remains
18912 with the address, though it can be changed by another &%address_data%& setting
18913 on a subsequent router. If a router generates child addresses, the value of
18914 &$address_data$& propagates to them. This also applies to the special kind of
18915 &"child"& that is generated by a router with the &%unseen%& option.
18916
18917 The idea of &%address_data%& is that you can use it to look up a lot of data
18918 for the address once, and then pick out parts of the data later. For example,
18919 you could use a single LDAP lookup to return a string of the form
18920 .code
18921 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18922 .endd
18923 In the transport you could pick out the mailbox by a setting such as
18924 .code
18925 file = ${extract{mailbox}{$address_data}}
18926 .endd
18927 This makes the configuration file less messy, and also reduces the number of
18928 lookups (though Exim does cache lookups).
18929
18930 See also the &%set%& option below.
18931
18932 .vindex "&$sender_address_data$&"
18933 .vindex "&$address_data$&"
18934 The &%address_data%& facility is also useful as a means of passing information
18935 from one router to another, and from a router to a transport. In addition, if
18936 &$address_data$& is set by a router when verifying a recipient address from an
18937 ACL, it remains available for use in the rest of the ACL statement. After
18938 verifying a sender, the value is transferred to &$sender_address_data$&.
18939
18940
18941
18942 .option address_test routers&!? boolean true
18943 .oindex "&%-bt%&"
18944 .cindex "router" "skipping when address testing"
18945 If this option is set false, the router is skipped when routing is being tested
18946 by means of the &%-bt%& command line option. This can be a convenience when
18947 your first router sends messages to an external scanner, because it saves you
18948 having to set the &"already scanned"& indicator when testing real address
18949 routing.
18950
18951
18952
18953 .option cannot_route_message routers string&!! unset
18954 .cindex "router" "customizing &""cannot route""& message"
18955 .cindex "customizing" "&""cannot route""& message"
18956 This option specifies a text message that is used when an address cannot be
18957 routed because Exim has run out of routers. The default message is
18958 &"Unrouteable address"&. This option is useful only on routers that have
18959 &%more%& set false, or on the very last router in a configuration, because the
18960 value that is used is taken from the last router that is considered. This
18961 includes a router that is skipped because its preconditions are not met, as
18962 well as a router that declines. For example, using the default configuration,
18963 you could put:
18964 .code
18965 cannot_route_message = Remote domain not found in DNS
18966 .endd
18967 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18968 and
18969 .code
18970 cannot_route_message = Unknown local user
18971 .endd
18972 on the final router that checks for local users. If string expansion fails for
18973 this option, the default message is used. Unless the expansion failure was
18974 explicitly forced, a message about the failure is written to the main and panic
18975 logs, in addition to the normal message about the routing failure.
18976
18977
18978 .option caseful_local_part routers boolean false
18979 .cindex "case of local parts"
18980 .cindex "router" "case of local parts"
18981 By default, routers handle the local parts of addresses in a case-insensitive
18982 manner, though the actual case is preserved for transmission with the message.
18983 If you want the case of letters to be significant in a router, you must set
18984 this option true. For individual router options that contain address or local
18985 part lists (for example, &%local_parts%&), case-sensitive matching can be
18986 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18987 more details.
18988
18989 .vindex "&$local_part$&"
18990 .vindex "&$original_local_part$&"
18991 .vindex "&$parent_local_part$&"
18992 The value of the &$local_part$& variable is forced to lower case while a
18993 router is running unless &%caseful_local_part%& is set. When a router assigns
18994 an address to a transport, the value of &$local_part$& when the transport runs
18995 is the same as it was in the router. Similarly, when a router generates child
18996 addresses by aliasing or forwarding, the values of &$original_local_part$&
18997 and &$parent_local_part$& are those that were used by the redirecting router.
18998
18999 This option applies to the processing of an address by a router. When a
19000 recipient address is being processed in an ACL, there is a separate &%control%&
19001 modifier that can be used to specify case-sensitive processing within the ACL
19002 (see section &<<SECTcontrols>>&).
19003
19004
19005
19006 .option check_local_user routers&!? boolean false
19007 .cindex "local user, checking in router"
19008 .cindex "router" "checking for local user"
19009 .cindex "&_/etc/passwd_&"
19010 .vindex "&$home$&"
19011 When this option is true, Exim checks that the local part of the recipient
19012 address (with affixes removed if relevant) is the name of an account on the
19013 local system. The check is done by calling the &[getpwnam()]& function rather
19014 than trying to read &_/etc/passwd_& directly. This means that other methods of
19015 holding password data (such as NIS) are supported. If the local part is a local
19016 user,
19017 .cindex "tainted data" "de-tainting"
19018 .cindex "de-tainting" "using router check_local_user option"
19019 &$local_part_data$& is set to an untainted version of the local part and
19020 &$home$& is set from the password data. The latter can be tested in other
19021 preconditions that are evaluated after this one (the order of evaluation is
19022 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19023 overridden by &%router_home_directory%&. If the local part is not a local user,
19024 the router is skipped.
19025
19026 If you want to check that the local part is either the name of a local user
19027 or matches something else, you cannot combine &%check_local_user%& with a
19028 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19029 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19030 setting to achieve this. For example:
19031 .code
19032 local_parts = passwd;$local_part : lsearch;/etc/other/users
19033 .endd
19034 Note, however, that the side effects of &%check_local_user%& (such as setting
19035 up a home directory) do not occur when a &(passwd)& lookup is used in a
19036 &%local_parts%& (or any other) precondition.
19037
19038
19039
19040 .option condition routers&!? string&!! unset
19041 .cindex "router" "customized precondition"
19042 This option specifies a general precondition test that has to succeed for the
19043 router to be called. The &%condition%& option is the last precondition to be
19044 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19045 result is a forced failure, or an empty string, or one of the strings &"0"& or
19046 &"no"& or &"false"& (checked without regard to the case of the letters), the
19047 router is skipped, and the address is offered to the next one.
19048
19049 If the result is any other value, the router is run (as this is the last
19050 precondition to be evaluated, all the other preconditions must be true).
19051
19052 This option is unusual in that multiple &%condition%& options may be present.
19053 All &%condition%& options must succeed.
19054
19055 The &%condition%& option provides a means of applying custom conditions to the
19056 running of routers. Note that in the case of a simple conditional expansion,
19057 the default expansion values are exactly what is wanted. For example:
19058 .code
19059 condition = ${if >{$message_age}{600}}
19060 .endd
19061 Because of the default behaviour of the string expansion, this is equivalent to
19062 .code
19063 condition = ${if >{$message_age}{600}{true}{}}
19064 .endd
19065
19066 A multiple condition example, which succeeds:
19067 .code
19068 condition = ${if >{$message_age}{600}}
19069 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19070 condition = foobar
19071 .endd
19072
19073 If the expansion fails (other than forced failure) delivery is deferred. Some
19074 of the other precondition options are common special cases that could in fact
19075 be specified using &%condition%&.
19076
19077 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19078 are far older, and use one set of semantics.  ACLs are newer and when
19079 they were created, the ACL &%condition%& process was given far stricter
19080 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19081 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19082 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19083 Router rules processing behavior.
19084
19085 This is best illustrated in an example:
19086 .code
19087 # If used in an ACL condition will fail with a syntax error, but
19088 # in a router condition any extra characters are treated as a string
19089
19090 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19091 true {yes} {no}}
19092
19093 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19094  {yes} {no}}
19095 .endd
19096 In each example above, the &%if%& statement actually ends after
19097 &"{google.com}}"&.  Since no true or false braces were defined, the
19098 default &%if%& behavior is to return a boolean true or a null answer
19099 (which evaluates to false). The rest of the line is then treated as a
19100 string. So the first example resulted in the boolean answer &"true"&
19101 with the string &" {yes} {no}}"& appended to it. The second example
19102 resulted in the null output (indicating false) with the string
19103 &" {yes} {no}}"& appended to it.
19104
19105 In fact you can put excess forward braces in too.  In the router
19106 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19107 mean something, like after a &"$"& or when required as part of a
19108 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19109 string characters.
19110
19111 Thus, in a Router, the above expansion strings will both always evaluate
19112 true, as the result of expansion is a non-empty string which doesn't
19113 match an explicit false value.  This can be tricky to debug.  By
19114 contrast, in an ACL either of those strings will always result in an
19115 expansion error because the result doesn't look sufficiently boolean.
19116
19117
19118 .option debug_print routers string&!! unset
19119 .cindex "testing" "variables in drivers"
19120 If this option is set and debugging is enabled (see the &%-d%& command line
19121 option) or in address-testing mode (see the &%-bt%& command line option),
19122 the string is expanded and included in the debugging output.
19123 If expansion of the string fails, the error message is written to the debugging
19124 output, and Exim carries on processing.
19125 This option is provided to help with checking out the values of variables and
19126 so on when debugging router configurations. For example, if a &%condition%&
19127 option appears not to be working, &%debug_print%& can be used to output the
19128 variables it references. The output happens after checks for &%domains%&,
19129 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19130 are tested. A newline is added to the text if it does not end with one.
19131 The variable &$router_name$& contains the name of the router.
19132
19133
19134
19135 .option disable_logging routers boolean false
19136 If this option is set true, nothing is logged for any routing errors
19137 or for any deliveries caused by this router. You should not set this option
19138 unless you really, really know what you are doing. See also the generic
19139 transport option of the same name.
19140
19141 .option dnssec_request_domains routers "domain list&!!" *
19142 .cindex "MX record" "security"
19143 .cindex "DNSSEC" "MX lookup"
19144 .cindex "security" "MX lookup"
19145 .cindex "DNS" "DNSSEC"
19146 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19147 the DNSSEC request bit set.
19148 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19149
19150 .option dnssec_require_domains routers "domain list&!!" unset
19151 .cindex "MX record" "security"
19152 .cindex "DNSSEC" "MX lookup"
19153 .cindex "security" "MX lookup"
19154 .cindex "DNS" "DNSSEC"
19155 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19156 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19157 (AD bit) set will be ignored and logged as a host-lookup failure.
19158 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19159
19160
19161 .option domains routers&!? "domain list&!!" unset
19162 .cindex "router" "restricting to specific domains"
19163 .vindex "&$domain_data$&"
19164 If this option is set, the router is skipped unless the current domain matches
19165 the list. If the match is achieved by means of a file lookup, the data that the
19166 lookup returned for the domain is placed in &$domain_data$& for use in string
19167 expansions of the driver's private options and in the transport.
19168 See section &<<SECTrouprecon>>& for
19169 a list of the order in which preconditions are evaluated.
19170
19171
19172
19173 .option driver routers string unset
19174 This option must always be set. It specifies which of the available routers is
19175 to be used.
19176
19177
19178 .option dsn_lasthop routers boolean false
19179 .cindex "DSN" "success"
19180 .cindex "Delivery Status Notification" "success"
19181 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19182 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19183 instead send a success DSN as if the next hop does not support DSN.
19184 Not effective on redirect routers.
19185
19186
19187
19188 .option errors_to routers string&!! unset
19189 .cindex "envelope from"
19190 .cindex "envelope sender"
19191 .cindex "router" "changing address for errors"
19192 If a router successfully handles an address, it may assign the address to a
19193 transport for delivery or it may generate child addresses. In both cases, if
19194 there is a delivery problem during later processing, the resulting bounce
19195 message is sent to the address that results from expanding this string,
19196 provided that the address verifies successfully. The &%errors_to%& option is
19197 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19198
19199 The &%errors_to%& setting associated with an address can be overridden if it
19200 subsequently passes through other routers that have their own &%errors_to%&
19201 settings, or if the message is delivered by a transport with a &%return_path%&
19202 setting.
19203
19204 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19205 the expansion fails to verify, the errors address associated with the incoming
19206 address is used. At top level, this is the envelope sender. A non-forced
19207 expansion failure causes delivery to be deferred.
19208
19209 If an address for which &%errors_to%& has been set ends up being delivered over
19210 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19211 any bounces that are generated by other MTAs on the delivery route are also
19212 sent there. You can set &%errors_to%& to the empty string by either of these
19213 settings:
19214 .code
19215 errors_to =
19216 errors_to = ""
19217 .endd
19218 An expansion item that yields an empty string has the same effect. If you do
19219 this, a locally detected delivery error for addresses processed by this router
19220 no longer gives rise to a bounce message; the error is discarded. If the
19221 address is delivered to a remote host, the return path is set to &`<>`&, unless
19222 overridden by the &%return_path%& option on the transport.
19223
19224 .vindex "&$address_data$&"
19225 If for some reason you want to discard local errors, but use a non-empty
19226 MAIL command for remote delivery, you can preserve the original return
19227 path in &$address_data$& in the router, and reinstate it in the transport by
19228 setting &%return_path%&.
19229
19230 The most common use of &%errors_to%& is to direct mailing list bounces to the
19231 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19232 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19233
19234
19235
19236 .option expn routers&!? boolean true
19237 .cindex "address" "testing"
19238 .cindex "testing" "addresses"
19239 .cindex "EXPN" "router skipping"
19240 .cindex "router" "skipping for EXPN"
19241 If this option is turned off, the router is skipped when testing an address
19242 as a result of processing an SMTP EXPN command. You might, for example,
19243 want to turn it off on a router for users' &_.forward_& files, while leaving it
19244 on for the system alias file.
19245 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19246 are evaluated.
19247
19248 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19249 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19250 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19251
19252
19253
19254 .option fail_verify routers boolean false
19255 .cindex "router" "forcing verification failure"
19256 Setting this option has the effect of setting both &%fail_verify_sender%& and
19257 &%fail_verify_recipient%& to the same value.
19258
19259
19260
19261 .option fail_verify_recipient routers boolean false
19262 If this option is true and an address is accepted by this router when
19263 verifying a recipient, verification fails.
19264
19265
19266
19267 .option fail_verify_sender routers boolean false
19268 If this option is true and an address is accepted by this router when
19269 verifying a sender, verification fails.
19270
19271
19272
19273 .option fallback_hosts routers "string list" unset
19274 .cindex "router" "fallback hosts"
19275 .cindex "fallback" "hosts specified on router"
19276 String expansion is not applied to this option. The argument must be a
19277 colon-separated list of host names or IP addresses. The list separator can be
19278 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19279 each name or address. In fact, the format of each item is exactly the same as
19280 defined for the list of hosts in a &(manualroute)& router (see section
19281 &<<SECTformatonehostitem>>&).
19282
19283 If a router queues an address for a remote transport, this host list is
19284 associated with the address, and used instead of the transport's fallback host
19285 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19286 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19287 transport for further details.
19288
19289
19290 .option group routers string&!! "see below"
19291 .cindex "gid (group id)" "local delivery"
19292 .cindex "local transports" "uid and gid"
19293 .cindex "transport" "local"
19294 .cindex "router" "setting group"
19295 When a router queues an address for a transport, and the transport does not
19296 specify a group, the group given here is used when running the delivery
19297 process.
19298 The group may be specified numerically or by name. If expansion fails, the
19299 error is logged and delivery is deferred.
19300 The default is unset, unless &%check_local_user%& is set, when the default
19301 is taken from the password information. See also &%initgroups%& and &%user%&
19302 and the discussion in chapter &<<CHAPenvironment>>&.
19303
19304
19305
19306 .option headers_add routers list&!! unset
19307 .cindex "header lines" "adding"
19308 .cindex "router" "adding header lines"
19309 This option specifies a list of text headers,
19310 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19311 that is associated with any addresses that are accepted by the router.
19312 Each item is separately expanded, at routing time.  However, this
19313 option has no effect when an address is just being verified. The way in which
19314 the text is used to add header lines at transport time is described in section
19315 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19316 message is in the process of being transported. This means that references to
19317 header lines in string expansions in the transport's configuration do not
19318 &"see"& the added header lines.
19319
19320 The &%headers_add%& option is expanded after &%errors_to%&, but before
19321 &%headers_remove%& and &%transport%&. If an item is empty, or if
19322 an item expansion is forced to fail, the item has no effect. Other expansion
19323 failures are treated as configuration errors.
19324
19325 Unlike most options, &%headers_add%& can be specified multiple times
19326 for a router; all listed headers are added.
19327
19328 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19329 router that has the &%one_time%& option set.
19330
19331 .cindex "duplicate addresses"
19332 .oindex "&%unseen%&"
19333 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19334 additions are deleted when the address is passed on to subsequent routers.
19335 For a &%redirect%& router, if a generated address is the same as the incoming
19336 address, this can lead to duplicate addresses with different header
19337 modifications. Exim does not do duplicate deliveries (except, in certain
19338 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19339 which of the duplicates is discarded, so this ambiguous situation should be
19340 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19341
19342
19343
19344 .option headers_remove routers list&!! unset
19345 .cindex "header lines" "removing"
19346 .cindex "router" "removing header lines"
19347 This option specifies a list of text headers,
19348 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19349 that is associated with any addresses that are accepted by the router.
19350 However, the option has no effect when an address is just being verified.
19351 Each list item is separately expanded, at transport time.
19352 If an item ends in *, it will match any header with the given prefix.
19353 The way in which
19354 the text is used to remove header lines at transport time is described in
19355 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19356 the message is in the process of being transported. This means that references
19357 to header lines in string expansions in the transport's configuration still
19358 &"see"& the original header lines.
19359
19360 The &%headers_remove%& option is handled after &%errors_to%& and
19361 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19362 the item has no effect. Other expansion failures are treated as configuration
19363 errors.
19364
19365 Unlike most options, &%headers_remove%& can be specified multiple times
19366 for a router; all listed headers are removed.
19367
19368 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19369 router that has the &%one_time%& option set.
19370
19371 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19372 removal requests are deleted when the address is passed on to subsequent
19373 routers, and this can lead to problems with duplicates -- see the similar
19374 warning for &%headers_add%& above.
19375
19376 &*Warning 3*&: Because of the separate expansion of the list items,
19377 items that contain a list separator must have it doubled.
19378 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19379
19380
19381
19382 .option ignore_target_hosts routers "host list&!!" unset
19383 .cindex "IP address" "discarding"
19384 .cindex "router" "discarding IP addresses"
19385 Although this option is a host list, it should normally contain IP address
19386 entries rather than names. If any host that is looked up by the router has an
19387 IP address that matches an item in this list, Exim behaves as if that IP
19388 address did not exist. This option allows you to cope with rogue DNS entries
19389 like
19390 .code
19391 remote.domain.example.  A  127.0.0.1
19392 .endd
19393 by setting
19394 .code
19395 ignore_target_hosts = 127.0.0.1
19396 .endd
19397 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19398 discarded in this way, the router declines. In a conventional configuration, an
19399 attempt to mail to such a domain would normally provoke the &"unrouteable
19400 domain"& error, and an attempt to verify an address in the domain would fail.
19401 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19402 router declines if presented with one of the listed addresses.
19403
19404 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19405 means of the first or the second of the following settings, respectively:
19406 .code
19407 ignore_target_hosts = 0.0.0.0/0
19408 ignore_target_hosts = <; 0::0/0
19409 .endd
19410 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19411 in the second line matches all IPv6 addresses.
19412
19413 This option may also be useful for ignoring link-local and site-local IPv6
19414 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19415 is expanded before use as a list, it is possible to make it dependent on the
19416 domain that is being routed.
19417
19418 .vindex "&$host_address$&"
19419 During its expansion, &$host_address$& is set to the IP address that is being
19420 checked.
19421
19422 .option initgroups routers boolean false
19423 .cindex "additional groups"
19424 .cindex "groups" "additional"
19425 .cindex "local transports" "uid and gid"
19426 .cindex "transport" "local"
19427 If the router queues an address for a transport, and this option is true, and
19428 the uid supplied by the router is not overridden by the transport, the
19429 &[initgroups()]& function is called when running the transport to ensure that
19430 any additional groups associated with the uid are set up. See also &%group%&
19431 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19432
19433
19434
19435 .option local_part_prefix routers&!? "string list" unset
19436 .cindex affix "router precondition"
19437 .cindex "router" "prefix for local part"
19438 .cindex "prefix" "for local part, used in router"
19439 If this option is set, the router is skipped unless the local part starts with
19440 one of the given strings, or &%local_part_prefix_optional%& is true. See
19441 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19442 evaluated.
19443
19444 The list is scanned from left to right, and the first prefix that matches is
19445 used. A limited form of wildcard is available; if the prefix begins with an
19446 asterisk, it matches the longest possible sequence of arbitrary characters at
19447 the start of the local part. An asterisk should therefore always be followed by
19448 some character that does not occur in normal local parts.
19449 .cindex "multiple mailboxes"
19450 .cindex "mailbox" "multiple"
19451 Wildcarding can be used to set up multiple user mailboxes, as described in
19452 section &<<SECTmulbox>>&.
19453
19454 .vindex "&$local_part$&"
19455 .vindex "&$local_part_prefix$&"
19456 During the testing of the &%local_parts%& option, and while the router is
19457 running, the prefix is removed from the local part, and is available in the
19458 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19459 the router accepts the address, this remains true during subsequent delivery by
19460 a transport. In particular, the local part that is transmitted in the RCPT
19461 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19462 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19463 the relevant transport.
19464
19465 .vindex &$local_part_prefix_v$&
19466 If wildcarding (above) was used then the part of the prefix matching the
19467 wildcard is available in &$local_part_prefix_v$&.
19468
19469 When an address is being verified, &%local_part_prefix%& affects only the
19470 behaviour of the router. If the callout feature of verification is in use, this
19471 means that the full address, including the prefix, will be used during the
19472 callout.
19473
19474 The prefix facility is commonly used to handle local parts of the form
19475 &%owner-something%&. Another common use is to support local parts of the form
19476 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19477 to tell a user their forwarding is broken &-- by placing a router like this one
19478 immediately before the router that handles &_.forward_& files:
19479 .code
19480 real_localuser:
19481   driver = accept
19482   local_part_prefix = real-
19483   check_local_user
19484   transport = local_delivery
19485 .endd
19486 For security, it would probably be a good idea to restrict the use of this
19487 router to locally-generated messages, using a condition such as this:
19488 .code
19489   condition = ${if match {$sender_host_address}\
19490                          {\N^(|127\.0\.0\.1)$\N}}
19491 .endd
19492
19493 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19494 both conditions must be met if not optional. Care must be taken if wildcards
19495 are used in both a prefix and a suffix on the same router. Different
19496 separator characters must be used to avoid ambiguity.
19497
19498
19499 .option local_part_prefix_optional routers boolean false
19500 See &%local_part_prefix%& above.
19501
19502
19503
19504 .option local_part_suffix routers&!? "string list" unset
19505 .cindex "router" "suffix for local part"
19506 .cindex "suffix for local part" "used in router"
19507 This option operates in the same way as &%local_part_prefix%&, except that the
19508 local part must end (rather than start) with the given string, the
19509 &%local_part_suffix_optional%& option determines whether the suffix is
19510 mandatory, and the wildcard * character, if present, must be the last
19511 character of the suffix. This option facility is commonly used to handle local
19512 parts of the form &%something-request%& and multiple user mailboxes of the form
19513 &%username-foo%&.
19514
19515
19516 .option local_part_suffix_optional routers boolean false
19517 See &%local_part_suffix%& above.
19518
19519
19520
19521 .option local_parts routers&!? "local part list&!!" unset
19522 .cindex "router" "restricting to specific local parts"
19523 .cindex "local part" "checking in router"
19524 The router is run only if the local part of the address matches the list.
19525 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19526 are evaluated, and
19527 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19528 string is expanded, it is possible to make it depend on the domain, for
19529 example:
19530 .code
19531 local_parts = dbm;/usr/local/specials/$domain_data
19532 .endd
19533 .vindex "&$local_part_data$&"
19534 If the match is achieved by a lookup, the data that the lookup returned
19535 for the local part is placed in the variable &$local_part_data$& for use in
19536 expansions of the router's private options or in the transport.
19537 You might use this option, for
19538 example, if you have a large number of local virtual domains, and you want to
19539 send all postmaster mail to the same place without having to set up an alias in
19540 each virtual domain:
19541 .code
19542 postmaster:
19543   driver = redirect
19544   local_parts = postmaster
19545   data = postmaster@real.domain.example
19546 .endd
19547
19548
19549 .option log_as_local routers boolean "see below"
19550 .cindex "log" "delivery line"
19551 .cindex "delivery" "log line format"
19552 Exim has two logging styles for delivery, the idea being to make local
19553 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19554 recipient address is given just as the local part, without a domain. The use of
19555 this style is controlled by this option. It defaults to true for the &(accept)&
19556 router, and false for all the others. This option applies only when a
19557 router assigns an address to a transport. It has no effect on routers that
19558 redirect addresses.
19559
19560
19561
19562 .option more routers boolean&!! true
19563 The result of string expansion for this option must be a valid boolean value,
19564 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19565 result causes an error, and delivery is deferred. If the expansion is forced to
19566 fail, the default value for the option (true) is used. Other failures cause
19567 delivery to be deferred.
19568
19569 If this option is set false, and the router declines to handle the address, no
19570 further routers are tried, routing fails, and the address is bounced.
19571 .oindex "&%self%&"
19572 However, if the router explicitly passes an address to the following router by
19573 means of the setting
19574 .code
19575 self = pass
19576 .endd
19577 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19578 does not affect the behaviour if one of the precondition tests fails. In that
19579 case, the address is always passed to the next router.
19580
19581 Note that &%address_data%& is not considered to be a precondition. If its
19582 expansion is forced to fail, the router declines, and the value of &%more%&
19583 controls what happens next.
19584
19585
19586 .option pass_on_timeout routers boolean false
19587 .cindex "timeout" "of router"
19588 .cindex "router" "timeout"
19589 If a router times out during a host lookup, it normally causes deferral of the
19590 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19591 router, overriding &%no_more%&. This may be helpful for systems that are
19592 intermittently connected to the Internet, or those that want to pass to a smart
19593 host any messages that cannot immediately be delivered.
19594
19595 There are occasional other temporary errors that can occur while doing DNS
19596 lookups. They are treated in the same way as a timeout, and this option
19597 applies to all of them.
19598
19599
19600
19601 .option pass_router routers string unset
19602 .cindex "router" "go to after &""pass""&"
19603 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19604 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19605 routing to continue, and overriding a false setting of &%more%&. When one of
19606 these routers returns &"pass"&, the address is normally handed on to the next
19607 router in sequence. This can be changed by setting &%pass_router%& to the name
19608 of another router. However (unlike &%redirect_router%&) the named router must
19609 be below the current router, to avoid loops. Note that this option applies only
19610 to the special case of &"pass"&. It does not apply when a router returns
19611 &"decline"& because it cannot handle an address.
19612
19613
19614
19615 .option redirect_router routers string unset
19616 .cindex "router" "start at after redirection"
19617 Sometimes an administrator knows that it is pointless to reprocess addresses
19618 generated from alias or forward files with the same router again. For
19619 example, if an alias file translates real names into login ids there is no
19620 point searching the alias file a second time, especially if it is a large file.
19621
19622 The &%redirect_router%& option can be set to the name of any router instance.
19623 It causes the routing of any generated addresses to start at the named router
19624 instead of at the first router. This option has no effect if the router in
19625 which it is set does not generate new addresses.
19626
19627
19628
19629 .option require_files routers&!? "string list&!!" unset
19630 .cindex "file" "requiring for router"
19631 .cindex "router" "requiring file existence"
19632 This option provides a general mechanism for predicating the running of a
19633 router on the existence or non-existence of certain files or directories.
19634 Before running a router, as one of its precondition tests, Exim works its way
19635 through the &%require_files%& list, expanding each item separately.
19636
19637 Because the list is split before expansion, any colons in expansion items must
19638 be doubled, or the facility for using a different list separator must be used
19639 (&<<SECTlistsepchange>>&).
19640 If any expansion is forced to fail, the item is ignored. Other expansion
19641 failures cause routing of the address to be deferred.
19642
19643 If any expanded string is empty, it is ignored. Otherwise, except as described
19644 below, each string must be a fully qualified file path, optionally preceded by
19645 &"!"&. The paths are passed to the &[stat()]& function to test for the
19646 existence of the files or directories. The router is skipped if any paths not
19647 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19648
19649 .cindex "NFS"
19650 If &[stat()]& cannot determine whether a file exists or not, delivery of
19651 the message is deferred. This can happen when NFS-mounted filesystems are
19652 unavailable.
19653
19654 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19655 options, so you cannot use it to check for the existence of a file in which to
19656 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19657 full list of the order in which preconditions are evaluated.) However, as
19658 these options are all expanded, you can use the &%exists%& expansion condition
19659 to make such tests. The &%require_files%& option is intended for checking files
19660 that the router may be going to use internally, or which are needed by a
19661 transport (e.g., &_.procmailrc_&).
19662
19663 During delivery, the &[stat()]& function is run as root, but there is a
19664 facility for some checking of the accessibility of a file by another user.
19665 This is not a proper permissions check, but just a &"rough"& check that
19666 operates as follows:
19667
19668 If an item in a &%require_files%& list does not contain any forward slash
19669 characters, it is taken to be the user (and optional group, separated by a
19670 comma) to be checked for subsequent files in the list. If no group is specified
19671 but the user is specified symbolically, the gid associated with the uid is
19672 used. For example:
19673 .code
19674 require_files = mail:/some/file
19675 require_files = $local_part_data:$home/.procmailrc
19676 .endd
19677 If a user or group name in a &%require_files%& list does not exist, the
19678 &%require_files%& condition fails.
19679
19680 Exim performs the check by scanning along the components of the file path, and
19681 checking the access for the given uid and gid. It checks for &"x"& access on
19682 directories, and &"r"& access on the final file. Note that this means that file
19683 access control lists, if the operating system has them, are ignored.
19684
19685 &*Warning 1*&: When the router is being run to verify addresses for an
19686 incoming SMTP message, Exim is not running as root, but under its own uid. This
19687 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19688 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19689 user is not permitted to read one of the directories on the file's path.
19690
19691 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19692 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19693 without root access. In this case, if a check for access by a particular user
19694 is requested, Exim creates a subprocess that runs as that user, and tries the
19695 check again in that process.
19696
19697 The default action for handling an unresolved EACCES is to consider it to
19698 be caused by a configuration error, and routing is deferred because the
19699 existence or non-existence of the file cannot be determined. However, in some
19700 circumstances it may be desirable to treat this condition as if the file did
19701 not exist. If the filename (or the exclamation mark that precedes the filename
19702 for non-existence) is preceded by a plus sign, the EACCES error is treated
19703 as if the file did not exist. For example:
19704 .code
19705 require_files = +/some/file
19706 .endd
19707 If the router is not an essential part of verification (for example, it
19708 handles users' &_.forward_& files), another solution is to set the &%verify%&
19709 option false so that the router is skipped when verifying.
19710
19711
19712
19713 .option retry_use_local_part routers boolean "see below"
19714 .cindex "hints database" "retry keys"
19715 .cindex "local part" "in retry keys"
19716 When a delivery suffers a temporary routing failure, a retry record is created
19717 in Exim's hints database. For addresses whose routing depends only on the
19718 domain, the key for the retry record should not involve the local part, but for
19719 other addresses, both the domain and the local part should be included.
19720 Usually, remote routing is of the former kind, and local routing is of the
19721 latter kind.
19722
19723 This option controls whether the local part is used to form the key for retry
19724 hints for addresses that suffer temporary errors while being handled by this
19725 router. The default value is true for any router that has any of
19726 &%check_local_user%&,
19727 &%local_parts%&,
19728 &%condition%&,
19729 &%local_part_prefix%&,
19730 &%local_part_suffix%&,
19731 &%senders%& or
19732 &%require_files%&
19733 set, and false otherwise. Note that this option does not apply to hints keys
19734 for transport delays; they are controlled by a generic transport option of the
19735 same name.
19736
19737 Failing to set this option when it is needed
19738 (because a remote router handles only some of the local-parts for a domain)
19739 can result in incorrect error messages being generated.
19740
19741 The setting of &%retry_use_local_part%& applies only to the router on which it
19742 appears. If the router generates child addresses, they are routed
19743 independently; this setting does not become attached to them.
19744
19745
19746
19747 .option router_home_directory routers string&!! unset
19748 .cindex "router" "home directory for"
19749 .cindex "home directory" "for router"
19750 .vindex "&$home$&"
19751 This option sets a home directory for use while the router is running. (Compare
19752 &%transport_home_directory%&, which sets a home directory for later
19753 transporting.) In particular, if used on a &(redirect)& router, this option
19754 sets a value for &$home$& while a filter is running. The value is expanded;
19755 forced expansion failure causes the option to be ignored &-- other failures
19756 cause the router to defer.
19757
19758 Expansion of &%router_home_directory%& happens immediately after the
19759 &%check_local_user%& test (if configured), before any further expansions take
19760 place.
19761 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19762 are evaluated.)
19763 While the router is running, &%router_home_directory%& overrides the value of
19764 &$home$& that came from &%check_local_user%&.
19765
19766 When a router accepts an address and assigns it to a local transport (including
19767 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19768 delivery), the home directory setting for the transport is taken from the first
19769 of these values that is set:
19770
19771 .ilist
19772 The &%home_directory%& option on the transport;
19773 .next
19774 The &%transport_home_directory%& option on the router;
19775 .next
19776 The password data if &%check_local_user%& is set on the router;
19777 .next
19778 The &%router_home_directory%& option on the router.
19779 .endlist
19780
19781 In other words, &%router_home_directory%& overrides the password data for the
19782 router, but not for the transport.
19783
19784
19785
19786 .option self routers string freeze
19787 .cindex "MX record" "pointing to local host"
19788 .cindex "local host" "MX pointing to"
19789 This option applies to those routers that use a recipient address to find a
19790 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19791 and &(manualroute)& routers.
19792 Certain configurations of the &(queryprogram)& router can also specify a list
19793 of remote hosts.
19794 Usually such routers are configured to send the message to a remote host via an
19795 &(smtp)& transport. The &%self%& option specifies what happens when the first
19796 host on the list turns out to be the local host.
19797 The way in which Exim checks for the local host is described in section
19798 &<<SECTreclocipadd>>&.
19799
19800 Normally this situation indicates either an error in Exim's configuration (for
19801 example, the router should be configured not to process this domain), or an
19802 error in the DNS (for example, the MX should not point to this host). For this
19803 reason, the default action is to log the incident, defer the address, and
19804 freeze the message. The following alternatives are provided for use in special
19805 cases:
19806
19807 .vlist
19808 .vitem &%defer%&
19809 Delivery of the message is tried again later, but the message is not frozen.
19810
19811 .vitem "&%reroute%&: <&'domain'&>"
19812 The domain is changed to the given domain, and the address is passed back to
19813 be reprocessed by the routers. No rewriting of headers takes place. This
19814 behaviour is essentially a redirection.
19815
19816 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19817 The domain is changed to the given domain, and the address is passed back to be
19818 reprocessed by the routers. Any headers that contain the original domain are
19819 rewritten.
19820
19821 .vitem &%pass%&
19822 .oindex "&%more%&"
19823 .vindex "&$self_hostname$&"
19824 The router passes the address to the next router, or to the router named in the
19825 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19826 subsequent routing and delivery, the variable &$self_hostname$& contains the
19827 name of the local host that the router encountered. This can be used to
19828 distinguish between different cases for hosts with multiple names. The
19829 combination
19830 .code
19831 self = pass
19832 no_more
19833 .endd
19834 ensures that only those addresses that routed to the local host are passed on.
19835 Without &%no_more%&, addresses that were declined for other reasons would also
19836 be passed to the next router.
19837
19838 .vitem &%fail%&
19839 Delivery fails and an error report is generated.
19840
19841 .vitem &%send%&
19842 .cindex "local host" "sending to"
19843 The anomaly is ignored and the address is queued for the transport. This
19844 setting should be used with extreme caution. For an &(smtp)& transport, it
19845 makes sense only in cases where the program that is listening on the SMTP port
19846 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19847 different configuration file that handles the domain in another way.
19848 .endlist
19849
19850
19851
19852 .option senders routers&!? "address list&!!" unset
19853 .cindex "router" "checking senders"
19854 If this option is set, the router is skipped unless the message's sender
19855 address matches something on the list.
19856 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19857 are evaluated.
19858
19859 There are issues concerning verification when the running of routers is
19860 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19861 setting, it sets the sender to the null string. When using the &%-bt%& option
19862 to check a configuration file, it is necessary also to use the &%-f%& option to
19863 set an appropriate sender. For incoming mail, the sender is unset when
19864 verifying the sender, but is available when verifying any recipients. If the
19865 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19866 matters.
19867
19868
19869 .option set routers "string list" unset
19870 .cindex router variables
19871 This option may be used multiple times on a router;
19872 because of this the list aspect is mostly irrelevant.
19873 The list separator is a semicolon but can be changed in the
19874 usual way.
19875
19876 Each list-element given must be of the form &"name = value"&
19877 and the names used must start with the string &"r_"&.
19878 Values containing a list-separator should have them doubled.
19879 When a router runs, the strings are evaluated in order,
19880 to create variables which are added to the set associated with
19881 the address.
19882 This is done immediately after all the preconditions, before the
19883 evaluation of the &%address_data%& option.
19884 The variable is set with the expansion of the value.
19885 The variables can be used by the router options
19886 (not including any preconditions)
19887 and by the transport.
19888 Later definitions of a given named variable will override former ones.
19889 Variable use is via the usual &$r_...$& syntax.
19890
19891 This is similar to the &%address_data%& option, except that
19892 many independent variables can be used, with choice of naming.
19893
19894
19895 .option translate_ip_address routers string&!! unset
19896 .cindex "IP address" "translating"
19897 .cindex "packet radio"
19898 .cindex "router" "IP address translation"
19899 There exist some rare networking situations (for example, packet radio) where
19900 it is helpful to be able to translate IP addresses generated by normal routing
19901 mechanisms into other IP addresses, thus performing a kind of manual IP
19902 routing. This should be done only if the normal IP routing of the TCP/IP stack
19903 is inadequate or broken. Because this is an extremely uncommon requirement, the
19904 code to support this option is not included in the Exim binary unless
19905 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19906
19907 .vindex "&$host_address$&"
19908 The &%translate_ip_address%& string is expanded for every IP address generated
19909 by the router, with the generated address set in &$host_address$&. If the
19910 expansion is forced to fail, no action is taken.
19911 For any other expansion error, delivery of the message is deferred.
19912 If the result of the expansion is an IP address, that replaces the original
19913 address; otherwise the result is assumed to be a host name &-- this is looked
19914 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19915 produce one or more replacement IP addresses. For example, to subvert all IP
19916 addresses in some specific networks, this could be added to a router:
19917 .code
19918 translate_ip_address = \
19919   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19920     {$value}fail}}
19921 .endd
19922 The file would contain lines like
19923 .code
19924 10.2.3.128/26    some.host
19925 10.8.4.34/26     10.44.8.15
19926 .endd
19927 You should not make use of this facility unless you really understand what you
19928 are doing.
19929
19930
19931
19932 .option transport routers string&!! unset
19933 This option specifies the transport to be used when a router accepts an address
19934 and sets it up for delivery. A transport is never needed if a router is used
19935 only for verification. The value of the option is expanded at routing time,
19936 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19937 and result must be the name of one of the configured transports. If it is not,
19938 delivery is deferred.
19939
19940 The &%transport%& option is not used by the &(redirect)& router, but it does
19941 have some private options that set up transports for pipe and file deliveries
19942 (see chapter &<<CHAPredirect>>&).
19943
19944
19945
19946 .option transport_current_directory routers string&!! unset
19947 .cindex "current directory for local transport"
19948 This option associates a current directory with any address that is routed
19949 to a local transport. This can happen either because a transport is
19950 explicitly configured for the router, or because it generates a delivery to a
19951 file or a pipe. During the delivery process (that is, at transport time), this
19952 option string is expanded and is set as the current directory, unless
19953 overridden by a setting on the transport.
19954 If the expansion fails for any reason, including forced failure, an error is
19955 logged, and delivery is deferred.
19956 See chapter &<<CHAPenvironment>>& for details of the local delivery
19957 environment.
19958
19959
19960
19961
19962 .option transport_home_directory routers string&!! "see below"
19963 .cindex "home directory" "for local transport"
19964 This option associates a home directory with any address that is routed to a
19965 local transport. This can happen either because a transport is explicitly
19966 configured for the router, or because it generates a delivery to a file or a
19967 pipe. During the delivery process (that is, at transport time), the option
19968 string is expanded and is set as the home directory, unless overridden by a
19969 setting of &%home_directory%& on the transport.
19970 If the expansion fails for any reason, including forced failure, an error is
19971 logged, and delivery is deferred.
19972
19973 If the transport does not specify a home directory, and
19974 &%transport_home_directory%& is not set for the router, the home directory for
19975 the transport is taken from the password data if &%check_local_user%& is set for
19976 the router. Otherwise it is taken from &%router_home_directory%& if that option
19977 is set; if not, no home directory is set for the transport.
19978
19979 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19980 environment.
19981
19982
19983
19984
19985 .option unseen routers boolean&!! false
19986 .cindex "router" "carrying on after success"
19987 The result of string expansion for this option must be a valid boolean value,
19988 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19989 result causes an error, and delivery is deferred. If the expansion is forced to
19990 fail, the default value for the option (false) is used. Other failures cause
19991 delivery to be deferred.
19992
19993 When this option is set true, routing does not cease if the router accepts the
19994 address. Instead, a copy of the incoming address is passed to the next router,
19995 overriding a false setting of &%more%&. There is little point in setting
19996 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19997 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19998 sometimes true and sometimes false).
19999
20000 .cindex "copy of message (&%unseen%& option)"
20001 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20002 qualifier in filter files. It can be used to cause copies of messages to be
20003 delivered to some other destination, while also carrying out a normal delivery.
20004 In effect, the current address is made into a &"parent"& that has two children
20005 &-- one that is delivered as specified by this router, and a clone that goes on
20006 to be routed further. For this reason, &%unseen%& may not be combined with the
20007 &%one_time%& option in a &(redirect)& router.
20008
20009 &*Warning*&: Header lines added to the address (or specified for removal) by
20010 this router or by previous routers affect the &"unseen"& copy of the message
20011 only. The clone that continues to be processed by further routers starts with
20012 no added headers and none specified for removal. For a &%redirect%& router, if
20013 a generated address is the same as the incoming address, this can lead to
20014 duplicate addresses with different header modifications. Exim does not do
20015 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20016 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20017 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20018 &%redirect%& router may be of help.
20019
20020 Unlike the handling of header modifications, any data that was set by the
20021 &%address_data%& option in the current or previous routers &'is'& passed on to
20022 subsequent routers.
20023
20024
20025 .option user routers string&!! "see below"
20026 .cindex "uid (user id)" "local delivery"
20027 .cindex "local transports" "uid and gid"
20028 .cindex "transport" "local"
20029 .cindex "router" "user for filter processing"
20030 .cindex "filter" "user for processing"
20031 When a router queues an address for a transport, and the transport does not
20032 specify a user, the user given here is used when running the delivery process.
20033 The user may be specified numerically or by name. If expansion fails, the
20034 error is logged and delivery is deferred.
20035 This user is also used by the &(redirect)& router when running a filter file.
20036 The default is unset, except when &%check_local_user%& is set. In this case,
20037 the default is taken from the password information. If the user is specified as
20038 a name, and &%group%& is not set, the group associated with the user is used.
20039 See also &%initgroups%& and &%group%& and the discussion in chapter
20040 &<<CHAPenvironment>>&.
20041
20042
20043
20044 .option verify routers&!? boolean true
20045 Setting this option has the effect of setting &%verify_sender%& and
20046 &%verify_recipient%& to the same value.
20047
20048
20049 .option verify_only routers&!? boolean false
20050 .cindex "EXPN" "with &%verify_only%&"
20051 .oindex "&%-bv%&"
20052 .cindex "router" "used only when verifying"
20053 If this option is set, the router is used only when verifying an address,
20054 delivering in cutthrough mode or
20055 testing with the &%-bv%& option, not when actually doing a delivery, testing
20056 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20057 restricted to verifying only senders or recipients by means of
20058 &%verify_sender%& and &%verify_recipient%&.
20059
20060 &*Warning*&: When the router is being run to verify addresses for an incoming
20061 SMTP message, Exim is not running as root, but under its own uid. If the router
20062 accesses any files, you need to make sure that they are accessible to the Exim
20063 user or group.
20064
20065
20066 .option verify_recipient routers&!? boolean true
20067 If this option is false, the router is skipped when verifying recipient
20068 addresses,
20069 delivering in cutthrough mode
20070 or testing recipient verification using &%-bv%&.
20071 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20072 are evaluated.
20073 See also the &$verify_mode$& variable.
20074
20075
20076 .option verify_sender routers&!? boolean true
20077 If this option is false, the router is skipped when verifying sender addresses
20078 or testing sender verification using &%-bvs%&.
20079 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20080 are evaluated.
20081 See also the &$verify_mode$& variable.
20082 .ecindex IIDgenoprou1
20083 .ecindex IIDgenoprou2
20084
20085
20086
20087
20088
20089
20090 . ////////////////////////////////////////////////////////////////////////////
20091 . ////////////////////////////////////////////////////////////////////////////
20092
20093 .chapter "The accept router" "CHID4"
20094 .cindex "&(accept)& router"
20095 .cindex "routers" "&(accept)&"
20096 The &(accept)& router has no private options of its own. Unless it is being
20097 used purely for verification (see &%verify_only%&) a transport is required to
20098 be defined by the generic &%transport%& option. If the preconditions that are
20099 specified by generic options are met, the router accepts the address and queues
20100 it for the given transport. The most common use of this router is for setting
20101 up deliveries to local mailboxes. For example:
20102 .code
20103 localusers:
20104   driver = accept
20105   domains = mydomain.example
20106   check_local_user
20107   transport = local_delivery
20108 .endd
20109 The &%domains%& condition in this example checks the domain of the address, and
20110 &%check_local_user%& checks that the local part is the login of a local user.
20111 When both preconditions are met, the &(accept)& router runs, and queues the
20112 address for the &(local_delivery)& transport.
20113
20114
20115
20116
20117
20118
20119 . ////////////////////////////////////////////////////////////////////////////
20120 . ////////////////////////////////////////////////////////////////////////////
20121
20122 .chapter "The dnslookup router" "CHAPdnslookup"
20123 .scindex IIDdnsrou1 "&(dnslookup)& router"
20124 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20125 The &(dnslookup)& router looks up the hosts that handle mail for the
20126 recipient's domain in the DNS. A transport must always be set for this router,
20127 unless &%verify_only%& is set.
20128
20129 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20130 SRV records. If none are found, or if SRV support is not configured,
20131 MX records are looked up. If no MX records exist, address records are sought.
20132 However, &%mx_domains%& can be set to disable the direct use of address
20133 records.
20134
20135 MX records of equal priority are sorted by Exim into a random order. Exim then
20136 looks for address records for the host names obtained from MX or SRV records.
20137 When a host has more than one IP address, they are sorted into a random order,
20138 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20139 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20140 generic option, the router declines.
20141
20142 Unless they have the highest priority (lowest MX value), MX records that point
20143 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20144 are discarded, together with any other MX records of equal or lower priority.
20145
20146 .cindex "MX record" "pointing to local host"
20147 .cindex "local host" "MX pointing to"
20148 .oindex "&%self%&" "in &(dnslookup)& router"
20149 If the host pointed to by the highest priority MX record, or looked up as an
20150 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20151 happens is controlled by the generic &%self%& option.
20152
20153
20154 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20155 There have been problems with DNS servers when SRV records are looked up.
20156 Some misbehaving servers return a DNS error or timeout when a non-existent
20157 SRV record is sought. Similar problems have in the past been reported for
20158 MX records. The global &%dns_again_means_nonexist%& option can help with this
20159 problem, but it is heavy-handed because it is a global option.
20160
20161 For this reason, there are two options, &%srv_fail_domains%& and
20162 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20163 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20164 an attempt to look up an SRV or MX record causes one of these results, and the
20165 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20166 such record"&. In the case of an SRV lookup, this means that the router
20167 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20168 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20169 case routing fails.
20170
20171
20172 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20173 .cindex "&(dnslookup)& router" "declines"
20174 There are a few cases where a &(dnslookup)& router will decline to accept
20175 an address; if such a router is expected to handle "all remaining non-local
20176 domains", then it is important to set &%no_more%&.
20177
20178 The router will defer rather than decline if the domain
20179 is found in the &%fail_defer_domains%& router option.
20180
20181 Reasons for a &(dnslookup)& router to decline currently include:
20182 .ilist
20183 The domain does not exist in DNS
20184 .next
20185 The domain exists but the MX record's host part is just "."; this is a common
20186 convention (borrowed from SRV) used to indicate that there is no such service
20187 for this domain and to not fall back to trying A/AAAA records.
20188 .next
20189 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20190 .next
20191 MX record points to a non-existent host.
20192 .next
20193 MX record points to an IP address and the main section option
20194 &%allow_mx_to_ip%& is not set.
20195 .next
20196 MX records exist and point to valid hosts, but all hosts resolve only to
20197 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20198 .next
20199 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20200 &%dns_check_names_pattern%& for handling one variant of this)
20201 .next
20202 &%check_secondary_mx%& is set on this router but the local host can
20203 not be found in the MX records (see below)
20204 .endlist
20205
20206
20207
20208
20209 .section "Private options for dnslookup" "SECID118"
20210 .cindex "options" "&(dnslookup)& router"
20211 The private options for the &(dnslookup)& router are as follows:
20212
20213 .option check_secondary_mx dnslookup boolean false
20214 .cindex "MX record" "checking for secondary"
20215 If this option is set, the router declines unless the local host is found in
20216 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20217 process domains for which the local host is a secondary mail exchanger
20218 differently to other domains. The way in which Exim decides whether a host is
20219 the local host is described in section &<<SECTreclocipadd>>&.
20220
20221
20222 .option check_srv dnslookup string&!! unset
20223 .cindex "SRV record" "enabling use of"
20224 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20225 addition to MX and address records. The support is disabled by default. To
20226 enable SRV support, set the &%check_srv%& option to the name of the service
20227 required. For example,
20228 .code
20229 check_srv = smtp
20230 .endd
20231 looks for SRV records that refer to the normal smtp service. The option is
20232 expanded, so the service name can vary from message to message or address
20233 to address. This might be helpful if SRV records are being used for a
20234 submission service. If the expansion is forced to fail, the &%check_srv%&
20235 option is ignored, and the router proceeds to look for MX records in the
20236 normal way.
20237
20238 When the expansion succeeds, the router searches first for SRV records for
20239 the given service (it assumes TCP protocol). A single SRV record with a
20240 host name that consists of just a single dot indicates &"no such service for
20241 this domain"&; if this is encountered, the router declines. If other kinds of
20242 SRV record are found, they are used to construct a host list for delivery
20243 according to the rules of RFC 2782. MX records are not sought in this case.
20244
20245 When no SRV records are found, MX records (and address records) are sought in
20246 the traditional way. In other words, SRV records take precedence over MX
20247 records, just as MX records take precedence over address records. Note that
20248 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20249 defined it. It is apparently believed that MX records are sufficient for email
20250 and that SRV records should not be used for this purpose. However, SRV records
20251 have an additional &"weight"& feature which some people might find useful when
20252 trying to split an SMTP load between hosts of different power.
20253
20254 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20255 when there is a DNS lookup error.
20256
20257
20258
20259
20260 .option fail_defer_domains dnslookup "domain list&!!" unset
20261 .cindex "MX record" "not found"
20262 DNS lookups for domains matching &%fail_defer_domains%&
20263 which find no matching record will cause the router to defer
20264 rather than the default behaviour of decline.
20265 This maybe be useful for queueing messages for a newly created
20266 domain while the DNS configuration is not ready.
20267 However, it will result in any message with mistyped domains
20268 also being queued.
20269
20270
20271 .option ipv4_only "string&!!" unset
20272 .cindex IPv6 disabling
20273 .cindex DNS "IPv6 disabling"
20274 The string is expanded, and if the result is anything but a forced failure,
20275 or an empty string, or one of the strings “0” or “no” or “false”
20276 (checked without regard to the case of the letters),
20277 only A records are used.
20278
20279 .option ipv4_prefer "string&!!" unset
20280 .cindex IPv4 preference
20281 .cindex DNS "IPv4 preference"
20282 The string is expanded, and if the result is anything but a forced failure,
20283 or an empty string, or one of the strings “0” or “no” or “false”
20284 (checked without regard to the case of the letters),
20285 A records are sorted before AAAA records (inverting the default).
20286
20287 .option mx_domains dnslookup "domain list&!!" unset
20288 .cindex "MX record" "required to exist"
20289 .cindex "SRV record" "required to exist"
20290 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20291 record in order to be recognized. (The name of this option could be improved.)
20292 For example, if all the mail hosts in &'fict.example'& are known to have MX
20293 records, except for those in &'discworld.fict.example'&, you could use this
20294 setting:
20295 .code
20296 mx_domains = ! *.discworld.fict.example : *.fict.example
20297 .endd
20298 This specifies that messages addressed to a domain that matches the list but
20299 has no MX record should be bounced immediately instead of being routed using
20300 the address record.
20301
20302
20303 .option mx_fail_domains dnslookup "domain list&!!" unset
20304 If the DNS lookup for MX records for one of the domains in this list causes a
20305 DNS lookup error, Exim behaves as if no MX records were found. See section
20306 &<<SECTprowitdnsloo>>& for more discussion.
20307
20308
20309
20310
20311 .option qualify_single dnslookup boolean true
20312 .cindex "DNS" "resolver options"
20313 .cindex "DNS" "qualifying single-component names"
20314 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20315 lookups. Typically, but not standardly, this causes the resolver to qualify
20316 single-component names with the default domain. For example, on a machine
20317 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20318 &'thesaurus.ref.example'& inside the resolver. For details of what your
20319 resolver actually does, consult your man pages for &'resolver'& and
20320 &'resolv.conf'&.
20321
20322
20323
20324 .option rewrite_headers dnslookup boolean true
20325 .cindex "rewriting" "header lines"
20326 .cindex "header lines" "rewriting"
20327 If the domain name in the address that is being processed is not fully
20328 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20329 an address is specified as &'dormouse@teaparty'&, the domain might be
20330 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20331 occur as a result of setting the &%widen_domains%& option. If
20332 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20333 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20334 header lines of the message are rewritten with the full domain name.
20335
20336 This option should be turned off only when it is known that no message is
20337 ever going to be sent outside an environment where the abbreviation makes
20338 sense.
20339
20340 When an MX record is looked up in the DNS and matches a wildcard record, name
20341 servers normally return a record containing the name that has been looked up,
20342 making it impossible to detect whether a wildcard was present or not. However,
20343 some name servers have recently been seen to return the wildcard entry. If the
20344 name returned by a DNS lookup begins with an asterisk, it is not used for
20345 header rewriting.
20346
20347
20348 .option same_domain_copy_routing dnslookup boolean false
20349 .cindex "address" "copying routing"
20350 Addresses with the same domain are normally routed by the &(dnslookup)& router
20351 to the same list of hosts. However, this cannot be presumed, because the router
20352 options and preconditions may refer to the local part of the address. By
20353 default, therefore, Exim routes each address in a message independently. DNS
20354 servers run caches, so repeated DNS lookups are not normally expensive, and in
20355 any case, personal messages rarely have more than a few recipients.
20356
20357 If you are running mailing lists with large numbers of subscribers at the same
20358 domain, and you are using a &(dnslookup)& router which is independent of the
20359 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20360 lookups for identical domains in one message. In this case, when &(dnslookup)&
20361 routes an address to a remote transport, any other unrouted addresses in the
20362 message that have the same domain are automatically given the same routing
20363 without processing them independently,
20364 provided the following conditions are met:
20365
20366 .ilist
20367 No router that processed the address specified &%headers_add%& or
20368 &%headers_remove%&.
20369 .next
20370 The router did not change the address in any way, for example, by &"widening"&
20371 the domain.
20372 .endlist
20373
20374
20375
20376
20377 .option search_parents dnslookup boolean false
20378 .cindex "DNS" "resolver options"
20379 When this option is true, the resolver option RES_DNSRCH is set for DNS
20380 lookups. This is different from the &%qualify_single%& option in that it
20381 applies to domains containing dots. Typically, but not standardly, it causes
20382 the resolver to search for the name in the current domain and in parent
20383 domains. For example, on a machine in the &'fict.example'& domain, if looking
20384 up &'teaparty.wonderland'& failed, the resolver would try
20385 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20386 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20387
20388 Setting this option true can cause problems in domains that have a wildcard MX
20389 record, because any domain that does not have its own MX record matches the
20390 local wildcard.
20391
20392
20393
20394 .option srv_fail_domains dnslookup "domain list&!!" unset
20395 If the DNS lookup for SRV records for one of the domains in this list causes a
20396 DNS lookup error, Exim behaves as if no SRV records were found. See section
20397 &<<SECTprowitdnsloo>>& for more discussion.
20398
20399
20400
20401
20402 .option widen_domains dnslookup "string list" unset
20403 .cindex "domain" "partial; widening"
20404 If a DNS lookup fails and this option is set, each of its strings in turn is
20405 added onto the end of the domain, and the lookup is tried again. For example,
20406 if
20407 .code
20408 widen_domains = fict.example:ref.example
20409 .endd
20410 is set and a lookup of &'klingon.dictionary'& fails,
20411 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20412 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20413 and &%search_parents%& options can cause some widening to be undertaken inside
20414 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20415 when verifying, unless &%rewrite_headers%& is false (not the default).
20416
20417
20418 .section "Effect of qualify_single and search_parents" "SECID119"
20419 When a domain from an envelope recipient is changed by the resolver as a result
20420 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20421 corresponding address in the message's header lines unless &%rewrite_headers%&
20422 is set false. Exim then re-routes the address, using the full domain.
20423
20424 These two options affect only the DNS lookup that takes place inside the router
20425 for the domain of the address that is being routed. They do not affect lookups
20426 such as that implied by
20427 .code
20428 domains = @mx_any
20429 .endd
20430 that may happen while processing a router precondition before the router is
20431 entered. No widening ever takes place for these lookups.
20432 .ecindex IIDdnsrou1
20433 .ecindex IIDdnsrou2
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443 . ////////////////////////////////////////////////////////////////////////////
20444 . ////////////////////////////////////////////////////////////////////////////
20445
20446 .chapter "The ipliteral router" "CHID5"
20447 .cindex "&(ipliteral)& router"
20448 .cindex "domain literal" "routing"
20449 .cindex "routers" "&(ipliteral)&"
20450 This router has no private options. Unless it is being used purely for
20451 verification (see &%verify_only%&) a transport is required to be defined by the
20452 generic &%transport%& option. The router accepts the address if its domain part
20453 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20454 router handles the address
20455 .code
20456 root@[192.168.1.1]
20457 .endd
20458 by setting up delivery to the host with that IP address. IPv4 domain literals
20459 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20460 are similar, but the address is preceded by &`ipv6:`&. For example:
20461 .code
20462 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20463 .endd
20464 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20465 grounds that sooner or later somebody will try it.
20466
20467 .oindex "&%self%&" "in &(ipliteral)& router"
20468 If the IP address matches something in &%ignore_target_hosts%&, the router
20469 declines. If an IP literal turns out to refer to the local host, the generic
20470 &%self%& option determines what happens.
20471
20472 The RFCs require support for domain literals; however, their use is
20473 controversial in today's Internet. If you want to use this router, you must
20474 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20475 Exim will not recognize the domain literal syntax in addresses.
20476
20477
20478
20479 . ////////////////////////////////////////////////////////////////////////////
20480 . ////////////////////////////////////////////////////////////////////////////
20481
20482 .chapter "The iplookup router" "CHID6"
20483 .cindex "&(iplookup)& router"
20484 .cindex "routers" "&(iplookup)&"
20485 The &(iplookup)& router was written to fulfil a specific requirement in
20486 Cambridge University (which in fact no longer exists). For this reason, it is
20487 not included in the binary of Exim by default. If you want to include it, you
20488 must set
20489 .code
20490 ROUTER_IPLOOKUP=yes
20491 .endd
20492 in your &_Local/Makefile_& configuration file.
20493
20494 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20495 connection to one or more specific hosts. The host can then return the same or
20496 a different address &-- in effect rewriting the recipient address in the
20497 message's envelope. The new address is then passed on to subsequent routers. If
20498 this process fails, the address can be passed on to other routers, or delivery
20499 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20500 must not be specified for it.
20501
20502 .cindex "options" "&(iplookup)& router"
20503 .option hosts iplookup string unset
20504 This option must be supplied. Its value is a colon-separated list of host
20505 names. The hosts are looked up using &[gethostbyname()]&
20506 (or &[getipnodebyname()]& when available)
20507 and are tried in order until one responds to the query. If none respond, what
20508 happens is controlled by &%optional%&.
20509
20510
20511 .option optional iplookup boolean false
20512 If &%optional%& is true, if no response is obtained from any host, the address
20513 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20514 delivery to the address is deferred.
20515
20516
20517 .option port iplookup integer 0
20518 .cindex "port" "&(iplookup)& router"
20519 This option must be supplied. It specifies the port number for the TCP or UDP
20520 call.
20521
20522
20523 .option protocol iplookup string udp
20524 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20525 protocols is to be used.
20526
20527
20528 .option query iplookup string&!! "see below"
20529 This defines the content of the query that is sent to the remote hosts. The
20530 default value is:
20531 .code
20532 $local_part@$domain $local_part@$domain
20533 .endd
20534 The repetition serves as a way of checking that a response is to the correct
20535 query in the default case (see &%response_pattern%& below).
20536
20537
20538 .option reroute iplookup string&!! unset
20539 If this option is not set, the rerouted address is precisely the byte string
20540 returned by the remote host, up to the first white space, if any. If set, the
20541 string is expanded to form the rerouted address. It can include parts matched
20542 in the response by &%response_pattern%& by means of numeric variables such as
20543 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20544 whether or not a pattern is in use. In all cases, the rerouted address must end
20545 up in the form &'local_part@domain'&.
20546
20547
20548 .option response_pattern iplookup string unset
20549 This option can be set to a regular expression that is applied to the string
20550 returned from the remote host. If the pattern does not match the response, the
20551 router declines. If &%response_pattern%& is not set, no checking of the
20552 response is done, unless the query was defaulted, in which case there is a
20553 check that the text returned after the first white space is the original
20554 address. This checks that the answer that has been received is in response to
20555 the correct question. For example, if the response is just a new domain, the
20556 following could be used:
20557 .code
20558 response_pattern = ^([^@]+)$
20559 reroute = $local_part@$1
20560 .endd
20561
20562 .option timeout iplookup time 5s
20563 This specifies the amount of time to wait for a response from the remote
20564 machine. The same timeout is used for the &[connect()]& function for a TCP
20565 call. It does not apply to UDP.
20566
20567
20568
20569
20570 . ////////////////////////////////////////////////////////////////////////////
20571 . ////////////////////////////////////////////////////////////////////////////
20572
20573 .chapter "The manualroute router" "CHID7"
20574 .scindex IIDmanrou1 "&(manualroute)& router"
20575 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20576 .cindex "domain" "manually routing"
20577 The &(manualroute)& router is so-called because it provides a way of manually
20578 routing an address according to its domain. It is mainly used when you want to
20579 route addresses to remote hosts according to your own rules, bypassing the
20580 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20581 route to local transports, a facility that may be useful if you want to save
20582 messages for dial-in hosts in local files.
20583
20584 The &(manualroute)& router compares a list of domain patterns with the domain
20585 it is trying to route. If there is no match, the router declines. Each pattern
20586 has associated with it a list of hosts and some other optional data, which may
20587 include a transport. The combination of a pattern and its data is called a
20588 &"routing rule"&. For patterns that do not have an associated transport, the
20589 generic &%transport%& option must specify a transport, unless the router is
20590 being used purely for verification (see &%verify_only%&).
20591
20592 .vindex "&$host$&"
20593 In the case of verification, matching the domain pattern is sufficient for the
20594 router to accept the address. When actually routing an address for delivery,
20595 an address that matches a domain pattern is queued for the associated
20596 transport. If the transport is not a local one, a host list must be associated
20597 with the pattern; IP addresses are looked up for the hosts, and these are
20598 passed to the transport along with the mail address. For local transports, a
20599 host list is optional. If it is present, it is passed in &$host$& as a single
20600 text string.
20601
20602 The list of routing rules can be provided as an inline string in
20603 &%route_list%&, or the data can be obtained by looking up the domain in a file
20604 or database by setting &%route_data%&. Only one of these settings may appear in
20605 any one instance of &(manualroute)&. The format of routing rules is described
20606 below, following the list of private options.
20607
20608
20609 .section "Private options for manualroute" "SECTprioptman"
20610
20611 .cindex "options" "&(manualroute)& router"
20612 The private options for the &(manualroute)& router are as follows:
20613
20614 .option host_all_ignored manualroute string defer
20615 See &%host_find_failed%&.
20616
20617 .option host_find_failed manualroute string freeze
20618 This option controls what happens when &(manualroute)& tries to find an IP
20619 address for a host, and the host does not exist. The option can be set to one
20620 of the following values:
20621 .code
20622 decline
20623 defer
20624 fail
20625 freeze
20626 ignore
20627 pass
20628 .endd
20629 The default (&"freeze"&) assumes that this state is a serious configuration
20630 error. The difference between &"pass"& and &"decline"& is that the former
20631 forces the address to be passed to the next router (or the router defined by
20632 &%pass_router%&),
20633 .oindex "&%more%&"
20634 overriding &%no_more%&, whereas the latter passes the address to the next
20635 router only if &%more%& is true.
20636
20637 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20638 cannot be found. If all the hosts in the list are ignored, the behaviour is
20639 controlled by the &%host_all_ignored%& option. This takes the same values
20640 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20641
20642 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20643 state; if a host lookup gets a temporary error, delivery is deferred unless the
20644 generic &%pass_on_timeout%& option is set.
20645
20646
20647 .option hosts_randomize manualroute boolean false
20648 .cindex "randomized host list"
20649 .cindex "host" "list of; randomized"
20650 If this option is set, the order of the items in a host list in a routing rule
20651 is randomized each time the list is used, unless an option in the routing rule
20652 overrides (see below). Randomizing the order of a host list can be used to do
20653 crude load sharing. However, if more than one mail address is routed by the
20654 same router to the same host list, the host lists are considered to be the same
20655 (even though they may be randomized into different orders) for the purpose of
20656 deciding whether to batch the deliveries into a single SMTP transaction.
20657
20658 When &%hosts_randomize%& is true, a host list may be split
20659 into groups whose order is separately randomized. This makes it possible to
20660 set up MX-like behaviour. The boundaries between groups are indicated by an
20661 item that is just &`+`& in the host list. For example:
20662 .code
20663 route_list = * host1:host2:host3:+:host4:host5
20664 .endd
20665 The order of the first three hosts and the order of the last two hosts is
20666 randomized for each use, but the first three always end up before the last two.
20667 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20668 randomized host list is passed to an &(smtp)& transport that also has
20669 &%hosts_randomize set%&, the list is not re-randomized.
20670
20671
20672 .option route_data manualroute string&!! unset
20673 If this option is set, it must expand to yield the data part of a routing rule.
20674 Typically, the expansion string includes a lookup based on the domain. For
20675 example:
20676 .code
20677 route_data = ${lookup{$domain}dbm{/etc/routes}}
20678 .endd
20679 If the expansion is forced to fail, or the result is an empty string, the
20680 router declines. Other kinds of expansion failure cause delivery to be
20681 deferred.
20682
20683
20684 .option route_list manualroute "string list" unset
20685 This string is a list of routing rules, in the form defined below. Note that,
20686 unlike most string lists, the items are separated by semicolons. This is so
20687 that they may contain colon-separated host lists.
20688
20689
20690 .option same_domain_copy_routing manualroute boolean false
20691 .cindex "address" "copying routing"
20692 Addresses with the same domain are normally routed by the &(manualroute)&
20693 router to the same list of hosts. However, this cannot be presumed, because the
20694 router options and preconditions may refer to the local part of the address. By
20695 default, therefore, Exim routes each address in a message independently. DNS
20696 servers run caches, so repeated DNS lookups are not normally expensive, and in
20697 any case, personal messages rarely have more than a few recipients.
20698
20699 If you are running mailing lists with large numbers of subscribers at the same
20700 domain, and you are using a &(manualroute)& router which is independent of the
20701 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20702 lookups for identical domains in one message. In this case, when
20703 &(manualroute)& routes an address to a remote transport, any other unrouted
20704 addresses in the message that have the same domain are automatically given the
20705 same routing without processing them independently. However, this is only done
20706 if &%headers_add%& and &%headers_remove%& are unset.
20707
20708
20709
20710
20711 .section "Routing rules in route_list" "SECID120"
20712 The value of &%route_list%& is a string consisting of a sequence of routing
20713 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20714 entered as two semicolons. Alternatively, the list separator can be changed as
20715 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20716 Empty rules are ignored. The format of each rule is
20717 .display
20718 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20719 .endd
20720 The following example contains two rules, each with a simple domain pattern and
20721 no options:
20722 .code
20723 route_list = \
20724   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20725   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20726 .endd
20727 The three parts of a rule are separated by white space. The pattern and the
20728 list of hosts can be enclosed in quotes if necessary, and if they are, the
20729 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20730 single domain pattern, which is the only mandatory item in the rule. The
20731 pattern is in the same format as one item in a domain list (see section
20732 &<<SECTdomainlist>>&),
20733 except that it may not be the name of an interpolated file.
20734 That is, it may be wildcarded, or a regular expression, or a file or database
20735 lookup (with semicolons doubled, because of the use of semicolon as a separator
20736 in a &%route_list%&).
20737
20738 The rules in &%route_list%& are searched in order until one of the patterns
20739 matches the domain that is being routed. The list of hosts and then options are
20740 then used as described below. If there is no match, the router declines. When
20741 &%route_list%& is set, &%route_data%& must not be set.
20742
20743
20744
20745 .section "Routing rules in route_data" "SECID121"
20746 The use of &%route_list%& is convenient when there are only a small number of
20747 routing rules. For larger numbers, it is easier to use a file or database to
20748 hold the routing information, and use the &%route_data%& option instead.
20749 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20750 Most commonly, &%route_data%& is set as a string that contains an
20751 expansion lookup. For example, suppose we place two routing rules in a file
20752 like this:
20753 .code
20754 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20755 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20756 .endd
20757 This data can be accessed by setting
20758 .code
20759 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20760 .endd
20761 Failure of the lookup results in an empty string, causing the router to
20762 decline. However, you do not have to use a lookup in &%route_data%&. The only
20763 requirement is that the result of expanding the string is a list of hosts,
20764 possibly followed by options, separated by white space. The list of hosts must
20765 be enclosed in quotes if it contains white space.
20766
20767
20768
20769
20770 .section "Format of the list of hosts" "SECID122"
20771 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20772 always separately expanded before use. If the expansion fails, the router
20773 declines. The result of the expansion must be a colon-separated list of names
20774 and/or IP addresses, optionally also including ports.
20775 If the list is written with spaces, it must be protected with quotes.
20776 The format of each item
20777 in the list is described in the next section. The list separator can be changed
20778 as described in section &<<SECTlistsepchange>>&.
20779
20780 If the list of hosts was obtained from a &%route_list%& item, the following
20781 variables are set during its expansion:
20782
20783 .ilist
20784 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20785 If the domain was matched against a regular expression, the numeric variables
20786 &$1$&, &$2$&, etc. may be set. For example:
20787 .code
20788 route_list = ^domain(\d+)   host-$1.text.example
20789 .endd
20790 .next
20791 &$0$& is always set to the entire domain.
20792 .next
20793 &$1$& is also set when partial matching is done in a file lookup.
20794
20795 .next
20796 .vindex "&$value$&"
20797 If the pattern that matched the domain was a lookup item, the data that was
20798 looked up is available in the expansion variable &$value$&. For example:
20799 .code
20800 route_list = lsearch;;/some/file.routes  $value
20801 .endd
20802 .endlist
20803
20804 Note the doubling of the semicolon in the pattern that is necessary because
20805 semicolon is the default route list separator.
20806
20807
20808
20809 .section "Format of one host item" "SECTformatonehostitem"
20810 Each item in the list of hosts can be either a host name or an IP address,
20811 optionally with an attached port number, or it can be a single "+"
20812 (see &%hosts_randomize%&).
20813 When no port is given, an IP address
20814 is not enclosed in brackets. When a port is specified, it overrides the port
20815 specification on the transport. The port is separated from the name or address
20816 by a colon. This leads to some complications:
20817
20818 .ilist
20819 Because colon is the default separator for the list of hosts, either
20820 the colon that specifies a port must be doubled, or the list separator must
20821 be changed. The following two examples have the same effect:
20822 .code
20823 route_list = * "host1.tld::1225 : host2.tld::1226"
20824 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20825 .endd
20826 .next
20827 When IPv6 addresses are involved, it gets worse, because they contain
20828 colons of their own. To make this case easier, it is permitted to
20829 enclose an IP address (either v4 or v6) in square brackets if a port
20830 number follows. For example:
20831 .code
20832 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20833 .endd
20834 .endlist
20835
20836 .section "How the list of hosts is used" "SECThostshowused"
20837 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20838 the hosts is tried, in the order specified, when carrying out the SMTP
20839 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20840 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20841 transport.
20842
20843 Hosts may be listed by name or by IP address. An unadorned name in the list of
20844 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20845 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20846 records in the DNS. For example:
20847 .code
20848 route_list = *  x.y.z:p.q.r/MX:e.f.g
20849 .endd
20850 If this feature is used with a port specifier, the port must come last. For
20851 example:
20852 .code
20853 route_list = *  dom1.tld/mx::1225
20854 .endd
20855 If the &%hosts_randomize%& option is set, the order of the items in the list is
20856 randomized before any lookups are done. Exim then scans the list; for any name
20857 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20858 be an interface on the local host and the item is not the first in the list,
20859 Exim discards it and any subsequent items. If it is the first item, what
20860 happens is controlled by the
20861 .oindex "&%self%&" "in &(manualroute)& router"
20862 &%self%& option of the router.
20863
20864 A name on the list that is followed by &`/MX`& is replaced with the list of
20865 hosts obtained by looking up MX records for the name. This is always a DNS
20866 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20867 below) are not relevant here. The order of these hosts is determined by the
20868 preference values in the MX records, according to the usual rules. Because
20869 randomizing happens before the MX lookup, it does not affect the order that is
20870 defined by MX preferences.
20871
20872 If the local host is present in the sublist obtained from MX records, but is
20873 not the most preferred host in that list, it and any equally or less
20874 preferred hosts are removed before the sublist is inserted into the main list.
20875
20876 If the local host is the most preferred host in the MX list, what happens
20877 depends on where in the original list of hosts the &`/MX`& item appears. If it
20878 is not the first item (that is, there are previous hosts in the main list),
20879 Exim discards this name and any subsequent items in the main list.
20880
20881 If the MX item is first in the list of hosts, and the local host is the
20882 most preferred host, what happens is controlled by the &%self%& option of the
20883 router.
20884
20885 DNS failures when lookup up the MX records are treated in the same way as DNS
20886 failures when looking up IP addresses: &%pass_on_timeout%& and
20887 &%host_find_failed%& are used when relevant.
20888
20889 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20890 whether obtained from an MX lookup or not.
20891
20892
20893
20894 .section "How the options are used" "SECThowoptused"
20895 The options are a sequence of words, space-separated.
20896 One of the words can be the name of a transport; this overrides the
20897 &%transport%& option on the router for this particular routing rule only. The
20898 other words (if present) control randomization of the list of hosts on a
20899 per-rule basis, and how the IP addresses of the hosts are to be found when
20900 routing to a remote transport. These options are as follows:
20901
20902 .ilist
20903 &%randomize%&: randomize the order of the hosts in this list, overriding the
20904 setting of &%hosts_randomize%& for this routing rule only.
20905 .next
20906 &%no_randomize%&: do not randomize the order of the hosts in this list,
20907 overriding the setting of &%hosts_randomize%& for this routing rule only.
20908 .next
20909 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20910 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20911 also look in &_/etc/hosts_& or other sources of information.
20912 .next
20913 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20914 no address records are found. If there is a temporary DNS error (such as a
20915 timeout), delivery is deferred.
20916 .next
20917 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20918 .next
20919 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20920 .endlist
20921
20922 For example:
20923 .code
20924 route_list = domain1  host1:host2:host3  randomize bydns;\
20925              domain2  host4:host5
20926 .endd
20927 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20928 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20929 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20930 or &[gethostbyname()]&, and the result of the lookup is the result of that
20931 call.
20932
20933 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20934 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20935 instead of TRY_AGAIN. That is why the default action is to try a DNS
20936 lookup first. Only if that gives a definite &"no such host"& is the local
20937 function called.
20938
20939 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20940 inadvertent constraint that a transport name as an option had to be the last
20941 option specified.
20942
20943
20944
20945 If no IP address for a host can be found, what happens is controlled by the
20946 &%host_find_failed%& option.
20947
20948 .vindex "&$host$&"
20949 When an address is routed to a local transport, IP addresses are not looked up.
20950 The host list is passed to the transport in the &$host$& variable.
20951
20952
20953
20954 .section "Manualroute examples" "SECID123"
20955 In some of the examples that follow, the presence of the &%remote_smtp%&
20956 transport, as defined in the default configuration file, is assumed:
20957
20958 .ilist
20959 .cindex "smart host" "example router"
20960 The &(manualroute)& router can be used to forward all external mail to a
20961 &'smart host'&. If you have set up, in the main part of the configuration, a
20962 named domain list that contains your local domains, for example:
20963 .code
20964 domainlist local_domains = my.domain.example
20965 .endd
20966 You can arrange for all other domains to be routed to a smart host by making
20967 your first router something like this:
20968 .code
20969 smart_route:
20970   driver = manualroute
20971   domains = !+local_domains
20972   transport = remote_smtp
20973   route_list = * smarthost.ref.example
20974 .endd
20975 This causes all non-local addresses to be sent to the single host
20976 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20977 they are tried in order
20978 (but you can use &%hosts_randomize%& to vary the order each time).
20979 Another way of configuring the same thing is this:
20980 .code
20981 smart_route:
20982   driver = manualroute
20983   transport = remote_smtp
20984   route_list = !+local_domains  smarthost.ref.example
20985 .endd
20986 There is no difference in behaviour between these two routers as they stand.
20987 However, they behave differently if &%no_more%& is added to them. In the first
20988 example, the router is skipped if the domain does not match the &%domains%&
20989 precondition; the following router is always tried. If the router runs, it
20990 always matches the domain and so can never decline. Therefore, &%no_more%&
20991 would have no effect. In the second case, the router is never skipped; it
20992 always runs. However, if it doesn't match the domain, it declines. In this case
20993 &%no_more%& would prevent subsequent routers from running.
20994
20995 .next
20996 .cindex "mail hub example"
20997 A &'mail hub'& is a host which receives mail for a number of domains via MX
20998 records in the DNS and delivers it via its own private routing mechanism. Often
20999 the final destinations are behind a firewall, with the mail hub being the one
21000 machine that can connect to machines both inside and outside the firewall. The
21001 &(manualroute)& router is usually used on a mail hub to route incoming messages
21002 to the correct hosts. For a small number of domains, the routing can be inline,
21003 using the &%route_list%& option, but for a larger number a file or database
21004 lookup is easier to manage.
21005
21006 If the domain names are in fact the names of the machines to which the mail is
21007 to be sent by the mail hub, the configuration can be quite simple. For
21008 example:
21009 .code
21010 hub_route:
21011   driver = manualroute
21012   transport = remote_smtp
21013   route_list = *.rhodes.tvs.example  $domain
21014 .endd
21015 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21016 whose names are the same as the mail domains. A similar approach can be taken
21017 if the host name can be obtained from the domain name by a string manipulation
21018 that the expansion facilities can handle. Otherwise, a lookup based on the
21019 domain can be used to find the host:
21020 .code
21021 through_firewall:
21022   driver = manualroute
21023   transport = remote_smtp
21024   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21025 .endd
21026 The result of the lookup must be the name or IP address of the host (or
21027 hosts) to which the address is to be routed. If the lookup fails, the route
21028 data is empty, causing the router to decline. The address then passes to the
21029 next router.
21030
21031 .next
21032 .cindex "batched SMTP output example"
21033 .cindex "SMTP" "batched outgoing; example"
21034 You can use &(manualroute)& to deliver messages to pipes or files in batched
21035 SMTP format for onward transportation by some other means. This is one way of
21036 storing mail for a dial-up host when it is not connected. The route list entry
21037 can be as simple as a single domain name in a configuration like this:
21038 .code
21039 save_in_file:
21040   driver = manualroute
21041   transport = batchsmtp_appendfile
21042   route_list = saved.domain.example
21043 .endd
21044 though often a pattern is used to pick up more than one domain. If there are
21045 several domains or groups of domains with different transport requirements,
21046 different transports can be listed in the routing information:
21047 .code
21048 save_in_file:
21049   driver = manualroute
21050   route_list = \
21051     *.saved.domain1.example  $domain  batch_appendfile; \
21052     *.saved.domain2.example  \
21053       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21054       batch_pipe
21055 .endd
21056 .vindex "&$domain$&"
21057 .vindex "&$host$&"
21058 The first of these just passes the domain in the &$host$& variable, which
21059 doesn't achieve much (since it is also in &$domain$&), but the second does a
21060 file lookup to find a value to pass, causing the router to decline to handle
21061 the address if the lookup fails.
21062
21063 .next
21064 .cindex "UUCP" "example of router for"
21065 Routing mail directly to UUCP software is a specific case of the use of
21066 &(manualroute)& in a gateway to another mail environment. This is an example of
21067 one way it can be done:
21068 .code
21069 # Transport
21070 uucp:
21071   driver = pipe
21072   user = nobody
21073   command = /usr/local/bin/uux -r - \
21074     ${substr_-5:$host}!rmail ${local_part}
21075   return_fail_output = true
21076
21077 # Router
21078 uucphost:
21079   transport = uucp
21080   driver = manualroute
21081   route_data = \
21082     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21083 .endd
21084 The file &_/usr/local/exim/uucphosts_& contains entries like
21085 .code
21086 darksite.ethereal.example:           darksite.UUCP
21087 .endd
21088 It can be set up more simply without adding and removing &".UUCP"& but this way
21089 makes clear the distinction between the domain name
21090 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21091 .endlist
21092 .ecindex IIDmanrou1
21093 .ecindex IIDmanrou2
21094
21095
21096
21097
21098
21099
21100
21101
21102 . ////////////////////////////////////////////////////////////////////////////
21103 . ////////////////////////////////////////////////////////////////////////////
21104
21105 .chapter "The queryprogram router" "CHAPdriverlast"
21106 .scindex IIDquerou1 "&(queryprogram)& router"
21107 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21108 .cindex "routing" "by external program"
21109 The &(queryprogram)& router routes an address by running an external command
21110 and acting on its output. This is an expensive way to route, and is intended
21111 mainly for use in lightly-loaded systems, or for performing experiments.
21112 However, if it is possible to use the precondition options (&%domains%&,
21113 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21114 be used in special cases, even on a busy host. There are the following private
21115 options:
21116 .cindex "options" "&(queryprogram)& router"
21117
21118 .option command queryprogram string&!! unset
21119 This option must be set. It specifies the command that is to be run. The
21120 command is split up into a command name and arguments, and then each is
21121 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21122 &<<CHAPpipetransport>>&).
21123
21124
21125 .option command_group queryprogram string unset
21126 .cindex "gid (group id)" "in &(queryprogram)& router"
21127 This option specifies a gid to be set when running the command while routing an
21128 address for deliver. It must be set if &%command_user%& specifies a numerical
21129 uid. If it begins with a digit, it is interpreted as the numerical value of the
21130 gid. Otherwise it is looked up using &[getgrnam()]&.
21131
21132
21133 .option command_user queryprogram string unset
21134 .cindex "uid (user id)" "for &(queryprogram)&"
21135 This option must be set. It specifies the uid which is set when running the
21136 command while routing an address for delivery. If the value begins with a digit,
21137 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21138 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21139 not set, a value for the gid also.
21140
21141 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21142 root, which it does during a normal delivery in a conventional configuration.
21143 However, when an address is being verified during message reception, Exim is
21144 usually running as the Exim user, not as root. If the &(queryprogram)& router
21145 is called from a non-root process, Exim cannot change uid or gid before running
21146 the command. In this circumstance the command runs under the current uid and
21147 gid.
21148
21149
21150 .option current_directory queryprogram string /
21151 This option specifies an absolute path which is made the current directory
21152 before running the command.
21153
21154
21155 .option timeout queryprogram time 1h
21156 If the command does not complete within the timeout period, its process group
21157 is killed and the message is frozen. A value of zero time specifies no
21158 timeout.
21159
21160
21161 The standard output of the command is connected to a pipe, which is read when
21162 the command terminates. It should consist of a single line of output,
21163 containing up to five fields, separated by white space. The maximum length of
21164 the line is 1023 characters. Longer lines are silently truncated. The first
21165 field is one of the following words (case-insensitive):
21166
21167 .ilist
21168 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21169 below).
21170 .next
21171 &'Decline'&: the router declines; pass the address to the next router, unless
21172 &%no_more%& is set.
21173 .next
21174 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21175 subsequent text on the line is an error message. If the router is run as part
21176 of address verification during an incoming SMTP message, the message is
21177 included in the SMTP response.
21178 .next
21179 &'Defer'&: routing could not be completed at this time; try again later. Any
21180 subsequent text on the line is an error message which is logged. It is not
21181 included in any SMTP response.
21182 .next
21183 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21184 .next
21185 &'Pass'&: pass the address to the next router (or the router specified by
21186 &%pass_router%&), overriding &%no_more%&.
21187 .next
21188 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21189 new addresses, which are routed independently, starting with the first router,
21190 or the router specified by &%redirect_router%&, if set.
21191 .endlist
21192
21193 When the first word is &'accept'&, the remainder of the line consists of a
21194 number of keyed data values, as follows (split into two lines here, to fit on
21195 the page):
21196 .code
21197 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21198 LOOKUP=byname|bydns DATA=<text>
21199 .endd
21200 The data items can be given in any order, and all are optional. If no transport
21201 is included, the transport specified by the generic &%transport%& option is
21202 used. The list of hosts and the lookup type are needed only if the transport is
21203 an &(smtp)& transport that does not itself supply a list of hosts.
21204
21205 The format of the list of hosts is the same as for the &(manualroute)& router.
21206 As well as host names and IP addresses with optional port numbers, as described
21207 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21208 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21209 (see section &<<SECThostshowused>>&).
21210
21211 If the lookup type is not specified, Exim behaves as follows when trying to
21212 find an IP address for each host: First, a DNS lookup is done. If this yields
21213 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21214 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21215 result of the lookup is the result of that call.
21216
21217 .vindex "&$address_data$&"
21218 If the DATA field is set, its value is placed in the &$address_data$&
21219 variable. For example, this return line
21220 .code
21221 accept hosts=x1.y.example:x2.y.example data="rule1"
21222 .endd
21223 routes the address to the default transport, passing a list of two hosts. When
21224 the transport runs, the string &"rule1"& is in &$address_data$&.
21225 .ecindex IIDquerou1
21226 .ecindex IIDquerou2
21227
21228
21229
21230
21231 . ////////////////////////////////////////////////////////////////////////////
21232 . ////////////////////////////////////////////////////////////////////////////
21233
21234 .chapter "The redirect router" "CHAPredirect"
21235 .scindex IIDredrou1 "&(redirect)& router"
21236 .scindex IIDredrou2 "routers" "&(redirect)&"
21237 .cindex "alias file" "in a &(redirect)& router"
21238 .cindex "address redirection" "&(redirect)& router"
21239 The &(redirect)& router handles several kinds of address redirection. Its most
21240 common uses are for resolving local part aliases from a central alias file
21241 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21242 files, but it has many other potential uses. The incoming address can be
21243 redirected in several different ways:
21244
21245 .ilist
21246 It can be replaced by one or more new addresses which are themselves routed
21247 independently.
21248 .next
21249 It can be routed to be delivered to a given file or directory.
21250 .next
21251 It can be routed to be delivered to a specified pipe command.
21252 .next
21253 It can cause an automatic reply to be generated.
21254 .next
21255 It can be forced to fail, optionally with a custom error message.
21256 .next
21257 It can be temporarily deferred, optionally with a custom message.
21258 .next
21259 It can be discarded.
21260 .endlist
21261
21262 The generic &%transport%& option must not be set for &(redirect)& routers.
21263 However, there are some private options which define transports for delivery to
21264 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21265 &%pipe_transport%& and &%reply_transport%& descriptions below.
21266
21267 If success DSNs have been requested
21268 .cindex "DSN" "success"
21269 .cindex "Delivery Status Notification" "success"
21270 redirection triggers one and the DSN options are not passed any further.
21271
21272
21273
21274 .section "Redirection data" "SECID124"
21275 The router operates by interpreting a text string which it obtains either by
21276 expanding the contents of the &%data%& option, or by reading the entire
21277 contents of a file whose name is given in the &%file%& option. These two
21278 options are mutually exclusive. The first is commonly used for handling system
21279 aliases, in a configuration like this:
21280 .code
21281 system_aliases:
21282   driver = redirect
21283   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21284 .endd
21285 If the lookup fails, the expanded string in this example is empty. When the
21286 expansion of &%data%& results in an empty string, the router declines. A forced
21287 expansion failure also causes the router to decline; other expansion failures
21288 cause delivery to be deferred.
21289
21290 A configuration using &%file%& is commonly used for handling users'
21291 &_.forward_& files, like this:
21292 .code
21293 userforward:
21294   driver = redirect
21295   check_local_user
21296   file = $home/.forward
21297   no_verify
21298 .endd
21299 If the file does not exist, or causes no action to be taken (for example, it is
21300 empty or consists only of comments), the router declines. &*Warning*&: This
21301 is not the case when the file contains syntactically valid items that happen to
21302 yield empty addresses, for example, items containing only RFC 2822 address
21303 comments.
21304
21305 .cindex "tainted data" "in filenames"
21306 .cindex redirect "tainted data"
21307 Tainted data may not be used for a filename.
21308
21309 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21310 directly for redirection,
21311 as they are provided by a potential attacker.
21312 In the examples above, &$local_part$& is used for looking up data held locally
21313 on the system, and not used directly (the second example derives &$home$& via
21314 the passsword file or database, using &$local_part$&).
21315
21316
21317
21318 .section "Forward files and address verification" "SECID125"
21319 .cindex "address redirection" "while verifying"
21320 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21321 &_.forward_& files, as in the example above. There are two reasons for this:
21322
21323 .ilist
21324 When Exim is receiving an incoming SMTP message from a remote host, it is
21325 running under the Exim uid, not as root. Exim is unable to change uid to read
21326 the file as the user, and it may not be able to read it as the Exim user. So in
21327 practice the router may not be able to operate.
21328 .next
21329 However, even when the router can operate, the existence of a &_.forward_& file
21330 is unimportant when verifying an address. What should be checked is whether the
21331 local part is a valid user name or not. Cutting out the redirection processing
21332 saves some resources.
21333 .endlist
21334
21335
21336
21337
21338
21339
21340 .section "Interpreting redirection data" "SECID126"
21341 .cindex "Sieve filter" "specifying in redirection data"
21342 .cindex "filter" "specifying in redirection data"
21343 The contents of the data string, whether obtained from &%data%& or &%file%&,
21344 can be interpreted in two different ways:
21345
21346 .ilist
21347 If the &%allow_filter%& option is set true, and the data begins with the text
21348 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21349 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21350 respectively. Details of the syntax and semantics of filter files are described
21351 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21352 document is intended for use by end users.
21353 .next
21354 Otherwise, the data must be a comma-separated list of redirection items, as
21355 described in the next section.
21356 .endlist
21357
21358 When a message is redirected to a file (a &"mail folder"&), the filename given
21359 in a non-filter redirection list must always be an absolute path. A filter may
21360 generate a relative path &-- how this is handled depends on the transport's
21361 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21362 for the &(appendfile)& transport.
21363
21364
21365
21366 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21367 .cindex "address redirection" "non-filter list items"
21368 When the redirection data is not an Exim or Sieve filter, for example, if it
21369 comes from a conventional alias or forward file, it consists of a list of
21370 addresses, filenames, pipe commands, or certain special items (see section
21371 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21372 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21373 depending on their default values. The items in the list are separated by
21374 commas or newlines.
21375 If a comma is required in an item, the entire item must be enclosed in double
21376 quotes.
21377
21378 Lines starting with a # character are comments, and are ignored, and # may
21379 also appear following a comma, in which case everything between the # and the
21380 next newline character is ignored.
21381
21382 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21383 double quotes are retained because some forms of mail address require their use
21384 (but never to enclose the entire address). In the following description,
21385 &"item"& refers to what remains after any surrounding double quotes have been
21386 removed.
21387
21388 .vindex "&$local_part$&"
21389 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21390 and the expansion contains a reference to &$local_part$&, you should make use
21391 of the &%quote_local_part%& expansion operator, in case the local part contains
21392 special characters. For example, to redirect all mail for the domain
21393 &'obsolete.example'&, retaining the existing local part, you could use this
21394 setting:
21395 .code
21396 data = ${quote_local_part:$local_part}@newdomain.example
21397 .endd
21398
21399
21400 .section "Redirecting to a local mailbox" "SECTredlocmai"
21401 .cindex "routing" "loops in"
21402 .cindex "loop" "while routing, avoidance of"
21403 .cindex "address redirection" "to local mailbox"
21404 A redirection item may safely be the same as the address currently under
21405 consideration. This does not cause a routing loop, because a router is
21406 automatically skipped if any ancestor of the address that is being processed
21407 is the same as the current address and was processed by the current router.
21408 Such an address is therefore passed to the following routers, so it is handled
21409 as if there were no redirection. When making this loop-avoidance test, the
21410 complete local part, including any prefix or suffix, is used.
21411
21412 .cindex "address redirection" "local part without domain"
21413 Specifying the same local part without a domain is a common usage in personal
21414 filter files when the user wants to have messages delivered to the local
21415 mailbox and also forwarded elsewhere. For example, the user whose login is
21416 &'cleo'& might have a &_.forward_& file containing this:
21417 .code
21418 cleo, cleopatra@egypt.example
21419 .endd
21420 .cindex "backslash in alias file"
21421 .cindex "alias file" "backslash in"
21422 For compatibility with other MTAs, such unqualified local parts may be
21423 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21424 it does make a difference if more than one domain is being handled
21425 synonymously.
21426
21427 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21428 2822 address that does not include a domain, the item is qualified using the
21429 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21430 addresses are qualified using the value in &%qualify_recipient%&, but you can
21431 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21432
21433 Care must be taken if there are alias names for local users.
21434 Consider an MTA handling a single local domain where the system alias file
21435 contains:
21436 .code
21437 Sam.Reman: spqr
21438 .endd
21439 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21440 messages in the local mailbox, and also forward copies elsewhere. He creates
21441 this forward file:
21442 .code
21443 Sam.Reman, spqr@reme.elsewhere.example
21444 .endd
21445 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21446 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21447 second time round, because it has previously routed it,
21448 and the following routers presumably cannot handle the alias. The forward file
21449 should really contain
21450 .code
21451 spqr, spqr@reme.elsewhere.example
21452 .endd
21453 but because this is such a common error, the &%check_ancestor%& option (see
21454 below) exists to provide a way to get round it. This is normally set on a
21455 &(redirect)& router that is handling users' &_.forward_& files.
21456
21457
21458
21459 .section "Special items in redirection lists" "SECTspecitredli"
21460 In addition to addresses, the following types of item may appear in redirection
21461 lists (that is, in non-filter redirection data):
21462
21463 .ilist
21464 .cindex "pipe" "in redirection list"
21465 .cindex "address redirection" "to pipe"
21466 An item is treated as a pipe command if it begins with &"|"& and does not parse
21467 as a valid RFC 2822 address that includes a domain. A transport for running the
21468 command must be specified by the &%pipe_transport%& option.
21469 Normally, either the router or the transport specifies a user and a group under
21470 which to run the delivery. The default is to use the Exim user and group.
21471
21472 Single or double quotes can be used for enclosing the individual arguments of
21473 the pipe command; no interpretation of escapes is done for single quotes. If
21474 the command contains a comma character, it is necessary to put the whole item
21475 in double quotes, for example:
21476 .code
21477 "|/some/command ready,steady,go"
21478 .endd
21479 since items in redirection lists are terminated by commas. Do not, however,
21480 quote just the command. An item such as
21481 .code
21482 |"/some/command ready,steady,go"
21483 .endd
21484 is interpreted as a pipe with a rather strange command name, and no arguments.
21485
21486 Note that the above example assumes that the text comes from a lookup source
21487 of some sort, so that the quotes are part of the data.  If composing a
21488 redirect router with a &%data%& option directly specifying this command, the
21489 quotes will be used by the configuration parser to define the extent of one
21490 string, but will not be passed down into the redirect router itself.  There
21491 are two main approaches to get around this: escape quotes to be part of the
21492 data itself, or avoid using this mechanism and instead create a custom
21493 transport with the &%command%& option set and reference that transport from
21494 an &%accept%& router.
21495
21496 .next
21497 .cindex "file" "in redirection list"
21498 .cindex "address redirection" "to file"
21499 An item is interpreted as a path name if it begins with &"/"& and does not
21500 parse as a valid RFC 2822 address that includes a domain. For example,
21501 .code
21502 /home/world/minbari
21503 .endd
21504 is treated as a filename, but
21505 .code
21506 /s=molari/o=babylon/@x400gate.way
21507 .endd
21508 is treated as an address. For a filename, a transport must be specified using
21509 the &%file_transport%& option. However, if the generated path name ends with a
21510 forward slash character, it is interpreted as a directory name rather than a
21511 filename, and &%directory_transport%& is used instead.
21512
21513 Normally, either the router or the transport specifies a user and a group under
21514 which to run the delivery. The default is to use the Exim user and group.
21515
21516 .cindex "&_/dev/null_&"
21517 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21518 bypassed at a high level, and the log entry shows &"**bypassed**"&
21519 instead of a transport name. In this case the user and group are not used.
21520
21521 .next
21522 .cindex "included address list"
21523 .cindex "address redirection" "included external list"
21524 If an item is of the form
21525 .code
21526 :include:<path name>
21527 .endd
21528 a list of further items is taken from the given file and included at that
21529 point. &*Note*&: Such a file can not be a filter file; it is just an
21530 out-of-line addition to the list. The items in the included list are separated
21531 by commas or newlines and are not subject to expansion. If this is the first
21532 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21533 the alias name. This example is incorrect:
21534 .code
21535 list1    :include:/opt/lists/list1
21536 .endd
21537 It must be given as
21538 .code
21539 list1:   :include:/opt/lists/list1
21540 .endd
21541 .cindex "tainted data" "in filenames"
21542 .cindex redirect "tainted data"
21543 Tainted data may not be used for a filename.
21544 .next
21545 .cindex "address redirection" "to black hole"
21546 .cindex "delivery" "discard"
21547 .cindex "delivery" "blackhole"
21548 .cindex "black hole"
21549 .cindex "abandoning mail"
21550 Sometimes you want to throw away mail to a particular local part.  Making the
21551 &%data%& option expand to an empty string does not work, because that causes
21552 the router to decline. Instead, the alias item
21553 .code
21554 :blackhole:
21555 .endd
21556 can be used. It does what its name implies. No delivery is
21557 done, and no error message is generated. This has the same effect as specifying
21558 &_/dev/null_& as a destination, but it can be independently disabled.
21559
21560 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21561 delivery is done for the original local part, even if other redirection items
21562 are present. If you are generating a multi-item list (for example, by reading a
21563 database) and need the ability to provide a no-op item, you must use
21564 &_/dev/null_&.
21565
21566 .next
21567 .cindex "delivery" "forcing failure"
21568 .cindex "delivery" "forcing deferral"
21569 .cindex "failing delivery" "forcing"
21570 .cindex "deferred delivery, forcing"
21571 .cindex "customizing" "failure message"
21572 An attempt to deliver a particular address can be deferred or forced to fail by
21573 redirection items of the form
21574 .code
21575 :defer:
21576 :fail:
21577 .endd
21578 respectively. When a redirection list contains such an item, it applies
21579 to the entire redirection; any other items in the list are ignored. Any
21580 text following &':fail:'& or &':defer:'& is placed in the error text
21581 associated with the failure. For example, an alias file might contain:
21582 .code
21583 X.Employee:  :fail: Gone away, no forwarding address
21584 .endd
21585 In the case of an address that is being verified from an ACL or as the subject
21586 of a
21587 .cindex "VRFY" "error text, display of"
21588 VRFY command, the text is included in the SMTP error response by
21589 default.
21590 .cindex "EXPN" "error text, display of"
21591 The text is not included in the response to an EXPN command. In non-SMTP cases
21592 the text is included in the error message that Exim generates.
21593
21594 .cindex "SMTP" "error codes"
21595 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21596 &':fail:'&. However, if the message starts with three digits followed by a
21597 space, optionally followed by an extended code of the form &'n.n.n'&, also
21598 followed by a space, and the very first digit is the same as the default error
21599 code, the code from the message is used instead. If the very first digit is
21600 incorrect, a panic error is logged, and the default code is used. You can
21601 suppress the use of the supplied code in a redirect router by setting the
21602 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21603 ignored.
21604
21605 .vindex "&$acl_verify_message$&"
21606 In an ACL, an explicitly provided message overrides the default, but the
21607 default message is available in the variable &$acl_verify_message$& and can
21608 therefore be included in a custom message if this is desired.
21609
21610 Normally the error text is the rest of the redirection list &-- a comma does
21611 not terminate it &-- but a newline does act as a terminator. Newlines are not
21612 normally present in alias expansions. In &(lsearch)& lookups they are removed
21613 as part of the continuation process, but they may exist in other kinds of
21614 lookup and in &':include:'& files.
21615
21616 During routing for message delivery (as opposed to verification), a redirection
21617 containing &':fail:'& causes an immediate failure of the incoming address,
21618 whereas &':defer:'& causes the message to remain in the queue so that a
21619 subsequent delivery attempt can happen at a later time. If an address is
21620 deferred for too long, it will ultimately fail, because the normal retry
21621 rules still apply.
21622
21623 .next
21624 .cindex "alias file" "exception to default"
21625 Sometimes it is useful to use a single-key search type with a default (see
21626 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21627 for exceptions to the default. These can be handled by aliasing them to
21628 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21629 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21630 results in an empty redirection list has the same effect.
21631 .endlist
21632
21633
21634 .section "Duplicate addresses" "SECTdupaddr"
21635 .cindex "duplicate addresses"
21636 .cindex "address duplicate, discarding"
21637 .cindex "pipe" "duplicated"
21638 Exim removes duplicate addresses from the list to which it is delivering, so as
21639 to deliver just one copy to each address. This does not apply to deliveries
21640 routed to pipes by different immediate parent addresses, but an indirect
21641 aliasing scheme of the type
21642 .code
21643 pipe:       |/some/command $local_part
21644 localpart1: pipe
21645 localpart2: pipe
21646 .endd
21647 does not work with a message that is addressed to both local parts, because
21648 when the second is aliased to the intermediate local part &"pipe"& it gets
21649 discarded as being the same as a previously handled address. However, a scheme
21650 such as
21651 .code
21652 localpart1: |/some/command $local_part
21653 localpart2: |/some/command $local_part
21654 .endd
21655 does result in two different pipe deliveries, because the immediate parents of
21656 the pipes are distinct.
21657
21658
21659
21660 .section "Repeated redirection expansion" "SECID128"
21661 .cindex "repeated redirection expansion"
21662 .cindex "address redirection" "repeated for each delivery attempt"
21663 When a message cannot be delivered to all of its recipients immediately,
21664 leading to two or more delivery attempts, redirection expansion is carried out
21665 afresh each time for those addresses whose children were not all previously
21666 delivered. If redirection is being used as a mailing list, this can lead to new
21667 members of the list receiving copies of old messages. The &%one_time%& option
21668 can be used to avoid this.
21669
21670
21671 .section "Errors in redirection lists" "SECID129"
21672 .cindex "address redirection" "errors"
21673 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21674 error is skipped, and an entry is written to the main log. This may be useful
21675 for mailing lists that are automatically managed. Otherwise, if an error is
21676 detected while generating the list of new addresses, the original address is
21677 deferred. See also &%syntax_errors_to%&.
21678
21679
21680
21681 .section "Private options for the redirect router" "SECID130"
21682
21683 .cindex "options" "&(redirect)& router"
21684 The private options for the &(redirect)& router are as follows:
21685
21686
21687 .option allow_defer redirect boolean false
21688 Setting this option allows the use of &':defer:'& in non-filter redirection
21689 data, or the &%defer%& command in an Exim filter file.
21690
21691
21692 .option allow_fail redirect boolean false
21693 .cindex "failing delivery" "from filter"
21694 If this option is true, the &':fail:'& item can be used in a redirection list,
21695 and the &%fail%& command may be used in an Exim filter file.
21696
21697
21698 .option allow_filter redirect boolean false
21699 .cindex "filter" "enabling use of"
21700 .cindex "Sieve filter" "enabling use of"
21701 Setting this option allows Exim to interpret redirection data that starts with
21702 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21703 are some features of Exim filter files that some administrators may wish to
21704 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21705
21706 It is also possible to lock out Exim filters or Sieve filters while allowing
21707 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21708
21709
21710 The filter is run using the uid and gid set by the generic &%user%& and
21711 &%group%& options. These take their defaults from the password data if
21712 &%check_local_user%& is set, so in the normal case of users' personal filter
21713 files, the filter is run as the relevant user. When &%allow_filter%& is set
21714 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21715
21716
21717
21718 .option allow_freeze redirect boolean false
21719 .cindex "freezing messages" "allowing in filter"
21720 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21721 This command is more normally encountered in system filters, and is disabled by
21722 default for redirection filters because it isn't something you usually want to
21723 let ordinary users do.
21724
21725
21726
21727 .option check_ancestor redirect boolean false
21728 This option is concerned with handling generated addresses that are the same
21729 as some address in the list of redirection ancestors of the current address.
21730 Although it is turned off by default in the code, it is set in the default
21731 configuration file for handling users' &_.forward_& files. It is recommended
21732 for this use of the &(redirect)& router.
21733
21734 When &%check_ancestor%& is set, if a generated address (including the domain)
21735 is the same as any ancestor of the current address, it is replaced by a copy of
21736 the current address. This helps in the case where local part A is aliased to B,
21737 and B has a &_.forward_& file pointing back to A. For example, within a single
21738 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21739 &_&~jb/.forward_& contains:
21740 .code
21741 \Joe.Bloggs, <other item(s)>
21742 .endd
21743 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21744 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21745 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21746 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21747 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21748 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21749 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21750 original address. See also the &%repeat_use%& option below.
21751
21752
21753 .option check_group redirect boolean "see below"
21754 When the &%file%& option is used, the group owner of the file is checked only
21755 when this option is set. The permitted groups are those listed in the
21756 &%owngroups%& option, together with the user's default group if
21757 &%check_local_user%& is set. If the file has the wrong group, routing is
21758 deferred. The default setting for this option is true if &%check_local_user%&
21759 is set and the &%modemask%& option permits the group write bit, or if the
21760 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21761
21762
21763
21764 .option check_owner redirect boolean "see below"
21765 When the &%file%& option is used, the owner of the file is checked only when
21766 this option is set. If &%check_local_user%& is set, the local user is
21767 permitted; otherwise the owner must be one of those listed in the &%owners%&
21768 option. The default value for this option is true if &%check_local_user%& or
21769 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21770
21771
21772 .option data redirect string&!! unset
21773 This option is mutually exclusive with &%file%&. One or other of them must be
21774 set, but not both. The contents of &%data%& are expanded, and then used as the
21775 list of forwarding items, or as a set of filtering instructions. If the
21776 expansion is forced to fail, or the result is an empty string or a string that
21777 has no effect (consists entirely of comments), the router declines.
21778
21779 When filtering instructions are used, the string must begin with &"#Exim
21780 filter"&, and all comments in the string, including this initial one, must be
21781 terminated with newline characters. For example:
21782 .code
21783 data = #Exim filter\n\
21784        if $h_to: contains Exim then save $home/mail/exim endif
21785 .endd
21786 If you are reading the data from a database where newlines cannot be included,
21787 you can use the &${sg}$& expansion item to turn the escape string of your
21788 choice into a newline.
21789
21790
21791 .option directory_transport redirect string&!! unset
21792 A &(redirect)& router sets up a direct delivery to a directory when a path name
21793 ending with a slash is specified as a new &"address"&. The transport used is
21794 specified by this option, which, after expansion, must be the name of a
21795 configured transport. This should normally be an &(appendfile)& transport.
21796
21797
21798 .option file redirect string&!! unset
21799 This option specifies the name of a file that contains the redirection data. It
21800 is mutually exclusive with the &%data%& option. The string is expanded before
21801 use; if the expansion is forced to fail, the router declines. Other expansion
21802 failures cause delivery to be deferred. The result of a successful expansion
21803 must be an absolute path. The entire file is read and used as the redirection
21804 data. If the data is an empty string or a string that has no effect (consists
21805 entirely of comments), the router declines.
21806
21807 .cindex "NFS" "checking for file existence"
21808 If the attempt to open the file fails with a &"does not exist"& error, Exim
21809 runs a check on the containing directory,
21810 unless &%ignore_enotdir%& is true (see below).
21811 If the directory does not appear to exist, delivery is deferred. This can
21812 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21813 is a mount problem. If the containing directory does exist, but the file does
21814 not, the router declines.
21815
21816
21817 .option file_transport redirect string&!! unset
21818 .vindex "&$address_file$&"
21819 A &(redirect)& router sets up a direct delivery to a file when a path name not
21820 ending in a slash is specified as a new &"address"&. The transport used is
21821 specified by this option, which, after expansion, must be the name of a
21822 configured transport. This should normally be an &(appendfile)& transport. When
21823 it is running, the filename is in &$address_file$&.
21824
21825
21826 .option filter_prepend_home redirect boolean true
21827 When this option is true, if a &(save)& command in an Exim filter specifies a
21828 relative path, and &$home$& is defined, it is automatically prepended to the
21829 relative path. If this option is set false, this action does not happen. The
21830 relative path is then passed to the transport unmodified.
21831
21832
21833 .option forbid_blackhole redirect boolean false
21834 .cindex "restricting access to features"
21835 .cindex "filter" "locking out certain features"
21836 If this option is true, the &':blackhole:'& item may not appear in a
21837 redirection list.
21838
21839
21840 .option forbid_exim_filter redirect boolean false
21841 .cindex "restricting access to features"
21842 .cindex "filter" "locking out certain features"
21843 If this option is set true, only Sieve filters are permitted when
21844 &%allow_filter%& is true.
21845
21846
21847
21848
21849 .option forbid_file redirect boolean false
21850 .cindex "restricting access to features"
21851 .cindex "delivery" "to file; forbidding"
21852 .cindex "filter" "locking out certain features"
21853 .cindex "Sieve filter" "forbidding delivery to a file"
21854 .cindex "Sieve filter" "&""keep""& facility; disabling"
21855 If this option is true, this router may not generate a new address that
21856 specifies delivery to a local file or directory, either from a filter or from a
21857 conventional forward file. This option is forced to be true if &%one_time%& is
21858 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21859 locks out the Sieve's &"keep"& facility.
21860
21861
21862 .option forbid_filter_dlfunc redirect boolean false
21863 .cindex "restricting access to features"
21864 .cindex "filter" "locking out certain features"
21865 If this option is true, string expansions in Exim filters are not allowed to
21866 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21867 functions.
21868
21869 .option forbid_filter_existstest redirect boolean false
21870 .cindex "restricting access to features"
21871 .cindex "filter" "locking out certain features"
21872 .cindex "expansion" "statting a file"
21873 If this option is true, string expansions in Exim filters are not allowed to
21874 make use of the &%exists%& condition or the &%stat%& expansion item.
21875
21876 .option forbid_filter_logwrite redirect boolean false
21877 .cindex "restricting access to features"
21878 .cindex "filter" "locking out certain features"
21879 If this option is true, use of the logging facility in Exim filters is not
21880 permitted. Logging is in any case available only if the filter is being run
21881 under some unprivileged uid (which is normally the case for ordinary users'
21882 &_.forward_& files).
21883
21884
21885 .option forbid_filter_lookup redirect boolean false
21886 .cindex "restricting access to features"
21887 .cindex "filter" "locking out certain features"
21888 If this option is true, string expansions in Exim filter files are not allowed
21889 to make use of &%lookup%& items.
21890
21891
21892 .option forbid_filter_perl redirect boolean false
21893 .cindex "restricting access to features"
21894 .cindex "filter" "locking out certain features"
21895 This option has an effect only if Exim is built with embedded Perl support. If
21896 it is true, string expansions in Exim filter files are not allowed to make use
21897 of the embedded Perl support.
21898
21899
21900 .option forbid_filter_readfile redirect boolean false
21901 .cindex "restricting access to features"
21902 .cindex "filter" "locking out certain features"
21903 If this option is true, string expansions in Exim filter files are not allowed
21904 to make use of &%readfile%& items.
21905
21906
21907 .option forbid_filter_readsocket redirect boolean false
21908 .cindex "restricting access to features"
21909 .cindex "filter" "locking out certain features"
21910 If this option is true, string expansions in Exim filter files are not allowed
21911 to make use of &%readsocket%& items.
21912
21913
21914 .option forbid_filter_reply redirect boolean false
21915 .cindex "restricting access to features"
21916 .cindex "filter" "locking out certain features"
21917 If this option is true, this router may not generate an automatic reply
21918 message. Automatic replies can be generated only from Exim or Sieve filter
21919 files, not from traditional forward files. This option is forced to be true if
21920 &%one_time%& is set.
21921
21922
21923 .option forbid_filter_run redirect boolean false
21924 .cindex "restricting access to features"
21925 .cindex "filter" "locking out certain features"
21926 If this option is true, string expansions in Exim filter files are not allowed
21927 to make use of &%run%& items.
21928
21929
21930 .option forbid_include redirect boolean false
21931 .cindex "restricting access to features"
21932 .cindex "filter" "locking out certain features"
21933 If this option is true, items of the form
21934 .code
21935 :include:<path name>
21936 .endd
21937 are not permitted in non-filter redirection lists.
21938
21939
21940 .option forbid_pipe redirect boolean false
21941 .cindex "restricting access to features"
21942 .cindex "filter" "locking out certain features"
21943 .cindex "delivery" "to pipe; forbidding"
21944 If this option is true, this router may not generate a new address which
21945 specifies delivery to a pipe, either from an Exim filter or from a conventional
21946 forward file. This option is forced to be true if &%one_time%& is set.
21947
21948
21949 .option forbid_sieve_filter redirect boolean false
21950 .cindex "restricting access to features"
21951 .cindex "filter" "locking out certain features"
21952 If this option is set true, only Exim filters are permitted when
21953 &%allow_filter%& is true.
21954
21955
21956 .cindex "SMTP" "error codes"
21957 .option forbid_smtp_code redirect boolean false
21958 If this option is set true, any SMTP error codes that are present at the start
21959 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21960 the default codes (451 and 550, respectively) are always used.
21961
21962
21963
21964
21965 .option hide_child_in_errmsg redirect boolean false
21966 .cindex "bounce message" "redirection details; suppressing"
21967 If this option is true, it prevents Exim from quoting a child address if it
21968 generates a bounce or delay message for it. Instead it says &"an address
21969 generated from <&'the top level address'&>"&. Of course, this applies only to
21970 bounces generated locally. If a message is forwarded to another host, &'its'&
21971 bounce may well quote the generated address.
21972
21973
21974 .option ignore_eacces redirect boolean false
21975 .cindex "EACCES"
21976 If this option is set and an attempt to open a redirection file yields the
21977 EACCES error (permission denied), the &(redirect)& router behaves as if the
21978 file did not exist.
21979
21980
21981 .option ignore_enotdir redirect boolean false
21982 .cindex "ENOTDIR"
21983 If this option is set and an attempt to open a redirection file yields the
21984 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21985 router behaves as if the file did not exist.
21986
21987 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21988 router that has the &%file%& option set discovers that the file does not exist
21989 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21990 against unmounted NFS directories. If the parent can not be statted, delivery
21991 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21992 is set, because that option tells Exim to ignore &"something on the path is not
21993 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21994 that some operating systems give ENOENT where others give ENOTDIR.
21995
21996
21997
21998 .option include_directory redirect string unset
21999 If this option is set, the path names of any &':include:'& items in a
22000 redirection list must start with this directory.
22001
22002
22003 .option modemask redirect "octal integer" 022
22004 This specifies mode bits which must not be set for a file specified by the
22005 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22006
22007
22008 .option one_time redirect boolean false
22009 .cindex "one-time aliasing/forwarding expansion"
22010 .cindex "alias file" "one-time expansion"
22011 .cindex "forward file" "one-time expansion"
22012 .cindex "mailing lists" "one-time expansion"
22013 .cindex "address redirection" "one-time expansion"
22014 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22015 files each time it tries to deliver a message causes a problem when one or more
22016 of the generated addresses fails be delivered at the first attempt. The problem
22017 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22018 but of what happens when the redirection list changes during the time that the
22019 message is on Exim's queue. This is particularly true in the case of mailing
22020 lists, where new subscribers might receive copies of messages that were posted
22021 before they subscribed.
22022
22023 If &%one_time%& is set and any addresses generated by the router fail to
22024 deliver at the first attempt, the failing addresses are added to the message as
22025 &"top level"& addresses, and the parent address that generated them is marked
22026 &"delivered"&. Thus, redirection does not happen again at the next delivery
22027 attempt.
22028
22029 &*Warning 1*&: Any header line addition or removal that is specified by this
22030 router would be lost if delivery did not succeed at the first attempt. For this
22031 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22032 permitted when &%one_time%& is set.
22033
22034 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22035 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22036 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22037
22038 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22039 &%one_time%&.
22040
22041 The original top-level address is remembered with each of the generated
22042 addresses, and is output in any log messages. However, any intermediate parent
22043 addresses are not recorded. This makes a difference to the log only if
22044 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22045 typically be used for mailing lists, where there is normally just one level of
22046 expansion.
22047
22048
22049 .option owners redirect "string list" unset
22050 .cindex "ownership" "alias file"
22051 .cindex "ownership" "forward file"
22052 .cindex "alias file" "ownership"
22053 .cindex "forward file" "ownership"
22054 This specifies a list of permitted owners for the file specified by &%file%&.
22055 This list is in addition to the local user when &%check_local_user%& is set.
22056 See &%check_owner%& above.
22057
22058
22059 .option owngroups redirect "string list" unset
22060 This specifies a list of permitted groups for the file specified by &%file%&.
22061 The list is in addition to the local user's primary group when
22062 &%check_local_user%& is set. See &%check_group%& above.
22063
22064
22065 .option pipe_transport redirect string&!! unset
22066 .vindex "&$address_pipe$&"
22067 A &(redirect)& router sets up a direct delivery to a pipe when a string
22068 starting with a vertical bar character is specified as a new &"address"&. The
22069 transport used is specified by this option, which, after expansion, must be the
22070 name of a configured transport. This should normally be a &(pipe)& transport.
22071 When the transport is run, the pipe command is in &$address_pipe$&.
22072
22073
22074 .option qualify_domain redirect string&!! unset
22075 .vindex "&$qualify_recipient$&"
22076 If this option is set, and an unqualified address (one without a domain) is
22077 generated, and that address would normally be qualified by the global setting
22078 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22079 expanding this string. If the expansion fails, the router declines. If you want
22080 to revert to the default, you can have the expansion generate
22081 &$qualify_recipient$&.
22082
22083 This option applies to all unqualified addresses generated by Exim filters,
22084 but for traditional &_.forward_& files, it applies only to addresses that are
22085 not preceded by a backslash. Sieve filters cannot generate unqualified
22086 addresses.
22087
22088 .option qualify_preserve_domain redirect boolean false
22089 .cindex "domain" "in redirection; preserving"
22090 .cindex "preserving domain in redirection"
22091 .cindex "address redirection" "domain; preserving"
22092 If this option is set, the router's local &%qualify_domain%& option must not be
22093 set (a configuration error occurs if it is). If an unqualified address (one
22094 without a domain) is generated, it is qualified with the domain of the parent
22095 address (the immediately preceding ancestor) instead of the global
22096 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22097 this applies whether or not the address is preceded by a backslash.
22098
22099
22100 .option repeat_use redirect boolean true
22101 If this option is set false, the router is skipped for a child address that has
22102 any ancestor that was routed by this router. This test happens before any of
22103 the other preconditions are tested. Exim's default anti-looping rules skip
22104 only when the ancestor is the same as the current address. See also
22105 &%check_ancestor%& above and the generic &%redirect_router%& option.
22106
22107
22108 .option reply_transport redirect string&!! unset
22109 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22110 &%vacation%& command is used in a filter file. The transport used is specified
22111 by this option, which, after expansion, must be the name of a configured
22112 transport. This should normally be an &(autoreply)& transport. Other transports
22113 are unlikely to do anything sensible or useful.
22114
22115
22116 .option rewrite redirect boolean true
22117 .cindex "address redirection" "disabling rewriting"
22118 If this option is set false, addresses generated by the router are not
22119 subject to address rewriting. Otherwise, they are treated like new addresses
22120 and are rewritten according to the global rewriting rules.
22121
22122
22123 .option sieve_subaddress redirect string&!! unset
22124 The value of this option is passed to a Sieve filter to specify the
22125 :subaddress part of an address.
22126
22127 .option sieve_useraddress redirect string&!! unset
22128 The value of this option is passed to a Sieve filter to specify the :user part
22129 of an address. However, if it is unset, the entire original local part
22130 (including any prefix or suffix) is used for :user.
22131
22132
22133 .option sieve_vacation_directory redirect string&!! unset
22134 .cindex "Sieve filter" "vacation directory"
22135 To enable the &"vacation"& extension for Sieve filters, you must set
22136 &%sieve_vacation_directory%& to the directory where vacation databases are held
22137 (do not put anything else in that directory), and ensure that the
22138 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22139 needs their own directory; Exim will create it if necessary.
22140
22141
22142
22143 .option skip_syntax_errors redirect boolean false
22144 .cindex "forward file" "broken"
22145 .cindex "address redirection" "broken files"
22146 .cindex "alias file" "broken"
22147 .cindex "broken alias or forward files"
22148 .cindex "ignoring faulty addresses"
22149 .cindex "skipping faulty addresses"
22150 .cindex "error" "skipping bad syntax"
22151 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22152 non-filter redirection data are skipped, and each failing address is logged. If
22153 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22154 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22155 are expanded and placed at the head of the error message generated by
22156 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22157 be the same address as the generic &%errors_to%& option. The
22158 &%skip_syntax_errors%& option is often used when handling mailing lists.
22159
22160 If all the addresses in a redirection list are skipped because of syntax
22161 errors, the router declines to handle the original address, and it is passed to
22162 the following routers.
22163
22164 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22165 error in the filter causes filtering to be abandoned without any action being
22166 taken. The incident is logged, and the router declines to handle the address,
22167 so it is passed to the following routers.
22168
22169 .cindex "Sieve filter" "syntax errors in"
22170 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22171 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22172 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22173
22174 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22175 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22176 option, used with an address that does not get redirected, can be used to
22177 notify users of these errors, by means of a router like this:
22178 .code
22179 userforward:
22180   driver = redirect
22181   allow_filter
22182   check_local_user
22183   file = $home/.forward
22184   file_transport = address_file
22185   pipe_transport = address_pipe
22186   reply_transport = address_reply
22187   no_verify
22188   skip_syntax_errors
22189   syntax_errors_to = real-$local_part@$domain
22190   syntax_errors_text = \
22191    This is an automatically generated message. An error has\n\
22192    been found in your .forward file. Details of the error are\n\
22193    reported below. While this error persists, you will receive\n\
22194    a copy of this message for every message that is addressed\n\
22195    to you. If your .forward file is a filter file, or if it is\n\
22196    a non-filter file containing no valid forwarding addresses,\n\
22197    a copy of each incoming message will be put in your normal\n\
22198    mailbox. If a non-filter file contains at least one valid\n\
22199    forwarding address, forwarding to the valid addresses will\n\
22200    happen, and those will be the only deliveries that occur.
22201 .endd
22202 You also need a router to ensure that local addresses that are prefixed by
22203 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22204 put this immediately before the &(userforward)& router:
22205 .code
22206 real_localuser:
22207   driver = accept
22208   check_local_user
22209   local_part_prefix = real-
22210   transport = local_delivery
22211 .endd
22212 For security, it would probably be a good idea to restrict the use of this
22213 router to locally-generated messages, using a condition such as this:
22214 .code
22215   condition = ${if match {$sender_host_address}\
22216                          {\N^(|127\.0\.0\.1)$\N}}
22217 .endd
22218
22219
22220 .option syntax_errors_text redirect string&!! unset
22221 See &%skip_syntax_errors%& above.
22222
22223
22224 .option syntax_errors_to redirect string unset
22225 See &%skip_syntax_errors%& above.
22226 .ecindex IIDredrou1
22227 .ecindex IIDredrou2
22228
22229
22230
22231
22232
22233
22234 . ////////////////////////////////////////////////////////////////////////////
22235 . ////////////////////////////////////////////////////////////////////////////
22236
22237 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22238          "Environment for local transports"
22239 .scindex IIDenvlotra1 "local transports" "environment for"
22240 .scindex IIDenvlotra2 "environment" "local transports"
22241 .scindex IIDenvlotra3 "transport" "local; environment for"
22242 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22243 transport can be thought of as similar to a pipe.) Exim always runs transports
22244 in subprocesses, under specified uids and gids. Typical deliveries to local
22245 mailboxes run under the uid and gid of the local user.
22246
22247 Exim also sets a specific current directory while running the transport; for
22248 some transports a home directory setting is also relevant. The &(pipe)&
22249 transport is the only one that sets up environment variables; see section
22250 &<<SECTpipeenv>>& for details.
22251
22252 The values used for the uid, gid, and the directories may come from several
22253 different places. In many cases, the router that handles the address associates
22254 settings with that address as a result of its &%check_local_user%&, &%group%&,
22255 or &%user%& options. However, values may also be given in the transport's own
22256 configuration, and these override anything that comes from the router.
22257
22258
22259
22260 .section "Concurrent deliveries" "SECID131"
22261 .cindex "concurrent deliveries"
22262 .cindex "simultaneous deliveries"
22263 If two different messages for the same local recipient arrive more or less
22264 simultaneously, the two delivery processes are likely to run concurrently. When
22265 the &(appendfile)& transport is used to write to a file, Exim applies locking
22266 rules to stop concurrent processes from writing to the same file at the same
22267 time.
22268
22269 However, when you use a &(pipe)& transport, it is up to you to arrange any
22270 locking that is needed. Here is a silly example:
22271 .code
22272 my_transport:
22273   driver = pipe
22274   command = /bin/sh -c 'cat >>/some/file'
22275 .endd
22276 This is supposed to write the message at the end of the file. However, if two
22277 messages arrive at the same time, the file will be scrambled. You can use the
22278 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22279 file using the same algorithm that Exim itself uses.
22280
22281
22282
22283
22284 .section "Uids and gids" "SECTenvuidgid"
22285 .cindex "local transports" "uid and gid"
22286 .cindex "transport" "local; uid and gid"
22287 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22288 overrides any group that the router set in the address, even if &%user%& is not
22289 set for the transport. This makes it possible, for example, to run local mail
22290 delivery under the uid of the recipient (set by the router), but in a special
22291 group (set by the transport). For example:
22292 .code
22293 # Routers ...
22294 # User/group are set by check_local_user in this router
22295 local_users:
22296   driver = accept
22297   check_local_user
22298   transport = group_delivery
22299
22300 # Transports ...
22301 # This transport overrides the group
22302 group_delivery:
22303   driver = appendfile
22304   file = /var/spool/mail/$local_part_data
22305   group = mail
22306 .endd
22307 If &%user%& is set for a transport, its value overrides what is set in the
22308 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22309 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22310 set.
22311
22312 .oindex "&%initgroups%&"
22313 When the uid is taken from the transport's configuration, the &[initgroups()]&
22314 function is called for the groups associated with that uid if the
22315 &%initgroups%& option is set for the transport. When the uid is not specified
22316 by the transport, but is associated with the address by a router, the option
22317 for calling &[initgroups()]& is taken from the router configuration.
22318
22319 .cindex "&(pipe)& transport" "uid for"
22320 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22321 is set and &%user%& is not set, the uid of the process that called Exim to
22322 receive the message is used, and if &%group%& is not set, the corresponding
22323 original gid is also used.
22324
22325 This is the detailed preference order for obtaining a gid; the first of the
22326 following that is set is used:
22327
22328 .ilist
22329 A &%group%& setting of the transport;
22330 .next
22331 A &%group%& setting of the router;
22332 .next
22333 A gid associated with a user setting of the router, either as a result of
22334 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22335 .next
22336 The group associated with a non-numeric &%user%& setting of the transport;
22337 .next
22338 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22339 the uid is the creator's uid;
22340 .next
22341 The Exim gid if the Exim uid is being used as a default.
22342 .endlist
22343
22344 If, for example, the user is specified numerically on the router and there are
22345 no group settings, no gid is available. In this situation, an error occurs.
22346 This is different for the uid, for which there always is an ultimate default.
22347 The first of the following that is set is used:
22348
22349 .ilist
22350 A &%user%& setting of the transport;
22351 .next
22352 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22353 .next
22354 A &%user%& setting of the router;
22355 .next
22356 A &%check_local_user%& setting of the router;
22357 .next
22358 The Exim uid.
22359 .endlist
22360
22361 Of course, an error will still occur if the uid that is chosen is on the
22362 &%never_users%& list.
22363
22364
22365
22366
22367
22368 .section "Current and home directories" "SECID132"
22369 .cindex "current directory for local transport"
22370 .cindex "home directory" "for local transport"
22371 .cindex "transport" "local; home directory for"
22372 .cindex "transport" "local; current directory for"
22373 Routers may set current and home directories for local transports by means of
22374 the &%transport_current_directory%& and &%transport_home_directory%& options.
22375 However, if the transport's &%current_directory%& or &%home_directory%& options
22376 are set, they override the router's values. In detail, the home directory
22377 for a local transport is taken from the first of these values that is set:
22378
22379 .ilist
22380 The &%home_directory%& option on the transport;
22381 .next
22382 The &%transport_home_directory%& option on the router;
22383 .next
22384 The password data if &%check_local_user%& is set on the router;
22385 .next
22386 The &%router_home_directory%& option on the router.
22387 .endlist
22388
22389 The current directory is taken from the first of these values that is set:
22390
22391 .ilist
22392 The &%current_directory%& option on the transport;
22393 .next
22394 The &%transport_current_directory%& option on the router.
22395 .endlist
22396
22397
22398 If neither the router nor the transport sets a current directory, Exim uses the
22399 value of the home directory, if it is set. Otherwise it sets the current
22400 directory to &_/_& before running a local transport.
22401
22402
22403
22404 .section "Expansion variables derived from the address" "SECID133"
22405 .vindex "&$domain$&"
22406 .vindex "&$local_part$&"
22407 .vindex "&$original_domain$&"
22408 Normally a local delivery is handling a single address, and in that case the
22409 variables such as &$domain$& and &$local_part$& are set during local
22410 deliveries. However, in some circumstances more than one address may be handled
22411 at once (for example, while writing batch SMTP for onward transmission by some
22412 other means). In this case, the variables associated with the local part are
22413 never set, &$domain$& is set only if all the addresses have the same domain,
22414 and &$original_domain$& is never set.
22415 .ecindex IIDenvlotra1
22416 .ecindex IIDenvlotra2
22417 .ecindex IIDenvlotra3
22418
22419
22420
22421
22422
22423
22424
22425 . ////////////////////////////////////////////////////////////////////////////
22426 . ////////////////////////////////////////////////////////////////////////////
22427
22428 .chapter "Generic options for transports" "CHAPtransportgeneric"
22429 .scindex IIDgenoptra1 "generic options" "transport"
22430 .scindex IIDgenoptra2 "options" "generic; for transports"
22431 .scindex IIDgenoptra3 "transport" "generic options for"
22432 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22433 prior to Exim 4.95 names would be silently truncated at this length, but now
22434 it is enforced.
22435
22436 The following generic options apply to all transports:
22437
22438
22439 .option body_only transports boolean false
22440 .cindex "transport" "body only"
22441 .cindex "message" "transporting body only"
22442 .cindex "body of message" "transporting"
22443 If this option is set, the message's headers are not transported. It is
22444 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22445 or &(pipe)& transports, the settings of &%message_prefix%& and
22446 &%message_suffix%& should be checked, because this option does not
22447 automatically suppress them.
22448
22449
22450 .option current_directory transports string&!! unset
22451 .cindex "transport" "current directory for"
22452 This specifies the current directory that is to be set while running the
22453 transport, overriding any value that may have been set by the router.
22454 If the expansion fails for any reason, including forced failure, an error is
22455 logged, and delivery is deferred.
22456
22457
22458 .option disable_logging transports boolean false
22459 If this option is set true, nothing is logged for any
22460 deliveries by the transport or for any
22461 transport errors. You should not set this option unless you really, really know
22462 what you are doing.
22463
22464
22465 .option debug_print transports string&!! unset
22466 .cindex "testing" "variables in drivers"
22467 If this option is set and debugging is enabled (see the &%-d%& command line
22468 option), the string is expanded and included in the debugging output when the
22469 transport is run.
22470 If expansion of the string fails, the error message is written to the debugging
22471 output, and Exim carries on processing.
22472 This facility is provided to help with checking out the values of variables and
22473 so on when debugging driver configurations. For example, if a &%headers_add%&
22474 option is not working properly, &%debug_print%& could be used to output the
22475 variables it references. A newline is added to the text if it does not end with
22476 one.
22477 The variables &$transport_name$& and &$router_name$& contain the name of the
22478 transport and the router that called it.
22479
22480 .option delivery_date_add transports boolean false
22481 .cindex "&'Delivery-date:'& header line"
22482 If this option is true, a &'Delivery-date:'& header is added to the message.
22483 This gives the actual time the delivery was made. As this is not a standard
22484 header, Exim has a configuration option (&%delivery_date_remove%&) which
22485 requests its removal from incoming messages, so that delivered messages can
22486 safely be resent to other recipients.
22487
22488
22489 .option driver transports string unset
22490 This specifies which of the available transport drivers is to be used.
22491 There is no default, and this option must be set for every transport.
22492
22493
22494 .option envelope_to_add transports boolean false
22495 .cindex "&'Envelope-to:'& header line"
22496 If this option is true, an &'Envelope-to:'& header is added to the message.
22497 This gives the original address(es) in the incoming envelope that caused this
22498 delivery to happen. More than one address may be present if the transport is
22499 configured to handle several addresses at once, or if more than one original
22500 address was redirected to the same final address. As this is not a standard
22501 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22502 its removal from incoming messages, so that delivered messages can safely be
22503 resent to other recipients.
22504
22505 &*Note:*& If used on a transport handling multiple recipients
22506 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22507 transport if &%batch_max%& is greater than 1)
22508 then information about Bcc recipients will be leaked.
22509 Doing so is generally not advised.
22510
22511
22512 .option event_action transports string&!! unset
22513 .cindex events
22514 This option declares a string to be expanded for Exim's events mechanism.
22515 For details see chapter &<<CHAPevents>>&.
22516
22517
22518 .option group transports string&!! "Exim group"
22519 .cindex "transport" "group; specifying"
22520 This option specifies a gid for running the transport process, overriding any
22521 value that the router supplies, and also overriding any value associated with
22522 &%user%& (see below).
22523
22524
22525 .option headers_add transports list&!! unset
22526 .cindex "header lines" "adding in transport"
22527 .cindex "transport" "header lines; adding"
22528 This option specifies a list of text headers,
22529 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22530 which are (separately) expanded and added to the header
22531 portion of a message as it is transported, as described in section
22532 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22533 routers. If the result of the expansion is an empty string, or if the expansion
22534 is forced to fail, no action is taken. Other expansion failures are treated as
22535 errors and cause the delivery to be deferred.
22536
22537 Unlike most options, &%headers_add%& can be specified multiple times
22538 for a transport; all listed headers are added.
22539
22540
22541 .option headers_only transports boolean false
22542 .cindex "transport" "header lines only"
22543 .cindex "message" "transporting headers only"
22544 .cindex "header lines" "transporting"
22545 If this option is set, the message's body is not transported. It is mutually
22546 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22547 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22548 checked, since this option does not automatically suppress them.
22549
22550
22551 .option headers_remove transports list&!! unset
22552 .cindex "header lines" "removing"
22553 .cindex "transport" "header lines; removing"
22554 This option specifies a list of text headers,
22555 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22556 to be removed from the message.
22557 However, the option has no effect when an address is just being verified.
22558 Each list item is separately expanded.
22559 If the result of the expansion is an empty string, or if the expansion
22560 is forced to fail, no action is taken. Other expansion failures are treated as
22561 errors and cause the delivery to be deferred.
22562 If an item ends in *, it will match any header with the given prefix.
22563
22564 Matching headers are omitted from the message as it is transported, as described
22565 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22566 routers.
22567
22568 Unlike most options, &%headers_remove%& can be specified multiple times
22569 for a transport; all listed headers are removed.
22570
22571 &*Warning*&: Because of the separate expansion of the list items,
22572 items that contain a list separator must have it doubled.
22573 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22574
22575
22576
22577 .option headers_rewrite transports string unset
22578 .cindex "transport" "header lines; rewriting"
22579 .cindex "rewriting" "at transport time"
22580 This option allows addresses in header lines to be rewritten at transport time,
22581 that is, as the message is being copied to its destination. The contents of the
22582 option are a colon-separated list of rewriting rules. Each rule is in exactly
22583 the same form as one of the general rewriting rules that are applied when a
22584 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22585 example,
22586 .code
22587 headers_rewrite = a@b c@d f : \
22588                   x@y w@z
22589 .endd
22590 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22591 &'w@z'& in all address-bearing header lines. The rules are applied to the
22592 header lines just before they are written out at transport time, so they affect
22593 only those copies of the message that pass through the transport. However, only
22594 the message's original header lines, and any that were added by a system
22595 filter, are rewritten. If a router or transport adds header lines, they are not
22596 affected by this option. These rewriting rules are &'not'& applied to the
22597 envelope. You can change the return path using &%return_path%&, but you cannot
22598 change envelope recipients at this time.
22599
22600
22601 .option home_directory transports string&!! unset
22602 .cindex "transport" "home directory for"
22603 .vindex "&$home$&"
22604 This option specifies a home directory setting for a local transport,
22605 overriding any value that may be set by the router. The home directory is
22606 placed in &$home$& while expanding the transport's private options. It is also
22607 used as the current directory if no current directory is set by the
22608 &%current_directory%& option on the transport or the
22609 &%transport_current_directory%& option on the router. If the expansion fails
22610 for any reason, including forced failure, an error is logged, and delivery is
22611 deferred.
22612
22613
22614 .option initgroups transports boolean false
22615 .cindex "additional groups"
22616 .cindex "groups" "additional"
22617 .cindex "transport" "group; additional"
22618 If this option is true and the uid for the delivery process is provided by the
22619 transport, the &[initgroups()]& function is called when running the transport
22620 to ensure that any additional groups associated with the uid are set up.
22621
22622
22623 .option max_parallel transports integer&!! unset
22624 .cindex limit "transport parallelism"
22625 .cindex transport "parallel processes"
22626 .cindex transport "concurrency limit"
22627 .cindex "delivery" "parallelism for transport"
22628 If this option is set and expands to an integer greater than zero
22629 it limits the number of concurrent runs of the transport.
22630 The control does not apply to shadow transports.
22631
22632 .cindex "hints database" "transport concurrency control"
22633 Exim implements this control by means of a hints database in which a record is
22634 incremented whenever a transport process is being created. The record
22635 is decremented and possibly removed when the process terminates.
22636 Obviously there is scope for
22637 records to get left lying around if there is a system or program crash. To
22638 guard against this, Exim ignores any records that are more than six hours old.
22639
22640 If you use this option, you should also arrange to delete the
22641 relevant hints database whenever your system reboots. The names of the files
22642 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22643 may be one or two files, depending on the type of DBM in use. The same files
22644 are used for ETRN and smtp transport serialization.
22645
22646
22647 .option message_size_limit transports string&!! 0
22648 .cindex "limit" "message size per transport"
22649 .cindex "size" "of message, limit"
22650 .cindex "transport" "message size; limiting"
22651 This option controls the size of messages passed through the transport. It is
22652 expanded before use; the result of the expansion must be a sequence of decimal
22653 digits, optionally followed by K or M. If the expansion fails for any reason,
22654 including forced failure, or if the result is not of the required form,
22655 delivery is deferred. If the value is greater than zero and the size of a
22656 message exceeds this limit, the address is failed. If there is any chance that
22657 the resulting bounce message could be routed to the same transport, you should
22658 ensure that &%return_size_limit%& is less than the transport's
22659 &%message_size_limit%&, as otherwise the bounce message will fail to get
22660 delivered.
22661
22662
22663
22664 .option rcpt_include_affixes transports boolean false
22665 .cindex "prefix" "for local part, including in envelope"
22666 .cindex "suffix for local part" "including in envelope"
22667 .cindex "local part" "prefix"
22668 .cindex "local part" "suffix"
22669 When this option is false (the default), and an address that has had any
22670 affixes (prefixes or suffixes) removed from the local part is delivered by any
22671 form of SMTP or LMTP, the affixes are not included. For example, if a router
22672 that contains
22673 .code
22674 local_part_prefix = *-
22675 .endd
22676 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22677 is delivered with
22678 .code
22679 RCPT TO:<xyz@some.domain>
22680 .endd
22681 This is also the case when an ACL-time callout is being used to verify a
22682 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22683 whole local part is included in the RCPT command. This option applies to BSMTP
22684 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22685 &(lmtp)& and &(smtp)& transports.
22686
22687
22688 .option retry_use_local_part transports boolean "see below"
22689 .cindex "hints database" "retry keys"
22690 When a delivery suffers a temporary failure, a retry record is created
22691 in Exim's hints database. For remote deliveries, the key for the retry record
22692 is based on the name and/or IP address of the failing remote host. For local
22693 deliveries, the key is normally the entire address, including both the local
22694 part and the domain. This is suitable for most common cases of local delivery
22695 temporary failure &-- for example, exceeding a mailbox quota should delay only
22696 deliveries to that mailbox, not to the whole domain.
22697
22698 However, in some special cases you may want to treat a temporary local delivery
22699 as a failure associated with the domain, and not with a particular local part.
22700 (For example, if you are storing all mail for some domain in files.) You can do
22701 this by setting &%retry_use_local_part%& false.
22702
22703 For all the local transports, its default value is true. For remote transports,
22704 the default value is false for tidiness, but changing the value has no effect
22705 on a remote transport in the current implementation.
22706
22707
22708 .option return_path transports string&!! unset
22709 .cindex "envelope sender"
22710 .cindex "envelope from"
22711 .cindex "transport" "return path; changing"
22712 .cindex "return path" "changing in transport"
22713 If this option is set, the string is expanded at transport time and replaces
22714 the existing return path (envelope sender) value in the copy of the message
22715 that is being delivered. An empty return path is permitted. This feature is
22716 designed for remote deliveries, where the value of this option is used in the
22717 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22718 only effect is to change the address that is placed in the &'Return-path:'&
22719 header line, if one is added to the message (see the next option).
22720
22721 &*Note:*& A changed return path is not logged unless you add
22722 &%return_path_on_delivery%& to the log selector.
22723
22724 .vindex "&$return_path$&"
22725 The expansion can refer to the existing value via &$return_path$&. This is
22726 either the message's envelope sender, or an address set by the
22727 &%errors_to%& option on a router. If the expansion is forced to fail, no
22728 replacement occurs; if it fails for another reason, delivery is deferred. This
22729 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22730 section &<<SECTverp>>&.
22731
22732 &*Note*&: If a delivery error is detected locally, including the case when a
22733 remote server rejects a message at SMTP time, the bounce message is not sent to
22734 the value of this option. It is sent to the previously set errors address.
22735 This defaults to the incoming sender address, but can be changed by setting
22736 &%errors_to%& in a router.
22737
22738
22739
22740 .option return_path_add transports boolean false
22741 .chindex Return-path:
22742 If this option is true, a &'Return-path:'& header is added to the message.
22743 Although the return path is normally available in the prefix line of BSD
22744 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22745 have easy access to it.
22746
22747 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22748 the delivery SMTP server makes the final delivery"&. This implies that this
22749 header should not be present in incoming messages. Exim has a configuration
22750 option, &%return_path_remove%&, which requests removal of this header from
22751 incoming messages, so that delivered messages can safely be resent to other
22752 recipients.
22753
22754
22755 .option shadow_condition transports string&!! unset
22756 See &%shadow_transport%& below.
22757
22758
22759 .option shadow_transport transports string unset
22760 .cindex "shadow transport"
22761 .cindex "transport" "shadow"
22762 A local transport may set the &%shadow_transport%& option to the name of
22763 another local transport. Shadow remote transports are not supported.
22764
22765 Whenever a delivery to the main transport succeeds, and either
22766 &%shadow_condition%& is unset, or its expansion does not result in the empty
22767 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22768 passed to the shadow transport, with the same delivery address or addresses. If
22769 expansion fails, no action is taken except that non-forced expansion failures
22770 cause a log line to be written.
22771
22772 The result of the shadow transport is discarded and does not affect the
22773 subsequent processing of the message. Only a single level of shadowing is
22774 provided; the &%shadow_transport%& option is ignored on any transport when it
22775 is running as a shadow. Options concerned with output from pipes are also
22776 ignored. The log line for the successful delivery has an item added on the end,
22777 of the form
22778 .code
22779 ST=<shadow transport name>
22780 .endd
22781 If the shadow transport did not succeed, the error message is put in
22782 parentheses afterwards. Shadow transports can be used for a number of different
22783 purposes, including keeping more detailed log information than Exim normally
22784 provides, and implementing automatic acknowledgment policies based on message
22785 headers that some sites insist on.
22786
22787
22788 .option transport_filter transports string&!! unset
22789 .cindex "transport" "filter"
22790 .cindex "filter" "transport filter"
22791 This option sets up a filtering (in the Unix shell sense) process for messages
22792 at transport time. It should not be confused with mail filtering as set up by
22793 individual users or via a system filter.
22794 If unset, or expanding to an empty string, no filtering is done.
22795
22796 When the message is about to be written out, the command specified by
22797 &%transport_filter%& is started up in a separate, parallel process, and
22798 the entire message, including the header lines, is passed to it on its standard
22799 input (this in fact is done from a third process, to avoid deadlock). The
22800 command must be specified as an absolute path.
22801
22802 The lines of the message that are written to the transport filter are
22803 terminated by newline (&"\n"&). The message is passed to the filter before any
22804 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22805 lines beginning with a dot, and also before any processing implied by the
22806 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22807 &(pipe)& transports.
22808
22809 The standard error for the filter process is set to the same destination as its
22810 standard output; this is read and written to the message's ultimate
22811 destination. The process that writes the message to the filter, the
22812 filter itself, and the original process that reads the result and delivers it
22813 are all run in parallel, like a shell pipeline.
22814
22815 The filter can perform any transformations it likes, but of course should take
22816 care not to break RFC 2822 syntax. Exim does not check the result, except to
22817 test for a final newline when SMTP is in use. All messages transmitted over
22818 SMTP must end with a newline, so Exim supplies one if it is missing.
22819
22820 .cindex "content scanning" "per user"
22821 A transport filter can be used to provide content-scanning on a per-user basis
22822 at delivery time if the only required effect of the scan is to modify the
22823 message. For example, a content scan could insert a new header line containing
22824 a spam score. This could be interpreted by a filter in the user's MUA. It is
22825 not possible to discard a message at this stage.
22826
22827 .cindex "SIZE" "ESMTP extension"
22828 A problem might arise if the filter increases the size of a message that is
22829 being sent down an SMTP connection. If the receiving SMTP server has indicated
22830 support for the SIZE parameter, Exim will have sent the size of the message
22831 at the start of the SMTP session. If what is actually sent is substantially
22832 more, the server might reject the message. This can be worked round by setting
22833 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22834 additions to the message, or to disable the use of SIZE altogether.
22835
22836 .vindex "&$pipe_addresses$&"
22837 The value of the &%transport_filter%& option is the command string for starting
22838 the filter, which is run directly from Exim, not under a shell. The string is
22839 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22840 Exim breaks it up into arguments and then expands each argument separately (see
22841 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22842 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22843 of arguments, one for each address that applies to this delivery. (This isn't
22844 an ideal name for this feature here, but as it was already implemented for the
22845 &(pipe)& transport, it seemed sensible not to change it.)
22846
22847 .vindex "&$host$&"
22848 .vindex "&$host_address$&"
22849 The expansion variables &$host$& and &$host_address$& are available when the
22850 transport is a remote one. They contain the name and IP address of the host to
22851 which the message is being sent. For example:
22852 . used to have $sender_address in this cmdline, but it's tainted
22853 .code
22854 transport_filter = /some/directory/transport-filter.pl \
22855   $host $host_address $pipe_addresses
22856 .endd
22857
22858 Two problems arise if you want to use more complicated expansion items to
22859 generate transport filter commands, both of which due to the fact that the
22860 command is split up &'before'& expansion.
22861 .ilist
22862 If an expansion item contains white space, you must quote it, so that it is all
22863 part of the same command item. If the entire option setting is one such
22864 expansion item, you have to take care what kind of quoting you use. For
22865 example:
22866 .code
22867 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22868 .endd
22869 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22870 &(/bin/cmd2)& otherwise.
22871
22872 Option strings in general have any fully-surrounding double quote wrapping
22873 removed early in parsing (see &<<SECTstrings>>&).
22874 Then, for this option, quotes protect against whitespace being
22875 regarded as a separator while splitting into the command argument vector.
22876 Either double or single quotes can be used here;
22877 the former interprets backlash-quoted charachters
22878 and the latter does not.
22879
22880 If double quotes had been used in this example, they would have been
22881 stripped by Exim when it read the option's value. When the value is used, if
22882 the single quotes were missing, the line would be split into two items,
22883 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22884 Exim tried to expand the first one.
22885 .next
22886 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22887 expansion cannot generate multiple arguments, or a command name followed by
22888 arguments. Consider this example:
22889 .code
22890 transport_filter = ${lookup{$host}lsearch{/a/file}\
22891                     {$value}{/bin/cat}}
22892 .endd
22893 The result of the lookup is interpreted as the name of the command, even
22894 if it contains white space. The simplest way round this is to use a shell:
22895 .code
22896 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22897                                {$value}{/bin/cat}}
22898 .endd
22899 .endlist
22900
22901 The filter process is run under the same uid and gid as the normal delivery.
22902 For remote deliveries this is the Exim uid/gid by default. The command should
22903 normally yield a zero return code. Transport filters are not supposed to fail.
22904 A non-zero code is taken to mean that the transport filter encountered some
22905 serious problem. Delivery of the message is deferred; the message remains on
22906 the queue and is tried again later. It is not possible to cause a message to be
22907 bounced from a transport filter.
22908
22909 If a transport filter is set on an autoreply transport, the original message is
22910 passed through the filter as it is being copied into the newly generated
22911 message, which happens if the &%return_message%& option is set.
22912
22913
22914 .option transport_filter_timeout transports time 5m
22915 .cindex "transport" "filter, timeout"
22916 When Exim is reading the output of a transport filter, it applies a timeout
22917 that can be set by this option. Exceeding the timeout is normally treated as a
22918 temporary delivery failure. However, if a transport filter is used with a
22919 &(pipe)& transport, a timeout in the transport filter is treated in the same
22920 way as a timeout in the pipe command itself. By default, a timeout is a hard
22921 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22922 becomes a temporary error.
22923
22924
22925 .option user transports string&!! "Exim user"
22926 .cindex "uid (user id)" "local delivery"
22927 .cindex "transport" "user, specifying"
22928 This option specifies the user under whose uid the delivery process is to be
22929 run, overriding any uid that may have been set by the router. If the user is
22930 given as a name, the uid is looked up from the password data, and the
22931 associated group is taken as the value of the gid to be used if the &%group%&
22932 option is not set.
22933
22934 For deliveries that use local transports, a user and group are normally
22935 specified explicitly or implicitly (for example, as a result of
22936 &%check_local_user%&) by the router or transport.
22937
22938 .cindex "hints database" "access by remote transport"
22939 For remote transports, you should leave this option unset unless you really are
22940 sure you know what you are doing. When a remote transport is running, it needs
22941 to be able to access Exim's hints databases, because each host may have its own
22942 retry data.
22943 .ecindex IIDgenoptra1
22944 .ecindex IIDgenoptra2
22945 .ecindex IIDgenoptra3
22946
22947
22948
22949
22950
22951
22952 . ////////////////////////////////////////////////////////////////////////////
22953 . ////////////////////////////////////////////////////////////////////////////
22954
22955 .chapter "Address batching in local transports" "CHAPbatching" &&&
22956          "Address batching"
22957 .cindex "transport" "local; address batching in"
22958 The only remote transport (&(smtp)&) is normally configured to handle more than
22959 one address at a time, so that when several addresses are routed to the same
22960 remote host, just one copy of the message is sent. Local transports, however,
22961 normally handle one address at a time. That is, a separate instance of the
22962 transport is run for each address that is routed to the transport. A separate
22963 copy of the message is delivered each time.
22964
22965 .cindex "batched local delivery"
22966 .oindex "&%batch_max%&"
22967 .oindex "&%batch_id%&"
22968 In special cases, it may be desirable to handle several addresses at once in a
22969 local transport, for example:
22970
22971 .ilist
22972 In an &(appendfile)& transport, when storing messages in files for later
22973 delivery by some other means, a single copy of the message with multiple
22974 recipients saves space.
22975 .next
22976 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22977 a single copy saves time, and is the normal way LMTP is expected to work.
22978 .next
22979 In a &(pipe)& transport, when passing the message
22980 to a scanner program or
22981 to some other delivery mechanism such as UUCP, multiple recipients may be
22982 acceptable.
22983 .endlist
22984
22985 These three local transports all have the same options for controlling multiple
22986 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22987 repeating the information for each transport, these options are described here.
22988
22989 The &%batch_max%& option specifies the maximum number of addresses that can be
22990 delivered together in a single run of the transport. Its default value is one
22991 (no batching). When more than one address is routed to a transport that has a
22992 &%batch_max%& value greater than one, the addresses are delivered in a batch
22993 (that is, in a single run of the transport with multiple recipients), subject
22994 to certain conditions:
22995
22996 .ilist
22997 .vindex "&$local_part$&"
22998 If any of the transport's options contain a reference to &$local_part$&, no
22999 batching is possible.
23000 .next
23001 .vindex "&$domain$&"
23002 If any of the transport's options contain a reference to &$domain$&, only
23003 addresses with the same domain are batched.
23004 .next
23005 .cindex "customizing" "batching condition"
23006 If &%batch_id%& is set, it is expanded for each address, and only those
23007 addresses with the same expanded value are batched. This allows you to specify
23008 customized batching conditions. Failure of the expansion for any reason,
23009 including forced failure, disables batching, but it does not stop the delivery
23010 from taking place.
23011 .next
23012 Batched addresses must also have the same errors address (where to send
23013 delivery errors), the same header additions and removals, the same user and
23014 group for the transport, and if a host list is present, the first host must
23015 be the same.
23016 .endlist
23017
23018 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23019 both when the file or pipe command is specified in the transport, and when it
23020 is specified by a &(redirect)& router, but all the batched addresses must of
23021 course be routed to the same file or pipe command. These two transports have an
23022 option called &%use_bsmtp%&, which causes them to deliver the message in
23023 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23024 &%check_string%& and &%escape_string%& options are forced to the values
23025 .code
23026 check_string = "."
23027 escape_string = ".."
23028 .endd
23029 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23030 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23031 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23032
23033 .cindex "&'Envelope-to:'& header line"
23034 If the generic &%envelope_to_add%& option is set for a batching transport, the
23035 &'Envelope-to:'& header that is added to the message contains all the addresses
23036 that are being processed together. If you are using a batching &(appendfile)&
23037 transport without &%use_bsmtp%&, the only way to preserve the recipient
23038 addresses is to set the &%envelope_to_add%& option.
23039
23040 .cindex "&(pipe)& transport" "with multiple addresses"
23041 .vindex "&$pipe_addresses$&"
23042 If you are using a &(pipe)& transport without BSMTP, and setting the
23043 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23044 the command. This is not a true variable; it is a bit of magic that causes each
23045 of the recipient addresses to be inserted into the command as a separate
23046 argument. This provides a way of accessing all the addresses that are being
23047 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23048 are specified by a &(redirect)& router.
23049
23050
23051
23052
23053 . ////////////////////////////////////////////////////////////////////////////
23054 . ////////////////////////////////////////////////////////////////////////////
23055
23056 .chapter "The appendfile transport" "CHAPappendfile"
23057 .scindex IIDapptra1 "&(appendfile)& transport"
23058 .scindex IIDapptra2 "transports" "&(appendfile)&"
23059 .cindex "directory creation"
23060 .cindex "creating directories"
23061 The &(appendfile)& transport delivers a message by appending it to an existing
23062 file, or by creating an entirely new file in a specified directory. Single
23063 files to which messages are appended can be in the traditional Unix mailbox
23064 format, or optionally in the MBX format supported by the Pine MUA and
23065 University of Washington IMAP daemon, &'inter alia'&. When each message is
23066 being delivered as a separate file, &"maildir"& format can optionally be used
23067 to give added protection against failures that happen part-way through the
23068 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23069 supported. For all file formats, Exim attempts to create as many levels of
23070 directory as necessary, provided that &%create_directory%& is set.
23071
23072 The code for the optional formats is not included in the Exim binary by
23073 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23074 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23075 included.
23076
23077 .cindex "quota" "system"
23078 Exim recognizes system quota errors, and generates an appropriate message. Exim
23079 also supports its own quota control within the transport, for use when the
23080 system facility is unavailable or cannot be used for some reason.
23081
23082 If there is an error while appending to a file (for example, quota exceeded or
23083 partition filled), Exim attempts to reset the file's length and last
23084 modification time back to what they were before. If there is an error while
23085 creating an entirely new file, the new file is removed.
23086
23087 Before appending to a file, a number of security checks are made, and the
23088 file is locked. A detailed description is given below, after the list of
23089 private options.
23090
23091 The &(appendfile)& transport is most commonly used for local deliveries to
23092 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23093 putting messages into files for remote delivery by some means other than Exim.
23094 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23095 option).
23096
23097
23098
23099 .section "The file and directory options" "SECTfildiropt"
23100 The &%file%& option specifies a single file, to which the message is appended;
23101 the &%directory%& option specifies a directory, in which a new file containing
23102 the message is created. Only one of these two options can be set, and for
23103 normal deliveries to mailboxes, one of them &'must'& be set.
23104
23105 .vindex "&$address_file$&"
23106 .vindex "&$local_part$&"
23107 However, &(appendfile)& is also used for delivering messages to files or
23108 directories whose names (or parts of names) are obtained from alias,
23109 forwarding, or filtering operations (for example, a &%save%& command in a
23110 user's Exim filter). When such a transport is running, &$local_part$& contains
23111 the local part that was aliased or forwarded, and &$address_file$& contains the
23112 name (or partial name) of the file or directory generated by the redirection
23113 operation. There are two cases:
23114
23115 .ilist
23116 If neither &%file%& nor &%directory%& is set, the redirection operation
23117 must specify an absolute path (one that begins with &`/`&). This is the most
23118 common case when users with local accounts use filtering to sort mail into
23119 different folders. See for example, the &(address_file)& transport in the
23120 default configuration. If the path ends with a slash, it is assumed to be the
23121 name of a directory. A delivery to a directory can also be forced by setting
23122 &%maildir_format%& or &%mailstore_format%&.
23123 .next
23124 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23125 used to determine the file or directory name for the delivery. Normally, the
23126 contents of &$address_file$& are used in some way in the string expansion.
23127 .endlist
23128 If the &%create_file%& option is set to a path which
23129 matches (see the option definition below for details)
23130 a file or directory name
23131 for the delivery, that name becomes de-tainted.
23132
23133 .cindex "tainted data" "in filenames"
23134 .cindex appendfile "tainted data"
23135 Tainted data may not be used for a file or directory name.
23136 This means that, for instance, &$local_part$& cannot be used directly
23137 as a component of a path.  It can however be used as the key for a lookup
23138 which returns a path (or component).
23139
23140
23141 .cindex "Sieve filter" "configuring &(appendfile)&"
23142 .cindex "Sieve filter" "relative mailbox path handling"
23143 As an example of the second case, consider an environment where users do not
23144 have home directories. They may be permitted to use Exim filter commands of the
23145 form:
23146 .code
23147 save folder23
23148 .endd
23149 or Sieve filter commands of the form:
23150 .code
23151 require "fileinto";
23152 fileinto "folder23";
23153 .endd
23154 In this situation, the expansion of &%file%& or &%directory%& in the transport
23155 must transform the relative path into an appropriate absolute filename. In the
23156 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23157 is used as a result of a &"keep"& action in the filter. This example shows one
23158 way of handling this requirement:
23159 .code
23160 file = ${if eq{$address_file}{inbox} \
23161             {/var/mail/$local_part_data} \
23162             {${if eq{${substr_0_1:$address_file}}{/} \
23163                   {$address_file} \
23164                   {$home/mail/$address_file} \
23165             }} \
23166        }
23167 .endd
23168 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23169 location, absolute paths are used without change, and other folders are in the
23170 &_mail_& directory within the home directory.
23171
23172 &*Note 1*&: While processing an Exim filter, a relative path such as
23173 &_folder23_& is turned into an absolute path if a home directory is known to
23174 the router. In particular, this is the case if &%check_local_user%& is set. If
23175 you want to prevent this happening at routing time, you can set
23176 &%router_home_directory%& empty. This forces the router to pass the relative
23177 path to the transport.
23178
23179 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23180 the &%file%& or &%directory%& option is still used if it is set.
23181
23182
23183
23184
23185 .section "Private options for appendfile" "SECID134"
23186 .cindex "options" "&(appendfile)& transport"
23187
23188
23189
23190 .option allow_fifo appendfile boolean false
23191 .cindex "fifo (named pipe)"
23192 .cindex "named pipe (fifo)"
23193 .cindex "pipe" "named (fifo)"
23194 Setting this option permits delivery to named pipes (FIFOs) as well as to
23195 regular files. If no process is reading the named pipe at delivery time, the
23196 delivery is deferred.
23197
23198
23199 .option allow_symlink appendfile boolean false
23200 .cindex "symbolic link" "to mailbox"
23201 .cindex "mailbox" "symbolic link"
23202 By default, &(appendfile)& will not deliver if the path name for the file is
23203 that of a symbolic link. Setting this option relaxes that constraint, but there
23204 are security issues involved in the use of symbolic links. Be sure you know
23205 what you are doing if you set this. Details of exactly what this option affects
23206 are included in the discussion which follows this list of options.
23207
23208
23209 .option batch_id appendfile string&!! unset
23210 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23211 However, batching is automatically disabled for &(appendfile)& deliveries that
23212 happen as a result of forwarding or aliasing or other redirection directly to a
23213 file.
23214
23215
23216 .option batch_max appendfile integer 1
23217 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23218
23219
23220 .option check_group appendfile boolean false
23221 When this option is set, the group owner of the file defined by the &%file%&
23222 option is checked to see that it is the same as the group under which the
23223 delivery process is running. The default setting is false because the default
23224 file mode is 0600, which means that the group is irrelevant.
23225
23226
23227 .option check_owner appendfile boolean true
23228 When this option is set, the owner of the file defined by the &%file%& option
23229 is checked to ensure that it is the same as the user under which the delivery
23230 process is running.
23231
23232
23233 .option check_string appendfile string "see below"
23234 .cindex "&""From""& line"
23235 As &(appendfile)& writes the message, the start of each line is tested for
23236 matching &%check_string%&, and if it does, the initial matching characters are
23237 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23238 a literal string, not a regular expression, and the case of any letters it
23239 contains is significant.
23240
23241 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23242 are forced to &"."& and &".."& respectively, and any settings in the
23243 configuration are ignored. Otherwise, they default to &"From&~"& and
23244 &">From&~"& when the &%file%& option is set, and unset when any of the
23245 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23246
23247 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23248 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23249 &"From&~"& indicates the start of a new message. All four options need changing
23250 if another format is used. For example, to deliver to mailboxes in MMDF format:
23251 .cindex "MMDF format mailbox"
23252 .cindex "mailbox" "MMDF format"
23253 .code
23254 check_string = "\1\1\1\1\n"
23255 escape_string = "\1\1\1\1 \n"
23256 message_prefix = "\1\1\1\1\n"
23257 message_suffix = "\1\1\1\1\n"
23258 .endd
23259 .option create_directory appendfile boolean true
23260 .cindex "directory creation"
23261 When this option is true, Exim attempts to create any missing superior
23262 directories for the file that it is about to write. A created directory's mode
23263 is given by the &%directory_mode%& option.
23264
23265 The group ownership of a newly created directory is highly dependent on the
23266 operating system (and possibly the file system) that is being used. For
23267 example, in Solaris, if the parent directory has the setgid bit set, its group
23268 is propagated to the child; if not, the currently set group is used. However,
23269 in FreeBSD, the parent's group is always used.
23270
23271
23272
23273 .option create_file appendfile string anywhere
23274 This option constrains the location of files and directories that are created
23275 by this transport. It applies to files defined by the &%file%& option and
23276 directories defined by the &%directory%& option. In the case of maildir
23277 delivery, it applies to the top level directory, not the maildir directories
23278 beneath.
23279
23280 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23281 &"belowhome"&, or to an absolute path.
23282
23283 In the second and third cases, a home directory must have been
23284 set for the transport, and the file or directory being created must
23285 reside within it.
23286 The "belowhome" checking additionally checks for attempts to use "../"
23287 to evade the testing.
23288 This option is not useful when an explicit filename is
23289 given for normal mailbox deliveries. It is intended for the case when filenames
23290 are generated from users' &_.forward_& files. These are usually handled
23291 by an &(appendfile)& transport called &%address_file%&. See also
23292 &%file_must_exist%&.
23293
23294 In the fourth case,
23295 the value given for this option must be an absolute path for an
23296 existing directory.
23297 The value is used for checking instead of a home directory;
23298 checking is done in "belowhome" mode.
23299
23300 .cindex "tainted data" "de-tainting"
23301 .cindex "de-tainting" "using appendfile create_file option"
23302 If "belowhome" checking is used, the file or directory path
23303 becomes de-tainted.
23304
23305
23306 .option directory appendfile string&!! unset
23307 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23308 or &%directory%& must be set, unless the delivery is the direct result of a
23309 redirection (see section &<<SECTfildiropt>>&).
23310
23311 When &%directory%& is set, the string is expanded, and the message is delivered
23312 into a new file or files in or below the given directory, instead of being
23313 appended to a single mailbox file. A number of different formats are provided
23314 (see &%maildir_format%& and &%mailstore_format%&), and see section
23315 &<<SECTopdir>>& for further details of this form of delivery.
23316
23317 The result of expansion must not be tainted, unless the &%create_file%& option
23318 specifies a path.
23319
23320
23321 .option directory_file appendfile string&!! "see below"
23322 .cindex "base62"
23323 .vindex "&$inode$&"
23324 When &%directory%& is set, but neither &%maildir_format%& nor
23325 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23326 whose name is obtained by expanding this string. The default value is:
23327 .code
23328 q${base62:$tod_epoch}-$inode
23329 .endd
23330 This generates a unique name from the current time, in base 62 form, and the
23331 inode of the file. The variable &$inode$& is available only when expanding this
23332 option.
23333
23334
23335 .option directory_mode appendfile "octal integer" 0700
23336 If &(appendfile)& creates any directories as a result of the
23337 &%create_directory%& option, their mode is specified by this option.
23338
23339
23340 .option escape_string appendfile string "see description"
23341 See &%check_string%& above.
23342
23343
23344 .option file appendfile string&!! unset
23345 This option is mutually exclusive with the &%directory%& option, but one of
23346 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23347 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23348 specifies a single file, to which the message is appended. One or more of
23349 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23350 &%file%&.
23351
23352 The result of expansion must not be tainted, unless the &%create_file%& option
23353 specifies a path.
23354
23355 .cindex "NFS" "lock file"
23356 .cindex "locking files"
23357 .cindex "lock files"
23358 If you are using more than one host to deliver over NFS into the same
23359 mailboxes, you should always use lock files.
23360
23361 The string value is expanded for each delivery, and must yield an absolute
23362 path. The most common settings of this option are variations on one of these
23363 examples:
23364 .code
23365 file = /var/spool/mail/$local_part_data
23366 file = /home/$local_part_data/inbox
23367 file = $home/inbox
23368 .endd
23369 .cindex "&""sticky""& bit"
23370 In the first example, all deliveries are done into the same directory. If Exim
23371 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23372 create a file in the directory, so the &"sticky"& bit must be turned on for
23373 deliveries to be possible, or alternatively the &%group%& option can be used to
23374 run the delivery under a group id which has write access to the directory.
23375
23376
23377
23378 .option file_format appendfile string unset
23379 .cindex "file" "mailbox; checking existing format"
23380 This option requests the transport to check the format of an existing file
23381 before adding to it. The check consists of matching a specific string at the
23382 start of the file. The value of the option consists of an even number of
23383 colon-separated strings. The first of each pair is the test string, and the
23384 second is the name of a transport. If the transport associated with a matched
23385 string is not the current transport, control is passed over to the other
23386 transport. For example, suppose the standard &(local_delivery)& transport has
23387 this added to it:
23388 .code
23389 file_format = "From       : local_delivery :\
23390                \1\1\1\1\n : local_mmdf_delivery"
23391 .endd
23392 Mailboxes that begin with &"From"& are still handled by this transport, but if
23393 a mailbox begins with four binary ones followed by a newline, control is passed
23394 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23395 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23396 is assumed to match the current transport. If the start of a mailbox doesn't
23397 match any string, or if the transport named for a given string is not defined,
23398 delivery is deferred.
23399
23400
23401 .option file_must_exist appendfile boolean false
23402 If this option is true, the file specified by the &%file%& option must exist.
23403 A temporary error occurs if it does not, causing delivery to be deferred.
23404 If this option is false, the file is created if it does not exist.
23405
23406
23407 .option lock_fcntl_timeout appendfile time 0s
23408 .cindex "timeout" "mailbox locking"
23409 .cindex "mailbox" "locking, blocking and non-blocking"
23410 .cindex "locking files"
23411 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23412 when locking an open mailbox file. If the call fails, the delivery process
23413 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23414 Non-blocking calls are used so that the file is not kept open during the wait
23415 for the lock; the reason for this is to make it as safe as possible for
23416 deliveries over NFS in the case when processes might be accessing an NFS
23417 mailbox without using a lock file. This should not be done, but
23418 misunderstandings and hence misconfigurations are not unknown.
23419
23420 On a busy system, however, the performance of a non-blocking lock approach is
23421 not as good as using a blocking lock with a timeout. In this case, the waiting
23422 is done inside the system call, and Exim's delivery process acquires the lock
23423 and can proceed as soon as the previous lock holder releases it.
23424
23425 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23426 timeout, are used. There may still be some retrying: the maximum number of
23427 retries is
23428 .code
23429 (lock_retries * lock_interval) / lock_fcntl_timeout
23430 .endd
23431 rounded up to the next whole number. In other words, the total time during
23432 which &(appendfile)& is trying to get a lock is roughly the same, unless
23433 &%lock_fcntl_timeout%& is set very large.
23434
23435 You should consider setting this option if you are getting a lot of delayed
23436 local deliveries because of errors of the form
23437 .code
23438 failed to lock mailbox /some/file (fcntl)
23439 .endd
23440
23441 .option lock_flock_timeout appendfile time 0s
23442 This timeout applies to file locking when using &[flock()]& (see
23443 &%use_flock%&); the timeout operates in a similar manner to
23444 &%lock_fcntl_timeout%&.
23445
23446
23447 .option lock_interval appendfile time 3s
23448 This specifies the time to wait between attempts to lock the file. See below
23449 for details of locking.
23450
23451
23452 .option lock_retries appendfile integer 10
23453 This specifies the maximum number of attempts to lock the file. A value of zero
23454 is treated as 1. See below for details of locking.
23455
23456
23457 .option lockfile_mode appendfile "octal integer" 0600
23458 This specifies the mode of the created lock file, when a lock file is being
23459 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23460
23461
23462 .option lockfile_timeout appendfile time 30m
23463 .cindex "timeout" "mailbox locking"
23464 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23465 exists and is older than this value, it is assumed to have been left behind by
23466 accident, and Exim attempts to remove it.
23467
23468
23469 .option mailbox_filecount appendfile string&!! unset
23470 .cindex "mailbox" "specifying size of"
23471 .cindex "size" "of mailbox"
23472 If this option is set, it is expanded, and the result is taken as the current
23473 number of files in the mailbox. It must be a decimal number, optionally
23474 followed by K or M. This provides a way of obtaining this information from an
23475 external source that maintains the data.
23476
23477
23478 .option mailbox_size appendfile string&!! unset
23479 .cindex "mailbox" "specifying size of"
23480 .cindex "size" "of mailbox"
23481 If this option is set, it is expanded, and the result is taken as the current
23482 size the mailbox. It must be a decimal number, optionally followed by K or M.
23483 This provides a way of obtaining this information from an external source that
23484 maintains the data. This is likely to be helpful for maildir deliveries where
23485 it is computationally expensive to compute the size of a mailbox.
23486
23487
23488
23489 .option maildir_format appendfile boolean false
23490 .cindex "maildir format" "specifying"
23491 If this option is set with the &%directory%& option, the delivery is into a new
23492 file, in the &"maildir"& format that is used by other mail software. When the
23493 transport is activated directly from a &(redirect)& router (for example, the
23494 &(address_file)& transport in the default configuration), setting
23495 &%maildir_format%& causes the path received from the router to be treated as a
23496 directory, whether or not it ends with &`/`&. This option is available only if
23497 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23498 &<<SECTmaildirdelivery>>& below for further details.
23499
23500
23501 .option maildir_quota_directory_regex appendfile string "See below"
23502 .cindex "maildir format" "quota; directories included in"
23503 .cindex "quota" "maildir; directories included in"
23504 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23505 a regular expression for specifying directories, relative to the quota
23506 directory (see &%quota_directory%&), that should be included in the quota
23507 calculation. The default value is:
23508 .code
23509 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23510 .endd
23511 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23512 (directories whose names begin with a dot). If you want to exclude the
23513 &_Trash_&
23514 folder from the count (as some sites do), you need to change this setting to
23515 .code
23516 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23517 .endd
23518 This uses a negative lookahead in the regular expression to exclude the
23519 directory whose name is &_.Trash_&. When a directory is excluded from quota
23520 calculations, quota processing is bypassed for any messages that are delivered
23521 directly into that directory.
23522
23523
23524 .option maildir_retries appendfile integer 10
23525 This option specifies the number of times to retry when writing a file in
23526 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23527
23528
23529 .option maildir_tag appendfile string&!! unset
23530 This option applies only to deliveries in maildir format, and is described in
23531 section &<<SECTmaildirdelivery>>& below.
23532
23533
23534 .option maildir_use_size_file appendfile&!! boolean false
23535 .cindex "maildir format" "&_maildirsize_& file"
23536 The result of string expansion for this option must be a valid boolean value.
23537 If it is true, it enables support for &_maildirsize_& files. Exim
23538 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23539 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23540 value is zero. See &%maildir_quota_directory_regex%& above and section
23541 &<<SECTmaildirdelivery>>& below for further details.
23542
23543 .option maildirfolder_create_regex appendfile string unset
23544 .cindex "maildir format" "&_maildirfolder_& file"
23545 .cindex "&_maildirfolder_&, creating"
23546 The value of this option is a regular expression. If it is unset, it has no
23547 effect. Otherwise, before a maildir delivery takes place, the pattern is
23548 matched against the name of the maildir directory, that is, the directory
23549 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23550 delivery. If there is a match, Exim checks for the existence of a file called
23551 &_maildirfolder_& in the directory, and creates it if it does not exist.
23552 See section &<<SECTmaildirdelivery>>& for more details.
23553
23554
23555 .option mailstore_format appendfile boolean false
23556 .cindex "mailstore format" "specifying"
23557 If this option is set with the &%directory%& option, the delivery is into two
23558 new files in  &"mailstore"& format. The option is available only if
23559 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23560 below for further details.
23561
23562
23563 .option mailstore_prefix appendfile string&!! unset
23564 This option applies only to deliveries in mailstore format, and is described in
23565 section &<<SECTopdir>>& below.
23566
23567
23568 .option mailstore_suffix appendfile string&!! unset
23569 This option applies only to deliveries in mailstore format, and is described in
23570 section &<<SECTopdir>>& below.
23571
23572
23573 .option mbx_format appendfile boolean false
23574 .cindex "locking files"
23575 .cindex "file" "locking"
23576 .cindex "file" "MBX format"
23577 .cindex "MBX format, specifying"
23578 This option is available only if Exim has been compiled with SUPPORT_MBX
23579 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23580 the message is appended to the mailbox file in MBX format instead of
23581 traditional Unix format. This format is supported by Pine4 and its associated
23582 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23583
23584 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23585 automatically changed by the use of &%mbx_format%&. They should normally be set
23586 empty when using MBX format, so this option almost always appears in this
23587 combination:
23588 .code
23589 mbx_format = true
23590 message_prefix =
23591 message_suffix =
23592 .endd
23593 If none of the locking options are mentioned in the configuration,
23594 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23595 is possible to specify the other kinds of locking with &%mbx_format%&, but
23596 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23597 interworks with &'c-client'&, providing for shared access to the mailbox. It
23598 should not be used if any program that does not use this form of locking is
23599 going to access the mailbox, nor should it be used if the mailbox file is NFS
23600 mounted, because it works only when the mailbox is accessed from a single host.
23601
23602 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23603 the standard version of &'c-client'&, because as long as it has a mailbox open
23604 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23605 append messages to it.
23606
23607
23608 .option message_prefix appendfile string&!! "see below"
23609 .cindex "&""From""& line"
23610 The string specified here is expanded and output at the start of every message.
23611 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23612 in which case it is:
23613 .code
23614 message_prefix = "From ${if def:return_path{$return_path}\
23615   {MAILER-DAEMON}} $tod_bsdinbox\n"
23616 .endd
23617 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23618 &`\n`& to &`\r\n`& in &%message_prefix%&.
23619
23620 .option message_suffix appendfile string&!! "see below"
23621 The string specified here is expanded and output at the end of every message.
23622 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23623 in which case it is a single newline character. The suffix can be suppressed by
23624 setting
23625 .code
23626 message_suffix =
23627 .endd
23628 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23629 &`\n`& to &`\r\n`& in &%message_suffix%&.
23630
23631 .option mode appendfile "octal integer" 0600
23632 If the output file is created, it is given this mode. If it already exists and
23633 has wider permissions, they are reduced to this mode. If it has narrower
23634 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23635 if the delivery is the result of a &%save%& command in a filter file specifying
23636 a particular mode, the mode of the output file is always forced to take that
23637 value, and this option is ignored.
23638
23639
23640 .option mode_fail_narrower appendfile boolean true
23641 This option applies in the case when an existing mailbox file has a narrower
23642 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23643 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23644 continues with the delivery attempt, using the existing mode of the file.
23645
23646
23647 .option notify_comsat appendfile boolean false
23648 If this option is true, the &'comsat'& daemon is notified after every
23649 successful delivery to a user mailbox. This is the daemon that notifies logged
23650 on users about incoming mail.
23651
23652
23653 .option quota appendfile string&!! unset
23654 .cindex "quota" "imposed by Exim"
23655 This option imposes a limit on the size of the file to which Exim is appending,
23656 or to the total space used in the directory tree when the &%directory%& option
23657 is set. In the latter case, computation of the space used is expensive, because
23658 all the files in the directory (and any sub-directories) have to be
23659 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23660 &%maildir_use_size_file%& for ways to avoid this in environments where users
23661 have no shell access to their mailboxes).
23662
23663 As there is no interlock against two simultaneous deliveries into a
23664 multi-file mailbox, it is possible for the quota to be overrun in this case.
23665 For single-file mailboxes, of course, an interlock is a necessity.
23666
23667 A file's size is taken as its &'used'& value. Because of blocking effects, this
23668 may be a lot less than the actual amount of disk space allocated to the file.
23669 If the sizes of a number of files are being added up, the rounding effect can
23670 become quite noticeable, especially on systems that have large block sizes.
23671 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23672 the obvious value which users understand most easily.
23673
23674 The value of the option is expanded, and must then be a numerical value
23675 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23676 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23677 and further option modifiers. If Exim is running on a system with
23678 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23679 be handled.
23680
23681 The option modifier &%no_check%& can be used to force delivery even if the over
23682 quota condition is met. The quota gets updated as usual.
23683
23684 &*Note*&: A value of zero is interpreted as &"no quota"&.
23685
23686 The expansion happens while Exim is running as root, before it changes uid for
23687 the delivery. This means that files that are inaccessible to the end user can
23688 be used to hold quota values that are looked up in the expansion. When delivery
23689 fails because this quota is exceeded, the handling of the error is as for
23690 system quota failures.
23691
23692 By default, Exim's quota checking mimics system quotas, and restricts the
23693 mailbox to the specified maximum size, though the value is not accurate to the
23694 last byte, owing to separator lines and additional headers that may get added
23695 during message delivery. When a mailbox is nearly full, large messages may get
23696 refused even though small ones are accepted, because the size of the current
23697 message is added to the quota when the check is made. This behaviour can be
23698 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23699 for exceeding the quota does not include the current message. Thus, deliveries
23700 continue until the quota has been exceeded; thereafter, no further messages are
23701 delivered. See also &%quota_warn_threshold%&.
23702
23703
23704 .option quota_directory appendfile string&!! unset
23705 This option defines the directory to check for quota purposes when delivering
23706 into individual files. The default is the delivery directory, or, if a file
23707 called &_maildirfolder_& exists in a maildir directory, the parent of the
23708 delivery directory.
23709
23710
23711 .option quota_filecount appendfile string&!! 0
23712 This option applies when the &%directory%& option is set. It limits the total
23713 number of files in the directory (compare the inode limit in system quotas). It
23714 can only be used if &%quota%& is also set. The value is expanded; an expansion
23715 failure causes delivery to be deferred. A value of zero is interpreted as
23716 &"no quota"&.
23717
23718 The option modifier &%no_check%& can be used to force delivery even if the over
23719 quota condition is met. The quota gets updated as usual.
23720
23721 .option quota_is_inclusive appendfile boolean true
23722 See &%quota%& above.
23723
23724
23725 .option quota_size_regex appendfile string unset
23726 This option applies when one of the delivery modes that writes a separate file
23727 for each message is being used. When Exim wants to find the size of one of
23728 these files in order to test the quota, it first checks &%quota_size_regex%&.
23729 If this is set to a regular expression that matches the filename, and it
23730 captures one string, that string is interpreted as a representation of the
23731 file's size. The value of &%quota_size_regex%& is not expanded.
23732
23733 This feature is useful only when users have no shell access to their mailboxes
23734 &-- otherwise they could defeat the quota simply by renaming the files. This
23735 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23736 the file length to the filename. For example:
23737 .code
23738 maildir_tag = ,S=$message_size
23739 quota_size_regex = ,S=(\d+)
23740 .endd
23741 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23742 number of lines in the message.
23743
23744 The regular expression should not assume that the length is at the end of the
23745 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23746 sometimes add other information onto the ends of message filenames.
23747
23748 Section &<<SECID136>>& contains further information.
23749
23750 This option should not be used when other message-handling software
23751 may duplicate messages by making hardlinks to the files.  When that is done Exim
23752 will count the message size once for each filename, in contrast with the actual
23753 disk usage.  When the option is not set, calculating total usage requires
23754 a system-call per file to get the size; the number of links is then available also
23755 as is used to adjust the effective size.
23756
23757
23758 .option quota_warn_message appendfile string&!! "see below"
23759 See below for the use of this option. If it is not set when
23760 &%quota_warn_threshold%& is set, it defaults to
23761 .code
23762 quota_warn_message = "\
23763   To: $local_part@$domain\n\
23764   Subject: Your mailbox\n\n\
23765   This message is automatically created \
23766   by mail delivery software.\n\n\
23767   The size of your mailbox has exceeded \
23768   a warning threshold that is\n\
23769   set by the system administrator.\n"
23770 .endd
23771
23772
23773 .option quota_warn_threshold appendfile string&!! 0
23774 .cindex "quota" "warning threshold"
23775 .cindex "mailbox" "size warning"
23776 .cindex "size" "of mailbox"
23777 This option is expanded in the same way as &%quota%& (see above). If the
23778 resulting value is greater than zero, and delivery of the message causes the
23779 size of the file or total space in the directory tree to cross the given
23780 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23781 may be specified as a percentage of it by following the value with a percent
23782 sign. For example:
23783 .code
23784 quota = 10M
23785 quota_warn_threshold = 75%
23786 .endd
23787 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23788 percent sign is ignored.
23789
23790 The warning message itself is specified by the &%quota_warn_message%& option,
23791 and it must start with a &'To:'& header line containing the recipient(s) of the
23792 warning message. These do not necessarily have to include the recipient(s) of
23793 the original message. A &'Subject:'& line should also normally be supplied. You
23794 can include any other header lines that you want. If you do not include a
23795 &'From:'& line, the default is:
23796 .code
23797 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23798 .endd
23799 .oindex &%errors_reply_to%&
23800 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23801 option.
23802
23803 The &%quota%& option does not have to be set in order to use this option; they
23804 are independent of one another except when the threshold is specified as a
23805 percentage.
23806
23807
23808 .option use_bsmtp appendfile boolean false
23809 .cindex "envelope from"
23810 .cindex "envelope sender"
23811 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23812 format, with the envelope sender and recipient(s) included as SMTP commands. If
23813 you want to include a leading HELO command with such messages, you can do
23814 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23815 for details of batch SMTP.
23816
23817
23818 .option use_crlf appendfile boolean false
23819 .cindex "carriage return"
23820 .cindex "linefeed"
23821 This option causes lines to be terminated with the two-character CRLF sequence
23822 (carriage return, linefeed) instead of just a linefeed character. In the case
23823 of batched SMTP, the byte sequence written to the file is then an exact image
23824 of what would be sent down a real SMTP connection.
23825
23826 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23827 (which are used to supply the traditional &"From&~"& and blank line separators
23828 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23829 carriage return characters if these are needed. In cases where these options
23830 have non-empty defaults, the values end with a single linefeed, so they must be
23831 changed to end with &`\r\n`& if &%use_crlf%& is set.
23832
23833
23834 .option use_fcntl_lock appendfile boolean "see below"
23835 This option controls the use of the &[fcntl()]& function to lock a file for
23836 exclusive use when a message is being appended. It is set by default unless
23837 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23838 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23839 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23840
23841
23842 .option use_flock_lock appendfile boolean false
23843 This option is provided to support the use of &[flock()]& for file locking, for
23844 the few situations where it is needed. Most modern operating systems support
23845 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23846 each other. Exim uses &[fcntl()]& locking by default.
23847
23848 This option is required only if you are using an operating system where
23849 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23850 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23851 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23852
23853 .cindex "Solaris" "&[flock()]& support"
23854 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23855 have it (and some, I think, provide a not quite right version built on top of
23856 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23857 the ability to use it, and any attempt to do so will cause a configuration
23858 error.
23859
23860 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23861 is just being mapped onto &[fcntl()]& by the OS).
23862
23863
23864 .option use_lockfile appendfile boolean "see below"
23865 If this option is turned off, Exim does not attempt to create a lock file when
23866 appending to a mailbox file. In this situation, the only locking is by
23867 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23868 sure that every MUA that is ever going to look at your users' mailboxes uses
23869 &[fcntl()]& rather than a lock file, and even then only when you are not
23870 delivering over NFS from more than one host.
23871
23872 .cindex "NFS" "lock file"
23873 In order to append to an NFS file safely from more than one host, it is
23874 necessary to take out a lock &'before'& opening the file, and the lock file
23875 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23876 file corruption.
23877
23878 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23879 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23880 except when &%mbx_format%& is set.
23881
23882
23883 .option use_mbx_lock appendfile boolean "see below"
23884 This option is available only if Exim has been compiled with SUPPORT_MBX
23885 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23886 locking rules be used. It is set by default if &%mbx_format%& is set and none
23887 of the locking options are mentioned in the configuration. The locking rules
23888 are the same as are used by the &'c-client'& library that underlies Pine and
23889 the IMAP4 and POP daemons that come with it (see the discussion below). The
23890 rules allow for shared access to the mailbox. However, this kind of locking
23891 does not work when the mailbox is NFS mounted.
23892
23893 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23894 &%use_flock_lock%& to control what kind of locking is used in implementing the
23895 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23896 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23897
23898
23899
23900
23901 .section "Operational details for appending" "SECTopappend"
23902 .cindex "appending to a file"
23903 .cindex "file" "appending"
23904 Before appending to a file, the following preparations are made:
23905
23906 .ilist
23907 If the name of the file is &_/dev/null_&, no action is taken, and a success
23908 return is given.
23909
23910 .next
23911 .cindex "directory creation"
23912 If any directories on the file's path are missing, Exim creates them if the
23913 &%create_directory%& option is set. A created directory's mode is given by the
23914 &%directory_mode%& option.
23915
23916 .next
23917 If &%file_format%& is set, the format of an existing file is checked. If this
23918 indicates that a different transport should be used, control is passed to that
23919 transport.
23920
23921 .next
23922 .cindex "file" "locking"
23923 .cindex "locking files"
23924 .cindex "NFS" "lock file"
23925 If &%use_lockfile%& is set, a lock file is built in a way that will work
23926 reliably over NFS, as follows:
23927
23928 .olist
23929 Create a &"hitching post"& file whose name is that of the lock file with the
23930 current time, primary host name, and process id added, by opening for writing
23931 as a new file. If this fails with an access error, delivery is deferred.
23932 .next
23933 Close the hitching post file, and hard link it to the lock filename.
23934 .next
23935 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23936 Unlink the hitching post name.
23937 .next
23938 Otherwise, use &[stat()]& to get information about the hitching post file, and
23939 then unlink hitching post name. If the number of links is exactly two, creation
23940 of the lock file succeeded but something (for example, an NFS server crash and
23941 restart) caused this fact not to be communicated to the &[link()]& call.
23942 .next
23943 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23944 up to &%lock_retries%& times. However, since any program that writes to a
23945 mailbox should complete its task very quickly, it is reasonable to time out old
23946 lock files that are normally the result of user agent and system crashes. If an
23947 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23948 it before trying again.
23949 .endlist olist
23950
23951 .next
23952 A call is made to &[lstat()]& to discover whether the main file exists, and if
23953 so, what its characteristics are. If &[lstat()]& fails for any reason other
23954 than non-existence, delivery is deferred.
23955
23956 .next
23957 .cindex "symbolic link" "to mailbox"
23958 .cindex "mailbox" "symbolic link"
23959 If the file does exist and is a symbolic link, delivery is deferred, unless the
23960 &%allow_symlink%& option is set, in which case the ownership of the link is
23961 checked, and then &[stat()]& is called to find out about the real file, which
23962 is then subjected to the checks below. The check on the top-level link
23963 ownership prevents one user creating a link for another's mailbox in a sticky
23964 directory, though allowing symbolic links in this case is definitely not a good
23965 idea. If there is a chain of symbolic links, the intermediate ones are not
23966 checked.
23967
23968 .next
23969 If the file already exists but is not a regular file, or if the file's owner
23970 and group (if the group is being checked &-- see &%check_group%& above) are
23971 different from the user and group under which the delivery is running,
23972 delivery is deferred.
23973
23974 .next
23975 If the file's permissions are more generous than specified, they are reduced.
23976 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23977 is set false, in which case the delivery is tried using the existing
23978 permissions.
23979
23980 .next
23981 The file's inode number is saved, and the file is then opened for appending.
23982 If this fails because the file has vanished, &(appendfile)& behaves as if it
23983 hadn't existed (see below). For any other failures, delivery is deferred.
23984
23985 .next
23986 If the file is opened successfully, check that the inode number hasn't
23987 changed, that it is still a regular file, and that the owner and permissions
23988 have not changed. If anything is wrong, defer delivery and freeze the message.
23989
23990 .next
23991 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23992 option is set. Otherwise, check that the file is being created in a permitted
23993 directory if the &%create_file%& option is set (deferring on failure), and then
23994 open for writing as a new file, with the O_EXCL and O_CREAT options,
23995 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23996 set). In this case, which can happen if the link points to a non-existent file,
23997 the file is opened for writing using O_CREAT but not O_EXCL, because
23998 that prevents link following.
23999
24000 .next
24001 .cindex "loop" "while file testing"
24002 If opening fails because the file exists, obey the tests given above for
24003 existing files. However, to avoid looping in a situation where the file is
24004 being continuously created and destroyed, the exists/not-exists loop is broken
24005 after 10 repetitions, and the message is then frozen.
24006
24007 .next
24008 If opening fails with any other error, defer delivery.
24009
24010 .next
24011 .cindex "file" "locking"
24012 .cindex "locking files"
24013 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24014 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24015 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24016 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24017 file, and an exclusive lock on the file whose name is
24018 .code
24019 /tmp/.<device-number>.<inode-number>
24020 .endd
24021 using the device and inode numbers of the open mailbox file, in accordance with
24022 the MBX locking rules. This file is created with a mode that is specified by
24023 the &%lockfile_mode%& option.
24024
24025 If Exim fails to lock the file, there are two possible courses of action,
24026 depending on the value of the locking timeout. This is obtained from
24027 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24028
24029 If the timeout value is zero, the file is closed, Exim waits for
24030 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24031 to lock it again. This happens up to &%lock_retries%& times, after which the
24032 delivery is deferred.
24033
24034 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24035 &[flock()]& are used (with the given timeout), so there has already been some
24036 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24037 immediately. It retries up to
24038 .code
24039 (lock_retries * lock_interval) / <timeout>
24040 .endd
24041 times (rounded up).
24042 .endlist
24043
24044 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24045 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24046
24047
24048 .section "Operational details for delivery to a new file" "SECTopdir"
24049 .cindex "delivery" "to single file"
24050 .cindex "&""From""& line"
24051 When the &%directory%& option is set instead of &%file%&, each message is
24052 delivered into a newly-created file or set of files. When &(appendfile)& is
24053 activated directly from a &(redirect)& router, neither &%file%& nor
24054 &%directory%& is normally set, because the path for delivery is supplied by the
24055 router. (See for example, the &(address_file)& transport in the default
24056 configuration.) In this case, delivery is to a new file if either the path name
24057 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24058
24059 No locking is required while writing the message to a new file, so the various
24060 locking options of the transport are ignored. The &"From"& line that by default
24061 separates messages in a single file is not normally needed, nor is the escaping
24062 of message lines that start with &"From"&, and there is no need to ensure a
24063 newline at the end of each message. Consequently, the default values for
24064 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24065 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24066
24067 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24068 the files in the delivery directory by default. However, you can specify a
24069 different directory by setting &%quota_directory%&. Also, for maildir
24070 deliveries (see below) the &_maildirfolder_& convention is honoured.
24071
24072
24073 .cindex "maildir format"
24074 .cindex "mailstore format"
24075 There are three different ways in which delivery to individual files can be
24076 done, controlled by the settings of the &%maildir_format%& and
24077 &%mailstore_format%& options. Note that code to support maildir or mailstore
24078 formats is not included in the binary unless SUPPORT_MAILDIR or
24079 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24080
24081 .cindex "directory creation"
24082 In all three cases an attempt is made to create the directory and any necessary
24083 sub-directories if they do not exist, provided that the &%create_directory%&
24084 option is set (the default). The location of a created directory can be
24085 constrained by setting &%create_file%&. A created directory's mode is given by
24086 the &%directory_mode%& option. If creation fails, or if the
24087 &%create_directory%& option is not set when creation is required, delivery is
24088 deferred.
24089
24090
24091
24092 .section "Maildir delivery" "SECTmaildirdelivery"
24093 .cindex "maildir format" "description of"
24094 If the &%maildir_format%& option is true, Exim delivers each message by writing
24095 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24096 directory that is defined by the &%directory%& option (the &"delivery
24097 directory"&). If the delivery is successful, the file is renamed into the
24098 &_new_& subdirectory.
24099
24100 In the filename, <&'stime'&> is the current time of day in seconds, and
24101 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24102 Exim checks that the time-of-day clock has moved on by at least one microsecond
24103 before terminating the delivery process. This guarantees uniqueness for the
24104 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24105 opening it. If any response other than ENOENT (does not exist) is given,
24106 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24107
24108 Before Exim carries out a maildir delivery, it ensures that subdirectories
24109 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24110 do not exist, Exim tries to create them and any superior directories in their
24111 path, subject to the &%create_directory%& and &%create_file%& options. If the
24112 &%maildirfolder_create_regex%& option is set, and the regular expression it
24113 contains matches the delivery directory, Exim also ensures that a file called
24114 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24115 &_maildirfolder_& file cannot be created, delivery is deferred.
24116
24117 These features make it possible to use Exim to create all the necessary files
24118 and directories in a maildir mailbox, including subdirectories for maildir++
24119 folders. Consider this example:
24120 .code
24121 maildir_format = true
24122 directory = /var/mail/$local_part_data\
24123            ${if eq{$local_part_suffix}{}{}\
24124            {/.${substr_1:$local_part_suffix}}}
24125 maildirfolder_create_regex = /\.[^/]+$
24126 .endd
24127 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24128 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24129 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24130 not match this name, so Exim will not look for or create the file
24131 &_/var/mail/pimbo/maildirfolder_&, though it will create
24132 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24133
24134 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24135 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24136 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24137 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24138 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24139
24140 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24141 not inadvertently match the toplevel maildir directory, because a
24142 &_maildirfolder_& file at top level would completely break quota calculations.
24143
24144 .cindex "quota" "in maildir delivery"
24145 .cindex "maildir++"
24146 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24147 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24148 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24149 Exim assumes the directory is a maildir++ folder directory, which is one level
24150 down from the user's top level mailbox directory. This causes it to start at
24151 the parent directory instead of the current directory when calculating the
24152 amount of space used.
24153
24154 One problem with delivering into a multi-file mailbox is that it is
24155 computationally expensive to compute the size of the mailbox for quota
24156 checking. Various approaches have been taken to reduce the amount of work
24157 needed. The next two sections describe two of them. A third alternative is to
24158 use some external process for maintaining the size data, and use the expansion
24159 of the &%mailbox_size%& option as a way of importing it into Exim.
24160
24161
24162
24163
24164 .section "Using tags to record message sizes" "SECID135"
24165 If &%maildir_tag%& is set, the string is expanded for each delivery.
24166 When the maildir file is renamed into the &_new_& sub-directory, the
24167 tag is added to its name. However, if adding the tag takes the length of the
24168 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24169 the tag is dropped and the maildir file is created with no tag.
24170
24171
24172 .vindex "&$message_size$&"
24173 Tags can be used to encode the size of files in their names; see
24174 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24175 happens after the message has been written. The value of the &$message_size$&
24176 variable is set to the number of bytes actually written. If the expansion is
24177 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24178 be deferred. The expanded tag may contain any printing characters except &"/"&.
24179 Non-printing characters in the string are ignored; if the resulting string is
24180 empty, it is ignored. If it starts with an alphanumeric character, a leading
24181 colon is inserted; this default has not proven to be the path that popular
24182 maildir implementations have chosen (but changing it in Exim would break
24183 backwards compatibility).
24184
24185 For one common implementation, you might set:
24186 .code
24187 maildir_tag = ,S=${message_size}
24188 .endd
24189 but you should check the documentation of the other software to be sure.
24190
24191 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24192 as this allows Exim to extract the size from your tag, instead of having to
24193 &[stat()]& each message file.
24194
24195
24196 .section "Using a maildirsize file" "SECID136"
24197 .cindex "quota" "in maildir delivery"
24198 .cindex "maildir format" "&_maildirsize_& file"
24199 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24200 storing quota and message size information in a file called &_maildirsize_&
24201 within the toplevel maildir directory. If this file does not exist, Exim
24202 creates it, setting the quota from the &%quota%& option of the transport. If
24203 the maildir directory itself does not exist, it is created before any attempt
24204 to write a &_maildirsize_& file.
24205
24206 The &_maildirsize_& file is used to hold information about the sizes of
24207 messages in the maildir, thus speeding up quota calculations. The quota value
24208 in the file is just a cache; if the quota is changed in the transport, the new
24209 value overrides the cached value when the next message is delivered. The cache
24210 is maintained for the benefit of other programs that access the maildir and
24211 need to know the quota.
24212
24213 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24214 file is maintained (with a zero quota setting), but no quota is imposed.
24215
24216 A regular expression is available for controlling which directories in the
24217 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24218 See the description of the &%maildir_quota_directory_regex%& option above for
24219 details.
24220
24221
24222 .section "Mailstore delivery" "SECID137"
24223 .cindex "mailstore format" "description of"
24224 If the &%mailstore_format%& option is true, each message is written as two
24225 files in the given directory. A unique base name is constructed from the
24226 message id and the current delivery process, and the files that are written use
24227 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24228 contains the message's envelope, and the &_.msg_& file contains the message
24229 itself. The base name is placed in the variable &$mailstore_basename$&.
24230
24231 During delivery, the envelope is first written to a file with the suffix
24232 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24233 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24234 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24235 file before accessing either of them. An alternative approach is to wait for
24236 the absence of a &_.tmp_& file.
24237
24238 The envelope file starts with any text defined by the &%mailstore_prefix%&
24239 option, expanded and terminated by a newline if there isn't one. Then follows
24240 the sender address on one line, then all the recipient addresses, one per line.
24241 There can be more than one recipient only if the &%batch_max%& option is set
24242 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24243 appended to the file, followed by a newline if it does not end with one.
24244
24245 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24246 failure, it is ignored. Other expansion errors are treated as serious
24247 configuration errors, and delivery is deferred. The variable
24248 &$mailstore_basename$& is available for use during these expansions.
24249
24250
24251 .section "Non-special new file delivery" "SECID138"
24252 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24253 file is created directly in the named directory. For example, when delivering
24254 messages into files in batched SMTP format for later delivery to some host (see
24255 section &<<SECTbatchSMTP>>&), a setting such as
24256 .code
24257 directory = /var/bsmtp/$host
24258 .endd
24259 might be used. A message is written to a file with a temporary name, which is
24260 then renamed when the delivery is complete. The final name is obtained by
24261 expanding the contents of the &%directory_file%& option.
24262 .ecindex IIDapptra1
24263 .ecindex IIDapptra2
24264
24265
24266
24267
24268
24269
24270 . ////////////////////////////////////////////////////////////////////////////
24271 . ////////////////////////////////////////////////////////////////////////////
24272
24273 .chapter "The autoreply transport" "CHID8"
24274 .scindex IIDauttra1 "transports" "&(autoreply)&"
24275 .scindex IIDauttra2 "&(autoreply)& transport"
24276 The &(autoreply)& transport is not a true transport in that it does not cause
24277 the message to be transmitted. Instead, it generates a new mail message as an
24278 automatic reply to the incoming message. &'References:'& and
24279 &'Auto-Submitted:'& header lines are included. These are constructed according
24280 to the rules in RFCs 2822 and 3834, respectively.
24281
24282 If the router that passes the message to this transport does not have the
24283 &%unseen%& option set, the original message (for the current recipient) is not
24284 delivered anywhere. However, when the &%unseen%& option is set on the router
24285 that passes the message to this transport, routing of the address continues, so
24286 another router can set up a normal message delivery.
24287
24288
24289 The &(autoreply)& transport is usually run as the result of mail filtering, a
24290 &"vacation"& message being the standard example. However, it can also be run
24291 directly from a router like any other transport. To reduce the possibility of
24292 message cascades, messages created by the &(autoreply)& transport always have
24293 empty envelope sender addresses, like bounce messages.
24294
24295 The parameters of the message to be sent can be specified in the configuration
24296 by options described below. However, these are used only when the address
24297 passed to the transport does not contain its own reply information. When the
24298 transport is run as a consequence of a
24299 &%mail%&
24300 or &%vacation%& command in a filter file, the parameters of the message are
24301 supplied by the filter, and passed with the address. The transport's options
24302 that define the message are then ignored (so they are not usually set in this
24303 case). The message is specified entirely by the filter or by the transport; it
24304 is never built from a mixture of options. However, the &%file_optional%&,
24305 &%mode%&, and &%return_message%& options apply in all cases.
24306
24307 &(Autoreply)& is implemented as a local transport. When used as a result of a
24308 command in a user's filter file, &(autoreply)& normally runs under the uid and
24309 gid of the user, and with appropriate current and home directories (see chapter
24310 &<<CHAPenvironment>>&).
24311
24312 There is a subtle difference between routing a message to a &(pipe)& transport
24313 that generates some text to be returned to the sender, and routing it to an
24314 &(autoreply)& transport. This difference is noticeable only if more than one
24315 address from the same message is so handled. In the case of a pipe, the
24316 separate outputs from the different addresses are gathered up and returned to
24317 the sender in a single message, whereas if &(autoreply)& is used, a separate
24318 message is generated for each address that is passed to it.
24319
24320 Non-printing characters are not permitted in the header lines generated for the
24321 message that &(autoreply)& creates, with the exception of newlines that are
24322 immediately followed by white space. If any non-printing characters are found,
24323 the transport defers.
24324 Whether characters with the top bit set count as printing characters or not is
24325 controlled by the &%print_topbitchars%& global option.
24326
24327 If any of the generic options for manipulating headers (for example,
24328 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24329 of the original message that is included in the generated message when
24330 &%return_message%& is set. They do not apply to the generated message itself.
24331
24332 .vindex "&$sender_address$&"
24333 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24334 the message, indicating that there were no recipients, it does not treat this
24335 as an error. This means that autoreplies sent to &$sender_address$& when this
24336 is empty (because the incoming message is a bounce message) do not cause
24337 problems. They are just discarded.
24338
24339
24340
24341 .section "Private options for autoreply" "SECID139"
24342 .cindex "options" "&(autoreply)& transport"
24343
24344 .option bcc autoreply string&!! unset
24345 This specifies the addresses that are to receive &"blind carbon copies"& of the
24346 message when the message is specified by the transport.
24347
24348
24349 .option cc autoreply string&!! unset
24350 This specifies recipients of the message and the contents of the &'Cc:'& header
24351 when the message is specified by the transport.
24352
24353
24354 .option file autoreply string&!! unset
24355 The contents of the file are sent as the body of the message when the message
24356 is specified by the transport. If both &%file%& and &%text%& are set, the text
24357 string comes first.
24358
24359
24360 .option file_expand autoreply boolean false
24361 If this is set, the contents of the file named by the &%file%& option are
24362 subjected to string expansion as they are added to the message.
24363
24364
24365 .option file_optional autoreply boolean false
24366 If this option is true, no error is generated if the file named by the &%file%&
24367 option or passed with the address does not exist or cannot be read.
24368
24369
24370 .option from autoreply string&!! unset
24371 This specifies the contents of the &'From:'& header when the message is
24372 specified by the transport.
24373
24374
24375 .option headers autoreply string&!! unset
24376 This specifies additional RFC 2822 headers that are to be added to the message
24377 when the message is specified by the transport. Several can be given by using
24378 &"\n"& to separate them. There is no check on the format.
24379
24380
24381 .option log autoreply string&!! unset
24382 This option names a file in which a record of every message sent is logged when
24383 the message is specified by the transport.
24384
24385
24386 .option mode autoreply "octal integer" 0600
24387 If either the log file or the &"once"& file has to be created, this mode is
24388 used.
24389
24390
24391 .option never_mail autoreply "address list&!!" unset
24392 If any run of the transport creates a message with a recipient that matches any
24393 item in the list, that recipient is quietly discarded. If all recipients are
24394 discarded, no message is created. This applies both when the recipients are
24395 generated by a filter and when they are specified in the transport.
24396
24397
24398
24399 .option once autoreply string&!! unset
24400 This option names a file or DBM database in which a record of each &'To:'&
24401 recipient is kept when the message is specified by the transport. &*Note*&:
24402 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24403
24404 If &%once%& is unset, or is set to an empty string, the message is always sent.
24405 By default, if &%once%& is set to a non-empty filename, the message
24406 is not sent if a potential recipient is already listed in the database.
24407 However, if the &%once_repeat%& option specifies a time greater than zero, the
24408 message is sent if that much time has elapsed since a message was last sent to
24409 this recipient. A setting of zero time for &%once_repeat%& (the default)
24410 prevents a message from being sent a second time &-- in this case, zero means
24411 infinity.
24412
24413 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24414 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24415 greater than zero, it changes the way Exim implements the &%once%& option.
24416 Instead of using a DBM file to record every recipient it sends to, it uses a
24417 regular file, whose size will never get larger than the given value.
24418
24419 In the file, Exim keeps a linear list of recipient addresses and the times at
24420 which they were sent messages. If the file is full when a new address needs to
24421 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24422 means that a given recipient may receive multiple messages, but at
24423 unpredictable intervals that depend on the rate of turnover of addresses in the
24424 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24425
24426
24427 .option once_file_size autoreply integer 0
24428 See &%once%& above.
24429
24430
24431 .option once_repeat autoreply time&!! 0s
24432 See &%once%& above.
24433 After expansion, the value of this option must be a valid time value.
24434
24435
24436 .option reply_to autoreply string&!! unset
24437 This specifies the contents of the &'Reply-To:'& header when the message is
24438 specified by the transport.
24439
24440
24441 .option return_message autoreply boolean false
24442 If this is set, a copy of the original message is returned with the new
24443 message, subject to the maximum size set in the &%return_size_limit%& global
24444 configuration option.
24445
24446
24447 .option subject autoreply string&!! unset
24448 This specifies the contents of the &'Subject:'& header when the message is
24449 specified by the transport. It is tempting to quote the original subject in
24450 automatic responses. For example:
24451 .code
24452 subject = Re: $h_subject:
24453 .endd
24454 There is a danger in doing this, however. It may allow a third party to
24455 subscribe your users to an opt-in mailing list, provided that the list accepts
24456 bounce messages as subscription confirmations. Well-managed lists require a
24457 non-bounce message to confirm a subscription, so the danger is relatively
24458 small.
24459
24460
24461
24462 .option text autoreply string&!! unset
24463 This specifies a single string to be used as the body of the message when the
24464 message is specified by the transport. If both &%text%& and &%file%& are set,
24465 the text comes first.
24466
24467
24468 .option to autoreply string&!! unset
24469 This specifies recipients of the message and the contents of the &'To:'& header
24470 when the message is specified by the transport.
24471 .ecindex IIDauttra1
24472 .ecindex IIDauttra2
24473
24474
24475
24476
24477 . ////////////////////////////////////////////////////////////////////////////
24478 . ////////////////////////////////////////////////////////////////////////////
24479
24480 .chapter "The lmtp transport" "CHAPLMTP"
24481 .cindex "transports" "&(lmtp)&"
24482 .cindex "&(lmtp)& transport"
24483 .cindex "LMTP" "over a pipe"
24484 .cindex "LMTP" "over a socket"
24485 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24486 specified command
24487 or by interacting with a Unix domain socket.
24488 This transport is something of a cross between the &(pipe)& and &(smtp)&
24489 transports. Exim also has support for using LMTP over TCP/IP; this is
24490 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24491 to be of minority interest, the default build-time configure in &_src/EDITME_&
24492 has it commented out. You need to ensure that
24493 .code
24494 TRANSPORT_LMTP=yes
24495 .endd
24496 .cindex "options" "&(lmtp)& transport"
24497 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24498 included in the Exim binary. The private options of the &(lmtp)& transport are
24499 as follows:
24500
24501 .option batch_id lmtp string&!! unset
24502 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24503
24504
24505 .option batch_max lmtp integer 1
24506 This limits the number of addresses that can be handled in a single delivery.
24507 Most LMTP servers can handle several addresses at once, so it is normally a
24508 good idea to increase this value. See the description of local delivery
24509 batching in chapter &<<CHAPbatching>>&.
24510
24511
24512 .option command lmtp string&!! unset
24513 This option must be set if &%socket%& is not set. The string is a command which
24514 is run in a separate process. It is split up into a command name and list of
24515 arguments, each of which is separately expanded (so expansion cannot change the
24516 number of arguments). The command is run directly, not via a shell. The message
24517 is passed to the new process using the standard input and output to operate the
24518 LMTP protocol.
24519
24520 .option ignore_quota lmtp boolean false
24521 .cindex "LMTP" "ignoring quota errors"
24522 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24523 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24524 in its response to the LHLO command.
24525
24526 .option socket lmtp string&!! unset
24527 This option must be set if &%command%& is not set. The result of expansion must
24528 be the name of a Unix domain socket. The transport connects to the socket and
24529 delivers the message to it using the LMTP protocol.
24530
24531
24532 .option timeout lmtp time 5m
24533 The transport is aborted if the created process or Unix domain socket does not
24534 respond to LMTP commands or message input within this timeout. Delivery
24535 is deferred, and will be tried again later. Here is an example of a typical
24536 LMTP transport:
24537 .code
24538 lmtp:
24539   driver = lmtp
24540   command = /some/local/lmtp/delivery/program
24541   batch_max = 20
24542   user = exim
24543 .endd
24544 This delivers up to 20 addresses at a time, in a mixture of domains if
24545 necessary, running as the user &'exim'&.
24546
24547
24548
24549 . ////////////////////////////////////////////////////////////////////////////
24550 . ////////////////////////////////////////////////////////////////////////////
24551
24552 .chapter "The pipe transport" "CHAPpipetransport"
24553 .scindex IIDpiptra1 "transports" "&(pipe)&"
24554 .scindex IIDpiptra2 "&(pipe)& transport"
24555 The &(pipe)& transport is used to deliver messages via a pipe to a command
24556 running in another process. One example is the use of &(pipe)& as a
24557 pseudo-remote transport for passing messages to some other delivery mechanism
24558 (such as UUCP). Another is the use by individual users to automatically process
24559 their incoming messages. The &(pipe)& transport can be used in one of the
24560 following ways:
24561
24562 .ilist
24563 .vindex "&$local_part$&"
24564 A router routes one address to a transport in the normal way, and the
24565 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24566 contains the local part of the address (as usual), and the command that is run
24567 is specified by the &%command%& option on the transport.
24568 .next
24569 .vindex "&$pipe_addresses$&"
24570 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24571 transport can handle more than one address in a single run. In this case, when
24572 more than one address is routed to the transport, &$local_part$& is not set
24573 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24574 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24575 that are routed to the transport.
24576 .next
24577 .vindex "&$address_pipe$&"
24578 A router redirects an address directly to a pipe command (for example, from an
24579 alias or forward file). In this case, &$address_pipe$& contains the text of the
24580 pipe command, and the &%command%& option on the transport is ignored unless
24581 &%force_command%& is set. If only one address is being transported
24582 (&%batch_max%& is not greater than one, or only one address was redirected to
24583 this pipe command), &$local_part$& contains the local part that was redirected.
24584 .endlist
24585
24586
24587 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24588 deliver messages over pipes using the LMTP interactive protocol. This is
24589 implemented by the &(lmtp)& transport.
24590
24591 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24592 &_.forward_& file, the command runs under the uid and gid of that user. In
24593 other cases, the uid and gid have to be specified explicitly, either on the
24594 transport or on the router that handles the address. Current and &"home"&
24595 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24596 details of the local delivery environment and chapter &<<CHAPbatching>>&
24597 for a discussion of local delivery batching.
24598
24599 .cindex "tainted data" "in pipe command"
24600 .cindex pipe "tainted data"
24601 Tainted data may not be used for the command name.
24602
24603
24604 .section "Concurrent delivery" "SECID140"
24605 If two messages arrive at almost the same time, and both are routed to a pipe
24606 delivery, the two pipe transports may be run concurrently. You must ensure that
24607 any pipe commands you set up are robust against this happening. If the commands
24608 write to a file, the &%exim_lock%& utility might be of use.
24609 Alternatively the &%max_parallel%& option could be used with a value
24610 of "1" to enforce serialization.
24611
24612
24613
24614
24615 .section "Returned status and data" "SECID141"
24616 .cindex "&(pipe)& transport" "returned data"
24617 If the command exits with a non-zero return code, the delivery is deemed to
24618 have failed, unless either the &%ignore_status%& option is set (in which case
24619 the return code is treated as zero), or the return code is one of those listed
24620 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24621 later"&. In this case, delivery is deferred. Details of a permanent failure are
24622 logged, but are not included in the bounce message, which merely contains
24623 &"local delivery failed"&.
24624
24625 If the command exits on a signal and the &%freeze_signal%& option is set then
24626 the message will be frozen in the queue. If that option is not set, a bounce
24627 will be sent as normal.
24628
24629 If the return code is greater than 128 and the command being run is a shell
24630 script, it normally means that the script was terminated by a signal whose
24631 value is the return code minus 128. The &%freeze_signal%& option does not
24632 apply in this case.
24633
24634 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24635 return code is set to 127. This is the value that a shell returns if it is
24636 asked to run a non-existent command. The wording for the log line suggests that
24637 a non-existent command may be the problem.
24638
24639 The &%return_output%& option can affect the result of a pipe delivery. If it is
24640 set and the command produces any output on its standard output or standard
24641 error streams, the command is considered to have failed, even if it gave a zero
24642 return code or if &%ignore_status%& is set. The output from the command is
24643 included as part of the bounce message. The &%return_fail_output%& option is
24644 similar, except that output is returned only when the command exits with a
24645 failure return code, that is, a value other than zero or a code that matches
24646 &%temp_errors%&.
24647
24648
24649
24650 .section "How the command is run" "SECThowcommandrun"
24651 .cindex "&(pipe)& transport" "path for command"
24652 The command line is (by default) broken down into a command name and arguments
24653 by the &(pipe)& transport itself. The &%allow_commands%& and
24654 &%restrict_to_path%& options can be used to restrict the commands that may be
24655 run.
24656
24657 .cindex "quoting" "in pipe command"
24658 Unquoted arguments are delimited by white space. If an argument appears in
24659 double quotes, backslash is interpreted as an escape character in the usual
24660 way. If an argument appears in single quotes, no escaping is done.
24661
24662 String expansion is applied to the command line except when it comes from a
24663 traditional &_.forward_& file (commands from a filter file are expanded). The
24664 expansion is applied to each argument in turn rather than to the whole line.
24665 For this reason, any string expansion item that contains white space must be
24666 quoted so as to be contained within a single argument. A setting such as
24667 .code
24668 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24669 .endd
24670 will not work, because the expansion item gets split between several
24671 arguments. You have to write
24672 .code
24673 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24674 .endd
24675 to ensure that it is all in one argument. The expansion is done in this way,
24676 argument by argument, so that the number of arguments cannot be changed as a
24677 result of expansion, and quotes or backslashes in inserted variables do not
24678 interact with external quoting. However, this leads to problems if you want to
24679 generate multiple arguments (or the command name plus arguments) from a single
24680 expansion. In this situation, the simplest solution is to use a shell. For
24681 example:
24682 .code
24683 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24684 .endd
24685
24686 .cindex "transport" "filter"
24687 .cindex "filter" "transport filter"
24688 .vindex "&$pipe_addresses$&"
24689 Special handling takes place when an argument consists of precisely the text
24690 &`$pipe_addresses`& (no quotes).
24691 This is not a general expansion variable; the only
24692 place this string is recognized is when it appears as an argument for a pipe or
24693 transport filter command. It causes each address that is being handled to be
24694 inserted in the argument list at that point &'as a separate argument'&. This
24695 avoids any problems with spaces or shell metacharacters, and is of use when a
24696 &(pipe)& transport is handling groups of addresses in a batch.
24697
24698 If &%force_command%& is enabled on the transport, special handling takes place
24699 for an argument that consists of precisely the text &`$address_pipe`&.  It
24700 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24701 argument is inserted in the argument list at that point
24702 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24703 the only item in the argument; in fact, if it were then &%force_command%&
24704 should behave as a no-op.  Rather, it should be used to adjust the command
24705 run while preserving the argument vector separation.
24706
24707 After splitting up into arguments and expansion, the resulting command is run
24708 in a subprocess directly from the transport, &'not'& under a shell. The
24709 message that is being delivered is supplied on the standard input, and the
24710 standard output and standard error are both connected to a single pipe that is
24711 read by Exim. The &%max_output%& option controls how much output the command
24712 may produce, and the &%return_output%& and &%return_fail_output%& options
24713 control what is done with it.
24714
24715 Not running the command under a shell (by default) lessens the security risks
24716 in cases when a command from a user's filter file is built out of data that was
24717 taken from an incoming message. If a shell is required, it can of course be
24718 explicitly specified as the command to be run. However, there are circumstances
24719 where existing commands (for example, in &_.forward_& files) expect to be run
24720 under a shell and cannot easily be modified. To allow for these cases, there is
24721 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24722 works. Instead of breaking up the command line as just described, it expands it
24723 as a single string and passes the result to &_/bin/sh_&. The
24724 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24725 with &%use_shell%&, and the whole mechanism is inherently less secure.
24726
24727
24728
24729 .section "Environment variables" "SECTpipeenv"
24730 .cindex "&(pipe)& transport" "environment for command"
24731 .cindex "environment" "&(pipe)& transport"
24732 The environment variables listed below are set up when the command is invoked.
24733 This list is a compromise for maximum compatibility with other MTAs. Note that
24734 the &%environment%& option can be used to add additional variables to this
24735 environment. The environment for the &(pipe)& transport is not subject
24736 to the &%add_environment%& and &%keep_environment%& main config options.
24737 &*Note*&: Using enviroment variables loses track of tainted data.
24738 Writers of &(pipe)& transport commands should be wary of data supplied
24739 by potential attackers.
24740 .display
24741 &`DOMAIN            `&   the domain of the address
24742 &`HOME              `&   the home directory, if set
24743 &`HOST              `&   the host name when called from a router (see below)
24744 &`LOCAL_PART        `&   see below
24745 &`LOCAL_PART_PREFIX `&   see below
24746 &`LOCAL_PART_SUFFIX `&   see below
24747 &`LOGNAME           `&   see below
24748 &`MESSAGE_ID        `&   Exim's local ID for the message
24749 &`PATH              `&   as specified by the &%path%& option below
24750 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24751 &`RECIPIENT         `&   the complete recipient address
24752 &`SENDER            `&   the sender of the message (empty if a bounce)
24753 &`SHELL             `&   &`/bin/sh`&
24754 &`TZ                `&   the value of the &%timezone%& option, if set
24755 &`USER              `&   see below
24756 .endd
24757 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24758 router, LOCAL_PART is set to the local part of the address. When it is
24759 called as a result of a forward or alias expansion, LOCAL_PART is set to
24760 the local part of the address that was expanded. In both cases, any affixes are
24761 removed from the local part, and made available in LOCAL_PART_PREFIX and
24762 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24763 same value as LOCAL_PART for compatibility with other MTAs.
24764
24765 .cindex "HOST"
24766 HOST is set only when a &(pipe)& transport is called from a router that
24767 associates hosts with an address, typically when using &(pipe)& as a
24768 pseudo-remote transport. HOST is set to the first host name specified by
24769 the router.
24770
24771 .cindex "HOME"
24772 If the transport's generic &%home_directory%& option is set, its value is used
24773 for the HOME environment variable. Otherwise, a home directory may be set
24774 by the router's &%transport_home_directory%& option, which defaults to the
24775 user's home directory if &%check_local_user%& is set.
24776
24777
24778 .section "Private options for pipe" "SECID142"
24779 .cindex "options" "&(pipe)& transport"
24780
24781
24782
24783 .option allow_commands pipe "string list&!!" unset
24784 .cindex "&(pipe)& transport" "permitted commands"
24785 The string is expanded, and is then interpreted as a colon-separated list of
24786 permitted commands. If &%restrict_to_path%& is not set, the only commands
24787 permitted are those in the &%allow_commands%& list. They need not be absolute
24788 paths; the &%path%& option is still used for relative paths. If
24789 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24790 in the &%allow_commands%& list, or a name without any slashes that is found on
24791 the path. In other words, if neither &%allow_commands%& nor
24792 &%restrict_to_path%& is set, there is no restriction on the command, but
24793 otherwise only commands that are permitted by one or the other are allowed. For
24794 example, if
24795 .code
24796 allow_commands = /usr/bin/vacation
24797 .endd
24798 and &%restrict_to_path%& is not set, the only permitted command is
24799 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24800 &%use_shell%& is set.
24801
24802
24803 .option batch_id pipe string&!! unset
24804 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24805
24806
24807 .option batch_max pipe integer 1
24808 This limits the number of addresses that can be handled in a single delivery.
24809 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24810
24811
24812 .option check_string pipe string unset
24813 As &(pipe)& writes the message, the start of each line is tested for matching
24814 &%check_string%&, and if it does, the initial matching characters are replaced
24815 by the contents of &%escape_string%&, provided both are set. The value of
24816 &%check_string%& is a literal string, not a regular expression, and the case of
24817 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24818 of &%check_string%& and &%escape_string%& are forced to values that implement
24819 the SMTP escaping protocol. Any settings made in the configuration file are
24820 ignored.
24821
24822
24823 .option command pipe string&!! unset
24824 This option need not be set when &(pipe)& is being used to deliver to pipes
24825 obtained directly from address redirections. In other cases, the option must be
24826 set, to provide a command to be run. It need not yield an absolute path (see
24827 the &%path%& option below). The command is split up into separate arguments by
24828 Exim, and each argument is separately expanded, as described in section
24829 &<<SECThowcommandrun>>& above.
24830
24831 .cindex "tainted data"
24832 No part of the resulting command may be tainted.
24833
24834
24835 .option environment pipe string&!! unset
24836 .cindex "&(pipe)& transport" "environment for command"
24837 .cindex "environment" "&(pipe)& transport"
24838 This option is used to add additional variables to the environment in which the
24839 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24840 a string which is expanded, and then interpreted as a colon-separated list of
24841 environment settings of the form <&'name'&>=<&'value'&>.
24842
24843
24844 .option escape_string pipe string unset
24845 See &%check_string%& above.
24846
24847
24848 .option freeze_exec_fail pipe boolean false
24849 .cindex "exec failure"
24850 .cindex "failure of exec"
24851 .cindex "&(pipe)& transport" "failure of exec"
24852 Failure to exec the command in a pipe transport is by default treated like
24853 any other failure while running the command. However, if &%freeze_exec_fail%&
24854 is set, failure to exec is treated specially, and causes the message to be
24855 frozen, whatever the setting of &%ignore_status%&.
24856
24857
24858 .option freeze_signal pipe boolean false
24859 .cindex "signal exit"
24860 .cindex "&(pipe)& transport", "signal exit"
24861 Normally if the process run by a command in a pipe transport exits on a signal,
24862 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24863 frozen in Exim's queue instead.
24864
24865
24866 .option force_command pipe boolean false
24867 .cindex "force command"
24868 .cindex "&(pipe)& transport", "force command"
24869 Normally when a router redirects an address directly to a pipe command
24870 the &%command%& option on the transport is ignored.  If &%force_command%&
24871 is set, the &%command%& option will used. This is especially
24872 useful for forcing a wrapper or additional argument to be added to the
24873 command. For example:
24874 .code
24875 command = /usr/bin/remote_exec myhost -- $address_pipe
24876 force_command
24877 .endd
24878
24879 Note that &$address_pipe$& is handled specially in &%command%& when
24880 &%force_command%& is set, expanding out to the original argument vector as
24881 separate items, similarly to a Unix shell &`"$@"`& construct.
24882
24883
24884 .option ignore_status pipe boolean false
24885 If this option is true, the status returned by the subprocess that is set up to
24886 run the command is ignored, and Exim behaves as if zero had been returned.
24887 Otherwise, a non-zero status or termination by signal causes an error return
24888 from the transport unless the status value is one of those listed in
24889 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24890
24891 &*Note*&: This option does not apply to timeouts, which do not return a status.
24892 See the &%timeout_defer%& option for how timeouts are handled.
24893
24894
24895 .option log_defer_output pipe boolean false
24896 .cindex "&(pipe)& transport" "logging output"
24897 If this option is set, and the status returned by the command is
24898 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24899 and any output was produced on stdout or stderr, the first line of it is
24900 written to the main log.
24901
24902
24903 .option log_fail_output pipe boolean false
24904 If this option is set, and the command returns any output on stdout or
24905 stderr, and also ends with a return code that is neither zero nor one of
24906 the return codes listed in &%temp_errors%& (that is, the delivery
24907 failed), the first line of output is written to the main log. This
24908 option and &%log_output%& are mutually exclusive.  Only one of them may
24909 be set.
24910
24911
24912 .option log_output pipe boolean false
24913 If this option is set and the command returns any output on stdout or
24914 stderr, the first line of output is written to the main log, whatever
24915 the return code. This option and &%log_fail_output%& are mutually
24916 exclusive. Only one of them may be set.
24917
24918
24919 .option max_output pipe integer 20K
24920 This specifies the maximum amount of output that the command may produce on its
24921 standard output and standard error file combined. If the limit is exceeded, the
24922 process running the command is killed. This is intended as a safety measure to
24923 catch runaway processes. The limit is applied independently of the settings of
24924 the options that control what is done with such output (for example,
24925 &%return_output%&). Because of buffering effects, the amount of output may
24926 exceed the limit by a small amount before Exim notices.
24927
24928
24929 .option message_prefix pipe string&!! "see below"
24930 The string specified here is expanded and output at the start of every message.
24931 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24932 .code
24933 message_prefix = \
24934   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24935   ${tod_bsdinbox}\n
24936 .endd
24937 .cindex "Cyrus"
24938 .cindex "&%tmail%&"
24939 .cindex "&""From""& line"
24940 This is required by the commonly used &_/usr/bin/vacation_& program.
24941 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24942 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24943 setting
24944 .code
24945 message_prefix =
24946 .endd
24947 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24948 &`\n`& to &`\r\n`& in &%message_prefix%&.
24949
24950
24951 .option message_suffix pipe string&!! "see below"
24952 The string specified here is expanded and output at the end of every message.
24953 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24954 The suffix can be suppressed by setting
24955 .code
24956 message_suffix =
24957 .endd
24958 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24959 &`\n`& to &`\r\n`& in &%message_suffix%&.
24960
24961
24962 .option path pipe string&!! "/bin:/usr/bin"
24963 This option is expanded and
24964 specifies the string that is set up in the PATH environment
24965 variable of the subprocess.
24966 If the &%command%& option does not yield an absolute path name, the command is
24967 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24968 apply to a command specified as a transport filter.
24969
24970
24971 .option permit_coredump pipe boolean false
24972 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24973 a core-dump of a pipe command, enable this command.  This enables core-dumps
24974 during delivery and affects both the Exim binary and the pipe command run.
24975 It is recommended that this option remain off unless and until you have a need
24976 for it and that this only be enabled when needed, as the risk of excessive
24977 resource consumption can be quite high.  Note also that Exim is typically
24978 installed as a setuid binary and most operating systems will inhibit coredumps
24979 of these by default, so further OS-specific action may be required.
24980
24981
24982 .option pipe_as_creator pipe boolean false
24983 .cindex "uid (user id)" "local delivery"
24984 If the generic &%user%& option is not set and this option is true, the delivery
24985 process is run under the uid that was in force when Exim was originally called
24986 to accept the message. If the group id is not otherwise set (via the generic
24987 &%group%& option), the gid that was in force when Exim was originally called to
24988 accept the message is used.
24989
24990
24991 .option restrict_to_path pipe boolean false
24992 When this option is set, any command name not listed in &%allow_commands%& must
24993 contain no slashes. The command is searched for only in the directories listed
24994 in the &%path%& option. This option is intended for use in the case when a pipe
24995 command has been generated from a user's &_.forward_& file. This is usually
24996 handled by a &(pipe)& transport called &%address_pipe%&.
24997
24998
24999 .option return_fail_output pipe boolean false
25000 If this option is true, and the command produced any output and ended with a
25001 return code other than zero or one of the codes listed in &%temp_errors%& (that
25002 is, the delivery failed), the output is returned in the bounce message.
25003 However, if the message has a null sender (that is, it is itself a bounce
25004 message), output from the command is discarded. This option and
25005 &%return_output%& are mutually exclusive. Only one of them may be set.
25006
25007
25008
25009 .option return_output pipe boolean false
25010 If this option is true, and the command produced any output, the delivery is
25011 deemed to have failed whatever the return code from the command, and the output
25012 is returned in the bounce message. Otherwise, the output is just discarded.
25013 However, if the message has a null sender (that is, it is a bounce message),
25014 output from the command is always discarded, whatever the setting of this
25015 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25016 of them may be set.
25017
25018
25019
25020 .option temp_errors pipe "string list" "see below"
25021 .cindex "&(pipe)& transport" "temporary failure"
25022 This option contains either a colon-separated list of numbers, or a single
25023 asterisk. If &%ignore_status%& is false
25024 and &%return_output%& is not set,
25025 and the command exits with a non-zero return code, the failure is treated as
25026 temporary and the delivery is deferred if the return code matches one of the
25027 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25028 codes are treated as permanent errors. The default setting contains the codes
25029 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25030 compiled on a system that does not define these macros, it assumes values of 75
25031 and 73, respectively.
25032
25033
25034 .option timeout pipe time 1h
25035 If the command fails to complete within this time, it is killed. This normally
25036 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25037 specifies no timeout. In order to ensure that any subprocesses created by the
25038 command are also killed, Exim makes the initial process a process group leader,
25039 and kills the whole process group on a timeout. However, this can be defeated
25040 if one of the processes starts a new process group.
25041
25042 .option timeout_defer pipe boolean false
25043 A timeout in a &(pipe)& transport, either in the command that the transport
25044 runs, or in a transport filter that is associated with it, is by default
25045 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25046 is set true, both kinds of timeout become temporary errors, causing the
25047 delivery to be deferred.
25048
25049 .option umask pipe "octal integer" 022
25050 This specifies the umask setting for the subprocess that runs the command.
25051
25052
25053 .option use_bsmtp pipe boolean false
25054 .cindex "envelope sender"
25055 If this option is set true, the &(pipe)& transport writes messages in &"batch
25056 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25057 commands. If you want to include a leading HELO command with such messages,
25058 you can do so by setting the &%message_prefix%& option. See section
25059 &<<SECTbatchSMTP>>& for details of batch SMTP.
25060
25061 .option use_classresources pipe boolean false
25062 .cindex "class resources (BSD)"
25063 This option is available only when Exim is running on FreeBSD, NetBSD, or
25064 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25065 resource limits when a &(pipe)& transport is run to perform a delivery. The
25066 limits for the uid under which the pipe is to run are obtained from the login
25067 class database.
25068
25069
25070 .option use_crlf pipe boolean false
25071 .cindex "carriage return"
25072 .cindex "linefeed"
25073 This option causes lines to be terminated with the two-character CRLF sequence
25074 (carriage return, linefeed) instead of just a linefeed character. In the case
25075 of batched SMTP, the byte sequence written to the pipe is then an exact image
25076 of what would be sent down a real SMTP connection.
25077
25078 The contents of the &%message_prefix%& and &%message_suffix%& options are
25079 written verbatim, so must contain their own carriage return characters if these
25080 are needed. When &%use_bsmtp%& is not set, the default values for both
25081 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25082 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25083
25084
25085 .option use_shell pipe boolean false
25086 .vindex "&$pipe_addresses$&"
25087 If this option is set, it causes the command to be passed to &_/bin/sh_&
25088 instead of being run directly from the transport, as described in section
25089 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25090 where the command is expected to be run under a shell and cannot easily be
25091 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25092 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25093 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25094 its &%-c%& option.
25095
25096
25097
25098 .section "Using an external local delivery agent" "SECID143"
25099 .cindex "local delivery" "using an external agent"
25100 .cindex "&'procmail'&"
25101 .cindex "external local delivery"
25102 .cindex "delivery" "&'procmail'&"
25103 .cindex "delivery" "by external agent"
25104 The &(pipe)& transport can be used to pass all messages that require local
25105 delivery to a separate local delivery agent such as &%procmail%&. When doing
25106 this, care must be taken to ensure that the pipe is run under an appropriate
25107 uid and gid. In some configurations one wants this to be a uid that is trusted
25108 by the delivery agent to supply the correct sender of the message. It may be
25109 necessary to recompile or reconfigure the delivery agent so that it trusts an
25110 appropriate user. The following is an example transport and router
25111 configuration for &%procmail%&:
25112 .code
25113 # transport
25114 procmail_pipe:
25115   driver = pipe
25116   command = /usr/local/bin/procmail -d $local_part_data
25117   return_path_add
25118   delivery_date_add
25119   envelope_to_add
25120   check_string = "From "
25121   escape_string = ">From "
25122   umask = 077
25123   user = $local_part_data
25124   group = mail
25125
25126 # router
25127 procmail:
25128   driver = accept
25129   check_local_user
25130   transport = procmail_pipe
25131 .endd
25132 In this example, the pipe is run as the local user, but with the group set to
25133 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25134 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25135 user to supply a correct sender address. If you do not specify either a
25136 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25137 home directory is the user's home directory by default.
25138
25139 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25140 .code
25141 IFS=" "
25142 .endd
25143 as shown in some &%procmail%& documentation, because Exim does not by default
25144 use a shell to run pipe commands.
25145
25146 .cindex "Cyrus"
25147 The next example shows a transport and a router for a system where local
25148 deliveries are handled by the Cyrus IMAP server.
25149 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25150 . but that suffix is tainted so cannot be used in a command arg
25151 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25152 .code
25153 # transport
25154 local_delivery_cyrus:
25155   driver = pipe
25156   command = /usr/cyrus/bin/deliver \
25157             -- $local_part_data
25158   user = cyrus
25159   group = mail
25160   return_output
25161   log_output
25162   message_prefix =
25163   message_suffix =
25164
25165 # router
25166 local_user_cyrus:
25167   driver = accept
25168   check_local_user
25169   transport = local_delivery_cyrus
25170 .endd
25171 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25172 &%return_output%& to cause any text written by Cyrus to be returned to the
25173 sender.
25174 .ecindex IIDpiptra1
25175 .ecindex IIDpiptra2
25176
25177
25178 . ////////////////////////////////////////////////////////////////////////////
25179 . ////////////////////////////////////////////////////////////////////////////
25180
25181 .chapter "The smtp transport" "CHAPsmtptrans"
25182 .scindex IIDsmttra1 "transports" "&(smtp)&"
25183 .scindex IIDsmttra2 "&(smtp)& transport"
25184 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25185 or LMTP protocol. The list of hosts to try can either be taken from the address
25186 that is being processed (having been set up by the router), or specified
25187 explicitly for the transport. Timeout and retry processing (see chapter
25188 &<<CHAPretry>>&) is applied to each IP address independently.
25189
25190
25191 .section "Multiple messages on a single connection" "SECID144"
25192 The sending of multiple messages over a single TCP/IP connection can arise in
25193 two ways:
25194
25195 .ilist
25196 If a message contains more than &%max_rcpt%& (see below) addresses that are
25197 routed to the same host, more than one copy of the message has to be sent to
25198 that host. In this situation, multiple copies may be sent in a single run of
25199 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25200 does when it has too many addresses to send in one message also depends on the
25201 value of the global &%remote_max_parallel%& option. Details are given in
25202 section &<<SECToutSMTPTCP>>&.)
25203 .next
25204 .cindex "hints database" "remembering routing"
25205 When a message has been successfully delivered over a TCP/IP connection, Exim
25206 looks in its hints database to see if there are any other messages awaiting a
25207 connection to the same host. If there are, a new delivery process is started
25208 for one of them, and the current TCP/IP connection is passed on to it. The new
25209 process may in turn send multiple copies and possibly create yet another
25210 process.
25211 .endlist
25212
25213
25214 For each copy sent over the same TCP/IP connection, a sequence counter is
25215 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25216 no further messages are sent over that connection.
25217
25218
25219
25220 .section "Use of the $host and $host_address variables" "SECID145"
25221 .vindex "&$host$&"
25222 .vindex "&$host_address$&"
25223 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25224 &$host_address$& are the name and IP address of the first host on the host list
25225 passed by the router. However, when the transport is about to connect to a
25226 specific host, and while it is connected to that host, &$host$& and
25227 &$host_address$& are set to the values for that host. These are the values
25228 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25229 &%serialize_hosts%&, and the various TLS options are expanded.
25230
25231
25232 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25233 .vindex &$tls_bits$&
25234 .vindex &$tls_cipher$&
25235 .vindex &$tls_peerdn$&
25236 .vindex &$tls_sni$&
25237 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25238 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25239 are the values that were set when the message was received.
25240 These are the values that are used for options that are expanded before any
25241 SMTP connections are made. Just before each connection is made, these four
25242 variables are emptied. If TLS is subsequently started, they are set to the
25243 appropriate values for the outgoing connection, and these are the values that
25244 are in force when any authenticators are run and when the
25245 &%authenticated_sender%& option is expanded.
25246
25247 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25248 and will be removed in a future release.
25249
25250
25251 .section "Private options for smtp" "SECID146"
25252 .cindex "options" "&(smtp)& transport"
25253 The private options of the &(smtp)& transport are as follows:
25254
25255
25256 .option address_retry_include_sender smtp boolean true
25257 .cindex "4&'xx'& responses" "retrying after"
25258 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25259 is the combination of sender and recipient that is delayed in subsequent queue
25260 runs until the retry time is reached. You can delay the recipient without
25261 reference to the sender (which is what earlier versions of Exim did), by
25262 setting &%address_retry_include_sender%& false. However, this can lead to
25263 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25264
25265 .option allow_localhost smtp boolean false
25266 .cindex "local host" "sending to"
25267 .cindex "fallback" "hosts specified on transport"
25268 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25269 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25270 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25271 the delivery anyway. This should be used only in special cases when the
25272 configuration ensures that no looping will result (for example, a differently
25273 configured Exim is listening on the port to which the message is sent).
25274
25275
25276 .option authenticated_sender smtp string&!! unset
25277 .cindex "Cyrus"
25278 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25279 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25280 overriding any existing authenticated sender value. If the string expansion is
25281 forced to fail, the option is ignored. Other expansion failures cause delivery
25282 to be deferred. If the result of expansion is an empty string, that is also
25283 ignored.
25284
25285 The expansion happens after the outgoing connection has been made and TLS
25286 started, if required. This means that the &$host$&, &$host_address$&,
25287 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25288 particular connection.
25289
25290 If the SMTP session is not authenticated, the expansion of
25291 &%authenticated_sender%& still happens (and can cause the delivery to be
25292 deferred if it fails), but no AUTH= item is added to MAIL commands
25293 unless &%authenticated_sender_force%& is true.
25294
25295 This option allows you to use the &(smtp)& transport in LMTP mode to
25296 deliver mail to Cyrus IMAP and provide the proper local part as the
25297 &"authenticated sender"&, via a setting such as:
25298 .code
25299 authenticated_sender = $local_part
25300 .endd
25301 This removes the need for IMAP subfolders to be assigned special ACLs to
25302 allow direct delivery to those subfolders.
25303
25304 Because of expected uses such as that just described for Cyrus (when no
25305 domain is involved), there is no checking on the syntax of the provided
25306 value.
25307
25308
25309 .option authenticated_sender_force smtp boolean false
25310 If this option is set true, the &%authenticated_sender%& option's value
25311 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25312 authenticated as a client.
25313
25314
25315 .option command_timeout smtp time 5m
25316 .cindex timeout "smtp transport command"
25317 This sets a timeout for receiving a response to an SMTP command that has been
25318 sent out. It is also used when waiting for the initial banner line from the
25319 remote host. Its value must not be zero.
25320
25321
25322 .option connect_timeout smtp time 5m
25323 .cindex timeout "smtp transport connect"
25324 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25325 to a remote host. A setting of zero allows the system timeout (typically
25326 several minutes) to act. To have any effect, the value of this option must be
25327 less than the system timeout. However, it has been observed that on some
25328 systems there is no system timeout, which is why the default value for this
25329 option is 5 minutes, a value recommended by RFC 1123.
25330
25331
25332 .option connection_max_messages smtp integer 500
25333 .cindex "SMTP" "passed connection"
25334 .cindex "SMTP" "multiple deliveries"
25335 .cindex "multiple SMTP deliveries"
25336 This controls the maximum number of separate message deliveries that are sent
25337 over a single TCP/IP connection. If the value is zero, there is no limit.
25338 For testing purposes, this value can be overridden by the &%-oB%& command line
25339 option.
25340
25341
25342 .option dane_require_tls_ciphers smtp string&!! unset
25343 .cindex "TLS" "requiring specific ciphers for DANE"
25344 .cindex "cipher" "requiring specific"
25345 .cindex DANE "TLS ciphers"
25346 This option may be used to override &%tls_require_ciphers%& for connections
25347 where DANE has been determined to be in effect.
25348 If not set, then &%tls_require_ciphers%& will be used.
25349 Normal SMTP delivery is not able to make strong demands of TLS cipher
25350 configuration, because delivery will fall back to plaintext.  Once DANE has
25351 been determined to be in effect, there is no plaintext fallback and making the
25352 TLS cipherlist configuration stronger will increase security, rather than
25353 counter-intuitively decreasing it.
25354 If the option expands to be empty or is forced to fail, then it will
25355 be treated as unset and &%tls_require_ciphers%& will be used instead.
25356
25357
25358 .option data_timeout smtp time 5m
25359 .cindex timeout "for transmitted SMTP data blocks"
25360 This sets a timeout for the transmission of each block in the data portion of
25361 the message. As a result, the overall timeout for a message depends on the size
25362 of the message. Its value must not be zero. See also &%final_timeout%&.
25363
25364
25365 .option dkim_canon smtp string&!! unset
25366 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25367 .option dkim_domain smtp "string list&!!" unset
25368 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25369 .option dkim_hash smtp string&!! sha256
25370 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25371 .option dkim_identity smtp string&!! unset
25372 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25373 .option dkim_private_key smtp string&!! unset
25374 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25375 .option dkim_selector smtp string&!! unset
25376 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25377 .option dkim_strict smtp string&!! unset
25378 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25379 .option dkim_sign_headers smtp string&!! "per RFC"
25380 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25381 .option dkim_timestamps smtp string&!! unset
25382 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25383
25384
25385 .option delay_after_cutoff smtp boolean true
25386 .cindex "final cutoff" "retries, controlling"
25387 .cindex retry "final cutoff"
25388 This option controls what happens when all remote IP addresses for a given
25389 domain have been inaccessible for so long that they have passed their retry
25390 cutoff times.
25391
25392 In the default state, if the next retry time has not been reached for any of
25393 them, the address is bounced without trying any deliveries. In other words,
25394 Exim delays retrying an IP address after the final cutoff time until a new
25395 retry time is reached, and can therefore bounce an address without ever trying
25396 a delivery, when machines have been down for a long time. Some people are
25397 unhappy at this prospect, so...
25398
25399 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25400 addresses are past their final cutoff time, Exim tries to deliver to those
25401 IP addresses that have not been tried since the message arrived. If there are
25402 none, of if they all fail, the address is bounced. In other words, it does not
25403 delay when a new message arrives, but immediately tries those expired IP
25404 addresses that haven't been tried since the message arrived. If there is a
25405 continuous stream of messages for the dead hosts, unsetting
25406 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25407 to them.
25408
25409
25410 .option dns_qualify_single smtp boolean true
25411 If the &%hosts%& or &%fallback_hosts%& option is being used,
25412 and the &%gethostbyname%& option is false,
25413 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25414 in chapter &<<CHAPdnslookup>>& for more details.
25415
25416
25417 .option dns_search_parents smtp boolean false
25418 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25419 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25420 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25421 details.
25422
25423
25424 .option dnssec_request_domains smtp "domain list&!!" *
25425 .cindex "MX record" "security"
25426 .cindex "DNSSEC" "MX lookup"
25427 .cindex "security" "MX lookup"
25428 .cindex "DNS" "DNSSEC"
25429 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25430 the DNSSEC request bit set. Setting this transport option is only useful if the
25431 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25432 router option.
25433
25434
25435
25436 .option dnssec_require_domains smtp "domain list&!!" unset
25437 .cindex "MX record" "security"
25438 .cindex "DNSSEC" "MX lookup"
25439 .cindex "security" "MX lookup"
25440 .cindex "DNS" "DNSSEC"
25441 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25442 the DNSSEC request bit set.  Setting this transport option is only
25443 useful if the transport overrides or sets the host names. See the
25444 &%dnssec_require_domains%& router option.
25445
25446
25447
25448 .option dscp smtp string&!! unset
25449 .cindex "DCSP" "outbound"
25450 This option causes the DSCP value associated with a socket to be set to one
25451 of a number of fixed strings or to numeric value.
25452 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25453 Common values include &`throughput`&, &`mincost`&, and on newer systems
25454 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25455
25456 The outbound packets from Exim will be marked with this value in the header
25457 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25458 that these values will have any effect, not be stripped by networking
25459 equipment, or do much of anything without cooperation with your Network
25460 Engineer and those of all network operators between the source and destination.
25461
25462
25463 .option fallback_hosts smtp "string list" unset
25464 .cindex "fallback" "hosts specified on transport"
25465 String expansion is not applied to this option. The argument must be a
25466 colon-separated list of host names or IP addresses, optionally also including
25467 port numbers, though the separator can be changed, as described in section
25468 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25469 item in a &%route_list%& setting for the &(manualroute)& router, as described
25470 in section &<<SECTformatonehostitem>>&.
25471
25472 Fallback hosts can also be specified on routers, which associate them with the
25473 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25474 &%fallback_hosts%& specified on the transport is used only if the address does
25475 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25476 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25477 However, &%hosts_randomize%& does apply to fallback host lists.
25478
25479 If Exim is unable to deliver to any of the hosts for a particular address, and
25480 the errors are not permanent rejections, the address is put on a separate
25481 transport queue with its host list replaced by the fallback hosts, unless the
25482 address was routed via MX records and the current host was in the original MX
25483 list. In that situation, the fallback host list is not used.
25484
25485 Once normal deliveries are complete, the fallback queue is delivered by
25486 re-running the same transports with the new host lists. If several failing
25487 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25488 copy of the message is sent.
25489
25490 The resolution of the host names on the fallback list is controlled by the
25491 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25492 both to cases when the host list comes with the address and when it is taken
25493 from &%hosts%&. This option provides a &"use a smart host only if delivery
25494 fails"& facility.
25495
25496
25497 .option final_timeout smtp time 10m
25498 .cindex timeout "for transmitted SMTP data accept"
25499 This is the timeout that applies while waiting for the response to the final
25500 line containing just &"."& that terminates a message. Its value must not be
25501 zero.
25502
25503 .option gethostbyname smtp boolean false
25504 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25505 being used, names are looked up using &[gethostbyname()]&
25506 (or &[getipnodebyname()]& when available)
25507 instead of using the DNS. Of course, that function may in fact use the DNS, but
25508 it may also consult other sources of information such as &_/etc/hosts_&.
25509
25510 .option gnutls_compat_mode smtp boolean unset
25511 This option controls whether GnuTLS is used in compatibility mode in an Exim
25512 server. This reduces security slightly, but improves interworking with older
25513 implementations of TLS.
25514
25515 .option helo_data smtp string&!! "see below"
25516 .cindex "HELO" "argument, setting"
25517 .cindex "EHLO" "argument, setting"
25518 .cindex "LHLO argument setting"
25519 The value of this option is expanded after a connection to a another host has
25520 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25521 command that starts the outgoing SMTP or LMTP session. The default value of the
25522 option is:
25523 .code
25524 $primary_hostname
25525 .endd
25526 During the expansion, the variables &$host$& and &$host_address$& are set to
25527 the identity of the remote host, and the variables &$sending_ip_address$& and
25528 &$sending_port$& are set to the local IP address and port number that are being
25529 used. These variables can be used to generate different values for different
25530 servers or different local IP addresses. For example, if you want the string
25531 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25532 interface address, you could use this:
25533 .code
25534 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25535   {${listextract{1}{<\n $value}}} \
25536   {$primary_hostname}}
25537 .endd
25538 The use of &%helo_data%& applies both to sending messages and when doing
25539 callouts.
25540
25541 .option host_name_extract smtp "string list&!!" "see below"
25542 .cindex "load balancer" "hosts behind"
25543 .cindex TLS resumption
25544 Some mail-accepting sites
25545 (notably Microsoft)
25546 operate many servers behind a network load-balancer.  When this is done,
25547 with separated TLS session caches, TLS session resuption becomes problematic.
25548 It will only succeed when the same server happens to be selected by the
25549 load-balancer, matching the session stored in the client's cache.
25550
25551 Exim can pull out a server name, if there is one, from the response to the
25552 client's SMTP EHLO command.
25553 The default value of this option:
25554 .code
25555     ${if and { {match {$host} {.outlook.com\$}} \
25556                {match {$item} {\N^250-([\w.]+)\s\N}} \
25557              } {$1}}
25558 .endd
25559 suffices for one known case.
25560 During the expansion of this option the &$item$& variable will have the
25561 server's EHLO response.
25562 The result of the option expansion is included in the key used to store and
25563 retrieve the TLS session, for session resumption.
25564
25565 Operators of high-load sites may wish to evaluate their logs for indications
25566 of other destination sites operating load-balancers, and develop a suitable
25567 expression for this option.
25568 The smtp:ehlo event and the &$tls_out_resumption$& variable
25569 will be useful for such work.
25570
25571 .option hosts smtp "string list&!!" unset
25572 Hosts are associated with an address by a router such as &(dnslookup)&, which
25573 finds the hosts by looking up the address domain in the DNS, or by
25574 &(manualroute)&, which has lists of hosts in its configuration. However,
25575 email addresses can be passed to the &(smtp)& transport by any router, and not
25576 all of them can provide an associated list of hosts.
25577
25578 The &%hosts%& option specifies a list of hosts to be used if the address being
25579 processed does not have any hosts associated with it. The hosts specified by
25580 &%hosts%& are also used, whether or not the address has its own hosts, if
25581 &%hosts_override%& is set.
25582
25583 The string is first expanded, before being interpreted as a colon-separated
25584 list of host names or IP addresses, possibly including port numbers. The
25585 separator may be changed to something other than colon, as described in section
25586 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25587 item in a &%route_list%& setting for the &(manualroute)& router, as described
25588 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25589 of the &(manualroute)& router is not available here.
25590
25591 If the expansion fails, delivery is deferred. Unless the failure was caused by
25592 the inability to complete a lookup, the error is logged to the panic log as
25593 well as the main log. Host names are looked up either by searching directly for
25594 address records in the DNS or by calling &[gethostbyname()]& (or
25595 &[getipnodebyname()]& when available), depending on the setting of the
25596 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25597 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25598 address are used.
25599
25600 During delivery, the hosts are tried in order, subject to their retry status,
25601 unless &%hosts_randomize%& is set.
25602
25603
25604 .option hosts_avoid_esmtp smtp "host list&!!" unset
25605 .cindex "ESMTP, avoiding use of"
25606 .cindex "HELO" "forcing use of"
25607 .cindex "EHLO" "avoiding use of"
25608 .cindex "PIPELINING" "avoiding the use of"
25609 This option is for use with broken hosts that announce ESMTP facilities (for
25610 example, PIPELINING) and then fail to implement them properly. When a host
25611 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25612 start of the SMTP session. This means that it cannot use any of the ESMTP
25613 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25614
25615
25616 .option hosts_avoid_pipelining smtp "host list&!!" unset
25617 .cindex "PIPELINING" "avoiding the use of"
25618 .cindex "ESMTP extensions" PIPELINING
25619 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25620 that matches this list, even if the server host advertises PIPELINING support.
25621
25622 .option hosts_pipe_connect smtp "host list&!!" unset
25623 .cindex "pipelining" "early connection"
25624 .cindex "pipelining" PIPECONNECT
25625 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25626 this option controls which to hosts the facility watched for
25627 and recorded, and used for subsequent connections.
25628
25629 The retry hints database is used for the record,
25630 and records are subject to the &%retry_data_expire%& option.
25631 When used, the pipelining saves on roundtrip times.
25632 It also turns SMTP into a client-first protocol
25633 so combines well with TCP Fast Open.
25634
25635 See also the &%pipelining_connect_advertise_hosts%& main option.
25636
25637 Note:
25638 When the facility is used, if the transport &%interface%& option is unset
25639 the &%helo_data%& option
25640 will be expanded before the &$sending_ip_address$& variable
25641 is filled in.
25642 A check is made for the use of that variable, without the
25643 presence of a &"def:"& test on it, but suitably complex coding
25644 can avoid the check and produce unexpected results.
25645 You have been warned.
25646
25647
25648 .option hosts_avoid_tls smtp "host list&!!" unset
25649 .cindex "TLS" "avoiding for certain hosts"
25650 Exim will not try to start a TLS session when delivering to any host that
25651 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25652
25653 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25654 .cindex "TLS" "avoiding for certain hosts"
25655 Exim will not try to start a TLS session for a verify callout,
25656 or when delivering in cutthrough mode,
25657 to any host that matches this list.
25658
25659
25660 .option hosts_max_try smtp integer 5
25661 .cindex "host" "maximum number to try"
25662 .cindex "limit" "number of hosts tried"
25663 .cindex "limit" "number of MX tried"
25664 .cindex "MX record" "maximum tried"
25665 This option limits the number of IP addresses that are tried for any one
25666 delivery in cases where there are temporary delivery errors. Section
25667 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25668
25669
25670 .option hosts_max_try_hardlimit smtp integer 50
25671 This is an additional check on the maximum number of IP addresses that Exim
25672 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25673 why it exists.
25674
25675
25676
25677 .option hosts_nopass_tls smtp "host list&!!" unset
25678 .cindex "TLS" "passing connection"
25679 .cindex "multiple SMTP deliveries"
25680 .cindex "TLS" "multiple message deliveries"
25681 For any host that matches this list, a connection on which a TLS session has
25682 been started will not be passed to a new delivery process for sending another
25683 message on the same connection. See section &<<SECTmulmessam>>& for an
25684 explanation of when this might be needed.
25685
25686 .option hosts_noproxy_tls smtp "host list&!!" unset
25687 .cindex "TLS" "passing connection"
25688 .cindex "multiple SMTP deliveries"
25689 .cindex "TLS" "multiple message deliveries"
25690 For any host that matches this list, a TLS session which has
25691 been started will not be passed to a new delivery process for sending another
25692 message on the same session.
25693
25694 The traditional implementation closes down TLS and re-starts it in the new
25695 process, on the same open TCP connection, for each successive message
25696 sent.  If permitted by this option a pipe to to the new process is set up
25697 instead, and the original process maintains the TLS connection and proxies
25698 the SMTP connection from and to the new process and any subsequents.
25699 The new process has no access to TLS information, so cannot include it in
25700 logging.
25701
25702
25703
25704 .option hosts_override smtp boolean false
25705 If this option is set and the &%hosts%& option is also set, any hosts that are
25706 attached to the address are ignored, and instead the hosts specified by the
25707 &%hosts%& option are always used. This option does not apply to
25708 &%fallback_hosts%&.
25709
25710
25711 .option hosts_randomize smtp boolean false
25712 .cindex "randomized host list"
25713 .cindex "host" "list of; randomized"
25714 .cindex "fallback" "randomized hosts"
25715 If this option is set, and either the list of hosts is taken from the
25716 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25717 were not obtained from MX records (this includes fallback hosts from the
25718 router), and were not randomized by the router, the order of trying the hosts
25719 is randomized each time the transport runs. Randomizing the order of a host
25720 list can be used to do crude load sharing.
25721
25722 When &%hosts_randomize%& is true, a host list may be split into groups whose
25723 order is separately randomized. This makes it possible to set up MX-like
25724 behaviour. The boundaries between groups are indicated by an item that is just
25725 &`+`& in the host list. For example:
25726 .code
25727 hosts = host1:host2:host3:+:host4:host5
25728 .endd
25729 The order of the first three hosts and the order of the last two hosts is
25730 randomized for each use, but the first three always end up before the last two.
25731 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25732
25733 .option hosts_require_auth smtp "host list&!!" unset
25734 .cindex "authentication" "required by client"
25735 This option provides a list of servers for which authentication must succeed
25736 before Exim will try to transfer a message. If authentication fails for
25737 servers which are not in this list, Exim tries to send unauthenticated. If
25738 authentication fails for one of these servers, delivery is deferred. This
25739 temporary error is detectable in the retry rules, so it can be turned into a
25740 hard failure if required. See also &%hosts_try_auth%&, and chapter
25741 &<<CHAPSMTPAUTH>>& for details of authentication.
25742
25743
25744 .option hosts_request_ocsp smtp "host list&!!" "see below"
25745 .cindex "TLS" "requiring for certain servers"
25746 Exim will request a Certificate Status on a
25747 TLS session for any host that matches this list.
25748 &%tls_verify_certificates%& should also be set for the transport.
25749
25750 .new
25751 The default is &"**"& if DANE is not in use for the connection,
25752 or if DANE-TA us used.
25753 It is empty if DANE-EE is used.
25754 .wen
25755
25756 .option hosts_require_alpn smtp "host list&!!" unset
25757 .cindex ALPN "require negotiation in client"
25758 .cindex TLS ALPN
25759 .cindex TLS "Application Layer Protocol Names"
25760 If the TLS library supports ALPN
25761 then a successful negotiation of ALPN will be required for any host
25762 matching the list, for TLS to be used.
25763 See also the &%tls_alpn%& option.
25764
25765 &*Note*&: prevention of fallback to in-clear connection is not
25766 managed by this option; see &%hosts_require_tls%&.
25767
25768 .option hosts_require_dane smtp "host list&!!" unset
25769 .cindex DANE "transport options"
25770 .cindex DANE "requiring for certain servers"
25771 If built with DANE support, Exim  will require that a DNSSEC-validated
25772 TLSA record is present for any host matching the list,
25773 and that a DANE-verified TLS connection is made.
25774 There will be no fallback to in-clear communication.
25775 See the &%dnssec_request_domains%& router and transport options.
25776 See section &<<SECDANE>>&.
25777
25778 .option hosts_require_ocsp smtp "host list&!!" unset
25779 .cindex "TLS" "requiring for certain servers"
25780 Exim will request, and check for a valid Certificate Status being given, on a
25781 TLS session for any host that matches this list.
25782 &%tls_verify_certificates%& should also be set for the transport.
25783
25784 .option hosts_require_tls smtp "host list&!!" unset
25785 .cindex "TLS" "requiring for certain servers"
25786 Exim will insist on using a TLS session when delivering to any host that
25787 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25788 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25789 incoming messages, use an appropriate ACL.
25790
25791 .option hosts_try_auth smtp "host list&!!" unset
25792 .cindex "authentication" "optional in client"
25793 This option provides a list of servers to which, provided they announce
25794 authentication support, Exim will attempt to authenticate as a client when it
25795 connects. If authentication fails
25796 and &%hosts_require_auth%& permits,
25797 Exim will try to transfer the message unauthenticated.
25798 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25799
25800 .option hosts_try_chunking smtp "host list&!!" *
25801 .cindex CHUNKING "enabling, in client"
25802 .cindex BDAT "SMTP command"
25803 .cindex "RFC 3030" "CHUNKING"
25804 This option provides a list of servers to which, provided they announce
25805 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25806 Unless DKIM signing is being done,
25807 BDAT will not be used in conjunction with a transport filter.
25808
25809 .option hosts_try_dane smtp "host list&!!" *
25810 .cindex DANE "transport options"
25811 .cindex DANE "attempting for certain servers"
25812 If built with DANE support, Exim  will look up a
25813 TLSA record for any host matching the list,
25814 If one is found and that lookup was DNSSEC-validated,
25815 then Exim requires that a DANE-verified TLS connection is made for that host;
25816 there will be no fallback to in-clear communication.
25817 See the &%dnssec_request_domains%& router and transport options.
25818 See section &<<SECDANE>>&.
25819
25820 .option hosts_try_fastopen smtp "host list&!!" *
25821 .cindex "fast open, TCP" "enabling, in client"
25822 .cindex "TCP Fast Open" "enabling, in client"
25823 .cindex "RFC 7413" "TCP Fast Open"
25824 This option provides a list of servers to which, provided
25825 the facility is supported by this system, Exim will attempt to
25826 perform a TCP Fast Open.
25827 No data is sent on the SYN segment but, if the remote server also
25828 supports the facility, it can send its SMTP banner immediately after
25829 the SYN,ACK segment.  This can save up to one round-trip time.
25830
25831 The facility is only active for previously-contacted servers,
25832 as the initiator must present a cookie in the SYN segment.
25833
25834 On (at least some) current Linux distributions the facility must be enabled
25835 in the kernel by the sysadmin before the support is usable.
25836 There is no option for control of the server side; if the system supports
25837 it it is always enabled.  Note that lengthy operations in the connect ACL,
25838 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25839
25840 .option hosts_try_prdr smtp "host list&!!" *
25841 .cindex "PRDR" "enabling, optional in client"
25842 .cindex "ESMTP extensions" PRDR
25843 This option provides a list of servers to which, provided they announce
25844 PRDR support, Exim will attempt to negotiate PRDR
25845 for multi-recipient messages.
25846 The option can usually be left as default.
25847
25848 .option interface smtp "string list&!!" unset
25849 .cindex "bind IP address"
25850 .cindex "IP address" "binding"
25851 .vindex "&$host$&"
25852 .vindex "&$host_address$&"
25853 This option specifies which interface to bind to when making an outgoing SMTP
25854 call. The value is an IP address, not an interface name such as
25855 &`eth0`&. Do not confuse this with the interface address that was used when a
25856 message was received, which is in &$received_ip_address$&, formerly known as
25857 &$interface_address$&. The name was changed to minimize confusion with the
25858 outgoing interface address. There is no variable that contains an outgoing
25859 interface address because, unless it is set by this option, its value is
25860 unknown.
25861
25862 During the expansion of the &%interface%& option the variables &$host$& and
25863 &$host_address$& refer to the host to which a connection is about to be made
25864 during the expansion of the string. Forced expansion failure, or an empty
25865 string result causes the option to be ignored. Otherwise, after expansion, the
25866 string must be a list of IP addresses, colon-separated by default, but the
25867 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25868 For example:
25869 .code
25870 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25871 .endd
25872 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25873 connection. If none of them are the correct type, the option is ignored. If
25874 &%interface%& is not set, or is ignored, the system's IP functions choose which
25875 interface to use if the host has more than one.
25876
25877
25878 .option keepalive smtp boolean true
25879 .cindex "keepalive" "on outgoing connection"
25880 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25881 connections. When set, it causes the kernel to probe idle connections
25882 periodically, by sending packets with &"old"& sequence numbers. The other end
25883 of the connection should send a acknowledgment if the connection is still okay
25884 or a reset if the connection has been aborted. The reason for doing this is
25885 that it has the beneficial effect of freeing up certain types of connection
25886 that can get stuck when the remote host is disconnected without tidying up the
25887 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25888 unreachable hosts.
25889
25890
25891 .option lmtp_ignore_quota smtp boolean false
25892 .cindex "LMTP" "ignoring quota errors"
25893 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25894 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25895 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25896
25897 .option max_rcpt smtp integer&!! 100
25898 .cindex "RCPT" "maximum number of outgoing"
25899 This option,
25900 .new
25901 after expansion,
25902 .wen
25903 limits the number of RCPT commands that are sent in a single
25904 SMTP message transaction.
25905 A value setting of zero disables the limit.
25906
25907 .new
25908 If a constant is given,
25909 .wen
25910 each set of addresses is treated independently, and
25911 so can cause parallel connections to the same host if &%remote_max_parallel%&
25912 permits this.
25913
25914
25915 .option message_linelength_limit smtp integer 998
25916 .cindex "line length" limit
25917 This option sets the maximum line length, in bytes, that the transport
25918 will send.  Any messages with lines exceeding the given value
25919 will fail and a failure-DSN ("bounce") message will if possible be returned
25920 to the sender.
25921 The default value is that defined by the SMTP standards.
25922
25923 It is generally wise to also check in the data ACL so that messages
25924 received via SMTP can be refused without producing a bounce.
25925
25926
25927 .option multi_domain smtp boolean&!! true
25928 .vindex "&$domain$&"
25929 When this option is set, the &(smtp)& transport can handle a number of
25930 addresses containing a mixture of different domains provided they all resolve
25931 to the same list of hosts. Turning the option off restricts the transport to
25932 handling only one domain at a time. This is useful if you want to use
25933 &$domain$& in an expansion for the transport, because it is set only when there
25934 is a single domain involved in a remote delivery.
25935
25936 It is expanded per-address and can depend on any of
25937 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25938 &$host$&, &$host_address$& and &$host_port$&.
25939
25940 If the connection is DANE-enabled then this option is ignored;
25941 only messages having the domain used for the DANE TLSA lookup are
25942 sent on the connection.
25943
25944 .option port smtp string&!! "see below"
25945 .cindex "port" "sending TCP/IP"
25946 .cindex "TCP/IP" "setting outgoing port"
25947 This option specifies the TCP/IP port on the server to which Exim connects.
25948 &*Note:*& Do not confuse this with the port that was used when a message was
25949 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25950 The name was changed to minimize confusion with the outgoing port. There is no
25951 variable that contains an outgoing port.
25952
25953 If the value of this option begins with a digit it is taken as a port number;
25954 otherwise it is looked up using &[getservbyname()]&. The default value is
25955 normally &"smtp"&,
25956 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25957 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25958 If the expansion fails, or if a port number cannot be found, delivery
25959 is deferred.
25960
25961 Note that at least one Linux distribution has been seen failing
25962 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25963
25964
25965
25966 .option protocol smtp string smtp
25967 .cindex "LMTP" "over TCP/IP"
25968 .cindex "ssmtp protocol" "outbound"
25969 .cindex "TLS" "SSL-on-connect outbound"
25970 .vindex "&$port$&"
25971 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25972 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25973 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25974 deliveries into closed message stores. Exim also has support for running LMTP
25975 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25976
25977 If this option is set to &"smtps"&, the default value for the &%port%& option
25978 changes to &"smtps"&, and the transport initiates TLS immediately after
25979 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25980 The Internet standards bodies used to strongly discourage use of this mode,
25981 but as of RFC 8314 it is preferred over STARTTLS for message submission
25982 (as distinct from MTA-MTA communication).
25983
25984
25985 .option retry_include_ip_address smtp boolean&!! true
25986 Exim normally includes both the host name and the IP address in the key it
25987 constructs for indexing retry data after a temporary delivery failure. This
25988 means that when one of several IP addresses for a host is failing, it gets
25989 tried periodically (controlled by the retry rules), but use of the other IP
25990 addresses is not affected.
25991
25992 However, in some dialup environments hosts are assigned a different IP address
25993 each time they connect. In this situation the use of the IP address as part of
25994 the retry key leads to undesirable behaviour. Setting this option false causes
25995 Exim to use only the host name.
25996 Since it is expanded it can be made to depend on the host or domain.
25997
25998
25999 .option serialize_hosts smtp "host list&!!" unset
26000 .cindex "serializing connections"
26001 .cindex "host" "serializing connections"
26002 Because Exim operates in a distributed manner, if several messages for the same
26003 host arrive at around the same time, more than one simultaneous connection to
26004 the remote host can occur. This is not usually a problem except when there is a
26005 slow link between the hosts. In that situation it may be helpful to restrict
26006 Exim to one connection at a time. This can be done by setting
26007 &%serialize_hosts%& to match the relevant hosts.
26008
26009 .cindex "hints database" "serializing deliveries to a host"
26010 Exim implements serialization by means of a hints database in which a record is
26011 written whenever a process connects to one of the restricted hosts. The record
26012 is deleted when the connection is completed. Obviously there is scope for
26013 records to get left lying around if there is a system or program crash. To
26014 guard against this, Exim ignores any records that are more than six hours old.
26015
26016 If you set up this kind of serialization, you should also arrange to delete the
26017 relevant hints database whenever your system reboots. The names of the files
26018 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26019 may be one or two files, depending on the type of DBM in use. The same files
26020 are used for ETRN serialization.
26021
26022 See also the &%max_parallel%& generic transport option.
26023
26024
26025 .option size_addition smtp integer 1024
26026 .cindex "SIZE" "ESMTP extension"
26027 .cindex "message" "size issue for transport filter"
26028 .cindex "size" "of message"
26029 .cindex "transport" "filter"
26030 .cindex "filter" "transport filter"
26031 If a remote SMTP server indicates that it supports the SIZE option of the
26032 MAIL command, Exim uses this to pass over the message size at the start of
26033 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26034 sends, to allow for headers and other text that may be added during delivery by
26035 configuration options or in a transport filter. It may be necessary to increase
26036 this if a lot of text is added to messages.
26037
26038 Alternatively, if the value of &%size_addition%& is set negative, it disables
26039 the use of the SIZE option altogether.
26040
26041
26042 .option socks_proxy smtp string&!! unset
26043 .cindex proxy SOCKS
26044 This option enables use of SOCKS proxies for connections made by the
26045 transport.  For details see section &<<SECTproxySOCKS>>&.
26046
26047
26048 .option tls_alpn smtp string&!! unset
26049 .cindex TLS "Application Layer Protocol Names"
26050 .cindex TLS ALPN
26051 .cindex ALPN "set name in client"
26052 If this option is set
26053 and the TLS library supports ALPN,
26054 the value given is used.
26055
26056 As of writing no value has been standardised for email use.
26057 The authors suggest using &"smtp"&.
26058
26059
26060
26061 .option tls_certificate smtp string&!! unset
26062 .cindex "TLS" "client certificate, location of"
26063 .cindex "certificate" "client, location of"
26064 .vindex "&$host$&"
26065 .vindex "&$host_address$&"
26066 The value of this option must be the absolute path to a file which contains the
26067 client's certificate, for possible use when sending a message over an encrypted
26068 connection. The values of &$host$& and &$host_address$& are set to the name and
26069 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26070 details of TLS.
26071
26072 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26073 certificate when sending messages as a client. The global option of the same
26074 name specifies the certificate for Exim as a server; it is not automatically
26075 assumed that the same certificate should be used when Exim is operating as a
26076 client.
26077
26078
26079 .option tls_crl smtp string&!! unset
26080 .cindex "TLS" "client certificate revocation list"
26081 .cindex "certificate" "revocation list for client"
26082 This option specifies a certificate revocation list. The expanded value must
26083 be the name of a file that contains a CRL in PEM format.
26084
26085
26086 .option tls_dh_min_bits smtp integer 1024
26087 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26088 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26089 key agreement is negotiated, the server will provide a large prime number
26090 for use.  This option establishes the minimum acceptable size of that number.
26091 If the parameter offered by the server is too small, then the TLS handshake
26092 will fail.
26093
26094 Only supported when using GnuTLS.
26095
26096
26097 .option tls_privatekey smtp string&!! unset
26098 .cindex "TLS" "client private key, location of"
26099 .vindex "&$host$&"
26100 .vindex "&$host_address$&"
26101 The value of this option must be the absolute path to a file which contains the
26102 client's private key. This is used when sending a message over an encrypted
26103 connection using a client certificate. The values of &$host$& and
26104 &$host_address$& are set to the name and address of the server during the
26105 expansion. If this option is unset, or the expansion is forced to fail, or the
26106 result is an empty string, the private key is assumed to be in the same file as
26107 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26108
26109
26110 .option tls_require_ciphers smtp string&!! unset
26111 .cindex "TLS" "requiring specific ciphers"
26112 .cindex "cipher" "requiring specific"
26113 .vindex "&$host$&"
26114 .vindex "&$host_address$&"
26115 The value of this option must be a list of permitted cipher suites, for use
26116 when setting up an outgoing encrypted connection. (There is a global option of
26117 the same name for controlling incoming connections.) The values of &$host$& and
26118 &$host_address$& are set to the name and address of the server during the
26119 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26120 is used in different ways by OpenSSL and GnuTLS (see sections
26121 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26122 ciphers is a preference order.
26123
26124
26125 .option tls_resumption_hosts smtp "host list&!!" unset
26126 .cindex TLS resumption
26127 This option controls which connections to use the TLS resumption feature.
26128 See &<<SECTresumption>>& for details.
26129
26130
26131
26132 .option tls_sni smtp string&!! unset
26133 .cindex "TLS" "Server Name Indication"
26134 .cindex "TLS" SNI
26135 .cindex SNI "setting in client"
26136 .vindex "&$tls_sni$&"
26137 If this option is set
26138 and the connection is not DANE-validated
26139 then it sets the $tls_out_sni variable and causes any
26140 TLS session to pass this value as the Server Name Indication extension to
26141 the remote side, which can be used by the remote side to select an appropriate
26142 certificate and private key for the session.
26143
26144 See &<<SECTtlssni>>& for more information.
26145
26146 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26147 TLS extensions.
26148
26149
26150
26151
26152 .option tls_tempfail_tryclear smtp boolean true
26153 .cindex "4&'xx'& responses" "to STARTTLS"
26154 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26155 setting up a TLS session, this option determines whether or not Exim should try
26156 to deliver the message unencrypted. If it is set false, delivery to the
26157 current host is deferred; if there are other hosts, they are tried. If this
26158 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26159 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26160 TLS negotiation fails, Exim closes the current connection (because it is in an
26161 unknown state), opens a new one to the same host, and then tries the delivery
26162 in clear.
26163
26164
26165 .option tls_try_verify_hosts smtp "host list&!!" *
26166 .cindex "TLS" "server certificate verification"
26167 .cindex "certificate" "verification of server"
26168 This option gives a list of hosts for which, on encrypted connections,
26169 certificate verification will be tried but need not succeed.
26170 The &%tls_verify_certificates%& option must also be set.
26171 Note that unless the host is in this list
26172 TLS connections will be denied to hosts using self-signed certificates
26173 when &%tls_verify_certificates%& is matched.
26174 The &$tls_out_certificate_verified$& variable is set when
26175 certificate verification succeeds.
26176
26177
26178 .option tls_verify_cert_hostnames smtp "host list&!!" *
26179 .cindex "TLS" "server certificate hostname verification"
26180 .cindex "certificate" "verification of server"
26181 This option give a list of hosts for which,
26182 while verifying the server certificate,
26183 checks will be included on the host name
26184 (note that this will generally be the result of a DNS MX lookup)
26185 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26186 Wildcard names are permitted,
26187 limited to being the initial component of a 3-or-more component FQDN.
26188
26189 There is no equivalent checking on client certificates.
26190
26191
26192 .option tls_verify_certificates smtp string&!! system
26193 .cindex "TLS" "server certificate verification"
26194 .cindex "certificate" "verification of server"
26195 .vindex "&$host$&"
26196 .vindex "&$host_address$&"
26197 The value of this option must be either the
26198 word "system"
26199 or the absolute path to
26200 a file or directory containing permitted certificates for servers,
26201 for use when setting up an encrypted connection.
26202
26203 The "system" value for the option will use a location compiled into the SSL library.
26204 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26205 is taken as empty and an explicit location
26206 must be specified.
26207
26208 The use of a directory for the option value is not available for GnuTLS versions
26209 preceding 3.3.6 and a single file must be used.
26210
26211 With OpenSSL the certificates specified
26212 explicitly
26213 either by file or directory
26214 are added to those given by the system default location.
26215
26216 The values of &$host$& and
26217 &$host_address$& are set to the name and address of the server during the
26218 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26219
26220 For back-compatibility,
26221 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26222 (a single-colon empty list counts as being set)
26223 and certificate verification fails the TLS connection is closed.
26224
26225
26226 .option tls_verify_hosts smtp "host list&!!" unset
26227 .cindex "TLS" "server certificate verification"
26228 .cindex "certificate" "verification of server"
26229 This option gives a list of hosts for which, on encrypted connections,
26230 certificate verification must succeed.
26231 The &%tls_verify_certificates%& option must also be set.
26232 If both this option and &%tls_try_verify_hosts%& are unset
26233 operation is as if this option selected all hosts.
26234 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26235 that connections use TLS.
26236 Fallback to in-clear communication will be done unless restricted by
26237 the &%hosts_require_tls%& option.
26238
26239 .option utf8_downconvert smtp integer&!! -1
26240 .cindex utf8 "address downconversion"
26241 .cindex i18n "utf8 address downconversion"
26242 If built with internationalization support,
26243 this option controls conversion of UTF-8 in message envelope addresses
26244 to a-label form.
26245 If, after expansion, the value is 1, 0, or -1 then this value overrides
26246 any value previously set for the message.  Otherwise, any previously
26247 set value is used.  To permit use of a previous value,
26248 set this option to an empty string.
26249 For details on the values see section &<<SECTi18nMTA>>&.
26250
26251
26252
26253
26254 .section "How the limits for the number of hosts to try are used" &&&
26255          "SECTvalhosmax"
26256 .cindex "host" "maximum number to try"
26257 .cindex "limit" "hosts; maximum number tried"
26258 There are two options that are concerned with the number of hosts that are
26259 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26260 &%hosts_max_try_hardlimit%&.
26261
26262
26263 The &%hosts_max_try%& option limits the number of hosts that are tried
26264 for a single delivery. However, despite the term &"host"& in its name, the
26265 option actually applies to each IP address independently. In other words, a
26266 multihomed host is treated as several independent hosts, just as it is for
26267 retrying.
26268
26269 Many of the larger ISPs have multiple MX records which often point to
26270 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26271 created as a result of routing one of these domains.
26272
26273 Trying every single IP address on such a long list does not seem sensible; if
26274 several at the top of the list fail, it is reasonable to assume there is some
26275 problem that is likely to affect all of them. Roughly speaking, the value of
26276 &%hosts_max_try%& is the maximum number that are tried before deferring the
26277 delivery. However, the logic cannot be quite that simple.
26278
26279 Firstly, IP addresses that are skipped because their retry times have not
26280 arrived do not count, and in addition, addresses that are past their retry
26281 limits are also not counted, even when they are tried. This means that when
26282 some IP addresses are past their retry limits, more than the value of
26283 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26284 that all IP addresses are considered before timing out an email address (but
26285 see below for an exception).
26286
26287 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26288 list to see if there is a subsequent host with a different (higher valued) MX.
26289 If there is, that host is considered next, and the current IP address is used
26290 but not counted. This behaviour helps in the case of a domain with a retry rule
26291 that hardly ever delays any hosts, as is now explained:
26292
26293 Consider the case of a long list of hosts with one MX value, and a few with a
26294 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26295 hosts at the top of the list are tried at first. With the default retry rule,
26296 which specifies increasing retry times, the higher MX hosts are eventually
26297 tried when those at the top of the list are skipped because they have not
26298 reached their retry times.
26299
26300 However, it is common practice to put a fixed short retry time on domains for
26301 large ISPs, on the grounds that their servers are rarely down for very long.
26302 Unfortunately, these are exactly the domains that tend to resolve to long lists
26303 of hosts. The short retry time means that the lowest MX hosts are tried every
26304 time. The attempts may be in a different order because of random sorting, but
26305 without the special MX check, the higher MX hosts would never be tried until
26306 all the lower MX hosts had timed out (which might be several days), because
26307 there are always some lower MX hosts that have reached their retry times. With
26308 the special check, Exim considers at least one IP address from each MX value at
26309 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26310 reached.
26311
26312 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26313 particular, Exim normally eventually tries all the IP addresses before timing
26314 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26315 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26316 been set up with hundreds of IP addresses for some domains. It can
26317 take a very long time indeed for an address to time out in these cases.
26318
26319 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26320 Exim never tries more than this number of IP addresses; if it hits this limit
26321 and they are all timed out, the email address is bounced, even though not all
26322 possible IP addresses have been tried.
26323 .ecindex IIDsmttra1
26324 .ecindex IIDsmttra2
26325
26326
26327
26328
26329
26330 . ////////////////////////////////////////////////////////////////////////////
26331 . ////////////////////////////////////////////////////////////////////////////
26332
26333 .chapter "Address rewriting" "CHAPrewrite"
26334 .scindex IIDaddrew "rewriting" "addresses"
26335 There are some circumstances in which Exim automatically rewrites domains in
26336 addresses. The two most common are when an address is given without a domain
26337 (referred to as an &"unqualified address"&) or when an address contains an
26338 abbreviated domain that is expanded by DNS lookup.
26339
26340 Unqualified envelope addresses are accepted only for locally submitted
26341 messages, or for messages that are received from hosts matching
26342 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26343 appropriate. Unqualified addresses in header lines are qualified if they are in
26344 locally submitted messages, or messages from hosts that are permitted to send
26345 unqualified envelope addresses. Otherwise, unqualified addresses in header
26346 lines are neither qualified nor rewritten.
26347
26348 One situation in which Exim does &'not'& automatically rewrite a domain is
26349 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26350 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26351 do this. The new RFCs do not contain this suggestion.
26352
26353
26354 .section "Explicitly configured address rewriting" "SECID147"
26355 This chapter describes the rewriting rules that can be used in the
26356 main rewrite section of the configuration file, and also in the generic
26357 &%headers_rewrite%& option that can be set on any transport.
26358
26359 Some people believe that configured address rewriting is a Mortal Sin.
26360 Others believe that life is not possible without it. Exim provides the
26361 facility; you do not have to use it.
26362
26363 The main rewriting rules that appear in the &"rewrite"& section of the
26364 configuration file are applied to addresses in incoming messages, both envelope
26365 addresses and addresses in header lines. Each rule specifies the types of
26366 address to which it applies.
26367
26368 Whether or not addresses in header lines are rewritten depends on the origin of
26369 the headers and the type of rewriting. Global rewriting, that is, rewriting
26370 rules from the rewrite section of the configuration file, is applied only to
26371 those headers that were received with the message. Header lines that are added
26372 by ACLs or by a system filter or by individual routers or transports (which
26373 are specific to individual recipient addresses) are not rewritten by the global
26374 rules.
26375
26376 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26377 applies all headers except those added by routers and transports. That is, as
26378 well as the headers that were received with the message, it also applies to
26379 headers that were added by an ACL or a system filter.
26380
26381
26382 In general, rewriting addresses from your own system or domain has some
26383 legitimacy. Rewriting other addresses should be done only with great care and
26384 in special circumstances. The author of Exim believes that rewriting should be
26385 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26386 Although it can sometimes be used as a routing tool, this is very strongly
26387 discouraged.
26388
26389 There are two commonly encountered circumstances where rewriting is used, as
26390 illustrated by these examples:
26391
26392 .ilist
26393 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26394 exchange mail with each other behind a firewall, but there is only a single
26395 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26396 &'hitch.fict.example'& when sending mail off-site.
26397 .next
26398 A host rewrites the local parts of its own users so that, for example,
26399 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26400 .endlist
26401
26402
26403
26404 .section "When does rewriting happen?" "SECID148"
26405 .cindex "rewriting" "timing of"
26406 .cindex "&ACL;" "rewriting addresses in"
26407 Configured address rewriting can take place at several different stages of a
26408 message's processing.
26409
26410 .vindex "&$sender_address$&"
26411 At the start of an ACL for MAIL, the sender address may have been rewritten
26412 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26413 ordinary rewrite rules have yet been applied. If, however, the sender address
26414 is verified in the ACL, it is rewritten before verification, and remains
26415 rewritten thereafter. The subsequent value of &$sender_address$& is the
26416 rewritten address. This also applies if sender verification happens in a
26417 RCPT ACL. Otherwise, when the sender address is not verified, it is
26418 rewritten as soon as a message's header lines have been received.
26419
26420 .vindex "&$domain$&"
26421 .vindex "&$local_part$&"
26422 Similarly, at the start of an ACL for RCPT, the current recipient's address
26423 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26424 rewrite rules have yet been applied to it. However, the behaviour is different
26425 from the sender address when a recipient is verified. The address is rewritten
26426 for the verification, but the rewriting is not remembered at this stage. The
26427 value of &$local_part$& and &$domain$& after verification are always the same
26428 as they were before (that is, they contain the unrewritten &-- except for
26429 SMTP-time rewriting &-- address).
26430
26431 As soon as a message's header lines have been received, all the envelope
26432 recipient addresses are permanently rewritten, and rewriting is also applied to
26433 the addresses in the header lines (if configured). This happens before adding
26434 any header lines that were specified in MAIL or RCPT ACLs, and
26435 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26436 before the DATA ACL and &[local_scan()]& functions are run.
26437
26438 When an address is being routed, either for delivery or for verification,
26439 rewriting is applied immediately to child addresses that are generated by
26440 redirection, unless &%no_rewrite%& is set on the router.
26441
26442 .cindex "envelope from"
26443 .cindex "envelope sender" "rewriting at transport time"
26444 .cindex "rewriting" "at transport time"
26445 .cindex "header lines" "rewriting at transport time"
26446 At transport time, additional rewriting of addresses in header lines can be
26447 specified by setting the generic &%headers_rewrite%& option on a transport.
26448 This option contains rules that are identical in form to those in the rewrite
26449 section of the configuration file. They are applied to the original message
26450 header lines and any that were added by ACLs or a system filter. They are not
26451 applied to header lines that are added by routers or the transport.
26452
26453 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26454 transport option. However, it is not possible to rewrite envelope recipients at
26455 transport time.
26456
26457
26458
26459
26460 .section "Testing the rewriting rules that apply on input" "SECID149"
26461 .cindex "rewriting" "testing"
26462 .cindex "testing" "rewriting"
26463 Exim's input rewriting configuration appears in a part of the runtime
26464 configuration file headed by &"begin rewrite"&. It can be tested by the
26465 &%-brw%& command line option. This takes an address (which can be a full RFC
26466 2822 address) as its argument. The output is a list of how the address would be
26467 transformed by the rewriting rules for each of the different places it might
26468 appear in an incoming message, that is, for each different header and for the
26469 envelope sender and recipient fields. For example,
26470 .code
26471 exim -brw ph10@exim.workshop.example
26472 .endd
26473 might produce the output
26474 .code
26475 sender: Philip.Hazel@exim.workshop.example
26476 from: Philip.Hazel@exim.workshop.example
26477 to: ph10@exim.workshop.example
26478 cc: ph10@exim.workshop.example
26479 bcc: ph10@exim.workshop.example
26480 reply-to: Philip.Hazel@exim.workshop.example
26481 env-from: Philip.Hazel@exim.workshop.example
26482 env-to: ph10@exim.workshop.example
26483 .endd
26484 which shows that rewriting has been set up for that address when used in any of
26485 the source fields, but not when it appears as a recipient address. At the
26486 present time, there is no equivalent way of testing rewriting rules that are
26487 set for a particular transport.
26488
26489
26490 .section "Rewriting rules" "SECID150"
26491 .cindex "rewriting" "rules"
26492 The rewrite section of the configuration file consists of lines of rewriting
26493 rules in the form
26494 .display
26495 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26496 .endd
26497 Rewriting rules that are specified for the &%headers_rewrite%& generic
26498 transport option are given as a colon-separated list. Each item in the list
26499 takes the same form as a line in the main rewriting configuration (except that
26500 any colons must be doubled, of course).
26501
26502 The formats of source patterns and replacement strings are described below.
26503 Each is terminated by white space, unless enclosed in double quotes, in which
26504 case normal quoting conventions apply inside the quotes. The flags are single
26505 characters which may appear in any order. Spaces and tabs between them are
26506 ignored.
26507
26508 For each address that could potentially be rewritten, the rules are scanned in
26509 order, and replacements for the address from earlier rules can themselves be
26510 replaced by later rules (but see the &"q"& and &"R"& flags).
26511
26512 The order in which addresses are rewritten is undefined, may change between
26513 releases, and must not be relied on, with one exception: when a message is
26514 received, the envelope sender is always rewritten first, before any header
26515 lines are rewritten. For example, the replacement string for a rewrite of an
26516 address in &'To:'& must not assume that the message's address in &'From:'& has
26517 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26518 that the envelope sender has already been rewritten.
26519
26520 .vindex "&$domain$&"
26521 .vindex "&$local_part$&"
26522 The variables &$local_part$& and &$domain$& can be used in the replacement
26523 string to refer to the address that is being rewritten. Note that lookup-driven
26524 rewriting can be done by a rule of the form
26525 .code
26526 *@*   ${lookup ...
26527 .endd
26528 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26529 refer to the address that is being rewritten.
26530
26531
26532 .section "Rewriting patterns" "SECID151"
26533 .cindex "rewriting" "patterns"
26534 .cindex "address list" "in a rewriting pattern"
26535 The source pattern in a rewriting rule is any item which may appear in an
26536 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26537 single-item address list, which means that it is expanded before being tested
26538 against the address. As always, if you use a regular expression as a pattern,
26539 you must take care to escape dollar and backslash characters, or use the &`\N`&
26540 facility to suppress string expansion within the regular expression.
26541
26542 Domains in patterns should be given in lower case. Local parts in patterns are
26543 case-sensitive. If you want to do case-insensitive matching of local parts, you
26544 can use a regular expression that starts with &`^(?i)`&.
26545
26546 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26547 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26548 depending on the type of match which occurred. These can be used in the
26549 replacement string to insert portions of the incoming address. &$0$& always
26550 refers to the complete incoming address. When a regular expression is used, the
26551 numerical variables are set from its capturing subexpressions. For other types
26552 of pattern they are set as follows:
26553
26554 .ilist
26555 If a local part or domain starts with an asterisk, the numerical variables
26556 refer to the character strings matched by asterisks, with &$1$& associated with
26557 the first asterisk, and &$2$& with the second, if present. For example, if the
26558 pattern
26559 .code
26560 *queen@*.fict.example
26561 .endd
26562 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26563 .code
26564 $0 = hearts-queen@wonderland.fict.example
26565 $1 = hearts-
26566 $2 = wonderland
26567 .endd
26568 Note that if the local part does not start with an asterisk, but the domain
26569 does, it is &$1$& that contains the wild part of the domain.
26570
26571 .next
26572 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26573 of the domain are placed in the next available numerical variables. Suppose,
26574 for example, that the address &'foo@bar.baz.example'& is processed by a
26575 rewriting rule of the form
26576 .display
26577 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26578 .endd
26579 and the key in the file that matches the domain is &`*.baz.example`&. Then
26580 .code
26581 $1 = foo
26582 $2 = bar
26583 $3 = baz.example
26584 .endd
26585 If the address &'foo@baz.example'& is looked up, this matches the same
26586 wildcard file entry, and in this case &$2$& is set to the empty string, but
26587 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26588 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26589 whole domain. For non-partial domain lookups, no numerical variables are set.
26590 .endlist
26591
26592
26593 .section "Rewriting replacements" "SECID152"
26594 .cindex "rewriting" "replacements"
26595 If the replacement string for a rule is a single asterisk, addresses that
26596 match the pattern and the flags are &'not'& rewritten, and no subsequent
26597 rewriting rules are scanned. For example,
26598 .code
26599 hatta@lookingglass.fict.example  *  f
26600 .endd
26601 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26602 &'From:'& headers.
26603
26604 .vindex "&$domain$&"
26605 .vindex "&$local_part$&"
26606 If the replacement string is not a single asterisk, it is expanded, and must
26607 yield a fully qualified address. Within the expansion, the variables
26608 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26609 Any letters they contain retain their original case &-- they are not lower
26610 cased. The numerical variables are set up according to the type of pattern that
26611 matched the address, as described above. If the expansion is forced to fail by
26612 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26613 current rule is abandoned, but subsequent rules may take effect. Any other
26614 expansion failure causes the entire rewriting operation to be abandoned, and an
26615 entry written to the panic log.
26616
26617
26618
26619 .subsection "Rewriting flags" "SSECID153"
26620 There are three different kinds of flag that may appear on rewriting rules:
26621
26622 .ilist
26623 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26624 c, f, h, r, s, t.
26625 .next
26626 A flag that specifies rewriting at SMTP time: S.
26627 .next
26628 Flags that control the rewriting process: Q, q, R, w.
26629 .endlist
26630
26631 For rules that are part of the &%headers_rewrite%& generic transport option,
26632 E, F, T, and S are not permitted.
26633
26634
26635
26636 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26637          "SSECID154"
26638 .cindex rewriting flags
26639 If none of the following flag letters, nor the &"S"& flag (see section
26640 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26641 and to both the sender and recipient fields of the envelope, whereas a
26642 transport-time rewriting rule just applies to all headers. Otherwise, the
26643 rewriting rule is skipped unless the relevant addresses are being processed.
26644 .display
26645 &`E`&       rewrite all envelope fields
26646 &`F`&       rewrite the envelope From field
26647 &`T`&       rewrite the envelope To field
26648 &`b`&       rewrite the &'Bcc:'& header
26649 &`c`&       rewrite the &'Cc:'& header
26650 &`f`&       rewrite the &'From:'& header
26651 &`h`&       rewrite all headers
26652 &`r`&       rewrite the &'Reply-To:'& header
26653 &`s`&       rewrite the &'Sender:'& header
26654 &`t`&       rewrite the &'To:'& header
26655 .endd
26656 "All headers" means all of the headers listed above that can be selected
26657 individually, plus their &'Resent-'& versions. It does not include
26658 other headers such as &'Subject:'& etc.
26659
26660 You should be particularly careful about rewriting &'Sender:'& headers, and
26661 restrict this to special known cases in your own domains.
26662
26663
26664 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26665 .cindex SMTP "rewriting malformed addresses"
26666 .cindex RCPT "rewriting argument of"
26667 .cindex MAIL "rewriting argument of"
26668 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26669 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26670 before any other processing; even before syntax checking. The pattern is
26671 required to be a regular expression, and it is matched against the whole of the
26672 data for the command, including any surrounding angle brackets.
26673
26674 .vindex "&$domain$&"
26675 .vindex "&$local_part$&"
26676 This form of rewrite rule allows for the handling of addresses that are not
26677 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26678 input). Because the input is not required to be a syntactically valid address,
26679 the variables &$local_part$& and &$domain$& are not available during the
26680 expansion of the replacement string. The result of rewriting replaces the
26681 original address in the MAIL or RCPT command.
26682
26683
26684 .subsection "Flags controlling the rewriting process" SSECID155
26685 There are four flags which control the way the rewriting process works. These
26686 take effect only when a rule is invoked, that is, when the address is of the
26687 correct type (matches the flags) and matches the pattern:
26688
26689 .ilist
26690 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26691 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26692 absence of &"Q"& the rewritten address must always include a domain.
26693 .next
26694 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26695 even if no rewriting actually takes place because of a &"fail"& in the
26696 expansion. The &"q"& flag is not effective if the address is of the wrong type
26697 (does not match the flags) or does not match the pattern.
26698 .next
26699 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26700 address, up to ten times. It can be combined with the &"q"& flag, to stop
26701 rewriting once it fails to match (after at least one successful rewrite).
26702 .next
26703 .cindex "rewriting" "whole addresses"
26704 When an address in a header is rewritten, the rewriting normally applies only
26705 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26706 left unchanged. For example, rewriting might change
26707 .code
26708 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26709 .endd
26710 into
26711 .code
26712 From: Ford Prefect <prefectf@hitch.fict.example>
26713 .endd
26714 .cindex "RFC 2047"
26715 Sometimes there is a need to replace the whole address item, and this can be
26716 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26717 causes an address in a header line to be rewritten, the entire address is
26718 replaced, not just the working part. The replacement must be a complete RFC
26719 2822 address, including the angle brackets if necessary. If text outside angle
26720 brackets contains a character whose value is greater than 126 or less than 32
26721 (except for tab), the text is encoded according to RFC 2047. The character set
26722 is taken from &%headers_charset%&, which gets its default at build time.
26723
26724 When the &"w"& flag is set on a rule that causes an envelope address to be
26725 rewritten, all but the working part of the replacement address is discarded.
26726 .endlist
26727
26728
26729 .section "Rewriting examples" "SECID156"
26730 Here is an example of the two common rewriting paradigms:
26731 .code
26732 *@*.hitch.fict.example  $1@hitch.fict.example
26733 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26734                      {$value}fail}@hitch.fict.example bctfrF
26735 .endd
26736 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26737 the string expansion to fail if the lookup does not succeed. In this context it
26738 has the effect of leaving the original address unchanged, but Exim goes on to
26739 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26740 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26741 explicitly, which would cause the rewritten address to be the same as before,
26742 at the cost of a small bit of processing. Not supplying either of these is an
26743 error, since the rewritten address would then contain no local part.
26744
26745 The first example above replaces the domain with a superior, more general
26746 domain. This may not be desirable for certain local parts. If the rule
26747 .code
26748 root@*.hitch.fict.example  *
26749 .endd
26750 were inserted before the first rule, rewriting would be suppressed for the
26751 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26752
26753 Rewriting can be made conditional on a number of tests, by making use of
26754 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26755 messages that originate outside the local host:
26756 .code
26757 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26758                          {$1@hitch.fict.example}fail}"
26759 .endd
26760 The replacement string is quoted in this example because it contains white
26761 space.
26762
26763 .cindex "rewriting" "bang paths"
26764 .cindex "bang paths" "rewriting"
26765 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26766 an address it treats it as an unqualified local part which it qualifies with
26767 the local qualification domain (if the source of the message is local or if the
26768 remote host is permitted to send unqualified addresses). Rewriting can
26769 sometimes be used to handle simple bang paths with a fixed number of
26770 components. For example, the rule
26771 .code
26772 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26773 .endd
26774 rewrites a two-component bang path &'host.name!user'& as the domain address
26775 &'user@host.name'&. However, there is a security implication in using this as
26776 a global rewriting rule for envelope addresses. It can provide a backdoor
26777 method for using your system as a relay, because the incoming addresses appear
26778 to be local. If the bang path addresses are received via SMTP, it is safer to
26779 use the &"S"& flag to rewrite them as they are received, so that relay checking
26780 can be done on the rewritten addresses.
26781 .ecindex IIDaddrew
26782
26783
26784
26785
26786
26787 . ////////////////////////////////////////////////////////////////////////////
26788 . ////////////////////////////////////////////////////////////////////////////
26789
26790 .chapter "Retry configuration" "CHAPretry"
26791 .scindex IIDretconf1 "retry" "configuration, description of"
26792 .scindex IIDregconf2 "configuration file" "retry section"
26793 The &"retry"& section of the runtime configuration file contains a list of
26794 retry rules that control how often Exim tries to deliver messages that cannot
26795 be delivered at the first attempt. If there are no retry rules (the section is
26796 empty or not present), there are no retries. In this situation, temporary
26797 errors are treated as permanent. The default configuration contains a single,
26798 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26799 line option can be used to test which retry rule will be used for a given
26800 address, domain and error.
26801
26802 The most common cause of retries is temporary failure to deliver to a remote
26803 host because the host is down, or inaccessible because of a network problem.
26804 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26805 address) basis, not on a per-message basis. Thus, if one message has recently
26806 been delayed, delivery of a new message to the same host is not immediately
26807 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26808 log selector is set, the message
26809 .cindex "retry" "time not reached"
26810 &"retry time not reached"& is written to the main log whenever a delivery is
26811 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26812 the handling of errors during remote deliveries.
26813
26814 Retry processing applies to routing as well as to delivering, except as covered
26815 in the next paragraph. The retry rules do not distinguish between these
26816 actions. It is not possible, for example, to specify different behaviour for
26817 failures to route the domain &'snark.fict.example'& and failures to deliver to
26818 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26819 added complication, so did not implement it. However, although they share the
26820 same retry rule, the actual retry times for routing and transporting a given
26821 domain are maintained independently.
26822
26823 When a delivery is not part of a queue run (typically an immediate delivery on
26824 receipt of a message), the routers are always run, and local deliveries are
26825 always attempted, even if retry times are set for them. This makes for better
26826 behaviour if one particular message is causing problems (for example, causing
26827 quota overflow, or provoking an error in a filter file). If such a delivery
26828 suffers a temporary failure, the retry data is updated as normal, and
26829 subsequent delivery attempts from queue runs occur only when the retry time for
26830 the local address is reached.
26831
26832 .section "Changing retry rules" "SECID157"
26833 If you change the retry rules in your configuration, you should consider
26834 whether or not to delete the retry data that is stored in Exim's spool area in
26835 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26836 always safe; that is why they are called &"hints"&.
26837
26838 The hints retry data contains suggested retry times based on the previous
26839 rules. In the case of a long-running problem with a remote host, it might
26840 record the fact that the host has timed out. If your new rules increase the
26841 timeout time for such a host, you should definitely remove the old retry data
26842 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26843 messages that it should now be retaining.
26844
26845
26846
26847 .section "Format of retry rules" "SECID158"
26848 .cindex "retry" "rules"
26849 Each retry rule occupies one line and consists of three or four parts,
26850 separated by white space: a pattern, an error name, an optional list of sender
26851 addresses, and a list of retry parameters. The pattern and sender lists must be
26852 enclosed in double quotes if they contain white space. The rules are searched
26853 in order until one is found where the pattern, error name, and sender list (if
26854 present) match the failing host or address, the error that occurred, and the
26855 message's sender, respectively.
26856
26857
26858 The pattern is any single item that may appear in an address list (see section
26859 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26860 which means that it is expanded before being tested against the address that
26861 has been delayed. A negated address list item is permitted. Address
26862 list processing treats a plain domain name as if it were preceded by &"*@"&,
26863 which makes it possible for many retry rules to start with just a domain. For
26864 example,
26865 .code
26866 lookingglass.fict.example        *  F,24h,30m;
26867 .endd
26868 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26869 whereas
26870 .code
26871 alice@lookingglass.fict.example  *  F,24h,30m;
26872 .endd
26873 applies only to temporary failures involving the local part &%alice%&.
26874 In practice, almost all rules start with a domain name pattern without a local
26875 part.
26876
26877 .cindex "regular expressions" "in retry rules"
26878 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26879 must match a complete address, not just a domain, because that is how regular
26880 expressions work in address lists.
26881 .display
26882 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26883 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26884 .endd
26885
26886
26887 .section "Choosing which retry rule to use for address errors" "SECID159"
26888 When Exim is looking for a retry rule after a routing attempt has failed (for
26889 example, after a DNS timeout), each line in the retry configuration is tested
26890 against the complete address only if &%retry_use_local_part%& is set for the
26891 router. Otherwise, only the domain is used, except when matching against a
26892 regular expression, when the local part of the address is replaced with &"*"&.
26893 A domain on its own can match a domain pattern, or a pattern that starts with
26894 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26895 &%check_local_user%& is true, and false for other routers.
26896
26897 Similarly, when Exim is looking for a retry rule after a local delivery has
26898 failed (for example, after a mailbox full error), each line in the retry
26899 configuration is tested against the complete address only if
26900 &%retry_use_local_part%& is set for the transport (it defaults true for all
26901 local transports).
26902
26903 .cindex "4&'xx'& responses" "retry rules for"
26904 However, when Exim is looking for a retry rule after a remote delivery attempt
26905 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26906 whole address is always used as the key when searching the retry rules. The
26907 rule that is found is used to create a retry time for the combination of the
26908 failing address and the message's sender. It is the combination of sender and
26909 recipient that is delayed in subsequent queue runs until its retry time is
26910 reached. You can delay the recipient without regard to the sender by setting
26911 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26912 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26913 commands.
26914
26915
26916
26917 .section "Choosing which retry rule to use for host and message errors" &&&
26918          "SECID160"
26919 For a temporary error that is not related to an individual address (for
26920 example, a connection timeout), each line in the retry configuration is checked
26921 twice. First, the name of the remote host is used as a domain name (preceded by
26922 &"*@"& when matching a regular expression). If this does not match the line,
26923 the domain from the email address is tried in a similar fashion. For example,
26924 suppose the MX records for &'a.b.c.example'& are
26925 .code
26926 a.b.c.example  MX  5  x.y.z.example
26927                MX  6  p.q.r.example
26928                MX  7  m.n.o.example
26929 .endd
26930 and the retry rules are
26931 .code
26932 p.q.r.example    *      F,24h,30m;
26933 a.b.c.example    *      F,4d,45m;
26934 .endd
26935 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26936 first rule matches neither the host nor the domain, so Exim looks at the second
26937 rule. This does not match the host, but it does match the domain, so it is used
26938 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26939 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26940 first retry rule is used, because it matches the host.
26941
26942 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26943 first rule to determine retry times, but for all the other hosts for the domain
26944 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26945 routing to &'a.b.c.example'& suffers a temporary failure.
26946
26947 &*Note*&: The host name is used when matching the patterns, not its IP address.
26948 However, if a message is routed directly to an IP address without the use of a
26949 host name, for example, if a &(manualroute)& router contains a setting such as:
26950 .code
26951 route_list = *.a.example  192.168.34.23
26952 .endd
26953 then the &"host name"& that is used when searching for a retry rule is the
26954 textual form of the IP address.
26955
26956 .section "Retry rules for specific errors" "SECID161"
26957 .cindex "retry" "specific errors; specifying"
26958 The second field in a retry rule is the name of a particular error, or an
26959 asterisk, which matches any error. The errors that can be tested for are:
26960
26961 .vlist
26962 .vitem &%auth_failed%&
26963 Authentication failed when trying to send to a host in the
26964 &%hosts_require_auth%& list in an &(smtp)& transport.
26965
26966 .vitem &%data_4xx%&
26967 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26968 after the command, or after sending the message's data.
26969
26970 .vitem &%mail_4xx%&
26971 A 4&'xx'& error was received for an outgoing MAIL command.
26972
26973 .vitem &%rcpt_4xx%&
26974 A 4&'xx'& error was received for an outgoing RCPT command.
26975 .endlist
26976
26977 For the three 4&'xx'& errors, either the first or both of the x's can be given
26978 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26979 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26980 and have retries every ten minutes with a one-hour timeout, you could set up a
26981 retry rule of this form:
26982 .code
26983 the.domain.name  rcpt_452   F,1h,10m
26984 .endd
26985 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26986 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26987
26988 .vlist
26989 .vitem &%lost_connection%&
26990 A server unexpectedly closed the SMTP connection. There may, of course,
26991 legitimate reasons for this (host died, network died), but if it repeats a lot
26992 for the same host, it indicates something odd.
26993
26994 .vitem &%lookup%&
26995 A DNS lookup for a host failed.
26996 Note that a &%dnslookup%& router will need to have matched
26997 its &%fail_defer_domains%& option for this retry type to be usable.
26998 Also note that a &%manualroute%& router will probably need
26999 its &%host_find_failed%& option set to &%defer%&.
27000
27001 .vitem &%refused_MX%&
27002 A connection to a host obtained from an MX record was refused.
27003
27004 .vitem &%refused_A%&
27005 A connection to a host not obtained from an MX record was refused.
27006
27007 .vitem &%refused%&
27008 A connection was refused.
27009
27010 .vitem &%timeout_connect_MX%&
27011 A connection attempt to a host obtained from an MX record timed out.
27012
27013 .vitem &%timeout_connect_A%&
27014 A connection attempt to a host not obtained from an MX record timed out.
27015
27016 .vitem &%timeout_connect%&
27017 A connection attempt timed out.
27018
27019 .vitem &%timeout_MX%&
27020 There was a timeout while connecting or during an SMTP session with a host
27021 obtained from an MX record.
27022
27023 .vitem &%timeout_A%&
27024 There was a timeout while connecting or during an SMTP session with a host not
27025 obtained from an MX record.
27026
27027 .vitem &%timeout%&
27028 There was a timeout while connecting or during an SMTP session.
27029
27030 .vitem &%tls_required%&
27031 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27032 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27033 to STARTTLS, or there was a problem setting up the TLS connection.
27034
27035 .vitem &%quota%&
27036 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27037 transport.
27038
27039 .vitem &%quota_%&<&'time'&>
27040 .cindex "quota" "error testing in retry rule"
27041 .cindex "retry" "quota error testing"
27042 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27043 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27044 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27045 for four days.
27046 .endlist
27047
27048 .cindex "mailbox" "time of last read"
27049 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27050 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27051 it should be based on the last time that the user accessed the mailbox.
27052 However, it is not always possible to determine this. Exim uses the following
27053 heuristic rules:
27054
27055 .ilist
27056 If the mailbox is a single file, the time of last access (the &"atime"&) is
27057 used. As no new messages are being delivered (because the mailbox is over
27058 quota), Exim does not access the file, so this is the time of last user access.
27059 .next
27060 .cindex "maildir format" "time of last read"
27061 For a maildir delivery, the time of last modification of the &_new_&
27062 subdirectory is used. As the mailbox is over quota, no new files are created in
27063 the &_new_& subdirectory, because no new messages are being delivered. Any
27064 change to the &_new_& subdirectory is therefore assumed to be the result of an
27065 MUA moving a new message to the &_cur_& directory when it is first read. The
27066 time that is used is therefore the last time that the user read a new message.
27067 .next
27068 For other kinds of multi-file mailbox, the time of last access cannot be
27069 obtained, so a retry rule that uses this type of error field is never matched.
27070 .endlist
27071
27072 The quota errors apply both to system-enforced quotas and to Exim's own quota
27073 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27074 when a local delivery is deferred because a partition is full (the ENOSPC
27075 error).
27076
27077
27078
27079 .section "Retry rules for specified senders" "SECID162"
27080 .cindex "retry" "rules; sender-specific"
27081 You can specify retry rules that apply only when the failing message has a
27082 specific sender. In particular, this can be used to define retry rules that
27083 apply only to bounce messages. The third item in a retry rule can be of this
27084 form:
27085 .display
27086 &`senders=`&<&'address list'&>
27087 .endd
27088 The retry timings themselves are then the fourth item. For example:
27089 .code
27090 *   rcpt_4xx   senders=:   F,1h,30m
27091 .endd
27092 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27093 host. If the address list contains white space, it must be enclosed in quotes.
27094 For example:
27095 .code
27096 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27097 .endd
27098 &*Warning*&: This facility can be unhelpful if it is used for host errors
27099 (which do not depend on the recipient). The reason is that the sender is used
27100 only to match the retry rule. Once the rule has been found for a host error,
27101 its contents are used to set a retry time for the host, and this will apply to
27102 all messages, not just those with specific senders.
27103
27104 When testing retry rules using &%-brt%&, you can supply a sender using the
27105 &%-f%& command line option, like this:
27106 .code
27107 exim -f "" -brt user@dom.ain
27108 .endd
27109 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27110 list is never matched.
27111
27112
27113
27114
27115
27116 .section "Retry parameters" "SECID163"
27117 .cindex "retry" "parameters in rules"
27118 The third (or fourth, if a senders list is present) field in a retry rule is a
27119 sequence of retry parameter sets, separated by semicolons. Each set consists of
27120 .display
27121 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27122 .endd
27123 The letter identifies the algorithm for computing a new retry time; the cutoff
27124 time is the time beyond which this algorithm no longer applies, and the
27125 arguments vary the algorithm's action. The cutoff time is measured from the
27126 time that the first failure for the domain (combined with the local part if
27127 relevant) was detected, not from the time the message was received.
27128
27129 .cindex "retry" "algorithms"
27130 .cindex "retry" "fixed intervals"
27131 .cindex "retry" "increasing intervals"
27132 .cindex "retry" "random intervals"
27133 The available algorithms are:
27134
27135 .ilist
27136 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27137 the interval.
27138 .next
27139 &'G'&: retry at geometrically increasing intervals. The first argument
27140 specifies a starting value for the interval, and the second a multiplier, which
27141 is used to increase the size of the interval at each retry.
27142 .next
27143 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27144 retry, the previous interval is multiplied by the factor in order to get a
27145 maximum for the next interval. The minimum interval is the first argument of
27146 the parameter, and an actual interval is chosen randomly between them. Such a
27147 rule has been found to be helpful in cluster configurations when all the
27148 members of the cluster restart at once, and may therefore synchronize their
27149 queue processing times.
27150 .endlist
27151
27152 When computing the next retry time, the algorithm definitions are scanned in
27153 order until one whose cutoff time has not yet passed is reached. This is then
27154 used to compute a new retry time that is later than the current time. In the
27155 case of fixed interval retries, this simply means adding the interval to the
27156 current time. For geometrically increasing intervals, retry intervals are
27157 computed from the rule's parameters until one that is greater than the previous
27158 interval is found. The main configuration variable
27159 .cindex "limit" "retry interval"
27160 .cindex "retry" "interval, maximum"
27161 .oindex "&%retry_interval_max%&"
27162 &%retry_interval_max%& limits the maximum interval between retries. It
27163 cannot be set greater than &`24h`&, which is its default value.
27164
27165 A single remote domain may have a number of hosts associated with it, and each
27166 host may have more than one IP address. Retry algorithms are selected on the
27167 basis of the domain name, but are applied to each IP address independently. If,
27168 for example, a host has two IP addresses and one is unusable, Exim will
27169 generate retry times for it and will not try to use it until its next retry
27170 time comes. Thus the good IP address is likely to be tried first most of the
27171 time.
27172
27173 .cindex "hints database" "use for retrying"
27174 Retry times are hints rather than promises. Exim does not make any attempt to
27175 run deliveries exactly at the computed times. Instead, a queue runner process
27176 starts delivery processes for delayed messages periodically, and these attempt
27177 new deliveries only for those addresses that have passed their next retry time.
27178 If a new message arrives for a deferred address, an immediate delivery attempt
27179 occurs only if the address has passed its retry time. In the absence of new
27180 messages, the minimum time between retries is the interval between queue runner
27181 processes. There is not much point in setting retry times of five minutes if
27182 your queue runners happen only once an hour, unless there are a significant
27183 number of incoming messages (which might be the case on a system that is
27184 sending everything to a smart host, for example).
27185
27186 The data in the retry hints database can be inspected by using the
27187 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27188 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27189 &'exinext'& utility script can be used to find out what the next retry times
27190 are for the hosts associated with a particular mail domain, and also for local
27191 deliveries that have been deferred.
27192
27193
27194 .section "Retry rule examples" "SECID164"
27195 Here are some example retry rules:
27196 .code
27197 alice@wonderland.fict.example quota_5d  F,7d,3h
27198 wonderland.fict.example       quota_5d
27199 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27200 lookingglass.fict.example     *         F,24h,30m;
27201 *                 refused_A   F,2h,20m;
27202 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27203 .endd
27204 The first rule sets up special handling for mail to
27205 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27206 mailbox has not been read for at least 5 days. Retries continue every three
27207 hours for 7 days. The second rule handles over-quota errors for all other local
27208 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27209 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27210 fail are bounced immediately if the mailbox has not been read for at least 5
27211 days.
27212
27213 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27214 happen every 15 minutes for an hour, then with geometrically increasing
27215 intervals until two days have passed since a delivery first failed. After the
27216 first hour there is a delay of one hour, then two hours, then four hours, and
27217 so on (this is a rather extreme example).
27218
27219 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27220 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27221 all other domains, with special action for connection refusal from hosts that
27222 were not obtained from an MX record.
27223
27224 The final rule in a retry configuration should always have asterisks in the
27225 first two fields so as to provide a general catch-all for any addresses that do
27226 not have their own special handling. This example tries every 15 minutes for 2
27227 hours, then with intervals starting at one hour and increasing by a factor of
27228 1.5 up to 16 hours, then every 8 hours up to 5 days.
27229
27230
27231
27232 .section "Timeout of retry data" "SECID165"
27233 .cindex "timeout" "of retry data"
27234 .oindex "&%retry_data_expire%&"
27235 .cindex "hints database" "data expiry"
27236 .cindex "retry" "timeout of data"
27237 Exim timestamps the data that it writes to its retry hints database. When it
27238 consults the data during a delivery it ignores any that is older than the value
27239 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27240 been tried for 7 days, Exim will try to deliver to it immediately a message
27241 arrives, and if that fails, it will calculate a retry time as if it were
27242 failing for the first time.
27243
27244 This improves the behaviour for messages routed to rarely-used hosts such as MX
27245 backups. If such a host was down at one time, and happens to be down again when
27246 Exim tries a month later, using the old retry data would imply that it had been
27247 down all the time, which is not a justified assumption.
27248
27249 If a host really is permanently dead, this behaviour causes a burst of retries
27250 every now and again, but only if messages routed to it are rare. If there is a
27251 message at least once every 7 days the retry data never expires.
27252
27253
27254
27255
27256 .section "Long-term failures" "SECID166"
27257 .cindex "delivery failure, long-term"
27258 .cindex "retry" "after long-term failure"
27259 Special processing happens when an email address has been failing for so long
27260 that the cutoff time for the last algorithm is reached. For example, using the
27261 default retry rule:
27262 .code
27263 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27264 .endd
27265 the cutoff time is four days. Reaching the retry cutoff is independent of how
27266 long any specific message has been failing; it is the length of continuous
27267 failure for the recipient address that counts.
27268
27269 When the cutoff time is reached for a local delivery, or for all the IP
27270 addresses associated with a remote delivery, a subsequent delivery failure
27271 causes Exim to give up on the address, and a bounce message is generated.
27272 In order to cater for new messages that use the failing address, a next retry
27273 time is still computed from the final algorithm, and is used as follows:
27274
27275 For local deliveries, one delivery attempt is always made for any subsequent
27276 messages. If this delivery fails, the address fails immediately. The
27277 post-cutoff retry time is not used.
27278
27279 .cindex "final cutoff" "retries, controlling"
27280 .cindex retry "final cutoff"
27281 If the delivery is remote, there are two possibilities, controlled by the
27282 .oindex "&%delay_after_cutoff%&"
27283 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27284 default. Until the post-cutoff retry time for one of the IP addresses,
27285 as set by the &%retry_data_expire%& option, is
27286 reached, the failing email address is bounced immediately, without a delivery
27287 attempt taking place. After that time, one new delivery attempt is made to
27288 those IP addresses that are past their retry times, and if that still fails,
27289 the address is bounced and new retry times are computed.
27290
27291 In other words, when all the hosts for a given email address have been failing
27292 for a long time, Exim bounces rather then defers until one of the hosts' retry
27293 times is reached. Then it tries once, and bounces if that attempt fails. This
27294 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27295 to a broken destination, but if the host does recover, Exim will eventually
27296 notice.
27297
27298 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27299 addresses are past their final cutoff time, Exim tries to deliver to those IP
27300 addresses that have not been tried since the message arrived. If there are
27301 no suitable IP addresses, or if they all fail, the address is bounced. In other
27302 words, it does not delay when a new message arrives, but tries the expired
27303 addresses immediately, unless they have been tried since the message arrived.
27304 If there is a continuous stream of messages for the failing domains, setting
27305 &%delay_after_cutoff%& false means that there will be many more attempts to
27306 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27307 true.
27308
27309 .section "Deliveries that work intermittently" "SECID167"
27310 .cindex "retry" "intermittently working deliveries"
27311 Some additional logic is needed to cope with cases where a host is
27312 intermittently available, or when a message has some attribute that prevents
27313 its delivery when others to the same address get through. In this situation,
27314 because some messages are successfully delivered, the &"retry clock"& for the
27315 host or address keeps getting reset by the successful deliveries, and so
27316 failing messages remain in the queue for ever because the cutoff time is never
27317 reached.
27318
27319 Two exceptional actions are applied to prevent this happening. The first
27320 applies to errors that are related to a message rather than a remote host.
27321 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27322 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27323 commands, and quota failures. For this type of error, if a message's arrival
27324 time is earlier than the &"first failed"& time for the error, the earlier time
27325 is used when scanning the retry rules to decide when to try next and when to
27326 time out the address.
27327
27328 The exceptional second action applies in all cases. If a message has been on
27329 the queue for longer than the cutoff time of any applicable retry rule for a
27330 given address, a delivery is attempted for that address, even if it is not yet
27331 time, and if this delivery fails, the address is timed out. A new retry time is
27332 not computed in this case, so that other messages for the same address are
27333 considered immediately.
27334 .ecindex IIDretconf1
27335 .ecindex IIDregconf2
27336
27337
27338
27339
27340
27341
27342 . ////////////////////////////////////////////////////////////////////////////
27343 . ////////////////////////////////////////////////////////////////////////////
27344
27345 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27346 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27347 .scindex IIDauthconf2 "authentication"
27348 The &"authenticators"& section of Exim's runtime configuration is concerned
27349 with SMTP authentication. This facility is an extension to the SMTP protocol,
27350 described in RFC 2554, which allows a client SMTP host to authenticate itself
27351 to a server. This is a common way for a server to recognize clients that are
27352 permitted to use it as a relay. SMTP authentication is not of relevance to the
27353 transfer of mail between servers that have no managerial connection with each
27354 other.
27355
27356 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27357 prior to Exim 4.95 names would be silently truncated at this length, but now
27358 it is enforced.
27359
27360 .cindex "AUTH" "description of"
27361 .cindex "ESMTP extensions" AUTH
27362 Very briefly, the way SMTP authentication works is as follows:
27363
27364 .olist
27365 The server advertises a number of authentication &'mechanisms'& in response to
27366 the client's EHLO command.
27367 .next
27368 The client issues an AUTH command, naming a specific mechanism. The command
27369 may, optionally, contain some authentication data.
27370 .next
27371 The server may issue one or more &'challenges'&, to which the client must send
27372 appropriate responses. In simple authentication mechanisms, the challenges are
27373 just prompts for user names and passwords. The server does not have to issue
27374 any challenges &-- in some mechanisms the relevant data may all be transmitted
27375 with the AUTH command.
27376 .next
27377 The server either accepts or denies authentication.
27378 .next
27379 If authentication succeeds, the client may optionally make use of the AUTH
27380 option on the MAIL command to pass an authenticated sender in subsequent
27381 mail transactions. Authentication lasts for the remainder of the SMTP
27382 connection.
27383 .next
27384 If authentication fails, the client may give up, or it may try a different
27385 authentication mechanism, or it may try transferring mail over the
27386 unauthenticated connection.
27387 .endlist
27388
27389 If you are setting up a client, and want to know which authentication
27390 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27391 SMTP port) on the server, and issue an EHLO command. The response to this
27392 includes the list of supported mechanisms. For example:
27393 .display
27394 &`$ `&&*&`telnet server.example 25`&*&
27395 &`Trying 192.168.34.25...`&
27396 &`Connected to server.example.`&
27397 &`Escape character is &#x0027;^]&#x0027;.`&
27398 &`220 server.example ESMTP Exim 4.20 ...`&
27399 &*&`ehlo client.example`&*&
27400 &`250-server.example Hello client.example [10.8.4.5]`&
27401 &`250-SIZE 52428800`&
27402 &`250-PIPELINING`&
27403 &`250-AUTH PLAIN`&
27404 &`250 HELP`&
27405 .endd
27406 The second-last line of this example output shows that the server supports
27407 authentication using the PLAIN mechanism. In Exim, the different authentication
27408 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27409 routers and transports, which authenticators are included in the binary is
27410 controlled by build-time definitions. The following are currently available,
27411 included by setting
27412 .code
27413 AUTH_CRAM_MD5=yes
27414 AUTH_CYRUS_SASL=yes
27415 AUTH_DOVECOT=yes
27416 AUTH_EXTERNAL=yes
27417 AUTH_GSASL=yes
27418 AUTH_HEIMDAL_GSSAPI=yes
27419 AUTH_PLAINTEXT=yes
27420 AUTH_SPA=yes
27421 AUTH_TLS=yes
27422 .endd
27423 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27424 authentication mechanism (RFC 2195), and the second provides an interface to
27425 the Cyrus SASL authentication library.
27426 The third is an interface to Dovecot's authentication system, delegating the
27427 work via a socket interface.
27428 The fourth provides for negotiation of authentication done via non-SMTP means,
27429 as defined by RFC 4422 Appendix A.
27430 The fifth provides an interface to the GNU SASL authentication library, which
27431 provides mechanisms but typically not data sources.
27432 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27433 supporting setting a server keytab.
27434 The seventh can be configured to support
27435 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27436 not formally documented, but used by several MUAs.
27437 The eighth authenticator
27438 supports Microsoft's &'Secure Password Authentication'& mechanism.
27439 The last is an Exim authenticator but not an SMTP one;
27440 instead it can use information from a TLS negotiation.
27441
27442 The authenticators are configured using the same syntax as other drivers (see
27443 section &<<SECTfordricon>>&). If no authenticators are required, no
27444 authentication section need be present in the configuration file. Each
27445 authenticator can in principle have both server and client functions. When Exim
27446 is receiving SMTP mail, it is acting as a server; when it is sending out
27447 messages over SMTP, it is acting as a client. Authenticator configuration
27448 options are provided for use in both these circumstances.
27449
27450 To make it clear which options apply to which situation, the prefixes
27451 &%server_%& and &%client_%& are used on option names that are specific to
27452 either the server or the client function, respectively. Server and client
27453 functions are disabled if none of their options are set. If an authenticator is
27454 to be used for both server and client functions, a single definition, using
27455 both sets of options, is required. For example:
27456 .code
27457 cram:
27458   driver = cram_md5
27459   public_name = CRAM-MD5
27460   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27461   client_name = ph10
27462   client_secret = secret2
27463 .endd
27464 The &%server_%& option is used when Exim is acting as a server, and the
27465 &%client_%& options when it is acting as a client.
27466
27467 Descriptions of the individual authenticators are given in subsequent chapters.
27468 The remainder of this chapter covers the generic options for the
27469 authenticators, followed by general discussion of the way authentication works
27470 in Exim.
27471
27472 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27473 per-mechanism basis.  Please read carefully to determine which variables hold
27474 account labels such as usercodes and which hold passwords or other
27475 authenticating data.
27476
27477 Note that some mechanisms support two different identifiers for accounts: the
27478 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27479 and &'authz'& are commonly encountered.  The American spelling is standard here.
27480 Conceptually, authentication data such as passwords are tied to the identifier
27481 used to authenticate; servers may have rules to permit one user to act as a
27482 second user, so that after login the session is treated as though that second
27483 user had logged in.  That second user is the &'authorization id'&.  A robust
27484 configuration might confirm that the &'authz'& field is empty or matches the
27485 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27486 as verified data, the &'authz'& as an unverified request which the server might
27487 choose to honour.
27488
27489 A &'realm'& is a text string, typically a domain name, presented by a server
27490 to a client to help it select an account and credentials to use.  In some
27491 mechanisms, the client and server provably agree on the realm, but clients
27492 typically can not treat the realm as secure data to be blindly trusted.
27493
27494
27495
27496 .section "Generic options for authenticators" "SECID168"
27497 .cindex "authentication" "generic options"
27498 .cindex "options" "generic; for authenticators"
27499
27500 .option client_condition authenticators string&!! unset
27501 When Exim is authenticating as a client, it skips any authenticator whose
27502 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27503 used, for example, to skip plain text authenticators when the connection is not
27504 encrypted by a setting such as:
27505 .code
27506 client_condition = ${if !eq{$tls_out_cipher}{}}
27507 .endd
27508
27509
27510 .option client_set_id authenticators string&!! unset
27511 When client authentication succeeds, this condition is expanded; the
27512 result is used in the log lines for outbound messages.
27513 Typically it will be the user name used for authentication.
27514
27515
27516 .option driver authenticators string unset
27517 This option must always be set. It specifies which of the available
27518 authenticators is to be used.
27519
27520
27521 .option public_name authenticators string unset
27522 This option specifies the name of the authentication mechanism that the driver
27523 implements, and by which it is known to the outside world. These names should
27524 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27525 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27526 defaults to the driver's instance name.
27527
27528
27529 .option server_advertise_condition authenticators string&!! unset
27530 When a server is about to advertise an authentication mechanism, the condition
27531 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27532 mechanism is not advertised.
27533 If the expansion fails, the mechanism is not advertised. If the failure was not
27534 forced, and was not caused by a lookup defer, the incident is logged.
27535 See section &<<SECTauthexiser>>& below for further discussion.
27536
27537
27538 .option server_condition authenticators string&!! unset
27539 This option must be set for a &%plaintext%& server authenticator, where it
27540 is used directly to control authentication. See section &<<SECTplainserver>>&
27541 for details.
27542
27543 For the &(gsasl)& authenticator, this option is required for various
27544 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27545
27546 For the other authenticators, &%server_condition%& can be used as an additional
27547 authentication or authorization mechanism that is applied after the other
27548 authenticator conditions succeed. If it is set, it is expanded when the
27549 authenticator would otherwise return a success code. If the expansion is forced
27550 to fail, authentication fails. Any other expansion failure causes a temporary
27551 error code to be returned. If the result of a successful expansion is an empty
27552 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27553 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27554 other result, a temporary error code is returned, with the expanded string as
27555 the error text.
27556
27557
27558 .option server_debug_print authenticators string&!! unset
27559 If this option is set and authentication debugging is enabled (see the &%-d%&
27560 command line option), the string is expanded and included in the debugging
27561 output when the authenticator is run as a server. This can help with checking
27562 out the values of variables.
27563 If expansion of the string fails, the error message is written to the debugging
27564 output, and Exim carries on processing.
27565
27566
27567 .option server_set_id authenticators string&!! unset
27568 .vindex "&$authenticated_id$&"
27569 .vindex "&$authenticated_fail_id$&"
27570 When an Exim server successfully authenticates a client, this string is
27571 expanded using data from the authentication, and preserved for any incoming
27572 messages in the variable &$authenticated_id$&. It is also included in the log
27573 lines for incoming messages. For example, a user/password authenticator
27574 configuration might preserve the user name that was used to authenticate, and
27575 refer to it subsequently during delivery of the message.
27576 On a failing authentication the expansion result is instead saved in
27577 the &$authenticated_fail_id$& variable.
27578 If expansion fails, the option is ignored.
27579
27580
27581 .option server_mail_auth_condition authenticators string&!! unset
27582 This option allows a server to discard authenticated sender addresses supplied
27583 as part of MAIL commands in SMTP connections that are authenticated by the
27584 driver on which &%server_mail_auth_condition%& is set. The option is not used
27585 as part of the authentication process; instead its (unexpanded) value is
27586 remembered for later use.
27587 How it is used is described in the following section.
27588
27589
27590
27591
27592
27593 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27594 .cindex "authentication" "sender; authenticated"
27595 .cindex "AUTH" "on MAIL command"
27596 When a client supplied an AUTH= item on a MAIL command, Exim applies
27597 the following checks before accepting it as the authenticated sender of the
27598 message:
27599
27600 .ilist
27601 If the connection is not using extended SMTP (that is, HELO was used rather
27602 than EHLO), the use of AUTH= is a syntax error.
27603 .next
27604 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27605 .next
27606 .vindex "&$authenticated_sender$&"
27607 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27608 running, the value of &$authenticated_sender$& is set to the value obtained
27609 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27610 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27611 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27612 given for the MAIL command.
27613 .next
27614 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27615 is accepted and placed in &$authenticated_sender$& only if the client has
27616 authenticated.
27617 .next
27618 If the AUTH= value was accepted by either of the two previous rules, and
27619 the client has authenticated, and the authenticator has a setting for the
27620 &%server_mail_auth_condition%&, the condition is checked at this point. The
27621 valued that was saved from the authenticator is expanded. If the expansion
27622 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27623 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27624 the value of &$authenticated_sender$& is retained and passed on with the
27625 message.
27626 .endlist
27627
27628
27629 When &$authenticated_sender$& is set for a message, it is passed on to other
27630 hosts to which Exim authenticates as a client. Do not confuse this value with
27631 &$authenticated_id$&, which is a string obtained from the authentication
27632 process, and which is not usually a complete email address.
27633
27634 .vindex "&$sender_address$&"
27635 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27636 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27637 therefore make use of &$authenticated_sender$&. The converse is not true: the
27638 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27639 ACL is run.
27640
27641
27642
27643 .section "Authentication on an Exim server" "SECTauthexiser"
27644 .cindex "authentication" "on an Exim server"
27645 When Exim receives an EHLO command, it advertises the public names of those
27646 authenticators that are configured as servers, subject to the following
27647 conditions:
27648
27649 .ilist
27650 The client host must match &%auth_advertise_hosts%& (default *).
27651 .next
27652 If the &%server_advertise_condition%& option is set, its expansion must not
27653 yield the empty string, &"0"&, &"no"&, or &"false"&.
27654 .endlist
27655
27656 The order in which the authenticators are defined controls the order in which
27657 the mechanisms are advertised.
27658
27659 Some mail clients (for example, some versions of Netscape) require the user to
27660 provide a name and password for authentication whenever AUTH is advertised,
27661 even though authentication may not in fact be needed (for example, Exim may be
27662 set up to allow unconditional relaying from the client by an IP address check).
27663 You can make such clients more friendly by not advertising AUTH to them.
27664 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27665 that runs for RCPT) to relay without authentication, you should set
27666 .code
27667 auth_advertise_hosts = ! 10.9.8.0/24
27668 .endd
27669 so that no authentication mechanisms are advertised to them.
27670
27671 The &%server_advertise_condition%& controls the advertisement of individual
27672 authentication mechanisms. For example, it can be used to restrict the
27673 advertisement of a particular mechanism to encrypted connections, by a setting
27674 such as:
27675 .code
27676 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27677 .endd
27678 .vindex "&$tls_in_cipher$&"
27679 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27680 yields &"yes"&, which allows the advertisement to happen.
27681
27682 When an Exim server receives an AUTH command from a client, it rejects it
27683 immediately if AUTH was not advertised in response to an earlier EHLO
27684 command. This is the case if
27685
27686 .ilist
27687 The client host does not match &%auth_advertise_hosts%&; or
27688 .next
27689 No authenticators are configured with server options; or
27690 .next
27691 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27692 server authenticators.
27693 .endlist
27694
27695
27696 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27697 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27698 AUTH is accepted from any client host.
27699
27700 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27701 server authentication mechanism that was advertised in response to EHLO and
27702 that matches the one named in the AUTH command. If it finds one, it runs
27703 the appropriate authentication protocol, and authentication either succeeds or
27704 fails. If there is no matching advertised mechanism, the AUTH command is
27705 rejected with a 504 error.
27706
27707 .vindex "&$received_protocol$&"
27708 .vindex "&$sender_host_authenticated$&"
27709 When a message is received from an authenticated host, the value of
27710 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27711 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27712 public name) of the authenticator driver that successfully authenticated the
27713 client from which the message was received. This variable is empty if there was
27714 no successful authentication.
27715
27716 .cindex authentication "expansion item"
27717 Successful authentication sets up information used by the
27718 &%authresults%& expansion item.
27719
27720 .new
27721 .cindex authentication "failure event, server"
27722 If an authenticator is run and does not succeed,
27723 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27724 While the event is being processed the variables
27725 &$sender_host_authenticated$& (with the authenticator name)
27726 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27727 will be valid.
27728 If the event is serviced and a string is returned then the string will be logged
27729 instead of the default log line.
27730 See <<CHAPevents>> for details on events.
27731 .wen
27732
27733
27734 .section "Testing server authentication" "SECID169"
27735 .cindex "authentication" "testing a server"
27736 .cindex "AUTH" "testing a server"
27737 .cindex "base64 encoding" "creating authentication test data"
27738 Exim's &%-bh%& option can be useful for testing server authentication
27739 configurations. The data for the AUTH command has to be sent using base64
27740 encoding. A quick way to produce such data for testing is the following Perl
27741 script:
27742 .code
27743 use MIME::Base64;
27744 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27745 .endd
27746 .cindex "binary zero" "in authentication data"
27747 This interprets its argument as a Perl string, and then encodes it. The
27748 interpretation as a Perl string allows binary zeros, which are required for
27749 some kinds of authentication, to be included in the data. For example, a
27750 command line to run this script on such data might be
27751 .code
27752 encode '\0user\0password'
27753 .endd
27754 Note the use of single quotes to prevent the shell interpreting the
27755 backslashes, so that they can be interpreted by Perl to specify characters
27756 whose code value is zero.
27757
27758 &*Warning 1*&: If either of the user or password strings starts with an octal
27759 digit, you must use three zeros instead of one after the leading backslash. If
27760 you do not, the octal digit that starts your string will be incorrectly
27761 interpreted as part of the code for the first character.
27762
27763 &*Warning 2*&: If there are characters in the strings that Perl interprets
27764 specially, you must use a Perl escape to prevent them being misinterpreted. For
27765 example, a command such as
27766 .code
27767 encode '\0user@domain.com\0pas$$word'
27768 .endd
27769 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27770
27771 If you have the &%mimencode%& command installed, another way to produce
27772 base64-encoded strings is to run the command
27773 .code
27774 echo -e -n `\0user\0password' | mimencode
27775 .endd
27776 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27777 in the argument, and the &%-n%& option specifies no newline at the end of its
27778 output. However, not all versions of &%echo%& recognize these options, so you
27779 should check your version before relying on this suggestion.
27780
27781
27782
27783 .section "Authentication by an Exim client" "SECID170"
27784 .cindex "authentication" "on an Exim client"
27785 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27786 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27787 announces support for authentication, and the host matches an entry in either
27788 of these options, Exim (as a client) tries to authenticate as follows:
27789
27790 .ilist
27791 For each authenticator that is configured as a client, in the order in which
27792 they are defined in the configuration, it searches the authentication
27793 mechanisms announced by the server for one whose name matches the public name
27794 of the authenticator.
27795 .next
27796 .vindex "&$host$&"
27797 .vindex "&$host_address$&"
27798 When it finds one that matches, it runs the authenticator's client code. The
27799 variables &$host$& and &$host_address$& are available for any string expansions
27800 that the client might do. They are set to the server's name and IP address. If
27801 any expansion is forced to fail, the authentication attempt is abandoned, and
27802 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27803 delivery to be deferred.
27804 .next
27805 If the result of the authentication attempt is a temporary error or a timeout,
27806 Exim abandons trying to send the message to the host for the moment. It will
27807 try again later. If there are any backup hosts available, they are tried in the
27808 usual way.
27809
27810 .new
27811 .next
27812 .cindex authentication "failure event, client"
27813 If the response to authentication is a permanent error (5&'xx'& code),
27814 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27815 While the event is being processed the variable
27816 &$sender_host_authenticated$& (with the authenticator name)
27817 will be valid.
27818 If the event is serviced and a string is returned then the string will be logged.
27819 See <<CHAPevents>> for details on events.
27820 .wen
27821
27822 .next
27823 If the response to authentication is a permanent error (5&'xx'& code), Exim
27824 carries on searching the list of authenticators and tries another one if
27825 possible. If all authentication attempts give permanent errors, or if there are
27826 no attempts because no mechanisms match (or option expansions force failure),
27827 what happens depends on whether the host matches &%hosts_require_auth%& or
27828 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27829 delivery is deferred. The error can be detected in the retry rules, and thereby
27830 turned into a permanent error if you wish. In the second case, Exim tries to
27831 deliver the message unauthenticated.
27832 .endlist
27833
27834 Note that the hostlist test for whether to do authentication can be
27835 confused if name-IP lookups change between the time the peer is decided
27836 upon and the time that the transport runs.  For example, with a manualroute
27837 router given a host name, and with DNS "round-robin" used by that name: if
27838 the local resolver cache times out between the router and the transport
27839 running, the transport may get an IP for the name for its authentication
27840 check which does not match the connection peer IP.
27841 No authentication will then be done, despite the names being identical.
27842
27843 For such cases use a separate transport which always authenticates.
27844
27845 .cindex "AUTH" "on MAIL command"
27846 When Exim has authenticated itself to a remote server, it adds the AUTH
27847 parameter to the MAIL commands it sends, if it has an authenticated sender for
27848 the message. If the message came from a remote host, the authenticated sender
27849 is the one that was receiving on an incoming MAIL command, provided that the
27850 incoming connection was authenticated and the &%server_mail_auth%& condition
27851 allowed the authenticated sender to be retained. If a local process calls Exim
27852 to send a message, the sender address that is built from the login name and
27853 &%qualify_domain%& is treated as authenticated. However, if the
27854 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27855 the authenticated sender that was received with the message.
27856 .ecindex IIDauthconf1
27857 .ecindex IIDauthconf2
27858
27859
27860
27861
27862
27863
27864 . ////////////////////////////////////////////////////////////////////////////
27865 . ////////////////////////////////////////////////////////////////////////////
27866
27867 .chapter "The plaintext authenticator" "CHAPplaintext"
27868 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27869 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27870 The &(plaintext)& authenticator can be configured to support the PLAIN and
27871 LOGIN authentication mechanisms, both of which transfer authentication data as
27872 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27873 security risk; you are strongly advised to insist on the use of SMTP encryption
27874 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27875 use unencrypted plain text, you should not use the same passwords for SMTP
27876 connections as you do for login accounts.
27877
27878 .section "Avoiding cleartext use" "SECTplain_TLS"
27879 The following generic option settings will disable &(plaintext)& authenticators when
27880 TLS is not being used:
27881 .code
27882   server_advertise_condition = ${if def:tls_in_cipher }
27883   client_condition =           ${if def:tls_out_cipher}
27884 .endd
27885
27886 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27887 but is still vulnerable to a Man In The Middle attack unless certificates
27888 (including their names) have been properly verified.
27889
27890 .section "Plaintext server options" "SECID171"
27891 .cindex "options" "&(plaintext)& authenticator (server)"
27892 When configured as a server, &(plaintext)& uses the following options:
27893
27894 .option server_condition authenticators string&!! unset
27895 This is actually a global authentication option, but it must be set in order to
27896 configure the &(plaintext)& driver as a server. Its use is described below.
27897
27898 .option server_prompts plaintext "string list&!!" unset
27899 The contents of this option, after expansion, must be a colon-separated list of
27900 prompt strings. If expansion fails, a temporary authentication rejection is
27901 given.
27902
27903 .section "Using plaintext in a server" "SECTplainserver"
27904 .cindex "AUTH" "in &(plaintext)& authenticator"
27905 .cindex "binary zero" "in &(plaintext)& authenticator"
27906 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27907         "in &(plaintext)& authenticator"
27908 .vindex "&$auth1$&, &$auth2$&, etc"
27909 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27910
27911 When running as a server, &(plaintext)& performs the authentication test by
27912 expanding a string. The data sent by the client with the AUTH command, or in
27913 response to subsequent prompts, is base64 encoded, and so may contain any byte
27914 values when decoded. If any data is supplied with the command, it is treated as
27915 a list of strings, separated by NULs (binary zeros), the first three of which
27916 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27917 (neither LOGIN nor PLAIN uses more than three strings).
27918
27919 For compatibility with previous releases of Exim, the values are also placed in
27920 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27921 variables for this purpose is now deprecated, as it can lead to confusion in
27922 string expansions that also use them for other things.
27923
27924 If there are more strings in &%server_prompts%& than the number of strings
27925 supplied with the AUTH command, the remaining prompts are used to obtain more
27926 data. Each response from the client may be a list of NUL-separated strings.
27927
27928 .vindex "&$authenticated_id$&"
27929 Once a sufficient number of data strings have been received,
27930 &%server_condition%& is expanded. If the expansion is forced to fail,
27931 authentication fails. Any other expansion failure causes a temporary error code
27932 to be returned. If the result of a successful expansion is an empty string,
27933 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27934 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27935 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27936 For any other result, a temporary error code is returned, with the expanded
27937 string as the error text.
27938
27939 &*Warning*&: If you use a lookup in the expansion to find the user's
27940 password, be sure to make the authentication fail if the user is unknown.
27941 There are good and bad examples at the end of the next section.
27942
27943
27944
27945 .section "The PLAIN authentication mechanism" "SECID172"
27946 .cindex "PLAIN authentication mechanism"
27947 .cindex authentication PLAIN
27948 .cindex "binary zero" "in &(plaintext)& authenticator"
27949 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27950 sent as one item of data (that is, one combined string containing two NUL
27951 separators). The data is sent either as part of the AUTH command, or
27952 subsequently in response to an empty prompt from the server.
27953
27954 The second and third strings are a user name and a corresponding password.
27955 Using a single fixed user name and password as an example, this could be
27956 configured as follows:
27957 .code
27958 fixed_plain:
27959   driver = plaintext
27960   public_name = PLAIN
27961   server_prompts = :
27962   server_condition = \
27963     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27964   server_set_id = $auth2
27965 .endd
27966 Note that the default result strings from &%if%& (&"true"& or an empty string)
27967 are exactly what we want here, so they need not be specified. Obviously, if the
27968 password contains expansion-significant characters such as dollar, backslash,
27969 or closing brace, they have to be escaped.
27970
27971 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27972 the end of a string list are ignored). If all the data comes as part of the
27973 AUTH command, as is commonly the case, the prompt is not used. This
27974 authenticator is advertised in the response to EHLO as
27975 .code
27976 250-AUTH PLAIN
27977 .endd
27978 and a client host can authenticate itself by sending the command
27979 .code
27980 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27981 .endd
27982 As this contains three strings (more than the number of prompts), no further
27983 data is required from the client. Alternatively, the client may just send
27984 .code
27985 AUTH PLAIN
27986 .endd
27987 to initiate authentication, in which case the server replies with an empty
27988 prompt. The client must respond with the combined data string.
27989
27990 The data string is base64 encoded, as required by the RFC. This example,
27991 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27992 represents a zero byte. This is split up into three strings, the first of which
27993 is empty. The &%server_condition%& option in the authenticator checks that the
27994 second two are &`username`& and &`mysecret`& respectively.
27995
27996 Having just one fixed user name and password, as in this example, is not very
27997 realistic, though for a small organization with only a handful of
27998 authenticating clients it could make sense.
27999
28000 A more sophisticated instance of this authenticator could use the user name in
28001 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28002 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28003 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28004 This is an incorrect example:
28005 .code
28006 server_condition = \
28007   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28008 .endd
28009 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28010 which it then compares to the supplied password (&$auth3$&). Why is this example
28011 incorrect? It works fine for existing users, but consider what happens if a
28012 non-existent user name is given. The lookup fails, but as no success/failure
28013 strings are given for the lookup, it yields an empty string. Thus, to defeat
28014 the authentication, all a client has to do is to supply a non-existent user
28015 name and an empty password. The correct way of writing this test is:
28016 .code
28017 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28018   {${if eq{$value}{$auth3}}} {false}}
28019 .endd
28020 In this case, if the lookup succeeds, the result is checked; if the lookup
28021 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28022 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28023 always fails if its second argument is empty. However, the second way of
28024 writing the test makes the logic clearer.
28025
28026
28027 .section "The LOGIN authentication mechanism" "SECID173"
28028 .cindex "LOGIN authentication mechanism"
28029 .cindex authentication LOGIN
28030 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28031 in a number of programs. No data is sent with the AUTH command. Instead, a
28032 user name and password are supplied separately, in response to prompts. The
28033 plaintext authenticator can be configured to support this as in this example:
28034 .code
28035 fixed_login:
28036   driver = plaintext
28037   public_name = LOGIN
28038   server_prompts = User Name : Password
28039   server_condition = \
28040     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28041   server_set_id = $auth1
28042 .endd
28043 Because of the way plaintext operates, this authenticator accepts data supplied
28044 with the AUTH command (in contravention of the specification of LOGIN), but
28045 if the client does not supply it (as is the case for LOGIN clients), the prompt
28046 strings are used to obtain two data items.
28047
28048 Some clients are very particular about the precise text of the prompts. For
28049 example, Outlook Express is reported to recognize only &"Username:"& and
28050 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28051 strings. It uses the &%ldapauth%& expansion condition to check the user
28052 name and password by binding to an LDAP server:
28053 .code
28054 login:
28055   driver = plaintext
28056   public_name = LOGIN
28057   server_prompts = Username:: : Password::
28058   server_condition = ${if and{{ \
28059     !eq{}{$auth1} }{ \
28060     ldapauth{\
28061       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28062       pass=${quote:$auth2} \
28063       ldap://ldap.example.org/} }} }
28064   server_set_id = uid=$auth1,ou=people,o=example.org
28065 .endd
28066 We have to check that the username is not empty before using it, because LDAP
28067 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28068 operator to correctly quote the DN for authentication. However, the basic
28069 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28070 correct one to use for the password, because quoting is needed only to make
28071 the password conform to the Exim syntax. At the LDAP level, the password is an
28072 uninterpreted string.
28073
28074
28075 .section "Support for different kinds of authentication" "SECID174"
28076 A number of string expansion features are provided for the purpose of
28077 interfacing to different ways of user authentication. These include checking
28078 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28079 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28080 &<<SECTexpcond>>&.
28081
28082
28083
28084
28085 .section "Using plaintext in a client" "SECID175"
28086 .cindex "options" "&(plaintext)& authenticator (client)"
28087 The &(plaintext)& authenticator has two client options:
28088
28089 .option client_ignore_invalid_base64 plaintext boolean false
28090 If the client receives a server prompt that is not a valid base64 string,
28091 authentication is abandoned by default. However, if this option is set true,
28092 the error in the challenge is ignored and the client sends the response as
28093 usual.
28094
28095 .option client_send plaintext string&!! unset
28096 The string is a colon-separated list of authentication data strings. Each
28097 string is independently expanded before being sent to the server. The first
28098 string is sent with the AUTH command; any more strings are sent in response
28099 to prompts from the server. Before each string is expanded, the value of the
28100 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28101 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28102 way. Thus, the prompt that is received in response to sending the first string
28103 (with the AUTH command) can be used in the expansion of the second string, and
28104 so on. If an invalid base64 string is received when
28105 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28106 &$auth$&<&'n'&> variable.
28107
28108 &*Note*&: You cannot use expansion to create multiple strings, because
28109 splitting takes priority and happens first.
28110
28111 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28112 the data, further processing is applied to each string before it is sent. If
28113 there are any single circumflex characters in the string, they are converted to
28114 NULs. Should an actual circumflex be required as data, it must be doubled in
28115 the string.
28116
28117 This is an example of a client configuration that implements the PLAIN
28118 authentication mechanism with a fixed user name and password:
28119 .code
28120 fixed_plain:
28121   driver = plaintext
28122   public_name = PLAIN
28123   client_send = ^username^mysecret
28124 .endd
28125 The lack of colons means that the entire text is sent with the AUTH
28126 command, with the circumflex characters converted to NULs.
28127 Note that due to the ambiguity of parsing three consectutive circumflex characters
28128 there is no way to provide a password having a leading circumflex.
28129
28130
28131 A similar example
28132 that uses the LOGIN mechanism is:
28133 .code
28134 fixed_login:
28135   driver = plaintext
28136   public_name = LOGIN
28137   client_send = : username : mysecret
28138 .endd
28139 The initial colon means that the first string is empty, so no data is sent with
28140 the AUTH command itself. The remaining strings are sent in response to
28141 prompts.
28142 .ecindex IIDplaiauth1
28143 .ecindex IIDplaiauth2
28144
28145
28146
28147
28148 . ////////////////////////////////////////////////////////////////////////////
28149 . ////////////////////////////////////////////////////////////////////////////
28150
28151 .chapter "The cram_md5 authenticator" "CHID9"
28152 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28153 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28154 .cindex "CRAM-MD5 authentication mechanism"
28155 .cindex authentication CRAM-MD5
28156 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28157 sends a challenge string to the client, and the response consists of a user
28158 name and the CRAM-MD5 digest of the challenge string combined with a secret
28159 string (password) which is known to both server and client. Thus, the secret
28160 is not sent over the network as plain text, which makes this authenticator more
28161 secure than &(plaintext)&. However, the downside is that the secret has to be
28162 available in plain text at either end.
28163
28164
28165 .section "Using cram_md5 as a server" "SECID176"
28166 .cindex "options" "&(cram_md5)& authenticator (server)"
28167 This authenticator has one server option, which must be set to configure the
28168 authenticator as a server:
28169
28170 .option server_secret cram_md5 string&!! unset
28171 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28172 When the server receives the client's response, the user name is placed in
28173 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28174 obtain the password for that user. The server then computes the CRAM-MD5 digest
28175 that the client should have sent, and checks that it received the correct
28176 string. If the expansion of &%server_secret%& is forced to fail, authentication
28177 fails. If the expansion fails for some other reason, a temporary error code is
28178 returned to the client.
28179
28180 For compatibility with previous releases of Exim, the user name is also placed
28181 in &$1$&. However, the use of this variables for this purpose is now
28182 deprecated, as it can lead to confusion in string expansions that also use
28183 numeric variables for other things.
28184
28185 For example, the following authenticator checks that the user name given by the
28186 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28187 user name, authentication fails.
28188 .code
28189 fixed_cram:
28190   driver = cram_md5
28191   public_name = CRAM-MD5
28192   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28193   server_set_id = $auth1
28194 .endd
28195 .vindex "&$authenticated_id$&"
28196 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28197 name in &$authenticated_id$&. A more typical configuration might look up the
28198 secret string in a file, using the user name as the key. For example:
28199 .code
28200 lookup_cram:
28201   driver = cram_md5
28202   public_name = CRAM-MD5
28203   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28204                   {$value}fail}
28205   server_set_id = $auth1
28206 .endd
28207 Note that this expansion explicitly forces failure if the lookup fails
28208 because &$auth1$& contains an unknown user name.
28209
28210 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28211 using the relevant libraries, you need to know the realm to specify in the
28212 lookup and then ask for the &"userPassword"& attribute for that user in that
28213 realm, with:
28214 .code
28215 cyrusless_crammd5:
28216   driver = cram_md5
28217   public_name = CRAM-MD5
28218   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28219                   dbmjz{/etc/sasldb2}{$value}fail}
28220   server_set_id = $auth1
28221 .endd
28222
28223 .section "Using cram_md5 as a client" "SECID177"
28224 .cindex "options" "&(cram_md5)& authenticator (client)"
28225 When used as a client, the &(cram_md5)& authenticator has two options:
28226
28227
28228
28229 .option client_name cram_md5 string&!! "the primary host name"
28230 This string is expanded, and the result used as the user name data when
28231 computing the response to the server's challenge.
28232
28233
28234 .option client_secret cram_md5 string&!! unset
28235 This option must be set for the authenticator to work as a client. Its value is
28236 expanded and the result used as the secret string when computing the response.
28237
28238
28239 .vindex "&$host$&"
28240 .vindex "&$host_address$&"
28241 Different user names and secrets can be used for different servers by referring
28242 to &$host$& or &$host_address$& in the options. Forced failure of either
28243 expansion string is treated as an indication that this authenticator is not
28244 prepared to handle this case. Exim moves on to the next configured client
28245 authenticator. Any other expansion failure causes Exim to give up trying to
28246 send the message to the current server.
28247
28248 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28249 strings, is:
28250 .code
28251 fixed_cram:
28252   driver = cram_md5
28253   public_name = CRAM-MD5
28254   client_name = ph10
28255   client_secret = secret
28256 .endd
28257 .ecindex IIDcramauth1
28258 .ecindex IIDcramauth2
28259
28260
28261
28262 . ////////////////////////////////////////////////////////////////////////////
28263 . ////////////////////////////////////////////////////////////////////////////
28264
28265 .chapter "The cyrus_sasl authenticator" "CHID10"
28266 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28267 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28268 .cindex "Cyrus" "SASL library"
28269 .cindex "Kerberos"
28270 The code for this authenticator was provided by Matthew Byng-Maddick while
28271 at A L Digital Ltd.
28272
28273 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28274 library implementation of the RFC 2222 (&"Simple Authentication and Security
28275 Layer"&). This library supports a number of authentication mechanisms,
28276 including PLAIN and LOGIN, but also several others that Exim does not support
28277 directly. In particular, there is support for Kerberos authentication.
28278
28279 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28280 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28281 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28282 name of the driver to determine which mechanism to support.
28283
28284 Where access to some kind of secret file is required, for example, in GSSAPI
28285 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28286 user, and that the Cyrus SASL library has no way of escalating privileges
28287 by default. You may also find you need to set environment variables,
28288 depending on the driver you are using.
28289
28290 The application name provided by Exim is &"exim"&, so various SASL options may
28291 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28292 Kerberos, note that because of limitations in the GSSAPI interface,
28293 changing the server keytab might need to be communicated down to the Kerberos
28294 layer independently. The mechanism for doing so is dependent upon the Kerberos
28295 implementation.
28296
28297 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28298 may be set to point to an alternative keytab file. Exim will pass this
28299 variable through from its own inherited environment when started as root or the
28300 Exim user. The keytab file needs to be readable by the Exim user.
28301 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28302 environment variable.  In practice, for those releases, the Cyrus authenticator
28303 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28304 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28305
28306
28307 .section "Using cyrus_sasl as a server" "SECID178"
28308 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28309 (on a successful authentication) into &$auth1$&. For compatibility with
28310 previous releases of Exim, the username is also placed in &$1$&. However, the
28311 use of this variable for this purpose is now deprecated, as it can lead to
28312 confusion in string expansions that also use numeric variables for other
28313 things.
28314
28315
28316 .option server_hostname cyrus_sasl string&!! "see below"
28317 This option selects the hostname that is used when communicating with the
28318 library. The default value is &`$primary_hostname`&. It is up to the underlying
28319 SASL plug-in what it does with this data.
28320
28321
28322 .option server_mech cyrus_sasl string "see below"
28323 This option selects the authentication mechanism this driver should use. The
28324 default is the value of the generic &%public_name%& option. This option allows
28325 you to use a different underlying mechanism from the advertised name. For
28326 example:
28327 .code
28328 sasl:
28329   driver = cyrus_sasl
28330   public_name = X-ANYTHING
28331   server_mech = CRAM-MD5
28332   server_set_id = $auth1
28333 .endd
28334
28335 .option server_realm cyrus_sasl string&!! unset
28336 This specifies the SASL realm that the server claims to be in.
28337
28338
28339 .option server_service cyrus_sasl string &`smtp`&
28340 This is the SASL service that the server claims to implement.
28341
28342
28343 For straightforward cases, you do not need to set any of the authenticator's
28344 private options. All you need to do is to specify an appropriate mechanism as
28345 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28346 PLAIN, you could have two authenticators as follows:
28347 .code
28348 sasl_cram_md5:
28349   driver = cyrus_sasl
28350   public_name = CRAM-MD5
28351   server_set_id = $auth1
28352
28353 sasl_plain:
28354   driver = cyrus_sasl
28355   public_name = PLAIN
28356   server_set_id = $auth2
28357 .endd
28358 Cyrus SASL does implement the LOGIN authentication method, even though it is
28359 not a standard method. It is disabled by default in the source distribution,
28360 but it is present in many binary distributions.
28361 .ecindex IIDcyrauth1
28362 .ecindex IIDcyrauth2
28363
28364
28365
28366
28367 . ////////////////////////////////////////////////////////////////////////////
28368 . ////////////////////////////////////////////////////////////////////////////
28369 .chapter "The dovecot authenticator" "CHAPdovecot"
28370 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28371 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28372 This authenticator is an interface to the authentication facility of the
28373 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28374 Note that Dovecot must be configured to use auth-client not auth-userdb.
28375 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28376 to use the same mechanisms for SMTP authentication. This is a server
28377 authenticator only. There is only one non-generic option:
28378
28379 .option server_socket dovecot string unset
28380
28381 This option must specify the UNIX socket that is the interface to Dovecot
28382 authentication. The &%public_name%& option must specify an authentication
28383 mechanism that Dovecot is configured to support. You can have several
28384 authenticators for different mechanisms. For example:
28385 .code
28386 dovecot_plain:
28387   driver = dovecot
28388   public_name = PLAIN
28389   server_advertise_condition = ${if def:tls_in_cipher}
28390   server_socket = /var/run/dovecot/auth-client
28391   server_set_id = $auth1
28392
28393 dovecot_ntlm:
28394   driver = dovecot
28395   public_name = NTLM
28396   server_socket = /var/run/dovecot/auth-client
28397   server_set_id = $auth1
28398 .endd
28399
28400 .new
28401 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28402 should not be advertised on cleartext SMTP connections.
28403 See the discussion in section &<<SECTplain_TLS>>&.
28404 .wen
28405
28406 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28407 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28408 option is passed in the Dovecot authentication command. If, for a TLS
28409 connection, a client certificate has been verified, the &"valid-client-cert"&
28410 option is passed. When authentication succeeds, the identity of the user
28411 who authenticated is placed in &$auth1$&.
28412
28413 The Dovecot configuration to match the above will look
28414 something like:
28415 .code
28416 conf.d/10-master.conf :-
28417
28418 service auth {
28419 ...
28420 #SASL
28421   unix_listener auth-client {
28422     mode = 0660
28423     user = mail
28424   }
28425 ...
28426 }
28427
28428 conf.d/10-auth.conf :-
28429
28430 auth_mechanisms = plain login ntlm
28431 .endd
28432
28433 .ecindex IIDdcotauth1
28434 .ecindex IIDdcotauth2
28435
28436
28437 . ////////////////////////////////////////////////////////////////////////////
28438 . ////////////////////////////////////////////////////////////////////////////
28439 .chapter "The gsasl authenticator" "CHAPgsasl"
28440 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28441 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28442 .cindex "authentication" "GNU SASL"
28443 .cindex "authentication" "SASL"
28444 .cindex "authentication" "EXTERNAL"
28445 .cindex "authentication" "ANONYMOUS"
28446 .cindex "authentication" "PLAIN"
28447 .cindex "authentication" "LOGIN"
28448 .cindex "authentication" "DIGEST-MD5"
28449 .cindex "authentication" "CRAM-MD5"
28450 .cindex "authentication" "SCRAM family"
28451 The &(gsasl)& authenticator provides integration for the GNU SASL
28452 library and the mechanisms it provides.  This is new as of the 4.80 release
28453 and there are a few areas where the library does not let Exim smoothly
28454 scale to handle future authentication mechanisms, so no guarantee can be
28455 made that any particular new authentication mechanism will be supported
28456 without code changes in Exim.
28457
28458 The library is expected to add support in an upcoming
28459 realease for the SCRAM-SHA-256 method.
28460 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28461 when this happens.
28462
28463 To see the list of mechanisms supported by the library run Exim with "auth" debug
28464 enabled and look for a line containing "GNU SASL supports".
28465 Note however that some may not have been tested from Exim.
28466
28467
28468 .option client_authz gsasl string&!! unset
28469 This option can be used to supply an &'authorization id'&
28470 which is different to the &'authentication_id'& provided
28471 by &%client_username%& option.
28472 If unset or (after expansion) empty it is not used,
28473 which is the common case.
28474
28475 .option client_channelbinding gsasl boolean false
28476 See &%server_channelbinding%& below.
28477
28478 .option client_password gsasl string&!! unset
28479 This option is exapanded before use, and should result in
28480 the password to be used, in clear.
28481
28482 .option client_username gsasl string&!! unset
28483 This option is exapanded before use, and should result in
28484 the account name to be used.
28485
28486
28487 .option client_spassword gsasl string&!! unset
28488 This option is only supported for library versions 1.9.1 and greater.
28489 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28490
28491 If a SCRAM mechanism is being used and this option is set
28492 and correctly sized
28493 it is used in preference to &%client_password%&.
28494 The value after expansion should be
28495 a 40 (for SHA-1) or 64 (for SHA-256) character string
28496 with the PBKDF2-prepared password, hex-encoded.
28497
28498 Note that this value will depend on the salt and iteration-count
28499 supplied by the server.
28500 The option is expanded before use.
28501 During the expansion &$auth1$& is set with the client username,
28502 &$auth2$& with the iteration count, and
28503 &$auth3$& with the salt.
28504
28505 The intent of this option
28506 is to support clients that can cache thes salted password
28507 to save on recalculation costs.
28508 The cache lookup should return an unusable value
28509 (eg. an empty string)
28510 if the salt or iteration count has changed
28511
28512 If the authentication succeeds then the above variables are set,
28513 .vindex "&$auth4$&"
28514 plus the calculated salted password value value in &$auth4$&,
28515 during the expansion of the &%client_set_id%& option.
28516 A side-effect of this expansion can be used to prime the cache.
28517
28518
28519 .option server_channelbinding gsasl boolean false
28520 Some authentication mechanisms are able to use external context at both ends
28521 of the session to bind the authentication to that context, and fail the
28522 authentication process if that context differs.  Specifically, some TLS
28523 ciphersuites can provide identifying information about the cryptographic
28524 context.
28525
28526 This should have meant that certificate identity and verification becomes a
28527 non-issue, as a man-in-the-middle attack will cause the correct client and
28528 server to see different identifiers and authentication will fail.
28529
28530 This is
28531 only usable by mechanisms which support "channel binding"; at time of
28532 writing, that's the SCRAM family.
28533 When using this feature the "-PLUS" variants of the method names need to be used.
28534
28535 This defaults off to ensure smooth upgrade across Exim releases, in case
28536 this option causes some clients to start failing.  Some future release
28537 of Exim might have switched the default to be true.
28538
28539 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28540 . Do not plan to rely upon this feature for security, ever, without consulting
28541 . with a subject matter expert (a cryptographic engineer).
28542
28543 This option was deprecated in previous releases due to doubts over
28544 the "Triple Handshake" vulnerability.
28545 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28546 Session Resumption was used) for safety.
28547
28548
28549 .option server_hostname gsasl string&!! "see below"
28550 This option selects the hostname that is used when communicating with the
28551 library. The default value is &`$primary_hostname`&.
28552 Some mechanisms will use this data.
28553
28554
28555 .option server_mech gsasl string "see below"
28556 This option selects the authentication mechanism this driver should use. The
28557 default is the value of the generic &%public_name%& option. This option allows
28558 you to use a different underlying mechanism from the advertised name. For
28559 example:
28560 .code
28561 sasl:
28562   driver = gsasl
28563   public_name = X-ANYTHING
28564   server_mech = CRAM-MD5
28565   server_set_id = $auth1
28566 .endd
28567
28568
28569 .option server_password gsasl string&!! unset
28570 Various mechanisms need access to the cleartext password on the server, so
28571 that proof-of-possession can be demonstrated on the wire, without sending
28572 the password itself.
28573
28574 The data available for lookup varies per mechanism.
28575 In all cases, &$auth1$& is set to the &'authentication id'&.
28576 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28577 if available, else the empty string.
28578 The &$auth3$& variable will always be the &'realm'& if available,
28579 else the empty string.
28580
28581 A forced failure will cause authentication to defer.
28582
28583 If using this option, it may make sense to set the &%server_condition%&
28584 option to be simply "true".
28585
28586
28587 .option server_realm gsasl string&!! unset
28588 This specifies the SASL realm that the server claims to be in.
28589 Some mechanisms will use this data.
28590
28591
28592 .option server_scram_iter gsasl string&!! 4096
28593 This option provides data for the SCRAM family of mechanisms.
28594 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28595 when this option is expanded.
28596
28597 The result of expansion should be a decimal number,
28598 and represents both a lower-bound on the security, and
28599 a compute cost factor imposed on the client
28600 (if it does not cache results, or the server changes
28601 either the iteration count or the salt).
28602 A minimum value of 4096 is required by the standards
28603 for all current SCRAM mechanism variants.
28604
28605 .option server_scram_salt gsasl string&!! unset
28606 This option provides data for the SCRAM family of mechanisms.
28607 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28608 when this option is expanded.
28609 The value should be a base64-encoded string,
28610 of random data typically 4-to-16 bytes long.
28611 If unset or empty after expansion the library will provides a value for the
28612 protocol conversation.
28613
28614
28615 .option server_key gsasl string&!! unset
28616 .option server_skey gsasl string&!! unset
28617 These options can be used for the SCRAM family of mechanisms
28618 to provide stored information related to a password,
28619 the storage of which is preferable to plaintext.
28620
28621 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28622 &%server_skey%& is StoredKey.
28623
28624 They are only available for version 1.9.0 (or later) of the gsasl library.
28625 When this is so, the macros
28626 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28627 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28628 will be defined.
28629
28630 The &$authN$& variables are available when these options are expanded.
28631
28632 If set, the results of expansion should for each
28633 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28634 of base64-coded data, and will be used in preference to the
28635 &%server_password%& option.
28636 If unset or not of the right length, &%server_password%& will be used.
28637
28638 The libgsasl library release includes a utility &'gsasl'& which can be used
28639 to generate these values.
28640
28641
28642 .option server_service gsasl string &`smtp`&
28643 This is the SASL service that the server claims to implement.
28644 Some mechanisms will use this data.
28645
28646
28647 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28648 .vindex "&$auth1$&, &$auth2$&, etc"
28649 These may be set when evaluating specific options, as detailed above.
28650 They will also be set when evaluating &%server_condition%&.
28651
28652 Unless otherwise stated below, the &(gsasl)& integration will use the following
28653 meanings for these variables:
28654
28655 .ilist
28656 .vindex "&$auth1$&"
28657 &$auth1$&: the &'authentication id'&
28658 .next
28659 .vindex "&$auth2$&"
28660 &$auth2$&: the &'authorization id'&
28661 .next
28662 .vindex "&$auth3$&"
28663 &$auth3$&: the &'realm'&
28664 .endlist
28665
28666 On a per-mechanism basis:
28667
28668 .ilist
28669 .cindex "authentication" "EXTERNAL"
28670 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28671 the &%server_condition%& option must be present.
28672 .next
28673 .cindex "authentication" "ANONYMOUS"
28674 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28675 the &%server_condition%& option must be present.
28676 .next
28677 .cindex "authentication" "GSSAPI"
28678 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28679 &$auth2$& will be set to the &'authorization id'&,
28680 the &%server_condition%& option must be present.
28681 .endlist
28682
28683 An &'anonymous token'& is something passed along as an unauthenticated
28684 identifier; this is analogous to FTP anonymous authentication passing an
28685 email address, or software-identifier@, as the "password".
28686
28687
28688 An example showing the password having the realm specified in the callback
28689 and demonstrating a Cyrus SASL to GSASL migration approach is:
28690 .code
28691 gsasl_cyrusless_crammd5:
28692   driver = gsasl
28693   public_name = CRAM-MD5
28694   server_realm = imap.example.org
28695   server_password = ${lookup{$auth1:$auth3:userPassword}\
28696                     dbmjz{/etc/sasldb2}{$value}fail}
28697   server_set_id = ${quote:$auth1}
28698   server_condition = yes
28699 .endd
28700
28701
28702 . ////////////////////////////////////////////////////////////////////////////
28703 . ////////////////////////////////////////////////////////////////////////////
28704
28705 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28706 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28707 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28708 .cindex "authentication" "GSSAPI"
28709 .cindex "authentication" "Kerberos"
28710 The &(heimdal_gssapi)& authenticator provides server integration for the
28711 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28712 reliably.
28713
28714 .option server_hostname heimdal_gssapi string&!! "see below"
28715 This option selects the hostname that is used, with &%server_service%&,
28716 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28717 identifier.  The default value is &`$primary_hostname`&.
28718
28719 .option server_keytab heimdal_gssapi string&!! unset
28720 If set, then Heimdal will not use the system default keytab (typically
28721 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28722 The value should be a pathname, with no &"file:"& prefix.
28723
28724 .option server_service heimdal_gssapi string&!! "smtp"
28725 This option specifies the service identifier used, in conjunction with
28726 &%server_hostname%&, for building the identifier for finding credentials
28727 from the keytab.
28728
28729
28730 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28731 Beware that these variables will typically include a realm, thus will appear
28732 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28733 not verified, so a malicious client can set it to anything.
28734
28735 The &$auth1$& field should be safely trustable as a value from the Key
28736 Distribution Center.  Note that these are not quite email addresses.
28737 Each identifier is for a role, and so the left-hand-side may include a
28738 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28739
28740 .vindex "&$auth1$&, &$auth2$&, etc"
28741 .ilist
28742 .vindex "&$auth1$&"
28743 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28744 .next
28745 .vindex "&$auth2$&"
28746 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28747 authentication.  If that was empty, this will also be set to the
28748 GSS Display Name.
28749 .endlist
28750
28751
28752 . ////////////////////////////////////////////////////////////////////////////
28753 . ////////////////////////////////////////////////////////////////////////////
28754
28755 .chapter "The spa authenticator" "CHAPspa"
28756 .scindex IIDspaauth1 "&(spa)& authenticator"
28757 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28758 .cindex "authentication" "Microsoft Secure Password"
28759 .cindex "authentication" "NTLM"
28760 .cindex "Microsoft Secure Password Authentication"
28761 .cindex "NTLM authentication"
28762 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28763 Password Authentication'& mechanism,
28764 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28765 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28766 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28767 server side was subsequently contributed by Tom Kistner. The mechanism works as
28768 follows:
28769
28770 .ilist
28771 After the AUTH command has been accepted, the client sends an SPA
28772 authentication request based on the user name and optional domain.
28773 .next
28774 The server sends back a challenge.
28775 .next
28776 The client builds a challenge response which makes use of the user's password
28777 and sends it to the server, which then accepts or rejects it.
28778 .endlist
28779
28780 Encryption is used to protect the password in transit.
28781
28782
28783
28784 .section "Using spa as a server" "SECID179"
28785 .cindex "options" "&(spa)& authenticator (server)"
28786 The &(spa)& authenticator has just one server option:
28787
28788 .option server_password spa string&!! unset
28789 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28790 This option is expanded, and the result must be the cleartext password for the
28791 authenticating user, whose name is at this point in &$auth1$&. For
28792 compatibility with previous releases of Exim, the user name is also placed in
28793 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28794 it can lead to confusion in string expansions that also use numeric variables
28795 for other things. For example:
28796 .code
28797 spa:
28798   driver = spa
28799   public_name = NTLM
28800   server_password = \
28801     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28802 .endd
28803 If the expansion is forced to fail, authentication fails. Any other expansion
28804 failure causes a temporary error code to be returned.
28805
28806
28807
28808
28809
28810 .section "Using spa as a client" "SECID180"
28811 .cindex "options" "&(spa)& authenticator (client)"
28812 The &(spa)& authenticator has the following client options:
28813
28814
28815
28816 .option client_domain spa string&!! unset
28817 This option specifies an optional domain for the authentication.
28818
28819
28820 .option client_password spa string&!! unset
28821 This option specifies the user's password, and must be set.
28822
28823
28824 .option client_username spa string&!! unset
28825 This option specifies the user name, and must be set. Here is an example of a
28826 configuration of this authenticator for use with the mail servers at
28827 &'msn.com'&:
28828 .code
28829 msn:
28830   driver = spa
28831   public_name = MSN
28832   client_username = msn/msn_username
28833   client_password = msn_plaintext_password
28834   client_domain = DOMAIN_OR_UNSET
28835 .endd
28836 .ecindex IIDspaauth1
28837 .ecindex IIDspaauth2
28838
28839
28840
28841
28842
28843 . ////////////////////////////////////////////////////////////////////////////
28844 . ////////////////////////////////////////////////////////////////////////////
28845
28846 .chapter "The external authenticator" "CHAPexternauth"
28847 .scindex IIDexternauth1 "&(external)& authenticator"
28848 .scindex IIDexternauth2 "authenticators" "&(external)&"
28849 .cindex "authentication" "Client Certificate"
28850 .cindex "authentication" "X509"
28851 .cindex "Certificate-based authentication"
28852 The &(external)& authenticator provides support for
28853 authentication based on non-SMTP information.
28854 The specification is in RFC 4422 Appendix A
28855 (&url(https://tools.ietf.org/html/rfc4422)).
28856 It is only a transport and negotiation mechanism;
28857 the process of authentication is entirely controlled
28858 by the server configuration.
28859
28860 The client presents an identity in-clear.
28861 It is probably wise for a server to only advertise,
28862 and for clients to only attempt,
28863 this authentication method on a secure (eg. under TLS) connection.
28864
28865 One possible use, compatible with the
28866 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28867 is for using X509 client certificates.
28868
28869 It thus overlaps in function with the TLS authenticator
28870 (see &<<CHAPtlsauth>>&)
28871 but is a full SMTP SASL authenticator
28872 rather than being implicit for TLS-connection carried
28873 client certificates only.
28874
28875 The examples and discussion in this chapter assume that
28876 client-certificate authentication is being done.
28877
28878 The client must present a certificate,
28879 for which it must have been requested via the
28880 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28881 (see &<<CHAPTLS>>&).
28882 For authentication to be effective the certificate should be
28883 verifiable against a trust-anchor certificate known to the server.
28884
28885 .section "External options" "SECTexternsoptions"
28886 .cindex "options" "&(external)& authenticator (server)"
28887 The &(external)& authenticator has two server options:
28888
28889 .option server_param2 external string&!! unset
28890 .option server_param3 external string&!! unset
28891 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28892 These options are expanded before the &%server_condition%& option
28893 and the result are placed in &$auth2$& and &$auth3$& resectively.
28894 If the expansion is forced to fail, authentication fails. Any other expansion
28895 failure causes a temporary error code to be returned.
28896
28897 They can be used to clarify the coding of a complex &%server_condition%&.
28898
28899 .section "Using external in a server" "SECTexternserver"
28900 .cindex "AUTH" "in &(external)& authenticator"
28901 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28902         "in &(external)& authenticator"
28903 .vindex "&$auth1$&, &$auth2$&, etc"
28904 .cindex "base64 encoding" "in &(external)& authenticator"
28905
28906 When running as a server, &(external)& performs the authentication test by
28907 expanding a string. The data sent by the client with the AUTH command, or in
28908 response to subsequent prompts, is base64 encoded, and so may contain any byte
28909 values when decoded. The decoded value is treated as
28910 an identity for authentication and
28911 placed in the expansion variable &$auth1$&.
28912
28913 For compatibility with previous releases of Exim, the value is also placed in
28914 the expansion variable &$1$&. However, the use of this
28915 variable for this purpose is now deprecated, as it can lead to confusion in
28916 string expansions that also use them for other things.
28917
28918 .vindex "&$authenticated_id$&"
28919 Once an identity has been received,
28920 &%server_condition%& is expanded. If the expansion is forced to fail,
28921 authentication fails. Any other expansion failure causes a temporary error code
28922 to be returned. If the result of a successful expansion is an empty string,
28923 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28924 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28925 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28926 For any other result, a temporary error code is returned, with the expanded
28927 string as the error text.
28928
28929 Example:
28930 .code
28931 ext_ccert_san_mail:
28932   driver =            external
28933   public_name =       EXTERNAL
28934
28935   server_advertise_condition = $tls_in_certificate_verified
28936   server_param2 =     ${certextract {subj_altname,mail,>:} \
28937                                     {$tls_in_peercert}}
28938   server_condition =  ${if forany {$auth2} \
28939                             {eq {$item}{$auth1}}}
28940   server_set_id =     $auth1
28941 .endd
28942 This accepts a client certificate that is verifiable against any
28943 of your configured trust-anchors
28944 (which usually means the full set of public CAs)
28945 and which has a mail-SAN matching the claimed identity sent by the client.
28946
28947 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28948 The account name is therefore guessable by an opponent.
28949 TLS 1.3 protects both server and client certificates, and is not vulnerable
28950 in this way.
28951
28952
28953 .section "Using external in a client" "SECTexternclient"
28954 .cindex "options" "&(external)& authenticator (client)"
28955 The &(external)& authenticator has one client option:
28956
28957 .option client_send external string&!! unset
28958 This option is expanded and sent with the AUTH command as the
28959 identity being asserted.
28960
28961 Example:
28962 .code
28963 ext_ccert:
28964   driver =      external
28965   public_name = EXTERNAL
28966
28967   client_condition = ${if !eq{$tls_out_cipher}{}}
28968   client_send = myaccount@smarthost.example.net
28969 .endd
28970
28971
28972 .ecindex IIDexternauth1
28973 .ecindex IIDexternauth2
28974
28975
28976
28977
28978
28979 . ////////////////////////////////////////////////////////////////////////////
28980 . ////////////////////////////////////////////////////////////////////////////
28981
28982 .chapter "The tls authenticator" "CHAPtlsauth"
28983 .scindex IIDtlsauth1 "&(tls)& authenticator"
28984 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28985 .cindex "authentication" "Client Certificate"
28986 .cindex "authentication" "X509"
28987 .cindex "Certificate-based authentication"
28988 The &(tls)& authenticator provides server support for
28989 authentication based on client certificates.
28990
28991 It is not an SMTP authentication mechanism and is not
28992 advertised by the server as part of the SMTP EHLO response.
28993 It is an Exim authenticator in the sense that it affects
28994 the protocol element of the log line, can be tested for
28995 by the &%authenticated%& ACL condition, and can set
28996 the &$authenticated_id$& variable.
28997
28998 The client must present a verifiable certificate,
28999 for which it must have been requested via the
29000 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29001 (see &<<CHAPTLS>>&).
29002
29003 If an authenticator of this type is configured it is
29004 run immediately after a TLS connection being negotiated
29005 (due to either STARTTLS or TLS-on-connect)
29006 and can authenticate the connection.
29007 If it does, SMTP authentication is not subsequently offered.
29008
29009 A maximum of one authenticator of this type may be present.
29010
29011
29012 .cindex "options" "&(tls)& authenticator (server)"
29013 The &(tls)& authenticator has three server options:
29014
29015 .option server_param1 tls string&!! unset
29016 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29017 This option is expanded after the TLS negotiation and
29018 the result is placed in &$auth1$&.
29019 If the expansion is forced to fail, authentication fails. Any other expansion
29020 failure causes a temporary error code to be returned.
29021
29022 .option server_param2 tls string&!! unset
29023 .option server_param3 tls string&!! unset
29024 As above, for &$auth2$& and &$auth3$&.
29025
29026 &%server_param1%& may also be spelled &%server_param%&.
29027
29028
29029 Example:
29030 .code
29031 tls:
29032   driver = tls
29033   server_param1 =     ${certextract {subj_altname,mail,>:} \
29034                                     {$tls_in_peercert}}
29035   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29036                                  {forany {$auth1} \
29037                             {!= {0} \
29038                                 {${lookup ldap{ldap:///\
29039                          mailname=${quote_ldap_dn:${lc:$item}},\
29040                          ou=users,LDAP_DC?mailid} {$value}{0} \
29041                        }    }  } }}}
29042   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29043 .endd
29044 This accepts a client certificate that is verifiable against any
29045 of your configured trust-anchors
29046 (which usually means the full set of public CAs)
29047 and which has a SAN with a good account name.
29048
29049 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29050 The account name is therefore guessable by an opponent.
29051 TLS 1.3 protects both server and client certificates, and is not vulnerable
29052 in this way.
29053 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29054
29055 . An alternative might use
29056 . .code
29057 .   server_param1 = ${sha256:$tls_in_peercert}
29058 . .endd
29059 . to require one of a set of specific certs that define a given account
29060 . (the verification is still required, but mostly irrelevant).
29061 . This would help for per-device use.
29062 .
29063 . However, for the future we really need support for checking a
29064 . user cert in LDAP - which probably wants a base-64 DER.
29065
29066 .ecindex IIDtlsauth1
29067 .ecindex IIDtlsauth2
29068
29069
29070 Note that because authentication is traditionally an SMTP operation,
29071 the &%authenticated%& ACL condition cannot be used in
29072 a connect- or helo-ACL.
29073
29074
29075
29076 . ////////////////////////////////////////////////////////////////////////////
29077 . ////////////////////////////////////////////////////////////////////////////
29078
29079 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29080          "Encrypted SMTP connections"
29081 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29082 .scindex IIDencsmtp2 "SMTP" "encryption"
29083 .cindex "TLS" "on SMTP connection"
29084 .cindex "OpenSSL"
29085 .cindex "GnuTLS"
29086 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29087 Sockets Layer), is implemented by making use of the OpenSSL library or the
29088 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29089 cryptographic code in the Exim distribution itself for implementing TLS. In
29090 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29091 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29092 You also need to understand the basic concepts of encryption at a managerial
29093 level, and in particular, the way that public keys, private keys, and
29094 certificates are used.
29095
29096 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29097 connection is established, the client issues a STARTTLS command. If the
29098 server accepts this, the client and the server negotiate an encryption
29099 mechanism. If the negotiation succeeds, the data that subsequently passes
29100 between them is encrypted.
29101
29102 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29103 and if so, what cipher suite is in use, whether the client supplied a
29104 certificate, and whether or not that certificate was verified. This makes it
29105 possible for an Exim server to deny or accept certain commands based on the
29106 encryption state.
29107
29108 &*Warning*&: Certain types of firewall and certain anti-virus products can
29109 disrupt TLS connections. You need to turn off SMTP scanning for these products
29110 in order to get TLS to work.
29111
29112
29113
29114 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29115          "SECID284"
29116 .cindex "submissions protocol"
29117 .cindex "ssmtp protocol"
29118 .cindex "smtps protocol"
29119 .cindex "SMTP" "submissions protocol"
29120 .cindex "SMTP" "ssmtp protocol"
29121 .cindex "SMTP" "smtps protocol"
29122 The history of port numbers for TLS in SMTP is a little messy and has been
29123 contentious.  As of RFC 8314, the common practice of using the historically
29124 allocated port 465 for "email submission but with TLS immediately upon connect
29125 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29126 by them in preference to STARTTLS.
29127
29128 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29129 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29130 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29131
29132 This approach was, for a while, officially abandoned when encrypted SMTP was
29133 standardized, but many clients kept using it, even as the TCP port number was
29134 reassigned for other use.
29135 Thus you may encounter guidance claiming that you shouldn't enable use of
29136 this port.
29137 In practice, a number of mail-clients have only ever supported submissions,
29138 not submission with STARTTLS upgrade.
29139 Ideally, offer both submission (587) and submissions (465) service.
29140
29141 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29142 global option. Its value must be a list of port numbers;
29143 the most common use is expected to be:
29144 .code
29145 tls_on_connect_ports = 465
29146 .endd
29147 The port numbers specified by this option apply to all SMTP connections, both
29148 via the daemon and via &'inetd'&. You still need to specify all the ports that
29149 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29150 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29151 an extra port &-- rather, it specifies different behaviour on a port that is
29152 defined elsewhere.
29153
29154 There is also a &%-tls-on-connect%& command line option. This overrides
29155 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29156
29157
29158
29159
29160
29161
29162 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29163 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29164 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29165 To build Exim to use OpenSSL you need to set
29166 .code
29167 USE_OPENSSL=yes
29168 .endd
29169 in Local/Makefile.
29170
29171 To build Exim to use GnuTLS, you need to set
29172 .code
29173 USE_GNUTLS=yes
29174 .endd
29175 in Local/Makefile.
29176
29177 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29178 include files and libraries for GnuTLS can be found.
29179
29180 There are some differences in usage when using GnuTLS instead of OpenSSL:
29181
29182 .ilist
29183 The &%tls_verify_certificates%& option
29184 cannot be the path of a directory
29185 for GnuTLS versions before 3.3.6
29186 (for later versions, or OpenSSL, it can be either).
29187 .next
29188 The default value for &%tls_dhparam%& differs for historical reasons.
29189 .next
29190 .vindex "&$tls_in_peerdn$&"
29191 .vindex "&$tls_out_peerdn$&"
29192 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29193 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29194 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29195 .next
29196 OpenSSL identifies cipher suites using hyphens as separators, for example:
29197 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29198 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29199 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29200 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29201 to handle its own older variants) when processing lists of cipher suites in the
29202 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29203 option).
29204 .next
29205 The &%tls_require_ciphers%& options operate differently, as described in the
29206 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29207 .next
29208 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29209 When using OpenSSL, this option is ignored.
29210 (If an API is found to let OpenSSL be configured in this way,
29211 let the Exim Maintainers know and we'll likely use it).
29212 .next
29213 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29214 main option, it must be ordered to match the &%tls_certificate%& list.
29215 .next
29216 Some other recently added features may only be available in one or the other.
29217 This should be documented with the feature.  If the documentation does not
29218 explicitly state that the feature is infeasible in the other TLS
29219 implementation, then patches are welcome.
29220 .next
29221 The output from "exim -bV" will show which (if any) support was included
29222 in the build.
29223 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29224 .endlist
29225
29226
29227 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29228 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29229 an explicit path; if the latter, then the text about generation still applies,
29230 but not the chosen filename.
29231 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29232 See the documentation of &%tls_dhparam%& for more information.
29233
29234 GnuTLS uses D-H parameters that may take a substantial amount of time
29235 to compute. It is unreasonable to re-compute them for every TLS session.
29236 Therefore, Exim keeps this data in a file in its spool directory, called
29237 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29238 of bits requested.
29239 The file is owned by the Exim user and is readable only by
29240 its owner. Every Exim process that start up GnuTLS reads the D-H
29241 parameters from this file. If the file does not exist, the first Exim process
29242 that needs it computes the data and writes it to a temporary file which is
29243 renamed once it is complete. It does not matter if several Exim processes do
29244 this simultaneously (apart from wasting a few resources). Once a file is in
29245 place, new Exim processes immediately start using it.
29246
29247 For maximum security, the parameters that are stored in this file should be
29248 recalculated periodically, the frequency depending on your paranoia level.
29249 If you are avoiding using the fixed D-H primes published in RFCs, then you
29250 are concerned about some advanced attacks and will wish to do this; if you do
29251 not regenerate then you might as well stick to the standard primes.
29252
29253 Arranging this is easy in principle; just delete the file when you want new
29254 values to be computed. However, there may be a problem. The calculation of new
29255 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29256 If the system is not very active, &_/dev/random_& may delay returning data
29257 until enough randomness (entropy) is available. This may cause Exim to hang for
29258 a substantial amount of time, causing timeouts on incoming connections.
29259
29260 The solution is to generate the parameters externally to Exim. They are stored
29261 in &_gnutls-params-N_& in PEM format, which means that they can be
29262 generated externally using the &(certtool)& command that is part of GnuTLS.
29263
29264 To replace the parameters with new ones, instead of deleting the file
29265 and letting Exim re-create it, you can generate new parameters using
29266 &(certtool)& and, when this has been done, replace Exim's cache file by
29267 renaming. The relevant commands are something like this:
29268 .code
29269 # ls
29270 [ look for file; assume gnutls-params-2236 is the most recent ]
29271 # rm -f new-params
29272 # touch new-params
29273 # chown exim:exim new-params
29274 # chmod 0600 new-params
29275 # certtool --generate-dh-params --bits 2236 >>new-params
29276 # openssl dhparam -noout -text -in new-params | head
29277 [ check the first line, make sure it's not more than 2236;
29278   if it is, then go back to the start ("rm") and repeat
29279   until the size generated is at most the size requested ]
29280 # chmod 0400 new-params
29281 # mv new-params gnutls-params-2236
29282 .endd
29283 If Exim never has to generate the parameters itself, the possibility of
29284 stalling is removed.
29285
29286 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29287 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29288 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29289 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29290 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29291 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29292 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29293 which applies to all D-H usage, client or server.  If the value returned by
29294 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29295 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29296 limit, which is still much higher than Exim historically used.
29297
29298 The filename and bits used will change as the GnuTLS maintainers change the
29299 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29300 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29301 2432 bits, while NSS is limited to 2236 bits.
29302
29303 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29304 increase the chance of the generated prime actually being within acceptable
29305 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29306 procedure above.  There is no sane procedure available to Exim to double-check
29307 the size of the generated prime, so it might still be too large.
29308
29309
29310 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29311 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29312 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29313 There is a function in the OpenSSL library that can be passed a list of cipher
29314 suites before the cipher negotiation takes place. This specifies which ciphers
29315 are acceptable for TLS versions prior to 1.3.
29316 The list is colon separated and may contain names like
29317 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29318 directly to this function call.
29319 Many systems will install the OpenSSL manual-pages, so you may have
29320 &'ciphers(1)'& available to you.
29321 The following quotation from the OpenSSL
29322 documentation specifies what forms of item are allowed in the cipher string:
29323
29324 .ilist
29325 It can consist of a single cipher suite such as RC4-SHA.
29326 .next
29327 It can represent a list of cipher suites containing a certain algorithm,
29328 or cipher suites of a certain type. For example SHA1 represents all
29329 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29330 SSL v3 algorithms.
29331 .next
29332 Lists of cipher suites can be combined in a single cipher string using
29333 the + character. This is used as a logical and operation. For example
29334 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29335 algorithms.
29336 .endlist
29337
29338 Each cipher string can be optionally preceded by one of the characters &`!`&,
29339 &`-`& or &`+`&.
29340 .ilist
29341 If &`!`& is used, the ciphers are permanently deleted from the list. The
29342 ciphers deleted can never reappear in the list even if they are explicitly
29343 stated.
29344 .next
29345 If &`-`& is used, the ciphers are deleted from the list, but some or all
29346 of the ciphers can be added again by later options.
29347 .next
29348 If &`+`& is used, the ciphers are moved to the end of the list. This
29349 option does not add any new ciphers; it just moves matching existing ones.
29350 .endlist
29351
29352 If none of these characters is present, the string is interpreted as
29353 a list of ciphers to be appended to the current preference list. If the list
29354 includes any ciphers already present they will be ignored: that is, they will
29355 not be moved to the end of the list.
29356 .endlist
29357
29358 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29359 string:
29360 .code
29361 # note single-quotes to get ! past any shell history expansion
29362 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29363 .endd
29364
29365 This example will let the library defaults be permitted on the MX port, where
29366 there's probably no identity verification anyway, but ups the ante on the
29367 submission ports where the administrator might have some influence on the
29368 choice of clients used:
29369 .code
29370 # OpenSSL variant; see man ciphers(1)
29371 tls_require_ciphers = ${if =={$received_port}{25}\
29372                            {DEFAULT}\
29373                            {HIGH:!MD5:!SHA1}}
29374 .endd
29375
29376 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29377 .code
29378 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29379 .endd
29380
29381 For TLS version 1.3 the control available is less fine-grained
29382 and Exim does not provide access to it at present.
29383 The value of the &%tls_require_ciphers%& option is ignored when
29384 TLS version 1.3 is negotiated.
29385
29386 As of writing the library default cipher suite list for TLSv1.3 is
29387 .code
29388 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29389 .endd
29390
29391
29392 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29393          "SECTreqciphgnu"
29394 .cindex "GnuTLS" "specifying parameters for"
29395 .cindex "TLS" "specifying ciphers (GnuTLS)"
29396 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29397 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29398 .cindex "TLS" "specifying protocols (GnuTLS)"
29399 .cindex "TLS" "specifying priority string (GnuTLS)"
29400 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29401 The GnuTLS library allows the caller to provide a "priority string", documented
29402 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29403 ciphersuite specification in OpenSSL.
29404
29405 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29406 and controls both protocols and ciphers.
29407
29408 The &%tls_require_ciphers%& option is available both as an global option,
29409 controlling how Exim behaves as a server, and also as an option of the
29410 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29411 the value is string expanded.  The resulting string is not an Exim list and
29412 the string is given to the GnuTLS library, so that Exim does not need to be
29413 aware of future feature enhancements of GnuTLS.
29414
29415 Documentation of the strings accepted may be found in the GnuTLS manual, under
29416 "Priority strings".  This is online as
29417 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29418 but beware that this relates to GnuTLS 3, which may be newer than the version
29419 installed on your system.  If you are using GnuTLS 3,
29420 then the example code
29421 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29422 on that site can be used to test a given string.
29423
29424 For example:
29425 .code
29426 # Disable older versions of protocols
29427 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29428 .endd
29429
29430 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29431 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29432 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29433
29434 This example will let the library defaults be permitted on the MX port, where
29435 there's probably no identity verification anyway, and lowers security further
29436 by increasing compatibility; but this ups the ante on the submission ports
29437 where the administrator might have some influence on the choice of clients
29438 used:
29439 .code
29440 # GnuTLS variant
29441 tls_require_ciphers = ${if =={$received_port}{25}\
29442                            {NORMAL:%COMPAT}\
29443                            {SECURE128}}
29444 .endd
29445
29446
29447 .section "Configuring an Exim server to use TLS" "SECID182"
29448 .cindex "TLS" "configuring an Exim server"
29449 .cindex "ESMTP extensions" STARTTLS
29450 When Exim has been built with TLS support, it advertises the availability of
29451 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29452 but not to any others. The default value of this option is *, which means
29453 that STARTTLS is always advertised.  Set it to blank to never advertise;
29454 this is reasonable for systems that want to use TLS only as a client.
29455
29456 If STARTTLS is to be used you
29457 need to set some other options in order to make TLS available.
29458
29459 If a client issues a STARTTLS command and there is some configuration
29460 problem in the server, the command is rejected with a 454 error. If the client
29461 persists in trying to issue SMTP commands, all except QUIT are rejected
29462 with the error
29463 .code
29464 554 Security failure
29465 .endd
29466 If a STARTTLS command is issued within an existing TLS session, it is
29467 rejected with a 554 error code.
29468
29469 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29470 must be set to match some hosts. The default is * which matches all hosts.
29471
29472 If this is all you do, TLS encryption will be enabled but not authentication -
29473 meaning that the peer has no assurance it is actually you he is talking to.
29474 You gain protection from a passive sniffer listening on the wire but not
29475 from someone able to intercept the communication.
29476
29477 Further protection requires some further configuration at the server end.
29478
29479 To make TLS work you need to set, in the server,
29480 .code
29481 tls_certificate = /some/file/name
29482 tls_privatekey = /some/file/name
29483 .endd
29484 These options are, in fact, expanded strings, so you can make them depend on
29485 the identity of the client that is connected if you wish. The first file
29486 contains the server's X509 certificate, and the second contains the private key
29487 that goes with it. These files need to be
29488 PEM format and readable by the Exim user, and must
29489 always be given as full path names.
29490 The key must not be password-protected.
29491 They can be the same file if both the
29492 certificate and the key are contained within it. If &%tls_privatekey%& is not
29493 set, or if its expansion is forced to fail or results in an empty string, this
29494 is assumed to be the case. The certificate file may also contain intermediate
29495 certificates that need to be sent to the client to enable it to authenticate
29496 the server's certificate.
29497
29498 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29499 colon-separated lists of file paths.  Ciphers using given authentication
29500 algorithms require the presence of a suitable certificate to supply the
29501 public-key.  The server selects among the certificates to present to the
29502 client depending on the selected cipher, hence the priority ordering for
29503 ciphers will affect which certificate is used.
29504
29505 If you do not understand about certificates and keys, please try to find a
29506 source of this background information, which is not Exim-specific. (There are a
29507 few comments below in section &<<SECTcerandall>>&.)
29508
29509 &*Note*&: These options do not apply when Exim is operating as a client &--
29510 they apply only in the case of a server. If you need to use a certificate in an
29511 Exim client, you must set the options of the same names in an &(smtp)&
29512 transport.
29513
29514 With just these options, an Exim server will be able to use TLS. It does not
29515 require the client to have a certificate (but see below for how to insist on
29516 this). There is one other option that may be needed in other situations. If
29517 .code
29518 tls_dhparam = /some/file/name
29519 .endd
29520 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29521 with the parameters contained in the file.
29522 Set this to &`none`& to disable use of DH entirely, by making no prime
29523 available:
29524 .code
29525 tls_dhparam = none
29526 .endd
29527 This may also be set to a string identifying a standard prime to be used for
29528 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29529 used is &`ike23`&.  There are a few standard primes available, see the
29530 documentation for &%tls_dhparam%& for the complete list.
29531
29532 See the command
29533 .code
29534 openssl dhparam
29535 .endd
29536 for a way of generating file data.
29537
29538 The strings supplied for these three options are expanded every time a client
29539 host connects. It is therefore possible to use different certificates and keys
29540 for different hosts, if you so wish, by making use of the client's IP address
29541 in &$sender_host_address$& to control the expansion. If a string expansion is
29542 forced to fail, Exim behaves as if the option is not set.
29543
29544 .cindex "cipher" "logging"
29545 .cindex "log" "TLS cipher"
29546 .vindex "&$tls_in_cipher$&"
29547 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29548 an incoming TLS connection. It is included in the &'Received:'& header of an
29549 incoming message (by default &-- you can, of course, change this), and it is
29550 also included in the log line that records a message's arrival, keyed by
29551 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29552 condition can be used to test for specific cipher suites in ACLs.
29553
29554 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29555 can check the name of the cipher suite and vary their actions accordingly. The
29556 cipher suite names vary, depending on which TLS library is being used. For
29557 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29558 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29559 documentation for more details.
29560
29561 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29562 (again depending on the &%tls_cipher%& log selector).
29563
29564
29565 .subsection "Requesting and verifying client certificates"
29566 .cindex "certificate" "verification of client"
29567 .cindex "TLS" "client certificate verification"
29568 If you want an Exim server to request a certificate when negotiating a TLS
29569 session with a client, you must set either &%tls_verify_hosts%& or
29570 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29571 apply to all TLS connections. For any host that matches one of these options,
29572 Exim requests a certificate as part of the setup of the TLS session. The
29573 contents of the certificate are verified by comparing it with a list of
29574 expected trust-anchors or certificates.
29575 These may be the system default set (depending on library version),
29576 an explicit file or,
29577 depending on library version, a directory, identified by
29578 &%tls_verify_certificates%&.
29579
29580 A file can contain multiple certificates, concatenated end to end. If a
29581 directory is used
29582 (OpenSSL only),
29583 each certificate must be in a separate file, with a name (or a symbolic link)
29584 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29585 certificate. You can compute the relevant hash by running the command
29586 .code
29587 openssl x509 -hash -noout -in /cert/file
29588 .endd
29589 where &_/cert/file_& contains a single certificate.
29590
29591 There is no checking of names of the client against the certificate
29592 Subject Name or Subject Alternate Names.
29593
29594 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29595 what happens if the client does not supply a certificate, or if the certificate
29596 does not match any of the certificates in the collection named by
29597 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29598 attempt to set up a TLS session is aborted, and the incoming connection is
29599 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29600 session continues. ACLs that run for subsequent SMTP commands can detect the
29601 fact that no certificate was verified, and vary their actions accordingly. For
29602 example, you can insist on a certificate before accepting a message for
29603 relaying, but not when the message is destined for local delivery.
29604
29605 .vindex "&$tls_in_peerdn$&"
29606 When a client supplies a certificate (whether it verifies or not), the value of
29607 the Distinguished Name of the certificate is made available in the variable
29608 &$tls_in_peerdn$& during subsequent processing of the message.
29609
29610 .cindex "log" "distinguished name"
29611 Because it is often a long text string, it is not included in the log line or
29612 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29613 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29614 &%received_header_text%& to change the &'Received:'& header. When no
29615 certificate is supplied, &$tls_in_peerdn$& is empty.
29616
29617
29618 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29619 .cindex certificate caching
29620 .cindex privatekey caching
29621 .cindex crl caching
29622 .cindex ocsp caching
29623 .cindex ciphers caching
29624 .cindex "CA bundle" caching
29625 .cindex "certificate authorities" caching
29626 .cindex tls_certificate caching
29627 .cindex tls_privatekey caching
29628 .cindex tls_crl caching
29629 .cindex tls_ocsp_file caching
29630 .cindex tls_require_ciphers caching
29631 .cindex tls_verify_certificate caching
29632 .cindex caching certificate
29633 .cindex caching privatekey
29634 .cindex caching crl
29635 .cindex caching ocsp
29636 .cindex caching ciphers
29637 .cindex caching "certificate authorities
29638 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29639 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29640 expandable elements,
29641 then the associated information is loaded at daemon startup.
29642 It is made available
29643 to child processes forked for handling received SMTP connections.
29644
29645 This caching is currently only supported under Linux and FreeBSD.
29646
29647 If caching is not possible, for example if an item has to be dependent
29648 on the peer host so contains a &$sender_host_name$& expansion, the load
29649 of the associated information is done at the startup of the TLS connection.
29650
29651 The cache is invalidated and reloaded after any changes to the directories
29652 containing files specified by these options.
29653
29654 The information specified by the main option &%tls_verify_certificates%&
29655 is similarly cached so long as it specifies files explicitly
29656 or (under GnuTLS) is the string &"system,cache"&.
29657 The latter case is not automatically invalidated;
29658 it is the operator's responsibility to arrange for a daemon restart
29659 any time the system certificate authority bundle is updated.
29660 A HUP signal is sufficient for this.
29661 The value &"system"& results in no caching under GnuTLS.
29662
29663 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29664 is acceptable in configurations for the Exim executavble.
29665
29666 Caching of the system Certificate Authorities bundle can
29667 save siginificant time and processing on every TLS connection
29668 accepted by Exim.
29669
29670
29671
29672
29673 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29674 .cindex "cipher" "logging"
29675 .cindex "log" "TLS cipher"
29676 .cindex "log" "distinguished name"
29677 .cindex "TLS" "configuring an Exim client"
29678 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29679 deliveries as well as to incoming, the latter one causing logging of the
29680 server certificate's DN. The remaining client configuration for TLS is all
29681 within the &(smtp)& transport.
29682
29683 .cindex "ESMTP extensions" STARTTLS
29684 It is not necessary to set any options to have TLS work in the &(smtp)&
29685 transport. If Exim is built with TLS support, and TLS is advertised by a
29686 server, the &(smtp)& transport always tries to start a TLS session. However,
29687 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29688 transport) to a list of server hosts for which TLS should not be used.
29689
29690 If you do not want Exim to attempt to send messages unencrypted when an attempt
29691 to set up an encrypted connection fails in any way, you can set
29692 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29693 those hosts, delivery is always deferred if an encrypted connection cannot be
29694 set up. If there are any other hosts for the address, they are tried in the
29695 usual way.
29696
29697 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29698 the message unencrypted. It always does this if the response to STARTTLS is
29699 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29700 session after a success response code, what happens is controlled by the
29701 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29702 delivery to this host is deferred, and other hosts (if available) are tried. If
29703 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29704 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29705 negotiation fails, Exim closes the current connection (because it is in an
29706 unknown state), opens a new one to the same host, and then tries the delivery
29707 unencrypted.
29708
29709 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29710 transport provide the client with a certificate, which is passed to the server
29711 if it requests it.
29712 This is an optional thing for TLS connections, although either end
29713 may insist on it.
29714 If the server is Exim, it will request a certificate only if
29715 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29716
29717 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29718 for client use (they are usable for server use).
29719 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29720 in failed connections.
29721
29722 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29723 specifies a collection of expected server certificates.
29724 These may be
29725 the system default set (depending on library version),
29726 a file,
29727 or (depending on library version) a directory.
29728 The client verifies the server's certificate
29729 against this collection, taking into account any revoked certificates that are
29730 in the list defined by &%tls_crl%&.
29731 Failure to verify fails the TLS connection unless either of the
29732 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29733
29734 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29735 certificate verification to the listed servers.  Verification either must
29736 or need not succeed respectively.
29737
29738 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29739 name checks are made on the server certificate.
29740 The match against this list is, as per other Exim usage, the
29741 IP for the host.  That is most closely associated with the
29742 name on the DNS A (or AAAA) record for the host.
29743 However, the name that needs to be in the certificate
29744 is the one at the head of any CNAME chain leading to the A record.
29745 The option defaults to always checking.
29746
29747 The &(smtp)& transport has two OCSP-related options:
29748 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29749 is requested and required for the connection to proceed.  The default
29750 value is empty.
29751 &%hosts_request_ocsp%&; a host-list for which (additionally)
29752 a Certificate Status is requested (but not necessarily verified).  The default
29753 value is "*" meaning that requests are made unless configured
29754 otherwise.
29755
29756 The host(s) should also be in &%hosts_require_tls%&, and
29757 &%tls_verify_certificates%& configured for the transport,
29758 for OCSP to be relevant.
29759
29760 If
29761 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29762 list of permitted cipher suites. If either of these checks fails, delivery to
29763 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29764 alternative hosts, if any.
29765
29766  &*Note*&:
29767 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29768 is operating as a client. Exim does not assume that a server certificate (set
29769 by the global options of the same name) should also be used when operating as a
29770 client.
29771
29772 .vindex "&$host$&"
29773 .vindex "&$host_address$&"
29774 All the TLS options in the &(smtp)& transport are expanded before use, with
29775 &$host$& and &$host_address$& containing the name and address of the server to
29776 which the client is connected. Forced failure of an expansion causes Exim to
29777 behave as if the relevant option were unset.
29778
29779 .vindex &$tls_out_bits$&
29780 .vindex &$tls_out_cipher$&
29781 .vindex &$tls_out_peerdn$&
29782 .vindex &$tls_out_sni$&
29783 Before an SMTP connection is established, the
29784 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29785 variables are emptied. (Until the first connection, they contain the values
29786 that were set when the message was received.) If STARTTLS is subsequently
29787 successfully obeyed, these variables are set to the relevant values for the
29788 outgoing connection.
29789
29790
29791
29792 .subsection "Caching of static client configuration items" SECTclientTLScache
29793 .cindex certificate caching
29794 .cindex privatekey caching
29795 .cindex crl caching
29796 .cindex ciphers caching
29797 .cindex "CA bundle" caching
29798 .cindex "certificate authorities" caching
29799 .cindex tls_certificate caching
29800 .cindex tls_privatekey caching
29801 .cindex tls_crl caching
29802 .cindex tls_require_ciphers caching
29803 .cindex tls_verify_certificate caching
29804 .cindex caching certificate
29805 .cindex caching privatekey
29806 .cindex caching crl
29807 .cindex caching ciphers
29808 .cindex caching "certificate authorities
29809 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29810 and &%tls_crl%& have values with no
29811 expandable elements,
29812 then the associated information is loaded per smtp transport
29813 at daemon startup, at the start of a queue run, or on a
29814 command-line specified message delivery.
29815 It is made available
29816 to child processes forked for handling making SMTP connections.
29817
29818 This caching is currently only supported under Linux.
29819
29820 If caching is not possible, the load
29821 of the associated information is done at the startup of the TLS connection.
29822
29823 The cache is invalidated in the daemon
29824 and reloaded after any changes to the directories
29825 containing files specified by these options.
29826
29827 The information specified by the main option &%tls_verify_certificates%&
29828 is similarly cached so long as it specifies files explicitly
29829 or (under GnuTLS) is the string &"system,cache"&.
29830 The latter case is not automatically invaludated;
29831 it is the operator's responsibility to arrange for a daemon restart
29832 any time the system certificate authority bundle is updated.
29833 A HUP signal is sufficient for this.
29834 The value &"system"& results in no caching under GnuTLS.
29835
29836 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29837 is acceptable in configurations for the Exim executavble.
29838
29839 Caching of the system Certificate Authorities bundle can
29840 save siginificant time and processing on every TLS connection
29841 initiated by Exim.
29842
29843
29844
29845
29846 .section "Use of TLS Server Name Indication" "SECTtlssni"
29847 .cindex "TLS" "Server Name Indication"
29848 .cindex "TLS" SNI
29849 .cindex SNI
29850 .vindex "&$tls_in_sni$&"
29851 .oindex "&%tls_in_sni%&"
29852 With TLS1.0 or above, there is an extension mechanism by which extra
29853 information can be included at various points in the protocol.  One of these
29854 extensions, documented in RFC 6066 (and before that RFC 4366) is
29855 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29856 client in the initial handshake, so that the server can examine the servername
29857 within and possibly choose to use different certificates and keys (and more)
29858 for this session.
29859
29860 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29861 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29862 address.
29863
29864 With SMTP to MX, there are the same problems here as in choosing the identity
29865 against which to validate a certificate: you can't rely on insecure DNS to
29866 provide the identity which you then cryptographically verify.  So this will
29867 be of limited use in that environment.
29868
29869 With SMTP to Submission, there is a well-defined hostname which clients are
29870 connecting to and can validate certificates against.  Thus clients &*can*&
29871 choose to include this information in the TLS negotiation.  If this becomes
29872 wide-spread, then hosters can choose to present different certificates to
29873 different clients.  Or even negotiate different cipher suites.
29874
29875 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29876 if not empty, will be sent on a TLS session as part of the handshake.  There's
29877 nothing more to it.  Choosing a sensible value not derived insecurely is the
29878 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29879 for the lifetime of the client connection (including during authentication).
29880
29881 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29882 is forced to the name of the destination host, after any MX- or CNAME-following.
29883
29884 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29885 received from a client.
29886 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29887
29888 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29889 option (prior to expansion) then the following options will be re-expanded
29890 during TLS session handshake, to permit alternative values to be chosen:
29891
29892 .ilist
29893 &%tls_certificate%&
29894 .next
29895 &%tls_crl%&
29896 .next
29897 &%tls_privatekey%&
29898 .next
29899 &%tls_verify_certificates%&
29900 .next
29901 &%tls_ocsp_file%&
29902 .endlist
29903
29904 Great care should be taken to deal with matters of case, various injection
29905 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29906 can always be referenced; it is important to remember that &$tls_in_sni$& is
29907 arbitrary unverified data provided prior to authentication.
29908 Further, the initial certificate is loaded before SNI has arrived, so
29909 an expansion for &%tls_certificate%& must have a default which is used
29910 when &$tls_in_sni$& is empty.
29911
29912 The Exim developers are proceeding cautiously and so far no other TLS options
29913 are re-expanded.
29914
29915 When Exim is built against OpenSSL, OpenSSL must have been built with support
29916 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29917 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29918 see &`-servername`& in the output, then OpenSSL has support.
29919
29920 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29921 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29922 built, then you have SNI support).
29923
29924 .subsection ALPN
29925 .cindex TLS ALPN
29926 .cindex ALPN "general information"
29927 .cindex TLS "Application Layer Protocol Names"
29928 There is a TLS feature related to SNI
29929 called Application Layer Protocol Name (ALPN).
29930 This is intended to declare, or select, what protocol layer will be using a TLS
29931 connection.
29932 The client for the connection proposes a set of protocol names, and
29933 the server responds with a selected one.
29934 It is not, as of 2021, commonly used for SMTP connections.
29935 However, to guard against misdirected or malicious use of web clients
29936 (which often do use ALPN) against MTA ports, Exim by default check that
29937 there is no incompatible ALPN specified by a client for a TLS connection.
29938 If there is, the connection is rejected.
29939
29940 As a client Exim does not supply ALPN by default.
29941 The behaviour of both client and server can be configured using the options
29942 &%tls_alpn%& and &%hosts_require_alpn%&.
29943 There are no variables providing observability.
29944 Some feature-specific logging may appear on denied connections, but this
29945 depends on the behaviour of the peer
29946 (not all peers can send a feature-specific TLS Alert).
29947
29948 This feature is available when Exim is built with
29949 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29950 the macro _HAVE_TLS_ALPN will be defined when this is so.
29951
29952
29953
29954 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29955          "SECTmulmessam"
29956 .cindex "multiple SMTP deliveries with TLS"
29957 .cindex "TLS" "multiple message deliveries"
29958 Exim sends multiple messages down the same TCP/IP connection by starting up
29959 an entirely new delivery process for each message, passing the socket from
29960 one process to the next. This implementation does not fit well with the use
29961 of TLS, because there is quite a lot of state information associated with a TLS
29962 connection, not just a socket identification. Passing all the state information
29963 to a new process is not feasible. Consequently, for sending using TLS Exim
29964 starts an additional proxy process for handling the encryption, piping the
29965 unencrypted data stream from and to the delivery processes.
29966
29967 An older mode of operation can be enabled on a per-host basis by the
29968 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29969 this list the proxy process described above is not used; instead Exim
29970 shuts down an existing TLS session being run by the delivery process
29971 before passing the socket to a new process. The new process may then
29972 try to start a new TLS session, and if successful, may try to re-authenticate
29973 if AUTH is in use, before sending the next message.
29974
29975 The RFC is not clear as to whether or not an SMTP session continues in clear
29976 after TLS has been shut down, or whether TLS may be restarted again later, as
29977 just described. However, if the server is Exim, this shutdown and
29978 reinitialization works. It is not known which (if any) other servers operate
29979 successfully if the client closes a TLS session and continues with unencrypted
29980 SMTP, but there are certainly some that do not work. For such servers, Exim
29981 should not pass the socket to another process, because the failure of the
29982 subsequent attempt to use it would cause Exim to record a temporary host error,
29983 and delay other deliveries to that host.
29984
29985 To test for this case, Exim sends an EHLO command to the server after
29986 closing down the TLS session. If this fails in any way, the connection is
29987 closed instead of being passed to a new delivery process, but no retry
29988 information is recorded.
29989
29990 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29991 &(smtp)& transport to match those hosts for which Exim should not pass
29992 connections to new processes if TLS has been used.
29993
29994
29995
29996
29997 .section "Certificates and all that" "SECTcerandall"
29998 .cindex "certificate" "references to discussion"
29999 In order to understand fully how TLS works, you need to know about
30000 certificates, certificate signing, and certificate authorities.
30001 This is a large topic and an introductory guide is unsuitable for the Exim
30002 reference manual, so instead we provide pointers to existing documentation.
30003
30004 The Apache web-server was for a long time the canonical guide, so their
30005 documentation is a good place to start; their SSL module's Introduction
30006 document is currently at
30007 .display
30008 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30009 .endd
30010 and their FAQ is at
30011 .display
30012 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30013 .endd
30014
30015 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30016 0-201-61598-3) in 2001, contains both introductory and more in-depth
30017 descriptions.
30018 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30019 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30020 Ivan is the author of the popular TLS testing tools at
30021 &url(https://www.ssllabs.com/).
30022
30023
30024 .subsection "Certificate chains" SECID186
30025 A file named by &%tls_certificate%& may contain more than one
30026 certificate. This is useful in the case where the certificate that is being
30027 sent is validated by an intermediate certificate which the other end does
30028 not have. Multiple certificates must be in the correct order in the file.
30029 First the host's certificate itself, then the first intermediate
30030 certificate to validate the issuer of the host certificate, then the next
30031 intermediate certificate to validate the issuer of the first intermediate
30032 certificate, and so on, until finally (optionally) the root certificate.
30033 The root certificate must already be trusted by the recipient for
30034 validation to succeed, of course, but if it's not preinstalled, sending the
30035 root certificate along with the rest makes it available for the user to
30036 install if the receiving end is a client MUA that can interact with a user.
30037
30038 Note that certificates using MD5 are unlikely to work on today's Internet;
30039 even if your libraries allow loading them for use in Exim when acting as a
30040 server, increasingly clients will not accept such certificates.  The error
30041 diagnostics in such a case can be frustratingly vague.
30042
30043
30044
30045 .subsection "Self-signed certificates" SECID187
30046 .cindex "certificate" "self-signed"
30047 You can create a self-signed certificate using the &'req'& command provided
30048 with OpenSSL, like this:
30049 . ==== Do not shorten the duration here without reading and considering
30050 . ==== the text below.  Please leave it at 9999 days.
30051 .code
30052 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30053             -days 9999 -nodes
30054 .endd
30055 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30056 delimited and so can be identified independently. The &%-days%& option
30057 specifies a period for which the certificate is valid. The &%-nodes%& option is
30058 important: if you do not set it, the key is encrypted with a passphrase
30059 that you are prompted for, and any use that is made of the key causes more
30060 prompting for the passphrase. This is not helpful if you are going to use
30061 this certificate and key in an MTA, where prompting is not possible.
30062
30063 . ==== I expect to still be working 26 years from now.  The less technical
30064 . ==== debt I create, in terms of storing up trouble for my later years, the
30065 . ==== happier I will be then.  We really have reached the point where we
30066 . ==== should start, at the very least, provoking thought and making folks
30067 . ==== pause before proceeding, instead of leaving all the fixes until two
30068 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30069 . ==== -pdp, 2012
30070 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30071 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30072 the above command might produce a date in the past.  Think carefully about
30073 the lifetime of the systems you're deploying, and either reduce the duration
30074 of the certificate or reconsider your platform deployment.  (At time of
30075 writing, reducing the duration is the most likely choice, but the inexorable
30076 progression of time takes us steadily towards an era where this will not
30077 be a sensible resolution).
30078
30079 A self-signed certificate made in this way is sufficient for testing, and
30080 may be adequate for all your requirements if you are mainly interested in
30081 encrypting transfers, and not in secure identification.
30082
30083 However, many clients require that the certificate presented by the server be a
30084 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30085 certificate. In this situation, the self-signed certificate described above
30086 must be installed on the client host as a trusted root &'certification
30087 authority'& (CA), and the certificate used by Exim must be a user certificate
30088 signed with that self-signed certificate.
30089
30090 For information on creating self-signed CA certificates and using them to sign
30091 user certificates, see the &'General implementation overview'& chapter of the
30092 Open-source PKI book, available online at
30093 &url(https://sourceforge.net/projects/ospkibook/).
30094
30095
30096 .subsection "Revoked certificates"
30097 .cindex "TLS" "revoked certificates"
30098 .cindex "revocation list"
30099 .cindex "certificate" "revocation list"
30100 .cindex "OCSP" "stapling"
30101 There are three ways for a certificate to be made unusable
30102 before its expiry.
30103
30104 .ilist
30105 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30106 certificates are revoked. If you have such a list, you can pass it to an Exim
30107 server using the global option called &%tls_crl%& and to an Exim client using
30108 an identically named option for the &(smtp)& transport. In each case, the value
30109 of the option is expanded and must then be the name of a file that contains a
30110 CRL in PEM format.
30111 The downside is that clients have to periodically re-download a potentially huge
30112 file from every certificate authority they know of.
30113
30114 .next
30115 The way with most moving parts at query time is Online Certificate
30116 Status Protocol (OCSP), where the client verifies the certificate
30117 against an OCSP server run by the CA.  This lets the CA track all
30118 usage of the certs.  It requires running software with access to the
30119 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30120 is based on HTTP and can be proxied accordingly.
30121
30122 The only widespread OCSP server implementation (known to this writer)
30123 comes as part of OpenSSL and aborts on an invalid request, such as
30124 connecting to the port and then disconnecting.  This requires
30125 re-entering the passphrase each time some random client does this.
30126
30127 .next
30128 The third way is OCSP Stapling; in this, the server using a certificate
30129 issued by the CA periodically requests an OCSP proof of validity from
30130 the OCSP server, then serves it up inline as part of the TLS
30131 negotiation.   This approach adds no extra round trips, does not let the
30132 CA track users, scales well with number of certs issued by the CA and is
30133 resilient to temporary OCSP server failures, as long as the server
30134 starts retrying to fetch an OCSP proof some time before its current
30135 proof expires.  The downside is that it requires server support.
30136
30137 Unless Exim is built with the support disabled,
30138 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30139 support for OCSP stapling is included.
30140
30141 There is a global option called &%tls_ocsp_file%&.
30142 The file specified therein is expected to be in DER format, and contain
30143 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30144 option will be re-expanded for SNI, if the &%tls_certificate%& option
30145 contains &`tls_in_sni`&, as per other TLS options.
30146
30147 Exim does not at this time implement any support for fetching a new OCSP
30148 proof.  The burden is on the administrator to handle this, outside of
30149 Exim.  The file specified should be replaced atomically, so that the
30150 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30151 on each connection, so a new file will be handled transparently on the
30152 next connection.
30153
30154 When built with OpenSSL Exim will check for a valid next update timestamp
30155 in the OCSP proof; if not present, or if the proof has expired, it will be
30156 ignored.
30157
30158 For the client to be able to verify the stapled OCSP the server must
30159 also supply, in its stapled information, any intermediate
30160 certificates for the chain leading to the OCSP proof from the signer
30161 of the server certificate.  There may be zero or one such. These
30162 intermediate certificates should be added to the server OCSP stapling
30163 file named by &%tls_ocsp_file%&.
30164
30165 Note that the proof only covers the terminal server certificate,
30166 not any of the chain from CA to it.
30167
30168 There is no current way to staple a proof for a client certificate.
30169
30170 .code
30171   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30172   OCSP server is supplied.  The server URL may be included in the
30173   server certificate, if the CA is helpful.
30174
30175   One failure mode seen was the OCSP Signer cert expiring before the end
30176   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30177   noted this as invalid overall, but the re-fetch script did not.
30178 .endd
30179 .endlist
30180
30181
30182 .ecindex IIDencsmtp1
30183 .ecindex IIDencsmtp2
30184
30185
30186 .section "TLS Resumption" "SECTresumption"
30187 .cindex TLS resumption
30188 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30189 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30190 (or later).
30191
30192 Session resumption (this is the "stateless" variant) involves the server sending
30193 a "session ticket" to the client on one connection, which can be stored by the
30194 client and used for a later session.  The ticket contains sufficient state for
30195 the server to reconstruct the TLS session, avoiding some expensive crypto
30196 calculation and (on TLS1.2) one full packet roundtrip time.
30197
30198 .ilist
30199 Operational cost/benefit:
30200
30201  The extra data being transmitted costs a minor amount, and the client has
30202  extra costs in storing and retrieving the data.
30203
30204  In the Exim/Gnutls implementation the extra cost on an initial connection
30205  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30206  The saved cost on a subsequent connection is about 4ms; three or more
30207  connections become a net win.  On longer network paths, two or more
30208  connections will have an average lower startup time thanks to the one
30209  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30210  packet roundtrips.
30211
30212 .cindex "hints database" tls
30213  Since a new hints DB is used on the TLS client,
30214  the hints DB maintenance should be updated to additionally handle "tls".
30215
30216 .next
30217 Security aspects:
30218
30219  The session ticket is encrypted, but is obviously an additional security
30220  vulnarability surface.  An attacker able to decrypt it would have access
30221  all connections using the resumed session.
30222  The session ticket encryption key is not committed to storage by the server
30223  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30224  overlap; GnuTLS 6hr but does not specify any overlap).
30225  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30226  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30227
30228  There is a question-mark over the security of the Diffie-Helman parameters
30229  used for session negotiation.
30230
30231 .next
30232 Observability:
30233
30234  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30235  element.
30236
30237  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30238  have bits 0-4 indicating respectively
30239  support built, client requested ticket, client offered session,
30240  server issued ticket, resume used.  A suitable decode list is provided
30241  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30242
30243 .next
30244 Control:
30245
30246 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30247 exim, operating as a server, will offer resumption to clients.
30248 Current best practice is to not offer the feature to MUA connection.
30249 Commonly this can be done like this:
30250 .code
30251 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30252 .endd
30253 If the peer host matches the list after expansion then resumption
30254 is offered and/or accepted.
30255
30256 The &%tls_resumption_hosts%& smtp transport option performs the
30257 equivalent function for operation as a client.
30258 If the peer host matches the list after expansion then resumption
30259 is attempted (if a stored session is available) or the information
30260 stored (if supplied by the peer).
30261
30262
30263 .next
30264 Issues:
30265
30266  In a resumed session:
30267 .ilist
30268   The variables &$tls_{in,out}_cipher$& will have values different
30269  to the original (under GnuTLS).
30270 .next
30271   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30272  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30273 . XXX need to do something with that hosts_require_ocsp
30274 .endlist
30275
30276 .endlist
30277
30278
30279 .section DANE "SECDANE"
30280 .cindex DANE
30281 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30282 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30283 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30284 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30285 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30286 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30287
30288 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30289 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30290 by (a) is thought to be smaller than that of the set of root CAs.
30291
30292 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30293 fail to pass on a server's STARTTLS.
30294
30295 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30296 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30297 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30298
30299 DANE requires a server operator to do three things:
30300 .olist
30301 Run DNSSEC.  This provides assurance to clients
30302 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30303 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30304 DNSSEC.
30305 .next
30306 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30307 .next
30308 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30309 .endlist
30310
30311 There are no changes to Exim specific to server-side operation of DANE.
30312 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30313 in &_Local/Makefile_&.
30314 If it has been included, the macro "_HAVE_DANE" will be defined.
30315
30316 .subsection "DNS records"
30317 A TLSA record consist of 4 fields, the "Certificate Usage", the
30318 "Selector", the "Matching type", and the "Certificate Association Data".
30319 For a detailed description of the TLSA record see
30320 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30321
30322 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30323 These are the "Trust Anchor" and "End Entity" variants.
30324 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30325 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30326 this is appropriate for a single system, using a self-signed certificate.
30327 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30328 well-known one.
30329 A private CA at simplest is just a self-signed certificate (with certain
30330 attributes) which is used to sign server certificates, but running one securely
30331 does require careful arrangement.
30332 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30333 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30334 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30335 all of which point to a single TLSA record.
30336 DANE-TA and DANE-EE can both be used together.
30337
30338 Our recommendation is to use DANE with a certificate from a public CA,
30339 because this enables a variety of strategies for remote clients to verify
30340 your certificate.
30341 You can then publish information both via DANE and another technology,
30342 "MTA-STS", described below.
30343
30344 When you use DANE-TA to publish trust anchor information, you ask entities
30345 outside your administrative control to trust the Certificate Authority for
30346 connections to you.
30347 If using a private CA then you should expect others to still apply the
30348 technical criteria they'd use for a public CA to your certificates.
30349 In particular, you should probably try to follow current best practices for CA
30350 operation around hash algorithms and key sizes.
30351 Do not expect other organizations to lower their security expectations just
30352 because a particular profile might be reasonable for your own internal use.
30353
30354 When this text was last updated, this in practice means to avoid use of SHA-1
30355 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30356 than 4096, for interoperability); to use keyUsage fields correctly; to use
30357 random serial numbers.
30358 The list of requirements is subject to change as best practices evolve.
30359 If you're not already using a private CA, or it doesn't meet these
30360 requirements, then we encourage you to avoid all these issues and use a public
30361 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30362
30363 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30364 a "Matching Type" (3rd) field of SHA2-512(2).
30365
30366 For the "Certificate Authority Data" (4th) field, commands like
30367
30368 .code
30369   openssl x509 -pubkey -noout <certificate.pem \
30370   | openssl rsa -outform der -pubin 2>/dev/null \
30371   | openssl sha512 \
30372   | awk '{print $2}'
30373 .endd
30374
30375 are workable to create a hash of the certificate's public key.
30376
30377 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30378
30379 .code
30380   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30381 .endd
30382
30383 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30384 is useful for quickly generating TLSA records.
30385
30386
30387 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30388
30389 The Certificate issued by the CA published in the DANE-TA model should be
30390 issued using a strong hash algorithm.
30391 Exim, and importantly various other MTAs sending to you, will not
30392 re-enable hash algorithms which have been disabled by default in TLS
30393 libraries.
30394 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30395 interoperability (and probably the maximum too, in 2018).
30396
30397 .subsection "Interaction with OCSP"
30398 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30399 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30400 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30401
30402 .code
30403   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30404                                  {= {4}{$tls_out_tlsa_usage}} } \
30405                          {*}{}}
30406 .endd
30407
30408 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30409 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30410 found. If the definition of &%hosts_request_ocsp%& includes the
30411 string "tls_out_tlsa_usage", they are re-expanded in time to
30412 control the OCSP request.
30413
30414 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30415 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30416
30417
30418 .subsection "Client configuration"
30419 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30420 and &%dane_require_tls_ciphers%&.
30421 The &"require"& variant will result in failure if the target host is not
30422 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30423 the &%dnssec_request_domains%& router or transport option.
30424
30425 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30426
30427 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30428 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30429 will be required for the host.  If it does not, the host will not
30430 be used; there is no fallback to non-DANE or non-TLS.
30431
30432 If DANE is requested and usable, then the TLS cipher list configuration
30433 prefers to use the option &%dane_require_tls_ciphers%& and falls
30434 back to &%tls_require_ciphers%& only if that is unset.
30435 This lets you configure "decent crypto" for DANE and "better than nothing
30436 crypto" as the default.  Note though that while GnuTLS lets the string control
30437 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30438 limited to ciphersuite constraints.
30439
30440 If DANE is requested and useable (see above) the following transport options are ignored:
30441 .code
30442   hosts_require_tls
30443   tls_verify_hosts
30444   tls_try_verify_hosts
30445   tls_verify_certificates
30446   tls_crl
30447   tls_verify_cert_hostnames
30448   tls_sni
30449 .endd
30450
30451 If DANE is not usable, whether requested or not, and CA-anchored
30452 verification evaluation is wanted, the above variables should be set appropriately.
30453
30454 The router and transport option &%dnssec_request_domains%& must not be
30455 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30456
30457 .subsection Observability
30458 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30459
30460 There is a new variable &$tls_out_dane$& which will have "yes" if
30461 verification succeeded using DANE and "no" otherwise (only useful
30462 in combination with events; see &<<CHAPevents>>&),
30463 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30464
30465 .cindex DANE reporting
30466 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30467 to achieve DANE-verified connection, if one was either requested and offered, or
30468 required.  This is intended to support TLS-reporting as defined in
30469 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30470 The &$event_data$& will be one of the Result Types defined in
30471 Section 4.3 of that document.
30472
30473 .subsection General
30474 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30475
30476 DANE is specified in published RFCs and decouples certificate authority trust
30477 selection from a "race to the bottom" of "you must trust everything for mail
30478 to get through".
30479 There is an alternative technology called MTA-STS, which
30480 instead publishes MX trust anchor information on an HTTPS website.  At the
30481 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30482 Exim has no support for MTA-STS as a client, but Exim mail server operators
30483 can choose to publish information describing their TLS configuration using
30484 MTA-STS to let those clients who do use that protocol derive trust
30485 information.
30486
30487 The MTA-STS design requires a certificate from a public Certificate Authority
30488 which is recognized by clients sending to you.
30489 That selection of which CAs are trusted by others is outside your control.
30490
30491 The most interoperable course of action is probably to use
30492 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30493 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30494 records for DANE clients (such as Exim and Postfix) and to publish anchor
30495 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30496 domain itself (with caveats around occasionally broken MTA-STS because of
30497 incompatible specification changes prior to reaching RFC status).
30498
30499
30500
30501 . ////////////////////////////////////////////////////////////////////////////
30502 . ////////////////////////////////////////////////////////////////////////////
30503
30504 .chapter "Access control lists" "CHAPACL"
30505 .scindex IIDacl "&ACL;" "description"
30506 .cindex "control of incoming mail"
30507 .cindex "message" "controlling incoming"
30508 .cindex "policy control" "access control lists"
30509 Access Control Lists (ACLs) are defined in a separate section of the runtime
30510 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30511 name, terminated by a colon. Here is a complete ACL section that contains just
30512 one very small ACL:
30513 .code
30514 begin acl
30515 small_acl:
30516   accept   hosts = one.host.only
30517 .endd
30518 You can have as many lists as you like in the ACL section, and the order in
30519 which they appear does not matter. The lists are self-terminating.
30520
30521 The majority of ACLs are used to control Exim's behaviour when it receives
30522 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30523 when a local process submits a message using SMTP by specifying the &%-bs%&
30524 option. The most common use is for controlling which recipients are accepted
30525 in incoming messages. In addition, you can define an ACL that is used to check
30526 local non-SMTP messages. The default configuration file contains an example of
30527 a realistic ACL for checking RCPT commands. This is discussed in chapter
30528 &<<CHAPdefconfil>>&.
30529
30530
30531 .section "Testing ACLs" "SECID188"
30532 The &%-bh%& command line option provides a way of testing your ACL
30533 configuration locally by running a fake SMTP session with which you interact.
30534
30535
30536 .section "Specifying when ACLs are used" "SECID189"
30537 .cindex "&ACL;" "options for specifying"
30538 In order to cause an ACL to be used, you have to name it in one of the relevant
30539 options in the main part of the configuration. These options are:
30540 .cindex "AUTH" "ACL for"
30541 .cindex "DATA" "ACLs for"
30542 .cindex "ETRN" "ACL for"
30543 .cindex "EXPN" "ACL for"
30544 .cindex "HELO" "ACL for"
30545 .cindex "EHLO" "ACL for"
30546 .cindex "DKIM" "ACL for"
30547 .cindex "MAIL" "ACL for"
30548 .cindex "QUIT, ACL for"
30549 .cindex "RCPT" "ACL for"
30550 .cindex "STARTTLS, ACL for"
30551 .cindex "VRFY" "ACL for"
30552 .cindex "SMTP" "connection, ACL for"
30553 .cindex "non-SMTP messages" "ACLs for"
30554 .cindex "MIME content scanning" "ACL for"
30555 .cindex "PRDR" "ACL for"
30556
30557 .table2 140pt
30558 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30559 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30560 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30561 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30562 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30563 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30564 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30565 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30566 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30567 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30568 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30569 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30570 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30571 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30572 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30573 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30574 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30575 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30576 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30577 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30578 .endtable
30579
30580 For example, if you set
30581 .code
30582 acl_smtp_rcpt = small_acl
30583 .endd
30584 the little ACL defined above is used whenever Exim receives a RCPT command
30585 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30586 done when RCPT commands arrive. A rejection of RCPT should cause the
30587 sending MTA to give up on the recipient address contained in the RCPT
30588 command, whereas rejection at other times may cause the client MTA to keep on
30589 trying to deliver the message. It is therefore recommended that you do as much
30590 testing as possible at RCPT time.
30591
30592
30593 .subsection "The non-SMTP ACLs" SECID190
30594 .cindex "non-SMTP messages" "ACLs for"
30595 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30596 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30597 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30598 the state of the SMTP connection such as encryption and authentication) are not
30599 relevant and are forbidden in these ACLs. However, the sender and recipients
30600 are known, so the &%senders%& and &%sender_domains%& conditions and the
30601 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30602 &$authenticated_sender$& are also available. You can specify added header lines
30603 in any of these ACLs.
30604
30605 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30606 non-SMTP message, before any of the message has been read. (This is the
30607 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30608 batched SMTP input, it runs after the DATA command has been reached. The
30609 result of this ACL is ignored; it cannot be used to reject a message. If you
30610 really need to, you could set a value in an ACL variable here and reject based
30611 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30612 controls, and in particular, it can be used to set
30613 .code
30614 control = suppress_local_fixups
30615 .endd
30616 This cannot be used in the other non-SMTP ACLs because by the time they are
30617 run, it is too late.
30618
30619 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30620 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30621
30622 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30623 kind of rejection is treated as permanent, because there is no way of sending a
30624 temporary error for these kinds of message.
30625
30626
30627 .subsection "The SMTP connect ACL" SECID191
30628 .cindex "SMTP" "connection, ACL for"
30629 .oindex &%smtp_banner%&
30630 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30631 session, after the test specified by &%host_reject_connection%& (which is now
30632 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30633 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30634 the message override the banner message that is otherwise specified by the
30635 &%smtp_banner%& option.
30636
30637 .new
30638 For tls-on-connect connections, the ACL is run before the TLS connection
30639 is accepted; if the ACL does not accept then the TCP connection is dropped without
30640 any TLS startup attempt and without any SMTP response being transmitted.
30641 .wen
30642
30643
30644 .subsection "The EHLO/HELO ACL" SECID192
30645 .cindex "EHLO" "ACL for"
30646 .cindex "HELO" "ACL for"
30647 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30648 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30649 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30650 Note that a client may issue more than one EHLO or HELO command in an SMTP
30651 session, and indeed is required to issue a new EHLO or HELO after successfully
30652 setting up encryption following a STARTTLS command.
30653
30654 Note also that a deny neither forces the client to go away nor means that
30655 mail will be refused on the connection.  Consider checking for
30656 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30657
30658 If the command is accepted by an &%accept%& verb that has a &%message%&
30659 modifier, the message may not contain more than one line (it will be truncated
30660 at the first newline and a panic logged if it does). Such a message cannot
30661 affect the EHLO options that are listed on the second and subsequent lines of
30662 an EHLO response.
30663
30664
30665 .subsection "The DATA ACLs" SECID193
30666 .cindex "DATA" "ACLs for"
30667 Two ACLs are associated with the DATA command, because it is two-stage
30668 command, with two responses being sent to the client.
30669 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30670 is obeyed. This gives you control after all the RCPT commands, but before
30671 the message itself is received. It offers the opportunity to give a negative
30672 response to the DATA command before the data is transmitted. Header lines
30673 added by MAIL or RCPT ACLs are not visible at this time, but any that
30674 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30675
30676 You cannot test the contents of the message, for example, to verify addresses
30677 in the headers, at RCPT time or when the DATA command is received. Such
30678 tests have to appear in the ACL that is run after the message itself has been
30679 received, before the final response to the DATA command is sent. This is
30680 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30681 associated with the DATA command.
30682
30683 .cindex CHUNKING "BDAT command"
30684 .cindex BDAT "SMTP command"
30685 .cindex "RFC 3030" CHUNKING
30686 If CHUNKING was advertised and a BDAT command sequence is received,
30687 the &%acl_smtp_predata%& ACL is not run.
30688 . XXX why not?  It should be possible, for the first BDAT.
30689 The &%acl_smtp_data%& is run after the last BDAT command and all of
30690 the data specified is received.
30691
30692 For both of these ACLs, it is not possible to reject individual recipients. An
30693 error response rejects the entire message. Unfortunately, it is known that some
30694 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30695 before or after the data) correctly &-- they keep the message on their queues
30696 and try again later, but that is their problem, though it does waste some of
30697 your resources.
30698
30699 The &%acl_smtp_data%& ACL is run after
30700 the &%acl_smtp_data_prdr%&,
30701 the &%acl_smtp_dkim%&
30702 and the &%acl_smtp_mime%& ACLs.
30703
30704 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30705 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30706 enabled (which is the default).
30707
30708 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30709 received, and is executed for each DKIM signature found in a message.  If not
30710 otherwise specified, the default action is to accept.
30711
30712 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30713
30714 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30715
30716
30717 .subsection "The SMTP MIME ACL" SECID194
30718 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30719 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30720
30721 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30722
30723
30724 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30725 .cindex "PRDR" "ACL for"
30726 .oindex "&%prdr_enable%&"
30727 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30728 with PRDR support enabled (which is the default).
30729 It becomes active only when the PRDR feature is negotiated between
30730 client and server for a message, and more than one recipient
30731 has been accepted.
30732
30733 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30734 has been received, and is executed once for each recipient of the message
30735 with &$local_part$& and &$domain$& valid.
30736 The test may accept, defer or deny for individual recipients.
30737 The &%acl_smtp_data%& will still be called after this ACL and
30738 can reject the message overall, even if this ACL has accepted it
30739 for some or all recipients.
30740
30741 PRDR may be used to support per-user content filtering.  Without it
30742 one must defer any recipient after the first that has a different
30743 content-filter configuration.  With PRDR, the RCPT-time check
30744 .cindex "PRDR" "variable for"
30745 for this can be disabled when the variable &$prdr_requested$&
30746 is &"yes"&.
30747 Any required difference in behaviour of the main DATA-time
30748 ACL should however depend on the PRDR-time ACL having run, as Exim
30749 will avoid doing so in some situations (e.g. single-recipient mails).
30750
30751 See also the &%prdr_enable%& global option
30752 and the &%hosts_try_prdr%& smtp transport option.
30753
30754 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30755 If the ACL is not defined, processing completes as if
30756 the feature was not requested by the client.
30757
30758 .subsection "The QUIT ACL" SECTQUITACL
30759 .cindex "QUIT, ACL for"
30760 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30761 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30762 does not in fact control any access.
30763 For this reason, it may only accept
30764 or warn as its final result.
30765
30766 This ACL can be used for tasks such as custom logging at the end of an SMTP
30767 session. For example, you can use ACL variables in other ACLs to count
30768 messages, recipients, etc., and log the totals at QUIT time using one or
30769 more &%logwrite%& modifiers on a &%warn%& verb.
30770
30771 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30772 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30773
30774 You do not need to have a final &%accept%&, but if you do, you can use a
30775 &%message%& modifier to specify custom text that is sent as part of the 221
30776 response to QUIT.
30777
30778 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30779 failure (for example, failure to open a log file, or when Exim is bombing out
30780 because it has detected an unrecoverable error), all SMTP commands from the
30781 client are given temporary error responses until QUIT is received or the
30782 connection is closed. In these special cases, the QUIT ACL does not run.
30783
30784
30785 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30786 .vindex &$acl_smtp_notquit$&
30787 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30788 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30789 trouble, such as being unable to write to its log files, this ACL is not run,
30790 because it might try to do things (such as write to log files) that make the
30791 situation even worse.
30792
30793 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30794 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30795 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30796 and &%warn%&.
30797
30798 .vindex &$smtp_notquit_reason$&
30799 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30800 to a string that indicates the reason for the termination of the SMTP
30801 connection. The possible values are:
30802 .table2
30803 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30804 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30805 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30806 .irow &`connection-lost`&          "The SMTP connection has been lost"
30807 .irow &`data-timeout`&             "Timeout while reading message data"
30808 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30809 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30810 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30811 .irow &`synchronization-error`&    "SMTP synchronization error"
30812 .irow &`tls-failed`&               "TLS failed to start"
30813 .endtable
30814 In most cases when an SMTP connection is closed without having received QUIT,
30815 Exim sends an SMTP response message before actually closing the connection.
30816 With the exception of the &`acl-drop`& case, the default message can be
30817 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30818 &%drop%& verb in another ACL, it is the message from the other ACL that is
30819 used.
30820
30821
30822 .section "Finding an ACL to use" "SECID195"
30823 .cindex "&ACL;" "finding which to use"
30824 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30825 you can use different ACLs in different circumstances. For example,
30826 .code
30827 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30828                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30829 .endd
30830 In the default configuration file there are some example settings for
30831 providing an RFC 4409 message &"submission"& service on port 587 and
30832 an RFC 8314 &"submissions"& service on port 465. You can use a string
30833 expansion like this to choose an ACL for MUAs on these ports which is
30834 more appropriate for this purpose than the default ACL on port 25.
30835
30836 The expanded string does not have to be the name of an ACL in the
30837 configuration file; there are other possibilities. Having expanded the
30838 string, Exim searches for an ACL as follows:
30839
30840 .ilist
30841 If the string begins with a slash, Exim uses it as a filename, and reads its
30842 contents as an ACL. The lines are processed in the same way as lines in the
30843 Exim configuration file. In particular, continuation lines are supported, blank
30844 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30845 If the file does not exist or cannot be read, an error occurs (typically
30846 causing a temporary failure of whatever caused the ACL to be run). For example:
30847 .code
30848 acl_smtp_data = /etc/acls/\
30849   ${lookup{$sender_host_address}lsearch\
30850   {/etc/acllist}{$value}{default}}
30851 .endd
30852 This looks up an ACL file to use on the basis of the host's IP address, falling
30853 back to a default if the lookup fails. If an ACL is successfully read from a
30854 file, it is retained in memory for the duration of the Exim process, so that it
30855 can be re-used without having to re-read the file.
30856 .next
30857 If the string does not start with a slash, and does not contain any spaces,
30858 Exim searches the ACL section of the configuration for an ACL whose name
30859 matches the string.
30860 .next
30861 If no named ACL is found, or if the string contains spaces, Exim parses
30862 the string as an inline ACL. This can save typing in cases where you just
30863 want to have something like
30864 .code
30865 acl_smtp_vrfy = accept
30866 .endd
30867 in order to allow free use of the VRFY command. Such a string may contain
30868 newlines; it is processed in the same way as an ACL that is read from a file.
30869 .endlist
30870
30871
30872
30873
30874 .section "ACL return codes" "SECID196"
30875 .cindex "&ACL;" "return codes"
30876 Except for the QUIT ACL, which does not affect the SMTP return code (see
30877 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30878 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30879 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30880 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30881 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30882 This also causes a 4&'xx'& return code.
30883
30884 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30885 &"deny"&, because there is no mechanism for passing temporary errors to the
30886 submitters of non-SMTP messages.
30887
30888
30889 ACLs that are relevant to message reception may also return &"discard"&. This
30890 has the effect of &"accept"&, but causes either the entire message or an
30891 individual recipient address to be discarded. In other words, it is a
30892 blackholing facility. Use it with care.
30893
30894 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30895 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30896 RCPT ACL is to discard just the one recipient address. If there are no
30897 recipients left when the message's data is received, the DATA ACL is not
30898 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30899 remaining recipients. The &"discard"& return is not permitted for the
30900 &%acl_smtp_predata%& ACL.
30901
30902 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30903 is done on the address and the result determines the SMTP response.
30904
30905
30906 .cindex "&[local_scan()]& function" "when all recipients discarded"
30907 The &[local_scan()]& function is always run, even if there are no remaining
30908 recipients; it may create new recipients.
30909
30910
30911
30912 .section "Unset ACL options" "SECID197"
30913 .cindex "&ACL;" "unset options"
30914 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30915 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30916 not defined at all. For any defined ACL, the default action when control
30917 reaches the end of the ACL statements is &"deny"&.
30918
30919 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30920 these two are ACLs that are used only for their side effects. They cannot be
30921 used to accept or reject anything.
30922
30923 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30924 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30925 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30926 when the ACL is not defined is &"accept"&.
30927
30928 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30929 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30930 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30931 messages over an SMTP connection. For an example, see the ACL in the default
30932 configuration file.
30933
30934
30935
30936
30937 .section "Data for message ACLs" "SECID198"
30938 .cindex "&ACL;" "data for message ACL"
30939 .vindex &$domain$&
30940 .vindex &$local_part$&
30941 .vindex &$sender_address$&
30942 .vindex &$sender_host_address$&
30943 .vindex &$smtp_command$&
30944 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30945 that contain information about the host and the message's sender (for example,
30946 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30947 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30948 &$local_part$& are set from the argument address. The entire SMTP command
30949 is available in &$smtp_command$&.
30950
30951 When an ACL for the AUTH parameter of MAIL is running, the variables that
30952 contain information about the host are set, but &$sender_address$& is not yet
30953 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30954 how it is used.
30955
30956 .vindex "&$message_size$&"
30957 The &$message_size$& variable is set to the value of the SIZE parameter on
30958 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30959 that parameter is not given. The value is updated to the true message size by
30960 the time the final DATA ACL is run (after the message data has been
30961 received).
30962
30963 .vindex "&$rcpt_count$&"
30964 .vindex "&$recipients_count$&"
30965 The &$rcpt_count$& variable increases by one for each RCPT command received.
30966 The &$recipients_count$& variable increases by one each time a RCPT command is
30967 accepted, so while an ACL for RCPT is being processed, it contains the number
30968 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30969 &$rcpt_count$& contains the total number of RCPT commands, and
30970 &$recipients_count$& contains the total number of accepted recipients.
30971
30972
30973
30974
30975
30976 .section "Data for non-message ACLs" "SECTdatfornon"
30977 .cindex "&ACL;" "data for non-message ACL"
30978 .vindex &$smtp_command_argument$&
30979 .vindex &$smtp_command$&
30980 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30981 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30982 and the entire SMTP command is available in &$smtp_command$&.
30983 These variables can be tested using a &%condition%& condition. For example,
30984 here is an ACL for use with AUTH, which insists that either the session is
30985 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30986 does not permit authentication methods that use cleartext passwords on
30987 unencrypted connections.
30988 .code
30989 acl_check_auth:
30990   accept encrypted = *
30991   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30992                      {CRAM-MD5}}
30993   deny   message   = TLS encryption or CRAM-MD5 required
30994 .endd
30995 (Another way of applying this restriction is to arrange for the authenticators
30996 that use cleartext passwords not to be advertised when the connection is not
30997 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30998 option to do this.)
30999
31000
31001
31002 .section "Format of an ACL" "SECID199"
31003 .cindex "&ACL;" "format of"
31004 .cindex "&ACL;" "verbs, definition of"
31005 An individual ACL consists of a number of statements. Each statement starts
31006 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31007 Modifiers can change the way the verb operates, define error and log messages,
31008 set variables, insert delays, and vary the processing of accepted messages.
31009
31010 If all the conditions are met, the verb is obeyed. The same condition may be
31011 used (with different arguments) more than once in the same statement. This
31012 provides a means of specifying an &"and"& conjunction between conditions. For
31013 example:
31014 .code
31015 deny  dnslists = list1.example
31016       dnslists = list2.example
31017 .endd
31018 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31019 the conditions and modifiers when it reaches a condition that fails. What
31020 happens then depends on the verb (and in one case, on a special modifier). Not
31021 all the conditions make sense at every testing point. For example, you cannot
31022 test a sender address in the ACL that is run for a VRFY command.
31023
31024
31025 .section "ACL verbs" "SECID200"
31026 The ACL verbs are as follows:
31027
31028 .ilist
31029 .cindex "&%accept%& ACL verb"
31030 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31031 of the conditions are not met, what happens depends on whether &%endpass%&
31032 appears among the conditions (for syntax see below). If the failing condition
31033 is before &%endpass%&, control is passed to the next ACL statement; if it is
31034 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31035 check a RCPT command:
31036 .code
31037 accept domains = +local_domains
31038        endpass
31039        verify = recipient
31040 .endd
31041 If the recipient domain does not match the &%domains%& condition, control
31042 passes to the next statement. If it does match, the recipient is verified, and
31043 the command is accepted if verification succeeds. However, if verification
31044 fails, the ACL yields &"deny"&, because the failing condition is after
31045 &%endpass%&.
31046
31047 The &%endpass%& feature has turned out to be confusing to many people, so its
31048 use is not recommended nowadays. It is always possible to rewrite an ACL so
31049 that &%endpass%& is not needed, and it is no longer used in the default
31050 configuration.
31051
31052 .cindex "&%message%& ACL modifier" "with &%accept%&"
31053 If a &%message%& modifier appears on an &%accept%& statement, its action
31054 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31055 (when an &%accept%& verb either accepts or passes control to the next
31056 statement), &%message%& can be used to vary the message that is sent when an
31057 SMTP command is accepted. For example, in a RCPT ACL you could have:
31058 .display
31059 &`accept  `&<&'some conditions'&>
31060 &`        message = OK, I will allow you through today`&
31061 .endd
31062 You can specify an SMTP response code, optionally followed by an &"extended
31063 response code"& at the start of the message, but the first digit must be the
31064 same as would be sent by default, which is 2 for an &%accept%& verb.
31065
31066 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31067 an error message that is used when access is denied. This behaviour is retained
31068 for backward compatibility, but current &"best practice"& is to avoid the use
31069 of &%endpass%&.
31070
31071
31072 .next
31073 .cindex "&%defer%& ACL verb"
31074 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31075 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31076 &%defer%& is the same as &%deny%&, because there is no way of sending a
31077 temporary error. For a RCPT command, &%defer%& is much the same as using a
31078 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31079 be used in any ACL, and even for a recipient it might be a simpler approach.
31080
31081
31082 .next
31083 .cindex "&%deny%& ACL verb"
31084 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31085 the conditions are not met, control is passed to the next ACL statement. For
31086 example,
31087 .code
31088 deny dnslists = blackholes.mail-abuse.org
31089 .endd
31090 rejects commands from hosts that are on a DNS black list.
31091
31092
31093 .next
31094 .cindex "&%discard%& ACL verb"
31095 &%discard%&: This verb behaves like &%accept%&, except that it returns
31096 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31097 that are concerned with receiving messages. When all the conditions are true,
31098 the sending entity receives a &"success"& response. However, &%discard%& causes
31099 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31100 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31101 message's recipients are discarded. Recipients that are discarded before DATA
31102 do not appear in the log line when the &%received_recipients%& log selector is set.
31103
31104 If the &%log_message%& modifier is set when &%discard%& operates,
31105 its contents are added to the line that is automatically written to the log.
31106 The &%message%& modifier operates exactly as it does for &%accept%&.
31107
31108
31109 .next
31110 .cindex "&%drop%& ACL verb"
31111 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31112 forcibly closed after the 5&'xx'& error message has been sent. For example:
31113 .code
31114 drop   condition = ${if > {$rcpt_count}{20}}
31115        message   = I don't take more than 20 RCPTs
31116 .endd
31117 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31118 The connection is always dropped after sending a 550 response.
31119
31120 .next
31121 .cindex "&%require%& ACL verb"
31122 &%require%&: If all the conditions are met, control is passed to the next ACL
31123 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31124 example, when checking a RCPT command,
31125 .code
31126 require message = Sender did not verify
31127         verify  = sender
31128 .endd
31129 passes control to subsequent statements only if the message's sender can be
31130 verified. Otherwise, it rejects the command. Note the positioning of the
31131 &%message%& modifier, before the &%verify%& condition. The reason for this is
31132 discussed in section &<<SECTcondmodproc>>&.
31133
31134 .next
31135 .cindex "&%warn%& ACL verb"
31136 &%warn%&: If all the conditions are true, a line specified by the
31137 &%log_message%& modifier is written to Exim's main log. Control always passes
31138 to the next ACL statement. If any condition is false, the log line is not
31139 written. If an identical log line is requested several times in the same
31140 message, only one copy is actually written to the log. If you want to force
31141 duplicates to be written, use the &%logwrite%& modifier instead.
31142
31143 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31144 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31145 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31146 first failing condition. There is more about adding header lines in section
31147 &<<SECTaddheadacl>>&.
31148
31149 If any condition on a &%warn%& statement cannot be completed (that is, there is
31150 some sort of defer), the log line specified by &%log_message%& is not written.
31151 This does not include the case of a forced failure from a lookup, which
31152 is considered to be a successful completion. After a defer, no further
31153 conditions or modifiers in the &%warn%& statement are processed. The incident
31154 is logged, and the ACL continues to be processed, from the next statement
31155 onwards.
31156
31157
31158 .vindex "&$acl_verify_message$&"
31159 When one of the &%warn%& conditions is an address verification that fails, the
31160 text of the verification failure message is in &$acl_verify_message$&. If you
31161 want this logged, you must set it up explicitly. For example:
31162 .code
31163 warn   !verify = sender
31164        log_message = sender verify failed: $acl_verify_message
31165 .endd
31166 .endlist
31167
31168 At the end of each ACL there is an implicit unconditional &%deny%&.
31169
31170 As you can see from the examples above, the conditions and modifiers are
31171 written one to a line, with the first one on the same line as the verb, and
31172 subsequent ones on following lines. If you have a very long condition, you can
31173 continue it onto several physical lines by the usual backslash continuation
31174 mechanism. It is conventional to align the conditions vertically.
31175
31176
31177
31178 .section "ACL variables" "SECTaclvariables"
31179 .cindex "&ACL;" "variables"
31180 There are some special variables that can be set during ACL processing. They
31181 can be used to pass information between different ACLs, different invocations
31182 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31183 transports, and filters that are used to deliver a message. The names of these
31184 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31185 an underscore, but the remainder of the name can be any sequence of
31186 alphanumeric characters and underscores that you choose. There is no limit on
31187 the number of ACL variables. The two sets act as follows:
31188 .ilist
31189 The values of those variables whose names begin with &$acl_c$& persist
31190 throughout an SMTP connection. They are never reset. Thus, a value that is set
31191 while receiving one message is still available when receiving the next message
31192 on the same SMTP connection.
31193 .next
31194 The values of those variables whose names begin with &$acl_m$& persist only
31195 while a message is being received. They are reset afterwards. They are also
31196 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31197 .endlist
31198
31199 When a message is accepted, the current values of all the ACL variables are
31200 preserved with the message and are subsequently made available at delivery
31201 time. The ACL variables are set by a modifier called &%set%&. For example:
31202 .code
31203 accept hosts = whatever
31204        set acl_m4 = some value
31205 accept authenticated = *
31206        set acl_c_auth = yes
31207 .endd
31208 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31209 be set. If you want to set a variable without taking any action, you can use a
31210 &%warn%& verb without any other modifiers or conditions.
31211
31212 .oindex &%strict_acl_vars%&
31213 What happens if a syntactically valid but undefined ACL variable is
31214 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31215 false (the default), an empty string is substituted; if it is true, an
31216 error is generated.
31217
31218 Versions of Exim before 4.64 have a limited set of numbered variables, but
31219 their names are compatible, so there is no problem with upgrading.
31220
31221
31222 .section "Condition and modifier processing" "SECTcondmodproc"
31223 .cindex "&ACL;" "conditions; processing"
31224 .cindex "&ACL;" "modifiers; processing"
31225 An exclamation mark preceding a condition negates its result. For example:
31226 .code
31227 deny   domains = *.dom.example
31228       !verify  = recipient
31229 .endd
31230 causes the ACL to return &"deny"& if the recipient domain ends in
31231 &'dom.example'& and the recipient address cannot be verified. Sometimes
31232 negation can be used on the right-hand side of a condition. For example, these
31233 two statements are equivalent:
31234 .code
31235 deny  hosts = !192.168.3.4
31236 deny !hosts =  192.168.3.4
31237 .endd
31238 However, for many conditions (&%verify%& being a good example), only left-hand
31239 side negation of the whole condition is possible.
31240
31241 The arguments of conditions and modifiers are expanded. A forced failure
31242 of an expansion causes a condition to be ignored, that is, it behaves as if the
31243 condition is true. Consider these two statements:
31244 .code
31245 accept  senders = ${lookup{$host_name}lsearch\
31246                   {/some/file}{$value}fail}
31247 accept  senders = ${lookup{$host_name}lsearch\
31248                   {/some/file}{$value}{}}
31249 .endd
31250 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31251 the returned list is searched, but if the lookup fails the behaviour is
31252 different in the two cases. The &%fail%& in the first statement causes the
31253 condition to be ignored, leaving no further conditions. The &%accept%& verb
31254 therefore succeeds. The second statement, however, generates an empty list when
31255 the lookup fails. No sender can match an empty list, so the condition fails,
31256 and therefore the &%accept%& also fails.
31257
31258 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31259 specify actions that are taken as the conditions for a statement are checked;
31260 others specify text for messages that are used when access is denied or a
31261 warning is generated. The &%control%& modifier affects the way an incoming
31262 message is handled.
31263
31264 The positioning of the modifiers in an ACL statement is important, because the
31265 processing of a verb ceases as soon as its outcome is known. Only those
31266 modifiers that have already been encountered will take effect. For example,
31267 consider this use of the &%message%& modifier:
31268 .code
31269 require message = Can't verify sender
31270         verify  = sender
31271         message = Can't verify recipient
31272         verify  = recipient
31273         message = This message cannot be used
31274 .endd
31275 If sender verification fails, Exim knows that the result of the statement is
31276 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31277 so its text is used as the error message. If sender verification succeeds, but
31278 recipient verification fails, the second message is used. If recipient
31279 verification succeeds, the third message becomes &"current"&, but is never used
31280 because there are no more conditions to cause failure.
31281
31282 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31283 modifier that is used, because all the conditions must be true for rejection to
31284 happen. Specifying more than one &%message%& modifier does not make sense, and
31285 the message can even be specified after all the conditions. For example:
31286 .code
31287 deny   hosts = ...
31288       !senders = *@my.domain.example
31289        message = Invalid sender from client host
31290 .endd
31291 The &"deny"& result does not happen until the end of the statement is reached,
31292 by which time Exim has set up the message.
31293
31294
31295
31296 .section "ACL modifiers" "SECTACLmodi"
31297 .cindex "&ACL;" "modifiers; list of"
31298 The ACL modifiers are as follows:
31299
31300 .vlist
31301 .vitem &*add_header*&&~=&~<&'text'&>
31302 This modifier specifies one or more header lines that are to be added to an
31303 incoming message, assuming, of course, that the message is ultimately
31304 accepted. For details, see section &<<SECTaddheadacl>>&.
31305
31306 .vitem &*continue*&&~=&~<&'text'&>
31307 .cindex "&%continue%& ACL modifier"
31308 .cindex "database" "updating in ACL"
31309 This modifier does nothing of itself, and processing of the ACL always
31310 continues with the next condition or modifier. The value of &%continue%& is in
31311 the side effects of expanding its argument. Typically this could be used to
31312 update a database. It is really just a syntactic tidiness, to avoid having to
31313 write rather ugly lines like this:
31314 .display
31315 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31316 .endd
31317 Instead, all you need is
31318 .display
31319 &`continue = `&<&'some expansion'&>
31320 .endd
31321
31322 .vitem &*control*&&~=&~<&'text'&>
31323 .cindex "&%control%& ACL modifier"
31324 This modifier affects the subsequent processing of the SMTP connection or of an
31325 incoming message that is accepted. The effect of the first type of control
31326 lasts for the duration of the connection, whereas the effect of the second type
31327 lasts only until the current message has been received. The message-specific
31328 controls always apply to the whole message, not to individual recipients,
31329 even if the &%control%& modifier appears in a RCPT ACL.
31330
31331 As there are now quite a few controls that can be applied, they are described
31332 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31333 in several different ways. For example:
31334
31335 . ==== As this is a nested list, any displays it contains must be indented
31336 . ==== as otherwise they are too far to the left. That comment applies only
31337 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31338 . ==== way.
31339
31340 .ilist
31341 It can be at the end of an &%accept%& statement:
31342 .code
31343     accept  ...some conditions
31344             control = queue
31345 .endd
31346 In this case, the control is applied when this statement yields &"accept"&, in
31347 other words, when the conditions are all true.
31348
31349 .next
31350 It can be in the middle of an &%accept%& statement:
31351 .code
31352     accept  ...some conditions...
31353             control = queue
31354             ...some more conditions...
31355 .endd
31356 If the first set of conditions are true, the control is applied, even if the
31357 statement does not accept because one of the second set of conditions is false.
31358 In this case, some subsequent statement must yield &"accept"& for the control
31359 to be relevant.
31360
31361 .next
31362 It can be used with &%warn%& to apply the control, leaving the
31363 decision about accepting or denying to a subsequent verb. For
31364 example:
31365 .code
31366     warn    ...some conditions...
31367             control = freeze
31368     accept  ...
31369 .endd
31370 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31371 &%logwrite%&, so it does not add anything to the message and does not write a
31372 log entry.
31373
31374 .next
31375 If you want to apply a control unconditionally, you can use it with a
31376 &%require%& verb. For example:
31377 .code
31378     require  control = no_multiline_responses
31379 .endd
31380 .endlist
31381
31382 .vitem &*delay*&&~=&~<&'time'&>
31383 .cindex "&%delay%& ACL modifier"
31384 .oindex "&%-bh%&"
31385 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31386 the time interval before proceeding. However, when testing Exim using the
31387 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31388 output instead). The time is given in the usual Exim notation, and the delay
31389 happens as soon as the modifier is processed. In an SMTP session, pending
31390 output is flushed before the delay is imposed.
31391
31392 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31393 example:
31394 .code
31395 deny    ...some conditions...
31396         delay = 30s
31397 .endd
31398 The delay happens if all the conditions are true, before the statement returns
31399 &"deny"&. Compare this with:
31400 .code
31401 deny    delay = 30s
31402         ...some conditions...
31403 .endd
31404 which waits for 30s before processing the conditions. The &%delay%& modifier
31405 can also be used with &%warn%& and together with &%control%&:
31406 .code
31407 warn    ...some conditions...
31408         delay = 2m
31409         control = freeze
31410 accept  ...
31411 .endd
31412
31413 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31414 responses to several commands are no longer buffered and sent in one packet (as
31415 they would normally be) because all output is flushed before imposing the
31416 delay. This optimization is disabled so that a number of small delays do not
31417 appear to the client as one large aggregated delay that might provoke an
31418 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31419 using a &%control%& modifier to set &%no_delay_flush%&.
31420
31421
31422 .vitem &*endpass*&
31423 .cindex "&%endpass%& ACL modifier"
31424 This modifier, which has no argument, is recognized only in &%accept%& and
31425 &%discard%& statements. It marks the boundary between the conditions whose
31426 failure causes control to pass to the next statement, and the conditions whose
31427 failure causes the ACL to return &"deny"&. This concept has proved to be
31428 confusing to some people, so the use of &%endpass%& is no longer recommended as
31429 &"best practice"&. See the description of &%accept%& above for more details.
31430
31431
31432 .vitem &*log_message*&&~=&~<&'text'&>
31433 .cindex "&%log_message%& ACL modifier"
31434 This modifier sets up a message that is used as part of the log message if the
31435 ACL denies access or a &%warn%& statement's conditions are true. For example:
31436 .code
31437 require log_message = wrong cipher suite $tls_in_cipher
31438         encrypted   = DES-CBC3-SHA
31439 .endd
31440 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31441 example:
31442 .display
31443 &`discard `&<&'some conditions'&>
31444 &`        log_message = Discarded $local_part@$domain because...`&
31445 .endd
31446 When access is denied, &%log_message%& adds to any underlying error message
31447 that may exist because of a condition failure. For example, while verifying a
31448 recipient address, a &':fail:'& redirection might have already set up a
31449 message.
31450
31451 The message may be defined before the conditions to which it applies, because
31452 the string expansion does not happen until Exim decides that access is to be
31453 denied. This means that any variables that are set by the condition are
31454 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31455 variables are set after a DNS black list lookup succeeds. If the expansion of
31456 &%log_message%& fails, or if the result is an empty string, the modifier is
31457 ignored.
31458
31459 .vindex "&$acl_verify_message$&"
31460 If you want to use a &%warn%& statement to log the result of an address
31461 verification, you can use &$acl_verify_message$& to include the verification
31462 error message.
31463
31464 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31465 the start of the logged message. If the same warning log message is requested
31466 more than once while receiving  a single email message, only one copy is
31467 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31468 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31469 is logged for a successful &%warn%& statement.
31470
31471 If &%log_message%& is not present and there is no underlying error message (for
31472 example, from the failure of address verification), but &%message%& is present,
31473 the &%message%& text is used for logging rejections. However, if any text for
31474 logging contains newlines, only the first line is logged. In the absence of
31475 both &%log_message%& and &%message%&, a default built-in message is used for
31476 logging rejections.
31477
31478
31479 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31480 .cindex "&%log_reject_target%& ACL modifier"
31481 .cindex "logging in ACL" "specifying which log"
31482 This modifier makes it possible to specify which logs are used for messages
31483 about ACL rejections. Its argument is a colon-separated list of words that can
31484 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31485 may be empty, in which case a rejection is not logged at all. For example, this
31486 ACL fragment writes no logging information when access is denied:
31487 .display
31488 &`deny `&<&'some conditions'&>
31489 &`     log_reject_target =`&
31490 .endd
31491 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31492 permanent and temporary rejections. Its effect lasts for the rest of the
31493 current ACL.
31494
31495
31496 .vitem &*logwrite*&&~=&~<&'text'&>
31497 .cindex "&%logwrite%& ACL modifier"
31498 .cindex "logging in ACL" "immediate"
31499 This modifier writes a message to a log file as soon as it is encountered when
31500 processing an ACL. (Compare &%log_message%&, which, except in the case of
31501 &%warn%& and &%discard%&, is used only if the ACL statement denies
31502 access.) The &%logwrite%& modifier can be used to log special incidents in
31503 ACLs. For example:
31504 .display
31505 &`accept `&<&'some special conditions'&>
31506 &`       control  = freeze`&
31507 &`       logwrite = froze message because ...`&
31508 .endd
31509 By default, the message is written to the main log. However, it may begin
31510 with a colon, followed by a comma-separated list of log names, and then
31511 another colon, to specify exactly which logs are to be written. For
31512 example:
31513 .code
31514 logwrite = :main,reject: text for main and reject logs
31515 logwrite = :panic: text for panic log only
31516 .endd
31517
31518
31519 .vitem &*message*&&~=&~<&'text'&>
31520 .cindex "&%message%& ACL modifier"
31521 This modifier sets up a text string that is expanded and used as a response
31522 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31523 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31524 there is some complication if &%endpass%& is involved; see the description of
31525 &%accept%& for details.)
31526
31527 The expansion of the message happens at the time Exim decides that the ACL is
31528 to end, not at the time it processes &%message%&. If the expansion fails, or
31529 generates an empty string, the modifier is ignored. Here is an example where
31530 &%message%& must be specified first, because the ACL ends with a rejection if
31531 the &%hosts%& condition fails:
31532 .code
31533 require  message = Host not recognized
31534          hosts = 10.0.0.0/8
31535 .endd
31536 (Once a condition has failed, no further conditions or modifiers are
31537 processed.)
31538
31539 .cindex "SMTP" "error codes"
31540 .oindex "&%smtp_banner%&
31541 For ACLs that are triggered by SMTP commands, the message is returned as part
31542 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31543 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31544 is accepted. In the case of the connect ACL, accepting with a message modifier
31545 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31546 accept message may not contain more than one line (otherwise it will be
31547 truncated at the first newline and a panic logged), and it cannot affect the
31548 EHLO options.
31549
31550 When SMTP is involved, the message may begin with an overriding response code,
31551 consisting of three digits optionally followed by an &"extended response code"&
31552 of the form &'n.n.n'&, each code being followed by a space. For example:
31553 .code
31554 deny  message = 599 1.2.3 Host not welcome
31555       hosts = 192.168.34.0/24
31556 .endd
31557 The first digit of the supplied response code must be the same as would be sent
31558 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31559 access, but for the predata ACL, note that the default success code is 354, not
31560 2&'xx'&.
31561
31562 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31563 the message modifier cannot override the 221 response code.
31564
31565 The text in a &%message%& modifier is literal; any quotes are taken as
31566 literals, but because the string is expanded, backslash escapes are processed
31567 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31568 response.
31569
31570 .vindex "&$acl_verify_message$&"
31571 While the text is being expanded, the &$acl_verify_message$& variable
31572 contains any message previously set.
31573 Afterwards, &$acl_verify_message$& is cleared.
31574
31575 If &%message%& is used on a statement that verifies an address, the message
31576 specified overrides any message that is generated by the verification process.
31577 However, the original message is available in the variable
31578 &$acl_verify_message$&, so you can incorporate it into your message if you
31579 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31580 routers to be passed back as part of the SMTP response, you should either not
31581 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31582
31583 For compatibility with previous releases of Exim, a &%message%& modifier that
31584 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31585 modifier, but this usage is now deprecated. However, &%message%& acts only when
31586 all the conditions are true, wherever it appears in an ACL command, whereas
31587 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31588 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31589 effect.
31590
31591
31592 .vitem &*queue*&&~=&~<&'text'&>
31593 .cindex "&%queue%& ACL modifier"
31594 .cindex "named queues" "selecting in ACL"
31595 This modifier specifies the use of a named queue for spool files
31596 for the message.
31597 It can only be used before the message is received (i.e. not in
31598 the DATA ACL).
31599 This could be used, for example, for known high-volume burst sources
31600 of traffic, or for quarantine of messages.
31601 Separate queue-runner processes will be needed for named queues.
31602 If the text after expansion is empty, the default queue is used.
31603
31604
31605 .vitem &*remove_header*&&~=&~<&'text'&>
31606 This modifier specifies one or more header names in a colon-separated list
31607  that are to be removed from an incoming message, assuming, of course, that
31608 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31609
31610
31611 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31612 .cindex "&%set%& ACL modifier"
31613 This modifier puts a value into one of the ACL variables (see section
31614 &<<SECTaclvariables>>&).
31615
31616
31617 .vitem &*udpsend*&&~=&~<&'parameters'&>
31618 .cindex "UDP communications"
31619 This modifier sends a UDP packet, for purposes such as statistics
31620 collection or behaviour monitoring. The parameters are expanded, and
31621 the result of the expansion must be a colon-separated list consisting
31622 of a destination server, port number, and the packet contents. The
31623 server can be specified as a host name or IPv4 or IPv6 address. The
31624 separator can be changed with the usual angle bracket syntax. For
31625 example, you might want to collect information on which hosts connect
31626 when:
31627 .code
31628 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31629              $tod_zulu $sender_host_address
31630 .endd
31631 .endlist
31632
31633
31634
31635
31636 .section "Use of the control modifier" "SECTcontrols"
31637 .cindex "&%control%& ACL modifier"
31638 The &%control%& modifier supports the following settings:
31639
31640 .vlist
31641 .vitem &*control&~=&~allow_auth_unadvertised*&
31642 This modifier allows a client host to use the SMTP AUTH command even when it
31643 has not been advertised in response to EHLO. Furthermore, because there are
31644 apparently some really broken clients that do this, Exim will accept AUTH after
31645 HELO (rather than EHLO) when this control is set. It should be used only if you
31646 really need it, and you should limit its use to those broken clients that do
31647 not work without it. For example:
31648 .code
31649 warn hosts   = 192.168.34.25
31650      control = allow_auth_unadvertised
31651 .endd
31652 Normally, when an Exim server receives an AUTH command, it checks the name of
31653 the authentication mechanism that is given in the command to ensure that it
31654 matches an advertised mechanism. When this control is set, the check that a
31655 mechanism has been advertised is bypassed. Any configured mechanism can be used
31656 by the client. This control is permitted only in the connection and HELO ACLs.
31657
31658
31659 .vitem &*control&~=&~caseful_local_part*& &&&
31660        &*control&~=&~caselower_local_part*&
31661 .cindex "&ACL;" "case of local part in"
31662 .cindex "case of local parts"
31663 .vindex "&$local_part$&"
31664 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31665 (that is, during RCPT processing). By default, the contents of &$local_part$&
31666 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31667 any uppercase letters in the original local part are restored in &$local_part$&
31668 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31669 is encountered.
31670
31671 These controls affect only the current recipient. Moreover, they apply only to
31672 local part handling that takes place directly in the ACL (for example, as a key
31673 in lookups). If a test to verify the recipient is obeyed, the case-related
31674 handling of the local part during the verification is controlled by the router
31675 configuration (see the &%caseful_local_part%& generic router option).
31676
31677 This facility could be used, for example, to add a spam score to local parts
31678 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31679 spam score:
31680 .code
31681 warn  control = caseful_local_part
31682       set acl_m4 = ${eval:\
31683                      $acl_m4 + \
31684                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31685                     }
31686       control = caselower_local_part
31687 .endd
31688 Notice that we put back the lower cased version afterwards, assuming that
31689 is what is wanted for subsequent tests.
31690
31691
31692 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31693 .cindex "&ACL;" "cutthrough routing"
31694 .cindex "cutthrough" "requesting"
31695 This option requests delivery be attempted while the item is being received.
31696
31697 The option is usable in the RCPT ACL.
31698 If enabled for a message received via smtp and routed to an smtp transport,
31699 and only one transport, interface, destination host and port combination
31700 is used for all recipients of the message,
31701 then the delivery connection is made while the receiving connection is open
31702 and data is copied from one to the other.
31703
31704 An attempt to set this option for any recipient but the first
31705 for a mail will be quietly ignored.
31706 If a recipient-verify callout
31707 (with use_sender)
31708 connection is subsequently
31709 requested in the same ACL it is held open and used for
31710 any subsequent recipients and the data,
31711 otherwise one is made after the initial RCPT ACL completes.
31712
31713 Note that routers are used in verify mode,
31714 and cannot depend on content of received headers.
31715 Note also that headers cannot be
31716 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31717 Headers may be modified by routers (subject to the above) and transports.
31718 The &'Received-By:'& header is generated as soon as the body reception starts,
31719 rather than the traditional time after the full message is received;
31720 this will affect the timestamp.
31721
31722 All the usual ACLs are called; if one results in the message being
31723 rejected, all effort spent in delivery (including the costs on
31724 the ultimate destination) will be wasted.
31725 Note that in the case of data-time ACLs this includes the entire
31726 message body.
31727
31728 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31729 of outgoing messages is done, because it sends data to the ultimate destination
31730 before the entire message has been received from the source.
31731 It is not supported for messages received with the SMTP PRDR
31732 or CHUNKING
31733 options in use.
31734
31735 Should the ultimate destination system positively accept or reject the mail,
31736 a corresponding indication is given to the source system and nothing is queued.
31737 If the item is successfully delivered in cutthrough mode
31738 the delivery log lines are tagged with ">>" rather than "=>" and appear
31739 before the acceptance "<=" line.
31740
31741 If there is a temporary error the item is queued for later delivery in the
31742 usual fashion.
31743 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31744 to the control; the default value is &"spool"& and the alternate value
31745 &"pass"& copies an SMTP defer response from the target back to the initiator
31746 and does not queue the message.
31747 Note that this is independent of any recipient verify conditions in the ACL.
31748
31749 Delivery in this mode avoids the generation of a bounce mail to a
31750 (possibly faked)
31751 sender when the destination system is doing content-scan based rejection.
31752
31753
31754 .vitem &*control&~=&~debug/*&<&'options'&>
31755 .cindex "&ACL;" "enabling debug logging"
31756 .cindex "debugging" "enabling from an ACL"
31757 This control turns on debug logging, almost as though Exim had been invoked
31758 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31759 by default called &'debuglog'&.
31760
31761 Logging set up by the control will be maintained across spool residency.
31762
31763 Options are a slash-separated list.
31764 If an option takes an argument, the option name and argument are separated by
31765 an equals character.
31766 Several options are supported:
31767 .display
31768 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31769                      The argument, which may access any variables already defined,
31770                      is appended to the default name.
31771
31772 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31773                      using the same values as the &`-d`& command-line option.
31774
31775 stop                 Logging started with this control may be
31776                      stopped by using this option.
31777
31778 kill                 Logging started with this control may be
31779                      stopped by using this option.
31780                      Additionally the debug file will be removed,
31781                      providing one means for speculative debug tracing.
31782
31783 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31784                      for pre-trigger debug capture.
31785                      Debug lines are recorded in the buffer until
31786                      and if) a trigger occurs; at which time they are
31787                      dumped to the debug file.  Newer lines displace the
31788                      oldest if the buffer is full.  After a trigger,
31789                      immediate writes to file are done as normal.
31790
31791 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31792                      see above) to be copied to file.  A reason of &*now*&
31793                      take effect immediately; one of &*paniclog*& triggers
31794                      on a write to the panic log.
31795 .endd
31796
31797 Some examples (which depend on variables that don't exist in all
31798 contexts):
31799 .code
31800       control = debug
31801       control = debug/tag=.$sender_host_address
31802       control = debug/opts=+expand+acl
31803       control = debug/tag=.$message_exim_id/opts=+expand
31804       control = debug/kill
31805       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31806       control = debug/trigger=now
31807 .endd
31808
31809
31810 .vitem &*control&~=&~dkim_disable_verify*&
31811 .cindex "disable DKIM verify"
31812 .cindex "DKIM" "disable verify"
31813 This control turns off DKIM verification processing entirely.  For details on
31814 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31815
31816
31817 .vitem &*control&~=&~dmarc_disable_verify*&
31818 .cindex "disable DMARC verify"
31819 .cindex "DMARC" "disable verify"
31820 This control turns off DMARC verification processing entirely.  For details on
31821 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31822
31823
31824 .vitem &*control&~=&~dscp/*&<&'value'&>
31825 .cindex "&ACL;" "setting DSCP value"
31826 .cindex "DSCP" "inbound"
31827 This option causes the DSCP value associated with the socket for the inbound
31828 connection to be adjusted to a given value, given as one of a number of fixed
31829 strings or to numeric value.
31830 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31831 Common values include &`throughput`&, &`mincost`&, and on newer systems
31832 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31833
31834 The outbound packets from Exim will be marked with this value in the header
31835 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31836 that these values will have any effect, not be stripped by networking
31837 equipment, or do much of anything without cooperation with your Network
31838 Engineer and those of all network operators between the source and destination.
31839
31840
31841 .vitem &*control&~=&~enforce_sync*& &&&
31842        &*control&~=&~no_enforce_sync*&
31843 .cindex "SMTP" "synchronization checking"
31844 .cindex "synchronization checking in SMTP"
31845 These controls make it possible to be selective about when SMTP synchronization
31846 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31847 state of the switch (it is true by default). See the description of this option
31848 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31849
31850 The effect of these two controls lasts for the remainder of the SMTP
31851 connection. They can appear in any ACL except the one for the non-SMTP
31852 messages. The most straightforward place to put them is in the ACL defined by
31853 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31854 before the first synchronization check. The expected use is to turn off the
31855 synchronization checks for badly-behaved hosts that you nevertheless need to
31856 work with.
31857
31858
31859 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31860 .cindex "fake defer"
31861 .cindex "defer, fake"
31862 This control works in exactly the same way as &%fakereject%& (described below)
31863 except that it causes an SMTP 450 response after the message data instead of a
31864 550 response. You must take care when using &%fakedefer%& because it causes the
31865 messages to be duplicated when the sender retries. Therefore, you should not
31866 use &%fakedefer%& if the message is to be delivered normally.
31867
31868 .vitem &*control&~=&~fakereject/*&<&'message'&>
31869 .cindex "fake rejection"
31870 .cindex "rejection, fake"
31871 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31872 words, only when an SMTP message is being received. If Exim accepts the
31873 message, instead the final 250 response, a 550 rejection message is sent.
31874 However, Exim proceeds to deliver the message as normal. The control applies
31875 only to the current message, not to any subsequent ones that may be received in
31876 the same SMTP connection.
31877
31878 The text for the 550 response is taken from the &%control%& modifier. If no
31879 message is supplied, the following is used:
31880 .code
31881 550-Your message has been rejected but is being
31882 550-kept for evaluation.
31883 550-If it was a legitimate message, it may still be
31884 550 delivered to the target recipient(s).
31885 .endd
31886 This facility should be used with extreme caution.
31887
31888 .vitem &*control&~=&~freeze*&
31889 .cindex "frozen messages" "forcing in ACL"
31890 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31891 other words, only when a message is being received. If the message is accepted,
31892 it is placed on Exim's queue and frozen. The control applies only to the
31893 current message, not to any subsequent ones that may be received in the same
31894 SMTP connection.
31895
31896 This modifier can optionally be followed by &`/no_tell`&. If the global option
31897 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31898 is told about the freezing), provided all the &*control=freeze*& modifiers that
31899 are obeyed for the current message have the &`/no_tell`& option.
31900
31901 .vitem &*control&~=&~no_delay_flush*&
31902 .cindex "SMTP" "output flushing, disabling for delay"
31903 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31904 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31905 use. This control, as long as it is encountered before the &%delay%& modifier,
31906 disables such output flushing.
31907
31908 .vitem &*control&~=&~no_callout_flush*&
31909 .cindex "SMTP" "output flushing, disabling for callout"
31910 Exim normally flushes SMTP output before performing a callout in an ACL, to
31911 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31912 use. This control, as long as it is encountered before the &%verify%& condition
31913 that causes the callout, disables such output flushing.
31914
31915 .vitem &*control&~=&~no_mbox_unspool*&
31916 This control is available when Exim is compiled with the content scanning
31917 extension. Content scanning may require a copy of the current message, or parts
31918 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31919 or spam scanner. Normally, such copies are deleted when they are no longer
31920 needed. If this control is set, the copies are not deleted. The control applies
31921 only to the current message, not to any subsequent ones that may be received in
31922 the same SMTP connection. It is provided for debugging purposes and is unlikely
31923 to be useful in production.
31924
31925 .vitem &*control&~=&~no_multiline_responses*&
31926 .cindex "multiline responses, suppressing"
31927 This control is permitted for any ACL except the one for non-SMTP messages.
31928 It seems that there are broken clients in use that cannot handle multiline
31929 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31930
31931 If this control is set, multiline SMTP responses from ACL rejections are
31932 suppressed. One way of doing this would have been to put out these responses as
31933 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31934 (&"use multiline responses for more"& it says &-- ha!), and some of the
31935 responses might get close to that. So this facility, which is after all only a
31936 sop to broken clients, is implemented by doing two very easy things:
31937
31938 .ilist
31939 Extra information that is normally output as part of a rejection caused by
31940 sender verification failure is omitted. Only the final line (typically &"sender
31941 verification failed"&) is sent.
31942 .next
31943 If a &%message%& modifier supplies a multiline response, only the first
31944 line is output.
31945 .endlist
31946
31947 The setting of the switch can, of course, be made conditional on the
31948 calling host. Its effect lasts until the end of the SMTP connection.
31949
31950 .vitem &*control&~=&~no_pipelining*&
31951 .cindex "PIPELINING" "suppressing advertising"
31952 .cindex "ESMTP extensions" PIPELINING
31953 This control turns off the advertising of the PIPELINING extension to SMTP in
31954 the current session. To be useful, it must be obeyed before Exim sends its
31955 response to an EHLO command. Therefore, it should normally appear in an ACL
31956 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31957 &%pipelining_advertise_hosts%&.
31958
31959 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31960        &*control&~=&~queue_only*&
31961 .oindex "&%queue%&"
31962 .oindex "&%queue_only%&"
31963 .cindex "queueing incoming messages"
31964 .cindex queueing "forcing in ACL"
31965 .cindex "first pass routing"
31966 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31967 other words, only when a message is being received. If the message is accepted,
31968 it is placed on Exim's queue and left there for delivery by a subsequent queue
31969 runner.
31970 If used with no options set,
31971 no immediate delivery process is started. In other words, it has the
31972 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31973
31974 If the &'first_pass_route'& option is given then
31975 the behaviour is like the command-line &'-oqds'& option;
31976 a delivery process is started which stops short of making
31977 any SMTP delivery.  The benefit is that the hints database will be updated for
31978 the message being waiting for a specific host, and a later queue run will be
31979 able to send all such messages on a single connection.
31980
31981 The control only applies to the current message, not to any subsequent ones that
31982  may be received in the same SMTP connection.
31983
31984 .vitem &*control&~=&~submission/*&<&'options'&>
31985 .cindex "message" "submission"
31986 .cindex "submission mode"
31987 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31988 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31989 the current message is a submission from a local MUA. In this case, Exim
31990 operates in &"submission mode"&, and applies certain fixups to the message if
31991 necessary. For example, it adds a &'Date:'& header line if one is not present.
31992 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31993 late (the message has already been created).
31994
31995 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31996 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31997 submission mode; the available options for this control are described there.
31998 The control applies only to the current message, not to any subsequent ones
31999 that may be received in the same SMTP connection.
32000
32001 .vitem &*control&~=&~suppress_local_fixups*&
32002 .cindex "submission fixups, suppressing"
32003 This control applies to locally submitted (non TCP/IP) messages, and is the
32004 complement of &`control = submission`&. It disables the fixups that are
32005 normally applied to locally-submitted messages. Specifically:
32006
32007 .ilist
32008 Any &'Sender:'& header line is left alone (in this respect, it is a
32009 dynamic version of &%local_sender_retain%&).
32010 .next
32011 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32012 .next
32013 There is no check that &'From:'& corresponds to the actual sender.
32014 .endlist ilist
32015
32016 This control may be useful when a remotely-originated message is accepted,
32017 passed to some scanning program, and then re-submitted for delivery. It can be
32018 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32019 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32020 data is read.
32021
32022 &*Note:*& This control applies only to the current message, not to any others
32023 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32024
32025 .vitem &*control&~=&~utf8_downconvert*&
32026 This control enables conversion of UTF-8 in message envelope addresses
32027 to a-label form.
32028 For details see section &<<SECTi18nMTA>>&.
32029 .endlist vlist
32030
32031
32032 .section "Summary of message fixup control" "SECTsummesfix"
32033 All four possibilities for message fixups can be specified:
32034
32035 .ilist
32036 Locally submitted, fixups applied: the default.
32037 .next
32038 Locally submitted, no fixups applied: use
32039 &`control = suppress_local_fixups`&.
32040 .next
32041 Remotely submitted, no fixups applied: the default.
32042 .next
32043 Remotely submitted, fixups applied: use &`control = submission`&.
32044 .endlist
32045
32046
32047
32048 .section "Adding header lines in ACLs" "SECTaddheadacl"
32049 .cindex "header lines" "adding in an ACL"
32050 .cindex "header lines" "position of added lines"
32051 .cindex "&%add_header%& ACL modifier"
32052 The &%add_header%& modifier can be used to add one or more extra header lines
32053 to an incoming message, as in this example:
32054 .code
32055 warn dnslists = sbl.spamhaus.org : \
32056                 dialup.mail-abuse.org
32057      add_header = X-blacklisted-at: $dnslist_domain
32058 .endd
32059 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32060 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32061 receiving a message). The message must ultimately be accepted for
32062 &%add_header%& to have any significant effect. You can use &%add_header%& with
32063 any ACL verb, including &%deny%& (though this is potentially useful only in a
32064 RCPT ACL).
32065
32066 Headers will not be added to the message if the modifier is used in
32067 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32068
32069 Leading and trailing newlines are removed from
32070 the data for the &%add_header%& modifier; if it then
32071 contains one or more newlines that
32072 are not followed by a space or a tab, it is assumed to contain multiple header
32073 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32074 front of any line that is not a valid header line.
32075
32076 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32077 They are added to the message before processing the DATA and MIME ACLs.
32078 However, if an identical header line is requested more than once, only one copy
32079 is actually added to the message. Further header lines may be accumulated
32080 during the DATA and MIME ACLs, after which they are added to the message, again
32081 with duplicates suppressed. Thus, it is possible to add two identical header
32082 lines to an SMTP message, but only if one is added before DATA and one after.
32083 In the case of non-SMTP messages, new headers are accumulated during the
32084 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32085 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32086 are included in the entry that is written to the reject log.
32087
32088 .cindex "header lines" "added; visibility of"
32089 Header lines are not visible in string expansions
32090 of message headers
32091 until they are added to the
32092 message. It follows that header lines defined in the MAIL, RCPT, and predata
32093 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32094 header lines that are added by the DATA or MIME ACLs are not visible in those
32095 ACLs. Because of this restriction, you cannot use header lines as a way of
32096 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32097 this, you can use ACL variables, as described in section
32098 &<<SECTaclvariables>>&.
32099
32100 The list of headers yet to be added is given by the &%$headers_added%& variable.
32101
32102 The &%add_header%& modifier acts immediately as it is encountered during the
32103 processing of an ACL. Notice the difference between these two cases:
32104 .display
32105 &`accept add_header = ADDED: some text`&
32106 &`       `&<&'some condition'&>
32107
32108 &`accept `&<&'some condition'&>
32109 &`       add_header = ADDED: some text`&
32110 .endd
32111 In the first case, the header line is always added, whether or not the
32112 condition is true. In the second case, the header line is added only if the
32113 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32114 ACL statement. All those that are encountered before a condition fails are
32115 honoured.
32116
32117 .cindex "&%warn%& ACL verb"
32118 For compatibility with previous versions of Exim, a &%message%& modifier for a
32119 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32120 effect only if all the conditions are true, even if it appears before some of
32121 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32122 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32123 are present on a &%warn%& verb, both are processed according to their
32124 specifications.
32125
32126 By default, new header lines are added to a message at the end of the existing
32127 header lines. However, you can specify that any particular header line should
32128 be added right at the start (before all the &'Received:'& lines), immediately
32129 after the first block of &'Received:'& lines, or immediately before any line
32130 that is not a &'Received:'& or &'Resent-something:'& header.
32131
32132 This is done by specifying &":at_start:"&, &":after_received:"&, or
32133 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32134 header line, respectively. (Header text cannot start with a colon, as there has
32135 to be a header name first.) For example:
32136 .code
32137 warn add_header = \
32138        :after_received:X-My-Header: something or other...
32139 .endd
32140 If more than one header line is supplied in a single &%add_header%& modifier,
32141 each one is treated independently and can therefore be placed differently. If
32142 you add more than one line at the start, or after the Received: block, they end
32143 up in reverse order.
32144
32145 &*Warning*&: This facility currently applies only to header lines that are
32146 added in an ACL. It does NOT work for header lines that are added in a
32147 system filter or in a router or transport.
32148
32149
32150
32151 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32152 .cindex "header lines" "removing in an ACL"
32153 .cindex "header lines" "position of removed lines"
32154 .cindex "&%remove_header%& ACL modifier"
32155 The &%remove_header%& modifier can be used to remove one or more header lines
32156 from an incoming message, as in this example:
32157 .code
32158 warn   message        = Remove internal headers
32159        remove_header  = x-route-mail1 : x-route-mail2
32160 .endd
32161 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32162 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32163 receiving a message). The message must ultimately be accepted for
32164 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32165 with any ACL verb, including &%deny%&, though this is really not useful for
32166 any verb that doesn't result in a delivered message.
32167
32168 Headers will not be removed from the message if the modifier is used in
32169 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32170
32171 More than one header can be removed at the same time by using a colon separated
32172 list of header specifiers.
32173 .new
32174 If a specifier does not start with a circumflex (^)
32175 then it is treated as a header name.
32176 The header name matching is case insensitive.
32177 If it does, then it is treated as a (front-anchored)
32178 regular expression applied to the whole header.
32179
32180 &*Note*&: The colon terminating a header name will need to be doubled
32181 if used in an RE, and there can legitimately be whitepace before it.
32182
32183 Example:
32184 .code
32185 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32186 .endd
32187 .wen
32188
32189 List expansion is not performed, so you cannot use hostlists to
32190 create a list of headers, however both connection and message variable expansion
32191 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32192 .code
32193 warn   hosts           = +internal_hosts
32194        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32195 warn   message         = Remove internal headers
32196        remove_header   = $acl_c_ihdrs
32197 .endd
32198 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32199 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32200 If multiple header lines match, all are removed.
32201 There is no harm in attempting to remove the same header twice nor in removing
32202 a non-existent header. Further header specifiers for removal may be accumulated
32203 during the DATA and MIME ACLs, after which matching headers are removed
32204 if present. In the case of non-SMTP messages, remove speifiers are
32205 accumulated during the non-SMTP ACLs, and are acted on after
32206 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32207 ACL, there really is no effect because there is no logging of what headers
32208 would have been removed.
32209
32210 .cindex "header lines" "removed; visibility of"
32211 Header lines are not visible in string expansions until the DATA phase when it
32212 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32213 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32214 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32215 this restriction, you cannot use header lines as a way of controlling data
32216 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32217 you should instead use ACL variables, as described in section
32218 &<<SECTaclvariables>>&.
32219
32220 The &%remove_header%& modifier acts immediately as it is encountered during the
32221 processing of an ACL. Notice the difference between these two cases:
32222 .display
32223 &`accept remove_header = X-Internal`&
32224 &`       `&<&'some condition'&>
32225
32226 &`accept `&<&'some condition'&>
32227 &`       remove_header = X-Internal`&
32228 .endd
32229 In the first case, the header line is always removed, whether or not the
32230 condition is true. In the second case, the header line is removed only if the
32231 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32232 same ACL statement. All those that are encountered before a condition fails
32233 are honoured.
32234
32235 &*Warning*&: This facility currently applies only to header lines that are
32236 present during ACL processing. It does NOT remove header lines that are added
32237 in a system filter or in a router or transport.
32238
32239
32240
32241
32242 .section "ACL conditions" "SECTaclconditions"
32243 .cindex "&ACL;" "conditions; list of"
32244 Some of the conditions listed in this section are available only when Exim is
32245 compiled with the content-scanning extension. They are included here briefly
32246 for completeness. More detailed descriptions can be found in the discussion on
32247 content scanning in chapter &<<CHAPexiscan>>&.
32248
32249 Not all conditions are relevant in all circumstances. For example, testing
32250 senders and recipients does not make sense in an ACL that is being run as the
32251 result of the arrival of an ETRN command, and checks on message headers can be
32252 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32253 can use the same condition (with different parameters) more than once in the
32254 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32255 The conditions are as follows:
32256
32257
32258 .vlist
32259 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32260 .cindex "&ACL;" "nested"
32261 .cindex "&ACL;" "indirect"
32262 .cindex "&ACL;" "arguments"
32263 .cindex "&%acl%& ACL condition"
32264 The possible values of the argument are the same as for the
32265 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32266 &"accept"& the condition is true; if it returns &"deny"& the condition is
32267 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32268 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32269 condition false. This means that further processing of the &%warn%& verb
32270 ceases, but processing of the ACL continues.
32271
32272 If the argument is a named ACL, up to nine space-separated optional values
32273 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32274 and $acl_narg is set to the count of values.
32275 Previous values of these variables are restored after the call returns.
32276 The name and values are expanded separately.
32277 Note that spaces in complex expansions which are used as arguments
32278 will act as argument separators.
32279
32280 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32281 the connection is dropped. If it returns &"discard"&, the verb must be
32282 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32283 conditions are tested.
32284
32285 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32286 loops. This condition allows you to use different ACLs in different
32287 circumstances. For example, different ACLs can be used to handle RCPT commands
32288 for different local users or different local domains.
32289
32290 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32291 .cindex "&%authenticated%& ACL condition"
32292 .cindex "authentication" "ACL checking"
32293 .cindex "&ACL;" "testing for authentication"
32294 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32295 the name of the authenticator is tested against the list. To test for
32296 authentication by any authenticator, you can set
32297 .code
32298 authenticated = *
32299 .endd
32300
32301 .vitem &*condition&~=&~*&<&'string'&>
32302 .cindex "&%condition%& ACL condition"
32303 .cindex "customizing" "ACL condition"
32304 .cindex "&ACL;" "customized test"
32305 .cindex "&ACL;" "testing, customized"
32306 This feature allows you to make up custom conditions. If the result of
32307 expanding the string is an empty string, the number zero, or one of the strings
32308 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32309 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32310 any other value, some error is assumed to have occurred, and the ACL returns
32311 &"defer"&. However, if the expansion is forced to fail, the condition is
32312 ignored. The effect is to treat it as true, whether it is positive or
32313 negative.
32314
32315 .vitem &*decode&~=&~*&<&'location'&>
32316 .cindex "&%decode%& ACL condition"
32317 This condition is available only when Exim is compiled with the
32318 content-scanning extension, and it is allowed only in the ACL defined by
32319 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32320 If all goes well, the condition is true. It is false only if there are
32321 problems such as a syntax error or a memory shortage. For more details, see
32322 chapter &<<CHAPexiscan>>&.
32323
32324 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32325 .cindex "&%dnslists%& ACL condition"
32326 .cindex "DNS list" "in ACL"
32327 .cindex "black list (DNS)"
32328 .cindex "&ACL;" "testing a DNS list"
32329 This condition checks for entries in DNS black lists. These are also known as
32330 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32331 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32332 different variants of this condition to describe briefly here. See sections
32333 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32334
32335 .vitem &*domains&~=&~*&<&'domain&~list'&>
32336 .cindex "&%domains%& ACL condition"
32337 .cindex "domain" "ACL checking"
32338 .cindex "&ACL;" "testing a recipient domain"
32339 .vindex "&$domain_data$&"
32340 This condition is relevant only in a RCPT ACL. It checks that the domain
32341 of the recipient address is in the domain list. If percent-hack processing is
32342 enabled, it is done before this test is done. If the check succeeds with a
32343 lookup, the result of the lookup is placed in &$domain_data$& until the next
32344 &%domains%& test.
32345
32346 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32347 use &%domains%& in a DATA ACL.
32348
32349
32350 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32351 .cindex "&%encrypted%& ACL condition"
32352 .cindex "encryption" "checking in an ACL"
32353 .cindex "&ACL;" "testing for encryption"
32354 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32355 name of the cipher suite in use is tested against the list. To test for
32356 encryption without testing for any specific cipher suite(s), set
32357 .code
32358 encrypted = *
32359 .endd
32360
32361
32362 .vitem &*hosts&~=&~*&<&'host&~list'&>
32363 .cindex "&%hosts%& ACL condition"
32364 .cindex "host" "ACL checking"
32365 .cindex "&ACL;" "testing the client host"
32366 This condition tests that the calling host matches the host list. If you have
32367 name lookups or wildcarded host names and IP addresses in the same host list,
32368 you should normally put the IP addresses first. For example, you could have:
32369 .code
32370 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32371 .endd
32372 The lookup in this example uses the host name for its key. This is implied by
32373 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32374 and it wouldn't matter which way round you had these two items.)
32375
32376 The reason for the problem with host names lies in the left-to-right way that
32377 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32378 but when it reaches an item that requires a host name, it fails if it cannot
32379 find a host name to compare with the pattern. If the above list is given in the
32380 opposite order, the &%accept%& statement fails for a host whose name cannot be
32381 found, even if its IP address is 10.9.8.7.
32382
32383 If you really do want to do the name check first, and still recognize the IP
32384 address even if the name lookup fails, you can rewrite the ACL like this:
32385 .code
32386 accept hosts = dbm;/etc/friendly/hosts
32387 accept hosts = 10.9.8.7
32388 .endd
32389 The default action on failing to find the host name is to assume that the host
32390 is not in the list, so the first &%accept%& statement fails. The second
32391 statement can then check the IP address.
32392
32393 .vindex "&$host_data$&"
32394 If a &%hosts%& condition is satisfied by means of a lookup, the result
32395 of the lookup is made available in the &$host_data$& variable. This
32396 allows you, for example, to set up a statement like this:
32397 .code
32398 deny  hosts = net-lsearch;/some/file
32399       message = $host_data
32400 .endd
32401 which gives a custom error message for each denied host.
32402
32403 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32404 .cindex "&%local_parts%& ACL condition"
32405 .cindex "local part" "ACL checking"
32406 .cindex "&ACL;" "testing a local part"
32407 .vindex "&$local_part_data$&"
32408 This condition is relevant only in a RCPT ACL. It checks that the local
32409 part of the recipient address is in the list. If percent-hack processing is
32410 enabled, it is done before this test. If the check succeeds with a lookup, the
32411 result of the lookup is placed in &$local_part_data$&, which remains set until
32412 the next &%local_parts%& test.
32413
32414 .vitem &*malware&~=&~*&<&'option'&>
32415 .cindex "&%malware%& ACL condition"
32416 .cindex "&ACL;" "virus scanning"
32417 .cindex "&ACL;" "scanning for viruses"
32418 This condition is available only when Exim is compiled with the
32419 content-scanning extension
32420 and only after a DATA command.
32421 It causes the incoming message to be scanned for
32422 viruses. For details, see chapter &<<CHAPexiscan>>&.
32423
32424 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32425 .cindex "&%mime_regex%& ACL condition"
32426 .cindex "&ACL;" "testing by regex matching"
32427 This condition is available only when Exim is compiled with the
32428 content-scanning extension, and it is allowed only in the ACL defined by
32429 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32430 with any of the regular expressions. For details, see chapter
32431 &<<CHAPexiscan>>&.
32432
32433 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32434 .cindex "rate limiting"
32435 This condition can be used to limit the rate at which a user or host submits
32436 messages. Details are given in section &<<SECTratelimiting>>&.
32437
32438 .vitem &*recipients&~=&~*&<&'address&~list'&>
32439 .cindex "&%recipients%& ACL condition"
32440 .cindex "recipient" "ACL checking"
32441 .cindex "&ACL;" "testing a recipient"
32442 This condition is relevant only in a RCPT ACL. It checks the entire
32443 recipient address against a list of recipients.
32444
32445 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32446 .cindex "&%regex%& ACL condition"
32447 .cindex "&ACL;" "testing by regex matching"
32448 This condition is available only when Exim is compiled with the
32449 content-scanning extension, and is available only in the DATA, MIME, and
32450 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32451 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32452
32453 .vitem &*seen&~=&~*&<&'parameters'&>
32454 .cindex "&%seen%& ACL condition"
32455 This condition can be used to test if a situation has been previously met,
32456 for example for greylisting.
32457 Details are given in section &<<SECTseen>>&.
32458
32459 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32460 .cindex "&%sender_domains%& ACL condition"
32461 .cindex "sender" "ACL checking"
32462 .cindex "&ACL;" "testing a sender domain"
32463 .vindex "&$domain$&"
32464 .vindex "&$sender_address_domain$&"
32465 This condition tests the domain of the sender of the message against the given
32466 domain list. &*Note*&: The domain of the sender address is in
32467 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32468 of this condition. This is an exception to the general rule for testing domain
32469 lists. It is done this way so that, if this condition is used in an ACL for a
32470 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32471 influence the sender checking.
32472
32473 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32474 relaying, because sender addresses are easily, and commonly, forged.
32475
32476 .vitem &*senders&~=&~*&<&'address&~list'&>
32477 .cindex "&%senders%& ACL condition"
32478 .cindex "sender" "ACL checking"
32479 .cindex "&ACL;" "testing a sender"
32480 This condition tests the sender of the message against the given list. To test
32481 for a bounce message, which has an empty sender, set
32482 .code
32483 senders = :
32484 .endd
32485 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32486 relaying, because sender addresses are easily, and commonly, forged.
32487
32488 .vitem &*spam&~=&~*&<&'username'&>
32489 .cindex "&%spam%& ACL condition"
32490 .cindex "&ACL;" "scanning for spam"
32491 This condition is available only when Exim is compiled with the
32492 content-scanning extension. It causes the incoming message to be scanned by
32493 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32494
32495 .vitem &*verify&~=&~certificate*&
32496 .cindex "&%verify%& ACL condition"
32497 .cindex "TLS" "client certificate verification"
32498 .cindex "certificate" "verification of client"
32499 .cindex "&ACL;" "certificate verification"
32500 .cindex "&ACL;" "testing a TLS certificate"
32501 This condition is true in an SMTP session if the session is encrypted, and a
32502 certificate was received from the client, and the certificate was verified. The
32503 server requests a certificate only if the client matches &%tls_verify_hosts%&
32504 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32505
32506 .vitem &*verify&~=&~csa*&
32507 .cindex "CSA verification"
32508 This condition checks whether the sending host (the client) is authorized to
32509 send email. Details of how this works are given in section
32510 &<<SECTverifyCSA>>&.
32511
32512 .vitem &*verify&~=&~header_names_ascii*&
32513 .cindex "&%verify%& ACL condition"
32514 .cindex "&ACL;" "verifying header names only ASCII"
32515 .cindex "header lines" "verifying header names only ASCII"
32516 .cindex "verifying" "header names only ASCII"
32517 This condition is relevant only in an ACL that is run after a message has been
32518 received.
32519 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32520 It checks all header names (not the content) to make sure
32521 there are no non-ASCII characters, also excluding control characters.  The
32522 allowable characters are decimal ASCII values 33 through 126.
32523
32524 Exim itself will handle headers with non-ASCII characters, but it can cause
32525 problems for downstream applications, so this option will allow their
32526 detection and rejection in the DATA ACL's.
32527
32528 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32529 .cindex "&%verify%& ACL condition"
32530 .cindex "&ACL;" "verifying sender in the header"
32531 .cindex "header lines" "verifying the sender in"
32532 .cindex "sender" "verifying in header"
32533 .cindex "verifying" "sender in header"
32534 This condition is relevant only in an ACL that is run after a message has been
32535 received, that is, in an ACL specified by &%acl_smtp_data%& or
32536 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32537 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32538 is loosely thought of as a &"sender"& address (hence the name of the test).
32539 However, an address that appears in one of these headers need not be an address
32540 that accepts bounce messages; only sender addresses in envelopes are required
32541 to accept bounces. Therefore, if you use the callout option on this check, you
32542 might want to arrange for a non-empty address in the MAIL command.
32543
32544 Details of address verification and the options are given later, starting at
32545 section &<<SECTaddressverification>>& (callouts are described in section
32546 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32547 condition to restrict it to bounce messages only:
32548 .code
32549 deny    senders = :
32550        !verify  = header_sender
32551         message = A valid sender header is required for bounces
32552 .endd
32553
32554 .vitem &*verify&~=&~header_syntax*&
32555 .cindex "&%verify%& ACL condition"
32556 .cindex "&ACL;" "verifying header syntax"
32557 .cindex "header lines" "verifying syntax"
32558 .cindex "verifying" "header syntax"
32559 This condition is relevant only in an ACL that is run after a message has been
32560 received, that is, in an ACL specified by &%acl_smtp_data%& or
32561 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32562 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32563 and &'Bcc:'&), returning true if there are no problems.
32564 Unqualified addresses (local parts without domains) are
32565 permitted only in locally generated messages and from hosts that match
32566 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32567 appropriate.
32568
32569 Note that this condition is a syntax check only. However, a common spamming
32570 ploy used to be to send syntactically invalid headers such as
32571 .code
32572 To: @
32573 .endd
32574 and this condition can be used to reject such messages, though they are not as
32575 common as they used to be.
32576
32577 .vitem &*verify&~=&~helo*&
32578 .cindex "&%verify%& ACL condition"
32579 .cindex "&ACL;" "verifying HELO/EHLO"
32580 .cindex "HELO" "verifying"
32581 .cindex "EHLO" "verifying"
32582 .cindex "verifying" "EHLO"
32583 .cindex "verifying" "HELO"
32584 This condition is true if a HELO or EHLO command has been received from the
32585 client host, and its contents have been verified. If there has been no previous
32586 attempt to verify the HELO/EHLO contents, it is carried out when this
32587 condition is encountered. See the description of the &%helo_verify_hosts%& and
32588 &%helo_try_verify_hosts%& options for details of how to request verification
32589 independently of this condition, and for detail of the verification.
32590
32591 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32592 option), this condition is always true.
32593
32594
32595 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32596 .cindex "verifying" "not blind"
32597 .cindex "bcc recipients, verifying none"
32598 This condition checks that there are no blind (bcc) recipients in the message.
32599 Every envelope recipient must appear either in a &'To:'& header line or in a
32600 &'Cc:'& header line for this condition to be true. Local parts are checked
32601 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32602 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32603 used only in a DATA or non-SMTP ACL.
32604
32605 There is one possible option, &`case_insensitive`&.  If this is present then
32606 local parts are checked case-insensitively.
32607
32608 There are, of course, many legitimate messages that make use of blind (bcc)
32609 recipients. This check should not be used on its own for blocking messages.
32610
32611
32612 .vitem &*verify&~=&~recipient/*&<&'options'&>
32613 .cindex "&%verify%& ACL condition"
32614 .cindex "&ACL;" "verifying recipient"
32615 .cindex "recipient" "verifying"
32616 .cindex "verifying" "recipient"
32617 .vindex "&$address_data$&"
32618 This condition is relevant only after a RCPT command. It verifies the current
32619 recipient. Details of address verification are given later, starting at section
32620 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32621 of &$address_data$& is the last value that was set while routing the address.
32622 This applies even if the verification fails. When an address that is being
32623 verified is redirected to a single address, verification continues with the new
32624 address, and in that case, the subsequent value of &$address_data$& is the
32625 value for the child address.
32626
32627 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32628 .cindex "&%verify%& ACL condition"
32629 .cindex "&ACL;" "verifying host reverse lookup"
32630 .cindex "host" "verifying reverse lookup"
32631 This condition ensures that a verified host name has been looked up from the IP
32632 address of the client host. (This may have happened already if the host name
32633 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32634 Verification ensures that the host name obtained from a reverse DNS lookup, or
32635 one of its aliases, does, when it is itself looked up in the DNS, yield the
32636 original IP address.
32637
32638 There is one possible option, &`defer_ok`&.  If this is present and a
32639 DNS operation returns a temporary error, the verify condition succeeds.
32640
32641 If this condition is used for a locally generated message (that is, when there
32642 is no client host involved), it always succeeds.
32643
32644 .vitem &*verify&~=&~sender/*&<&'options'&>
32645 .cindex "&%verify%& ACL condition"
32646 .cindex "&ACL;" "verifying sender"
32647 .cindex "sender" "verifying"
32648 .cindex "verifying" "sender"
32649 This condition is relevant only after a MAIL or RCPT command, or after a
32650 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32651 the message's sender is empty (that is, this is a bounce message), the
32652 condition is true. Otherwise, the sender address is verified.
32653
32654 .vindex "&$address_data$&"
32655 .vindex "&$sender_address_data$&"
32656 If there is data in the &$address_data$& variable at the end of routing, its
32657 value is placed in &$sender_address_data$& at the end of verification. This
32658 value can be used in subsequent conditions and modifiers in the same ACL
32659 statement. It does not persist after the end of the current statement. If you
32660 want to preserve the value for longer, you can save it in an ACL variable.
32661
32662 Details of verification are given later, starting at section
32663 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32664 to avoid doing it more than once per message.
32665
32666 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32667 .cindex "&%verify%& ACL condition"
32668 This is a variation of the previous option, in which a modified address is
32669 verified as a sender.
32670
32671 Note that '/' is legal in local-parts; if the address may have such
32672 (eg. is generated from the received message)
32673 they must be protected from the options parsing by doubling:
32674 .code
32675 verify = sender=${listquote{/}{${address:$h_sender:}}}
32676 .endd
32677 .endlist
32678
32679
32680
32681 .section "Using DNS lists" "SECTmorednslists"
32682 .cindex "DNS list" "in ACL"
32683 .cindex "black list (DNS)"
32684 .cindex "&ACL;" "testing a DNS list"
32685 In its simplest form, the &%dnslists%& condition tests whether the calling host
32686 is on at least one of a number of DNS lists by looking up the inverted IP
32687 address in one or more DNS domains. (Note that DNS list domains are not mail
32688 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32689 special options instead.) For example, if the calling host's IP
32690 address is 192.168.62.43, and the ACL statement is
32691 .code
32692 deny dnslists = blackholes.mail-abuse.org : \
32693                 dialups.mail-abuse.org
32694 .endd
32695 the following records are looked up:
32696 .code
32697 43.62.168.192.blackholes.mail-abuse.org
32698 43.62.168.192.dialups.mail-abuse.org
32699 .endd
32700 As soon as Exim finds an existing DNS record, processing of the list stops.
32701 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32702 to test that a host is on more than one list (an &"and"& conjunction), you can
32703 use two separate conditions:
32704 .code
32705 deny dnslists = blackholes.mail-abuse.org
32706      dnslists = dialups.mail-abuse.org
32707 .endd
32708 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32709 behaves as if the host does not match the list item, that is, as if the DNS
32710 record does not exist. If there are further items in the DNS list, they are
32711 processed.
32712
32713 This is usually the required action when &%dnslists%& is used with &%deny%&
32714 (which is the most common usage), because it prevents a DNS failure from
32715 blocking mail. However, you can change this behaviour by putting one of the
32716 following special items in the list:
32717 .itable none 0 0 2 25* left 75* left
32718 .irow "+include_unknown"   "behave as if the item is on the list"
32719 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32720 .irow "+defer_unknown  "   "give a temporary error"
32721 .endtable
32722 .cindex "&`+include_unknown`&"
32723 .cindex "&`+exclude_unknown`&"
32724 .cindex "&`+defer_unknown`&"
32725 Each of these applies to any subsequent items on the list. For example:
32726 .code
32727 deny dnslists = +defer_unknown : foo.bar.example
32728 .endd
32729 Testing the list of domains stops as soon as a match is found. If you want to
32730 warn for one list and block for another, you can use two different statements:
32731 .code
32732 deny  dnslists = blackholes.mail-abuse.org
32733 warn  dnslists = dialups.mail-abuse.org
32734       message  = X-Warn: sending host is on dialups list
32735 .endd
32736 .cindex caching "of dns lookup"
32737 .cindex DNS TTL
32738 DNS list lookups are cached by Exim for the duration of the SMTP session
32739 (but limited by the DNS return TTL value),
32740 so a lookup based on the IP address is done at most once for any incoming
32741 connection (assuming long-enough TTL).
32742 Exim does not share information between multiple incoming
32743 connections (but your local name server cache should be active).
32744
32745 There are a number of DNS lists to choose from, some commercial, some free,
32746 or free for small deployments.  An overview can be found at
32747 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32748
32749
32750
32751 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32752 .cindex "DNS list" "keyed by explicit IP address"
32753 By default, the IP address that is used in a DNS list lookup is the IP address
32754 of the calling host. However, you can specify another IP address by listing it
32755 after the domain name, introduced by a slash. For example:
32756 .code
32757 deny dnslists = black.list.tld/192.168.1.2
32758 .endd
32759 This feature is not very helpful with explicit IP addresses; it is intended for
32760 use with IP addresses that are looked up, for example, the IP addresses of the
32761 MX hosts or nameservers of an email sender address. For an example, see section
32762 &<<SECTmulkeyfor>>& below.
32763
32764
32765
32766
32767 .subsection "DNS lists keyed on domain names" SECID202
32768 .cindex "DNS list" "keyed by domain name"
32769 There are some lists that are keyed on domain names rather than inverted IP
32770 addresses (see, e.g., the &'domain based zones'& link at
32771 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32772 with these lists. You can change the name that is looked up in a DNS list by
32773 listing it after the domain name, introduced by a slash. For example,
32774 .code
32775 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32776       message  = Sender's domain is listed at $dnslist_domain
32777 .endd
32778 This particular example is useful only in ACLs that are obeyed after the
32779 RCPT or DATA commands, when a sender address is available. If (for
32780 example) the message's sender is &'user@tld.example'& the name that is looked
32781 up by this example is
32782 .code
32783 tld.example.dsn.rfc-ignorant.org
32784 .endd
32785 A single &%dnslists%& condition can contain entries for both names and IP
32786 addresses. For example:
32787 .code
32788 deny dnslists = sbl.spamhaus.org : \
32789                 dsn.rfc-ignorant.org/$sender_address_domain
32790 .endd
32791 The first item checks the sending host's IP address; the second checks a domain
32792 name. The whole condition is true if either of the DNS lookups succeeds.
32793
32794
32795
32796
32797 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32798 .cindex "DNS list" "multiple keys for"
32799 The syntax described above for looking up explicitly-defined values (either
32800 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32801 name for the DNS list, what follows the slash can in fact be a list of items.
32802 As with all lists in Exim, the default separator is a colon. However, because
32803 this is a sublist within the list of DNS blacklist domains, it is necessary
32804 either to double the separators like this:
32805 .code
32806 dnslists = black.list.tld/name.1::name.2
32807 .endd
32808 or to change the separator character, like this:
32809 .code
32810 dnslists = black.list.tld/<;name.1;name.2
32811 .endd
32812 If an item in the list is an IP address, it is inverted before the DNS
32813 blacklist domain is appended. If it is not an IP address, no inversion
32814 occurs. Consider this condition:
32815 .code
32816 dnslists = black.list.tld/<;192.168.1.2;a.domain
32817 .endd
32818 The DNS lookups that occur are:
32819 .code
32820 2.1.168.192.black.list.tld
32821 a.domain.black.list.tld
32822 .endd
32823 Once a DNS record has been found (that matches a specific IP return
32824 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32825 are done. If there is a temporary DNS error, the rest of the sublist of domains
32826 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32827 only if no other DNS lookup in this sublist succeeds. In other words, a
32828 successful lookup for any of the items in the sublist overrides a temporary
32829 error for a previous item.
32830
32831 The ability to supply a list of items after the slash is in some sense just a
32832 syntactic convenience. These two examples have the same effect:
32833 .code
32834 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32835 dnslists = black.list.tld/a.domain::b.domain
32836 .endd
32837 However, when the data for the list is obtained from a lookup, the second form
32838 is usually much more convenient. Consider this example:
32839 .code
32840 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32841                                    ${lookup dnsdb {>|mxh=\
32842                                    $sender_address_domain} }} }
32843      message  = The mail servers for the domain \
32844                 $sender_address_domain \
32845                 are listed at $dnslist_domain ($dnslist_value); \
32846                 see $dnslist_text.
32847 .endd
32848 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32849 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32850 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32851 of expanding the condition might be something like this:
32852 .code
32853 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32854 .endd
32855 Thus, this example checks whether or not the IP addresses of the sender
32856 domain's mail servers are on the Spamhaus black list.
32857
32858 The key that was used for a successful DNS list lookup is put into the variable
32859 &$dnslist_matched$& (see section &<<SECID204>>&).
32860
32861
32862
32863
32864 .subsection "Data returned by DNS lists" SECID203
32865 .cindex "DNS list" "data returned from"
32866 DNS lists are constructed using address records in the DNS. The original RBL
32867 just used the address 127.0.0.1 on the right hand side of each record, but the
32868 RBL+ list and some other lists use a number of values with different meanings.
32869 The values used on the RBL+ list are:
32870 .itable none 0 0 2 20* left 80* left
32871 .irow 127.1.0.1  "RBL"
32872 .irow 127.1.0.2  "DUL"
32873 .irow 127.1.0.3  "DUL and RBL"
32874 .irow 127.1.0.4  "RSS"
32875 .irow 127.1.0.5  "RSS and RBL"
32876 .irow 127.1.0.6  "RSS and DUL"
32877 .irow 127.1.0.7  "RSS and DUL and RBL"
32878 .endtable
32879 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32880 different values. Some DNS lists may return more than one address record;
32881 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32882
32883 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32884 range. If a DNSBL operator loses control of the domain, lookups on it
32885 may start returning other addresses.  Because of this, Exim now ignores
32886 returned values outside the 127/8 region.
32887
32888
32889 .subsection "Variables set from DNS lists" SECID204
32890 .cindex "expansion" "variables, set from DNS list"
32891 .cindex "DNS list" "variables set from"
32892 .vindex "&$dnslist_domain$&"
32893 .vindex "&$dnslist_matched$&"
32894 .vindex "&$dnslist_text$&"
32895 .vindex "&$dnslist_value$&"
32896 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32897 the name of the overall domain that matched (for example,
32898 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32899 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32900 the DNS record. When the key is an IP address, it is not reversed in
32901 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32902 cases, for example:
32903 .code
32904 deny dnslists = spamhaus.example
32905 .endd
32906 the key is also available in another variable (in this case,
32907 &$sender_host_address$&). In more complicated cases, however, this is not true.
32908 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32909 might generate a dnslists lookup like this:
32910 .code
32911 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32912 .endd
32913 If this condition succeeds, the value in &$dnslist_matched$& might be
32914 &`192.168.6.7`& (for example).
32915
32916 If more than one address record is returned by the DNS lookup, all the IP
32917 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32918 The variable &$dnslist_text$& contains the contents of any associated TXT
32919 record. For lists such as RBL+ the TXT record for a merged entry is often not
32920 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32921 information.
32922
32923 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32924 &-- even if these appear before the condition in the ACL, they are not
32925 expanded until after it has failed. For example:
32926 .code
32927 deny    hosts = !+local_networks
32928         message = $sender_host_address is listed \
32929                   at $dnslist_domain
32930         dnslists = rbl-plus.mail-abuse.example
32931 .endd
32932
32933
32934
32935 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32936 .cindex "DNS list" "matching specific returned data"
32937 You can add an equals sign and an IP address after a &%dnslists%& domain name
32938 in order to restrict its action to DNS records with a matching right hand side.
32939 For example,
32940 .code
32941 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32942 .endd
32943 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32944 any address record is considered to be a match. For the moment, we assume
32945 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32946 describes how multiple records are handled.
32947
32948 More than one IP address may be given for checking, using a comma as a
32949 separator. These are alternatives &-- if any one of them matches, the
32950 &%dnslists%& condition is true. For example:
32951 .code
32952 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32953 .endd
32954 If you want to specify a constraining address list and also specify names or IP
32955 addresses to be looked up, the constraining address list must be specified
32956 first. For example:
32957 .code
32958 deny dnslists = dsn.rfc-ignorant.org\
32959                 =127.0.0.2/$sender_address_domain
32960 .endd
32961
32962 If the character &`&&`& is used instead of &`=`&, the comparison for each
32963 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32964 In other words, the listed addresses are used as bit masks. The comparison is
32965 true if all the bits in the mask are present in the address that is being
32966 tested. For example:
32967 .code
32968 dnslists = a.b.c&0.0.0.3
32969 .endd
32970 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32971 want to test whether one bit or another bit is present (as opposed to both
32972 being present), you must use multiple values. For example:
32973 .code
32974 dnslists = a.b.c&0.0.0.1,0.0.0.2
32975 .endd
32976 matches if the final component of the address is an odd number or two times
32977 an odd number.
32978
32979
32980
32981 .subsection "Negated DNS matching conditions" SECID205
32982 You can supply a negative list of IP addresses as part of a &%dnslists%&
32983 condition. Whereas
32984 .code
32985 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32986 .endd
32987 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32988 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32989 .code
32990 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32991 .endd
32992 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32993 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32994 words, the result of the test is inverted if an exclamation mark appears before
32995 the &`=`& (or the &`&&`&) sign.
32996
32997 &*Note*&: This kind of negation is not the same as negation in a domain,
32998 host, or address list (which is why the syntax is different).
32999
33000 If you are using just one list, the negation syntax does not gain you much. The
33001 previous example is precisely equivalent to
33002 .code
33003 deny  dnslists = a.b.c
33004      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33005 .endd
33006 However, if you are using multiple lists, the negation syntax is clearer.
33007 Consider this example:
33008 .code
33009 deny  dnslists = sbl.spamhaus.org : \
33010                  list.dsbl.org : \
33011                  dnsbl.njabl.org!=127.0.0.3 : \
33012                  relays.ordb.org
33013 .endd
33014 Using only positive lists, this would have to be:
33015 .code
33016 deny  dnslists = sbl.spamhaus.org : \
33017                  list.dsbl.org
33018 deny  dnslists = dnsbl.njabl.org
33019      !dnslists = dnsbl.njabl.org=127.0.0.3
33020 deny  dnslists = relays.ordb.org
33021 .endd
33022 which is less clear, and harder to maintain.
33023
33024 Negation can also be used with a bitwise-and restriction.
33025 The dnslists condition with only be trus if a result is returned
33026 by the lookup which, anded with the restriction, is all zeroes.
33027 For example:
33028 .code
33029 deny dnslists = zen.spamhaus.org!&0.255.255.0
33030 .endd
33031
33032
33033
33034
33035 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33036 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33037 thereby providing more than one IP address. When an item in a &%dnslists%& list
33038 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33039 the match to specific results from the DNS lookup, there are two ways in which
33040 the checking can be handled. For example, consider the condition:
33041 .code
33042 dnslists = a.b.c=127.0.0.1
33043 .endd
33044 What happens if the DNS lookup for the incoming IP address yields both
33045 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33046 condition true because at least one given value was found, or is it false
33047 because at least one of the found values was not listed? And how does this
33048 affect negated conditions? Both possibilities are provided for with the help of
33049 additional separators &`==`& and &`=&&`&.
33050
33051 .ilist
33052 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33053 IP addresses matches one of the listed addresses. For the example above, the
33054 condition is true because 127.0.0.1 matches.
33055 .next
33056 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33057 looked up IP addresses matches one of the listed addresses. If the condition is
33058 changed to:
33059 .code
33060 dnslists = a.b.c==127.0.0.1
33061 .endd
33062 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33063 false because 127.0.0.2 is not listed. You would need to have:
33064 .code
33065 dnslists = a.b.c==127.0.0.1,127.0.0.2
33066 .endd
33067 for the condition to be true.
33068 .endlist
33069
33070 When &`!`& is used to negate IP address matching, it inverts the result, giving
33071 the precise opposite of the behaviour above. Thus:
33072 .ilist
33073 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33074 addresses matches one of the listed addresses. Consider:
33075 .code
33076 dnslists = a.b.c!&0.0.0.1
33077 .endd
33078 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33079 false because 127.0.0.1 matches.
33080 .next
33081 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33082 looked up IP address that does not match. Consider:
33083 .code
33084 dnslists = a.b.c!=&0.0.0.1
33085 .endd
33086 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33087 true, because 127.0.0.2 does not match. You would need to have:
33088 .code
33089 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33090 .endd
33091 for the condition to be false.
33092 .endlist
33093 When the DNS lookup yields only a single IP address, there is no difference
33094 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33095
33096
33097
33098
33099 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33100 .cindex "DNS list" "information from merged"
33101 When the facility for restricting the matching IP values in a DNS list is used,
33102 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33103 the true reason for rejection. This happens when lists are merged and the IP
33104 address in the A record is used to distinguish them; unfortunately there is
33105 only one TXT record. One way round this is not to use merged lists, but that
33106 can be inefficient because it requires multiple DNS lookups where one would do
33107 in the vast majority of cases when the host of interest is not on any of the
33108 lists.
33109
33110 A less inefficient way of solving this problem is available. If
33111 two domain names, comma-separated, are given, the second is used first to
33112 do an initial check, making use of any IP value restrictions that are set.
33113 If there is a match, the first domain is used, without any IP value
33114 restrictions, to get the TXT record. As a byproduct of this, there is also
33115 a check that the IP being tested is indeed on the first list. The first
33116 domain is the one that is put in &$dnslist_domain$&. For example:
33117 .code
33118 deny   dnslists = \
33119          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33120          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33121        message  = \
33122          rejected because $sender_host_address is blacklisted \
33123          at $dnslist_domain\n$dnslist_text
33124 .endd
33125 For the first blacklist item, this starts by doing a lookup in
33126 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33127 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33128 value, and as long as something is found, it looks for the corresponding TXT
33129 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33130 The second blacklist item is processed similarly.
33131
33132 If you are interested in more than one merged list, the same list must be
33133 given several times, but because the results of the DNS lookups are cached,
33134 the DNS calls themselves are not repeated. For example:
33135 .code
33136 deny dnslists = \
33137          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33138          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33139          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33140          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33141 .endd
33142 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33143 values matches (or if no record is found), this is the only lookup that is
33144 done. Only if there is a match is one of the more specific lists consulted.
33145
33146
33147
33148 .subsection "DNS lists and IPv6" SECTmorednslistslast
33149 .cindex "IPv6" "DNS black lists"
33150 .cindex "DNS list" "IPv6 usage"
33151 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33152 nibble by nibble. For example, if the calling host's IP address is
33153 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33154 .code
33155 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33156   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33157 .endd
33158 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33159 lists contain wildcard records, intended for IPv4, that interact badly with
33160 IPv6. For example, the DNS entry
33161 .code
33162 *.3.some.list.example.    A    127.0.0.1
33163 .endd
33164 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33165 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33166
33167 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33168 &%condition%& condition, as in this example:
33169 .code
33170 deny   condition = ${if isip4{$sender_host_address}}
33171        dnslists  = some.list.example
33172 .endd
33173
33174 If an explicit key is being used for a DNS lookup and it may be an IPv6
33175 address you should specify alternate list separators for both the outer
33176 (DNS list name) list and inner (lookup keys) list:
33177 .code
33178        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33179 .endd
33180
33181
33182 .section "Previously seen user and hosts" "SECTseen"
33183 .cindex "&%seen%& ACL condition"
33184 .cindex greylisting
33185 The &%seen%& ACL condition can be used to test whether a
33186 situation has been previously met.
33187 It uses a hints database to record a timestamp against a key.
33188 The syntax of the condition is:
33189 .display
33190 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33191 .endd
33192
33193 For example,
33194 .code
33195 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33196 .endd
33197 in a RCPT ACL will implement simple greylisting.
33198
33199 The parameters for the condition are
33200 a possible minus sign,
33201 then an interval,
33202 then, slash-separated, a list of options.
33203 The interval is taken as an offset before the current time,
33204 and used for the test.
33205 If the interval is preceded by a minus sign then the condition returns
33206 whether a record is found which is before the test time.
33207 Otherwise, the condition returns whether one is found which is since the
33208 test time.
33209
33210 Options are read in order with later ones overriding earlier ones.
33211
33212 The default key is &$sender_host_address$&.
33213 An explicit key can be set using a &%key=value%& option.
33214
33215 If a &%readonly%& option is given then
33216 no record create or update is done.
33217 If a &%write%& option is given then
33218 a record create or update is always done.
33219 An update is done if the test is for &"since"&.
33220 If none of those hold and there was no existing record,
33221 a record is created.
33222
33223 Creates and updates are marked with the current time.
33224
33225 Finally, a &"before"& test which succeeds, and for which the record
33226 is old enough, will be refreshed with a timestamp of the test time.
33227 This can prevent tidying of the database from removing the entry.
33228 The interval for this is, by default, 10 days.
33229 An explicit interval can be set using a
33230 &%refresh=value%& option.
33231
33232 Note that &"seen"& should be added to the list of hints databases
33233 for maintenance if this ACL condition is used.
33234
33235
33236 .section "Rate limiting incoming messages" "SECTratelimiting"
33237 .cindex "rate limiting" "client sending"
33238 .cindex "limiting client sending rates"
33239 .oindex "&%smtp_ratelimit_*%&"
33240 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33241 which clients can send email. This is more powerful than the
33242 &%smtp_ratelimit_*%& options, because those options control the rate of
33243 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33244 works across all connections (concurrent and sequential) from the same client
33245 host. The syntax of the &%ratelimit%& condition is:
33246 .display
33247 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33248 .endd
33249 If the average client sending rate is less than &'m'& messages per time
33250 period &'p'& then the condition is false; otherwise it is true.
33251
33252 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33253 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33254 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33255 of &'p'&.
33256
33257 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33258 time interval, for example, &`8h`& for eight hours. A larger time constant
33259 means that it takes Exim longer to forget a client's past behaviour. The
33260 parameter &'m'& is the maximum number of messages that a client is permitted to
33261 send in each time interval. It also specifies the number of messages permitted
33262 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33263 constant, you can allow a client to send more messages in a burst without
33264 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33265 both small, messages must be sent at an even rate.
33266
33267 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33268 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33269 when deploying the &%ratelimit%& ACL condition. The script prints usage
33270 instructions when it is run with no arguments.
33271
33272 The key is used to look up the data for calculating the client's average
33273 sending rate. This data is stored in Exim's spool directory, alongside the
33274 retry and other hints databases. The default key is &$sender_host_address$&,
33275 which means Exim computes the sending rate of each client host IP address.
33276 By changing the key you can change how Exim identifies clients for the purpose
33277 of ratelimiting. For example, to limit the sending rate of each authenticated
33278 user, independent of the computer they are sending from, set the key to
33279 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33280 example, &$authenticated_id$& is only meaningful if the client has
33281 authenticated (which you can check with the &%authenticated%& ACL condition).
33282
33283 The lookup key does not have to identify clients: If you want to limit the
33284 rate at which a recipient receives messages, you can use the key
33285 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33286 ACL.
33287
33288 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33289 specifies what Exim measures the rate of, for example, messages or recipients
33290 or bytes. You can adjust the measurement using the &%unique=%& and/or
33291 &%count=%& options. You can also control when Exim updates the recorded rate
33292 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33293 separated by a slash, like the other parameters. They may appear in any order.
33294
33295 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33296 any options that alter the meaning of the stored data. The limit &'m'& is not
33297 stored, so you can alter the configured maximum rate and Exim will still
33298 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33299 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33300 behaviour. The lookup key is not affected by changes to the update mode and
33301 the &%count=%& option.
33302
33303
33304 .subsection "Ratelimit options for what is being measured" ratoptmea
33305 .cindex "rate limiting" "per_* options"
33306 .vlist
33307 .vitem per_conn
33308 .cindex "rate limiting" per_conn
33309 This option limits the client's connection rate. It is not
33310 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33311 &%acl_not_smtp_start%& ACLs.
33312
33313 .vitem per_mail
33314 .cindex "rate limiting" per_conn
33315 This option limits the client's rate of sending messages. This is
33316 the default if none of the &%per_*%& options is specified. It can be used in
33317 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33318 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33319
33320 .vitem per_byte
33321 .cindex "rate limiting" per_conn
33322 This option limits the sender's email bandwidth. It can be used in
33323 the same ACLs as the &%per_mail%& option, though it is best to use this option
33324 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33325 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33326 in its MAIL command, which may be inaccurate or completely missing. You can
33327 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33328 in kilobytes, megabytes, or gigabytes, respectively.
33329
33330 .vitem per_rcpt
33331 .cindex "rate limiting" per_rcpt
33332 This option causes Exim to limit the rate at which recipients are
33333 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33334 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33335 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33336 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33337 in either case the rate limiting engine will see a message with many
33338 recipients as a large high-speed burst.
33339
33340 .vitem per_addr
33341 .cindex "rate limiting" per_addr
33342 This option is like the &%per_rcpt%& option, except it counts the
33343 number of different recipients that the client has sent messages to in the
33344 last time period. That is, if the client repeatedly sends messages to the same
33345 recipient, its measured rate is not increased. This option can only be used in
33346 &%acl_smtp_rcpt%&.
33347
33348 .vitem per_cmd
33349 .cindex "rate limiting" per_cmd
33350 This option causes Exim to recompute the rate every time the
33351 condition is processed. This can be used to limit the rate of any SMTP
33352 command. If it is used in multiple ACLs it can limit the aggregate rate of
33353 multiple different commands.
33354
33355 .vitem count
33356 .cindex "rate limiting" count
33357 This option can be used to alter how much Exim adds to the client's
33358 measured rate.
33359 A value is required, after an equals sign.
33360 For example, the &%per_byte%& option is equivalent to
33361 &`per_mail/count=$message_size`&.
33362 If there is no &%count=%& option, Exim
33363 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33364 other than &%acl_smtp_rcpt%&).
33365 The count does not have to be an integer.
33366
33367 .vitem unique
33368 .cindex "rate limiting" unique
33369 This option is described in section &<<ratoptuniq>>& below.
33370 .endlist
33371
33372
33373 .subsection "Ratelimit update modes" ratoptupd
33374 .cindex "rate limiting" "reading data without updating"
33375 You can specify one of three options with the &%ratelimit%& condition to
33376 control when its database is updated. This section describes the &%readonly%&
33377 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33378
33379 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33380 previously-computed rate to check against the limit.
33381
33382 For example, you can test the client's sending rate and deny it access (when
33383 it is too fast) in the connect ACL. If the client passes this check then it
33384 can go on to send a message, in which case its recorded rate will be updated
33385 in the MAIL ACL. Subsequent connections from the same client will check this
33386 new rate.
33387 .code
33388 acl_check_connect:
33389  deny ratelimit = 100 / 5m / readonly
33390       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33391                   (max $sender_rate_limit)
33392 # ...
33393 acl_check_mail:
33394  warn ratelimit = 100 / 5m / strict
33395       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33396                   (max $sender_rate_limit)
33397 .endd
33398
33399 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33400 processing a message then it may increase the client's measured rate more than
33401 it should. For example, this will happen if you check the &%per_rcpt%& option
33402 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33403 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33404 multiple update problems by using the &%readonly%& option on later ratelimit
33405 checks.
33406
33407 The &%per_*%& options described above do not make sense in some ACLs. If you
33408 use a &%per_*%& option in an ACL where it is not normally permitted then the
33409 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33410 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33411 next section) so you must specify the &%readonly%& option explicitly.
33412
33413
33414 .subsection "Ratelimit options for handling fast clients" ratoptfast
33415 .cindex "rate limiting" "strict and leaky modes"
33416 If a client's average rate is greater than the maximum, the rate limiting
33417 engine can react in two possible ways, depending on the presence of the
33418 &%strict%& or &%leaky%& update modes. This is independent of the other
33419 counter-measures (such as rejecting the message) that may be specified by the
33420 rest of the ACL.
33421
33422 The &%leaky%& (default) option means that the client's recorded rate is not
33423 updated if it is above the limit. The effect of this is that Exim measures the
33424 client's average rate of successfully sent email,
33425 up to the given limit.
33426 This is appropriate if the countermeasure when the condition is true
33427 consists of refusing the message, and
33428 is generally the better choice if you have clients that retry automatically.
33429 If the action when true is anything more complex then this option is
33430 likely not what is wanted.
33431
33432 The &%strict%& option means that the client's recorded rate is always
33433 updated. The effect of this is that Exim measures the client's average rate
33434 of attempts to send email, which can be much higher than the maximum it is
33435 actually allowed. If the client is over the limit it may be subjected to
33436 counter-measures by the ACL. It must slow down and allow sufficient time to
33437 pass that its computed rate falls below the maximum before it can send email
33438 again. The time (the number of smoothing periods) it must wait and not
33439 attempt to send mail can be calculated with this formula:
33440 .code
33441         ln(peakrate/maxrate)
33442 .endd
33443
33444
33445 .subsection "Limiting the rate of different events" ratoptuniq
33446 .cindex "rate limiting" "counting unique events"
33447 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33448 rate of different events. For example, the &%per_addr%& option uses this
33449 mechanism to count the number of different recipients that the client has
33450 sent messages to in the last time period; it is equivalent to
33451 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33452 measure the rate that a client uses different sender addresses with the
33453 options &`per_mail/unique=$sender_address`&.
33454
33455 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33456 has seen for that key. The whole set is thrown away when it is older than the
33457 rate smoothing period &'p'&, so each different event is counted at most once
33458 per period. In the &%leaky%& update mode, an event that causes the client to
33459 go over the limit is not added to the set, in the same way that the client's
33460 recorded rate is not updated in the same situation.
33461
33462 When you combine the &%unique=%& and &%readonly%& options, the specific
33463 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33464 rate.
33465
33466 The &%unique=%& mechanism needs more space in the ratelimit database than the
33467 other &%ratelimit%& options in order to store the event set. The number of
33468 unique values is potentially as large as the rate limit, so the extra space
33469 required increases with larger limits.
33470
33471 The uniqueification is not perfect: there is a small probability that Exim
33472 will think a new event has happened before. If the sender's rate is less than
33473 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33474 the measured rate can go above the limit, in which case Exim may under-count
33475 events by a significant margin. Fortunately, if the rate is high enough (2.7
33476 times the limit) that the false positive rate goes above 9%, then Exim will
33477 throw away the over-full event set before the measured rate falls below the
33478 limit. Therefore the only harm should be that exceptionally high sending rates
33479 are logged incorrectly; any countermeasures you configure will be as effective
33480 as intended.
33481
33482
33483 .subsection "Using rate limiting" useratlim
33484 Exim's other ACL facilities are used to define what counter-measures are taken
33485 when the rate limit is exceeded. This might be anything from logging a warning
33486 (for example, while measuring existing sending rates in order to define
33487 policy), through time delays to slow down fast senders, up to rejecting the
33488 message. For example:
33489 .code
33490 # Log all senders' rates
33491 warn ratelimit = 0 / 1h / strict
33492      log_message = Sender rate $sender_rate / $sender_rate_period
33493
33494 # Slow down fast senders; note the need to truncate $sender_rate
33495 # at the decimal point.
33496 warn ratelimit = 100 / 1h / per_rcpt / strict
33497      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33498                    $sender_rate_limit }s
33499
33500 # Keep authenticated users under control
33501 deny authenticated = *
33502      ratelimit = 100 / 1d / strict / $authenticated_id
33503
33504 # System-wide rate limit
33505 defer ratelimit = 10 / 1s / $primary_hostname
33506       message = Sorry, too busy. Try again later.
33507
33508 # Restrict incoming rate from each host, with a default
33509 # set using a macro and special cases looked up in a table.
33510 defer ratelimit = ${lookup {$sender_host_address} \
33511                    cdb {DB/ratelimits.cdb} \
33512                    {$value} {RATELIMIT} }
33513       message = Sender rate exceeds $sender_rate_limit \
33514                messages per $sender_rate_period
33515 .endd
33516 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33517 especially with the &%per_rcpt%& option, you may suffer from a performance
33518 bottleneck caused by locking on the ratelimit hints database. Apart from
33519 making your ACLs less complicated, you can reduce the problem by using a
33520 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33521 this means that Exim will lose its hints data after a reboot (including retry
33522 hints, the callout cache, and ratelimit data).
33523
33524
33525
33526 .section "Address verification" "SECTaddressverification"
33527 .cindex "verifying address" "options for"
33528 .cindex "policy control" "address verification"
33529 Several of the &%verify%& conditions described in section
33530 &<<SECTaclconditions>>& cause addresses to be verified. Section
33531 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33532 The verification conditions can be followed by options that modify the
33533 verification process. The options are separated from the keyword and from each
33534 other by slashes, and some of them contain parameters. For example:
33535 .code
33536 verify = sender/callout
33537 verify = recipient/defer_ok/callout=10s,defer_ok
33538 .endd
33539 The first stage of address verification, which always happens, is to run the
33540 address through the routers, in &"verify mode"&. Routers can detect the
33541 difference between verification and routing for delivery, and their actions can
33542 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33543 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33544 The available options are as follows:
33545
33546 .ilist
33547 If the &%callout%& option is specified, successful routing to one or more
33548 remote hosts is followed by a &"callout"& to those hosts as an additional
33549 check. Callouts and their sub-options are discussed in the next section.
33550 .next
33551 If there is a defer error while doing verification routing, the ACL
33552 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33553 options, the condition is forced to be true instead. Note that this is a main
33554 verification option as well as a suboption for callouts.
33555 .next
33556 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33557 discusses the reporting of sender address verification failures.
33558 .next
33559 The &%success_on_redirect%& option causes verification always to succeed
33560 immediately after a successful redirection. By default, if a redirection
33561 generates just one address, that address is also verified. See further
33562 discussion in section &<<SECTredirwhilveri>>&.
33563 .next
33564 If the &%quota%& option is specified for recipient verify,
33565 successful routing to an appendfile transport is followed by a call into
33566 the transport to evaluate the quota status for the recipient.
33567 No actual delivery is done, but verification will succeed if the quota
33568 is sufficient for the message (if the sender gave a message size) or
33569 not already exceeded (otherwise).
33570 .endlist
33571
33572 .cindex "verifying address" "differentiating failures"
33573 .vindex "&$recipient_verify_failure$&"
33574 .vindex "&$sender_verify_failure$&"
33575 .vindex "&$acl_verify_message$&"
33576 After an address verification failure, &$acl_verify_message$& contains the
33577 error message that is associated with the failure. It can be preserved by
33578 coding like this:
33579 .code
33580 warn  !verify = sender
33581        set acl_m0 = $acl_verify_message
33582 .endd
33583 If you are writing your own custom rejection message or log message when
33584 denying access, you can use this variable to include information about the
33585 verification failure.
33586 This variable is cleared at the end of processing the ACL verb.
33587
33588 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33589 appropriate) contains one of the following words:
33590
33591 .ilist
33592 &%qualify%&: The address was unqualified (no domain), and the message
33593 was neither local nor came from an exempted host.
33594 .next
33595 &%route%&: Routing failed.
33596 .next
33597 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33598 occurred at or before the MAIL command (that is, on initial
33599 connection, HELO, or MAIL).
33600 .next
33601 &%recipient%&: The RCPT command in a callout was rejected.
33602 .next
33603 &%postmaster%&: The postmaster check in a callout was rejected.
33604 .next
33605 &%quota%&: The quota check for a local recipient did non pass.
33606 .endlist
33607
33608 The main use of these variables is expected to be to distinguish between
33609 rejections of MAIL and rejections of RCPT in callouts.
33610
33611 The above variables may also be set after a &*successful*&
33612 address verification to:
33613
33614 .ilist
33615 &%random%&: A random local-part callout succeeded
33616 .endlist
33617
33618
33619
33620
33621 .section "Callout verification" "SECTcallver"
33622 .cindex "verifying address" "by callout"
33623 .cindex "callout" "verification"
33624 .cindex "SMTP" "callout verification"
33625 For non-local addresses, routing verifies the domain, but is unable to do any
33626 checking of the local part. There are situations where some means of verifying
33627 the local part is desirable. One way this can be done is to make an SMTP
33628 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33629 a subsequent host for a recipient address, to see if the host accepts the
33630 address. We use the term &'callout'& to cover both cases. Note that for a
33631 sender address, the callback is not to the client host that is trying to
33632 deliver the message, but to one of the hosts that accepts incoming mail for the
33633 sender's domain.
33634
33635 Exim does not do callouts by default. If you want them to happen, you must
33636 request them by setting appropriate options on the &%verify%& condition, as
33637 described below. This facility should be used with care, because it can add a
33638 lot of resource usage to the cost of verifying an address. However, Exim does
33639 cache the results of callouts, which helps to reduce the cost. Details of
33640 caching are in section &<<SECTcallvercache>>&.
33641
33642 Recipient callouts are usually used only between hosts that are controlled by
33643 the same administration. For example, a corporate gateway host could use
33644 callouts to check for valid recipients on an internal mailserver. A successful
33645 callout does not guarantee that a real delivery to the address would succeed;
33646 on the other hand, a failing callout does guarantee that a delivery would fail.
33647
33648 If the &%callout%& option is present on a condition that verifies an address, a
33649 second stage of verification occurs if the address is successfully routed to
33650 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33651 &(manualroute)& router, where the router specifies the hosts. However, if a
33652 router that does not set up hosts routes to an &(smtp)& transport with a
33653 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33654 &%hosts_override%& set, its hosts are always used, whether or not the router
33655 supplies a host list.
33656 Callouts are only supported on &(smtp)& transports.
33657
33658 The port that is used is taken from the transport, if it is specified and is a
33659 remote transport. (For routers that do verification only, no transport need be
33660 specified.) Otherwise, the default SMTP port is used. If a remote transport
33661 specifies an outgoing interface, this is used; otherwise the interface is not
33662 specified. Likewise, the text that is used for the HELO command is taken from
33663 the transport's &%helo_data%& option; if there is no transport, the value of
33664 &$smtp_active_hostname$& is used.
33665
33666 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33667 test whether a bounce message could be delivered to the sender address. The
33668 following SMTP commands are sent:
33669 .display
33670 &`HELO `&<&'local host name'&>
33671 &`MAIL FROM:<>`&
33672 &`RCPT TO:`&<&'the address to be tested'&>
33673 &`QUIT`&
33674 .endd
33675 LHLO is used instead of HELO if the transport's &%protocol%& option is
33676 set to &"lmtp"&.
33677
33678 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33679 settings.
33680
33681 A recipient callout check is similar. By default, it also uses an empty address
33682 for the sender. This default is chosen because most hosts do not make use of
33683 the sender address when verifying a recipient. Using the same address means
33684 that a single cache entry can be used for each recipient. Some sites, however,
33685 do make use of the sender address when verifying. These are catered for by the
33686 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33687
33688 If the response to the RCPT command is a 2&'xx'& code, the verification
33689 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33690 Exim tries the next host, if any. If there is a problem with all the remote
33691 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33692 &%callout%& option is given, in which case the condition is forced to succeed.
33693
33694 .cindex "SMTP" "output flushing, disabling for callout"
33695 A callout may take a little time. For this reason, Exim normally flushes SMTP
33696 output before performing a callout in an ACL, to avoid unexpected timeouts in
33697 clients when the SMTP PIPELINING extension is in use. The flushing can be
33698 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33699
33700 .cindex "tainted data" "de-tainting"
33701 .cindex "de-tainting" "using recipient verify"
33702 A recipient callout which gets a 2&'xx'& code
33703 will assign untainted values to the
33704 &$domain_data$& and &$local_part_data$& variables,
33705 corresponding to the domain and local parts of the recipient address.
33706
33707
33708
33709
33710 .subsection "Additional parameters for callouts" CALLaddparcall
33711 .cindex "callout" "additional parameters for"
33712 The &%callout%& option can be followed by an equals sign and a number of
33713 optional parameters, separated by commas. For example:
33714 .code
33715 verify = recipient/callout=10s,defer_ok
33716 .endd
33717 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33718 separate verify options, is retained for backwards compatibility, but is now
33719 deprecated. The additional parameters for &%callout%& are as follows:
33720
33721
33722 .vlist
33723 .vitem <&'a&~time&~interval'&>
33724 .cindex "callout" "timeout, specifying"
33725 This specifies the timeout that applies for the callout attempt to each host.
33726 For example:
33727 .code
33728 verify = sender/callout=5s
33729 .endd
33730 The default is 30 seconds. The timeout is used for each response from the
33731 remote host. It is also used for the initial connection, unless overridden by
33732 the &%connect%& parameter.
33733
33734
33735 .vitem &*connect&~=&~*&<&'time&~interval'&>
33736 .cindex "callout" "connection timeout, specifying"
33737 This parameter makes it possible to set a different (usually smaller) timeout
33738 for making the SMTP connection. For example:
33739 .code
33740 verify = sender/callout=5s,connect=1s
33741 .endd
33742 If not specified, this timeout defaults to the general timeout value.
33743
33744 .vitem &*defer_ok*&
33745 .cindex "callout" "defer, action on"
33746 When this parameter is present, failure to contact any host, or any other kind
33747 of temporary error, is treated as success by the ACL. However, the cache is not
33748 updated in this circumstance.
33749
33750 .vitem &*fullpostmaster*&
33751 .cindex "callout" "full postmaster check"
33752 This operates like the &%postmaster%& option (see below), but if the check for
33753 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33754 accordance with the specification in RFC 2821. The RFC states that the
33755 unqualified address &'postmaster'& should be accepted.
33756
33757
33758 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33759 .cindex "callout" "sender when verifying header"
33760 When verifying addresses in header lines using the &%header_sender%&
33761 verification option, Exim behaves by default as if the addresses are envelope
33762 sender addresses from a message. Callout verification therefore tests to see
33763 whether a bounce message could be delivered, by using an empty address in the
33764 MAIL command. However, it is arguable that these addresses might never be used
33765 as envelope senders, and could therefore justifiably reject bounce messages
33766 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33767 address to use in the MAIL command. For example:
33768 .code
33769 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33770 .endd
33771 This parameter is available only for the &%header_sender%& verification option.
33772
33773
33774 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33775 .cindex "callout" "overall timeout, specifying"
33776 This parameter sets an overall timeout for performing a callout verification.
33777 For example:
33778 .code
33779 verify = sender/callout=5s,maxwait=30s
33780 .endd
33781 This timeout defaults to four times the callout timeout for individual SMTP
33782 commands. The overall timeout applies when there is more than one host that can
33783 be tried. The timeout is checked before trying the next host. This prevents
33784 very long delays if there are a large number of hosts and all are timing out
33785 (for example, when network connections are timing out).
33786
33787
33788 .vitem &*no_cache*&
33789 .cindex "callout" "cache, suppressing"
33790 .cindex "caching callout, suppressing"
33791 When this parameter is given, the callout cache is neither read nor updated.
33792
33793 .vitem &*postmaster*&
33794 .cindex "callout" "postmaster; checking"
33795 When this parameter is set, a successful callout check is followed by a similar
33796 check for the local part &'postmaster'& at the same domain. If this address is
33797 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33798 the postmaster check is recorded in a cache record; if it is a failure, this is
33799 used to fail subsequent callouts for the domain without a connection being
33800 made, until the cache record expires.
33801
33802 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33803 The postmaster check uses an empty sender in the MAIL command by default.
33804 You can use this parameter to do a postmaster check using a different address.
33805 For example:
33806 .code
33807 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33808 .endd
33809 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33810 one overrides. The &%postmaster%& parameter is equivalent to this example:
33811 .code
33812 require  verify = sender/callout=postmaster_mailfrom=
33813 .endd
33814 &*Warning*&: The caching arrangements for postmaster checking do not take
33815 account of the sender address. It is assumed that either the empty address or
33816 a fixed non-empty address will be used. All that Exim remembers is that the
33817 postmaster check for the domain succeeded or failed.
33818
33819
33820 .vitem &*random*&
33821 .cindex "callout" "&""random""& check"
33822 When this parameter is set, before doing the normal callout check, Exim does a
33823 check for a &"random"& local part at the same domain. The local part is not
33824 really random &-- it is defined by the expansion of the option
33825 &%callout_random_local_part%&, which defaults to
33826 .code
33827 $primary_hostname-$tod_epoch-testing
33828 .endd
33829 The idea here is to try to determine whether the remote host accepts all local
33830 parts without checking. If it does, there is no point in doing callouts for
33831 specific local parts. If the &"random"& check succeeds, the result is saved in
33832 a cache record, and used to force the current and subsequent callout checks to
33833 succeed without a connection being made, until the cache record expires.
33834
33835 .vitem &*use_postmaster*&
33836 .cindex "callout" "sender for recipient check"
33837 This parameter applies to recipient callouts only. For example:
33838 .code
33839 deny  !verify = recipient/callout=use_postmaster
33840 .endd
33841 .vindex "&$qualify_domain$&"
33842 It causes a non-empty postmaster address to be used in the MAIL command when
33843 performing the callout for the recipient, and also for a &"random"& check if
33844 that is configured. The local part of the address is &`postmaster`& and the
33845 domain is the contents of &$qualify_domain$&.
33846
33847 .vitem &*use_sender*&
33848 This option applies to recipient callouts only. For example:
33849 .code
33850 require  verify = recipient/callout=use_sender
33851 .endd
33852 It causes the message's actual sender address to be used in the MAIL
33853 command when performing the callout, instead of an empty address. There is no
33854 need to use this option unless you know that the called hosts make use of the
33855 sender when checking recipients. If used indiscriminately, it reduces the
33856 usefulness of callout caching.
33857
33858 .vitem &*hold*&
33859 This option applies to recipient callouts only. For example:
33860 .code
33861 require  verify = recipient/callout=use_sender,hold
33862 .endd
33863 It causes the connection to be held open and used for any further recipients
33864 and for eventual delivery (should that be done quickly).
33865 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33866 when that is used for the connections.
33867 The advantage is only gained if there are no callout cache hits
33868 (which could be enforced by the no_cache option),
33869 if the use_sender option is used,
33870 if neither the random nor the use_postmaster option is used,
33871 and if no other callouts intervene.
33872 .endlist
33873
33874 If you use any of the parameters that set a non-empty sender for the MAIL
33875 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33876 &%use_sender%&), you should think about possible loops. Recipient checking is
33877 usually done between two hosts that are under the same management, and the host
33878 that receives the callouts is not normally configured to do callouts itself.
33879 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33880 these circumstances.
33881
33882 However, if you use a non-empty sender address for a callout to an arbitrary
33883 host, there is the likelihood that the remote host will itself initiate a
33884 callout check back to your host. As it is checking what appears to be a message
33885 sender, it is likely to use an empty address in MAIL, thus avoiding a
33886 callout loop. However, to be on the safe side it would be best to set up your
33887 own ACLs so that they do not do sender verification checks when the recipient
33888 is the address you use for header sender or postmaster callout checking.
33889
33890 Another issue to think about when using non-empty senders for callouts is
33891 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33892 by the sender/recipient combination; thus, for any given recipient, many more
33893 actual callouts are performed than when an empty sender or postmaster is used.
33894
33895
33896
33897
33898 .subsection "Callout caching" SECTcallvercache
33899 .cindex "hints database" "callout cache"
33900 .cindex "callout" "cache, description of"
33901 .cindex "caching" "callout"
33902 Exim caches the results of callouts in order to reduce the amount of resources
33903 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33904 option. A hints database called &"callout"& is used for the cache. Two
33905 different record types are used: one records the result of a callout check for
33906 a specific address, and the other records information that applies to the
33907 entire domain (for example, that it accepts the local part &'postmaster'&).
33908
33909 When an original callout fails, a detailed SMTP error message is given about
33910 the failure. However, for subsequent failures that use the cache data, this message
33911 is not available.
33912
33913 The expiry times for negative and positive address cache records are
33914 independent, and can be set by the global options &%callout_negative_expire%&
33915 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33916
33917 If a host gives a negative response to an SMTP connection, or rejects any
33918 commands up to and including
33919 .code
33920 MAIL FROM:<>
33921 .endd
33922 (but not including the MAIL command with a non-empty address),
33923 any callout attempt is bound to fail. Exim remembers such failures in a
33924 domain cache record, which it uses to fail callouts for the domain without
33925 making new connections, until the domain record times out. There are two
33926 separate expiry times for domain cache records:
33927 &%callout_domain_negative_expire%& (default 3h) and
33928 &%callout_domain_positive_expire%& (default 7d).
33929
33930 Domain records expire when the negative expiry time is reached if callouts
33931 cannot be made for the domain, or if the postmaster check failed.
33932 Otherwise, they expire when the positive expiry time is reached. This
33933 ensures that, for example, a host that stops accepting &"random"& local parts
33934 will eventually be noticed.
33935
33936 The callout caching mechanism is based on the domain of the address that is
33937 being tested. If the domain routes to several hosts, it is assumed that their
33938 behaviour will be the same.
33939
33940
33941
33942 .section "Quota caching" "SECTquotacache"
33943 .cindex "hints database" "quota cache"
33944 .cindex "quota" "cache, description of"
33945 .cindex "caching" "quota"
33946 Exim caches the results of quota verification
33947 in order to reduce the amount of resources used.
33948 The &"callout"& hints database is used.
33949
33950 The default cache periods are five minutes for a positive (good) result
33951 and one hour for a negative result.
33952 To change the periods the &%quota%& option can be followed by an equals sign
33953 and a number of optional paramemters, separated by commas.
33954 For example:
33955 .code
33956 verify = recipient/quota=cachepos=1h,cacheneg=1d
33957 .endd
33958 Possible parameters are:
33959 .vlist
33960 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33961 .cindex "quota cache" "positive entry expiry, specifying"
33962 Set the lifetime for a positive cache entry.
33963 A value of zero seconds is legitimate.
33964
33965 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33966 .cindex "quota cache" "negative entry expiry, specifying"
33967 As above, for a negative entry.
33968
33969 .vitem &*no_cache*&
33970 Set both positive and negative lifetimes to zero.
33971
33972 .section "Sender address verification reporting" "SECTsenaddver"
33973 .cindex "verifying" "suppressing error details"
33974 See section &<<SECTaddressverification>>& for a general discussion of
33975 verification. When sender verification fails in an ACL, the details of the
33976 failure are given as additional output lines before the 550 response to the
33977 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33978 you might see:
33979 .code
33980 MAIL FROM:<xyz@abc.example>
33981 250 OK
33982 RCPT TO:<pqr@def.example>
33983 550-Verification failed for <xyz@abc.example>
33984 550-Called:   192.168.34.43
33985 550-Sent:     RCPT TO:<xyz@abc.example>
33986 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33987 550 Sender verification failed
33988 .endd
33989 If more than one RCPT command fails in the same way, the details are given
33990 only for the first of them. However, some administrators do not want to send
33991 out this much information. You can suppress the details by adding
33992 &`/no_details`& to the ACL statement that requests sender verification. For
33993 example:
33994 .code
33995 verify = sender/no_details
33996 .endd
33997
33998 .section "Redirection while verifying" "SECTredirwhilveri"
33999 .cindex "verifying" "redirection while"
34000 .cindex "address redirection" "while verifying"
34001 A dilemma arises when a local address is redirected by aliasing or forwarding
34002 during verification: should the generated addresses themselves be verified,
34003 or should the successful expansion of the original address be enough to verify
34004 it? By default, Exim takes the following pragmatic approach:
34005
34006 .ilist
34007 When an incoming address is redirected to just one child address, verification
34008 continues with the child address, and if that fails to verify, the original
34009 verification also fails.
34010 .next
34011 When an incoming address is redirected to more than one child address,
34012 verification does not continue. A success result is returned.
34013 .endlist
34014
34015 This seems the most reasonable behaviour for the common use of aliasing as a
34016 way of redirecting different local parts to the same mailbox. It means, for
34017 example, that a pair of alias entries of the form
34018 .code
34019 A.Wol:   aw123
34020 aw123:   :fail: Gone away, no forwarding address
34021 .endd
34022 work as expected, with both local parts causing verification failure. When a
34023 redirection generates more than one address, the behaviour is more like a
34024 mailing list, where the existence of the alias itself is sufficient for
34025 verification to succeed.
34026
34027 It is possible, however, to change the default behaviour so that all successful
34028 redirections count as successful verifications, however many new addresses are
34029 generated. This is specified by the &%success_on_redirect%& verification
34030 option. For example:
34031 .code
34032 require verify = recipient/success_on_redirect/callout=10s
34033 .endd
34034 In this example, verification succeeds if a router generates a new address, and
34035 the callout does not occur, because no address was routed to a remote host.
34036
34037 When verification is being tested via the &%-bv%& option, the treatment of
34038 redirections is as just described, unless the &%-v%& or any debugging option is
34039 also specified. In that case, full verification is done for every generated
34040 address and a report is output for each of them.
34041
34042
34043
34044 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34045 .cindex "CSA" "verifying"
34046 Client SMTP Authorization is a system that allows a site to advertise
34047 which machines are and are not permitted to send email. This is done by placing
34048 special SRV records in the DNS; these are looked up using the client's HELO
34049 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34050 Authorization checks in Exim are performed by the ACL condition:
34051 .code
34052 verify = csa
34053 .endd
34054 This fails if the client is not authorized. If there is a DNS problem, or if no
34055 valid CSA SRV record is found, or if the client is authorized, the condition
34056 succeeds. These three cases can be distinguished using the expansion variable
34057 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34058 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34059 be likely to cause problems for legitimate email.
34060
34061 The error messages produced by the CSA code include slightly more
34062 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34063 looking up the CSA SRV record, or problems looking up the CSA target
34064 address record. There are four reasons for &$csa_status$& being &"fail"&:
34065
34066 .ilist
34067 The client's host name is explicitly not authorized.
34068 .next
34069 The client's IP address does not match any of the CSA target IP addresses.
34070 .next
34071 The client's host name is authorized but it has no valid target IP addresses
34072 (for example, the target's addresses are IPv6 and the client is using IPv4).
34073 .next
34074 The client's host name has no CSA SRV record but a parent domain has asserted
34075 that all subdomains must be explicitly authorized.
34076 .endlist
34077
34078 The &%csa%& verification condition can take an argument which is the domain to
34079 use for the DNS query. The default is:
34080 .code
34081 verify = csa/$sender_helo_name
34082 .endd
34083 This implementation includes an extension to CSA. If the query domain
34084 is an address literal such as [192.0.2.95], or if it is a bare IP
34085 address, Exim searches for CSA SRV records in the reverse DNS as if
34086 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34087 meaningful to say:
34088 .code
34089 verify = csa/$sender_host_address
34090 .endd
34091 In fact, this is the check that Exim performs if the client does not say HELO.
34092 This extension can be turned off by setting the main configuration option
34093 &%dns_csa_use_reverse%& to be false.
34094
34095 If a CSA SRV record is not found for the domain itself, a search
34096 is performed through its parent domains for a record which might be
34097 making assertions about subdomains. The maximum depth of this search is limited
34098 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34099 default. Exim does not look for CSA SRV records in a top level domain, so the
34100 default settings handle HELO domains as long as seven
34101 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34102 of legitimate HELO domains.
34103
34104 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34105 direct SRV lookups, this is not sufficient because of the extra parent domain
34106 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34107 addresses into lookups in the reverse DNS space. The result of a successful
34108 lookup such as:
34109 .code
34110 ${lookup dnsdb {csa=$sender_helo_name}}
34111 .endd
34112 has two space-separated fields: an authorization code and a target host name.
34113 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34114 authorization required but absent, or &"?"& for unknown.
34115
34116
34117
34118
34119 .section "Bounce address tag validation" "SECTverifyPRVS"
34120 .cindex "BATV, verifying"
34121 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34122 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34123 Genuine incoming bounce messages should therefore always be addressed to
34124 recipients that have a valid tag. This scheme is a way of detecting unwanted
34125 bounce messages caused by sender address forgeries (often called &"collateral
34126 spam"&), because the recipients of such messages do not include valid tags.
34127
34128 There are two expansion items to help with the implementation of the BATV
34129 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34130 the original envelope sender address by using a simple key to add a hash of the
34131 address and some time-based randomizing information. The &%prvs%& expansion
34132 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34133 The syntax of these expansion items is described in section
34134 &<<SECTexpansionitems>>&.
34135 The validity period on signed addresses is seven days.
34136
34137 As an example, suppose the secret per-address keys are stored in an MySQL
34138 database. A query to look up the key for an address could be defined as a macro
34139 like this:
34140 .code
34141 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34142                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34143                 }{$value}}
34144 .endd
34145 Suppose also that the senders who make use of BATV are defined by an address
34146 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34147 use this:
34148 .code
34149 # Bounces: drop unsigned addresses for BATV senders
34150 deny senders = :
34151      recipients = +batv_senders
34152      message = This address does not send an unsigned reverse path
34153
34154 # Bounces: In case of prvs-signed address, check signature.
34155 deny senders = :
34156      condition  = ${prvscheck {$local_part@$domain}\
34157                   {PRVSCHECK_SQL}{1}}
34158      !condition = $prvscheck_result
34159      message = Invalid reverse path signature.
34160 .endd
34161 The first statement rejects recipients for bounce messages that are addressed
34162 to plain BATV sender addresses, because it is known that BATV senders do not
34163 send out messages with plain sender addresses. The second statement rejects
34164 recipients that are prvs-signed, but with invalid signatures (either because
34165 the key is wrong, or the signature has timed out).
34166
34167 A non-prvs-signed address is not rejected by the second statement, because the
34168 &%prvscheck%& expansion yields an empty string if its first argument is not a
34169 prvs-signed address, thus causing the &%condition%& condition to be false. If
34170 the first argument is a syntactically valid prvs-signed address, the yield is
34171 the third string (in this case &"1"&), whether or not the cryptographic and
34172 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34173 of the checks (empty for failure, &"1"& for success).
34174
34175 There is one more issue you must consider when implementing prvs-signing:
34176 you have to ensure that the routers accept prvs-signed addresses and
34177 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34178 router to remove the signature with a configuration along these lines:
34179 .code
34180 batv_redirect:
34181   driver = redirect
34182   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34183 .endd
34184 This works because, if the third argument of &%prvscheck%& is empty, the result
34185 of the expansion of a prvs-signed address is the decoded value of the original
34186 address. This router should probably be the first of your routers that handles
34187 local addresses.
34188
34189 To create BATV-signed addresses in the first place, a transport of this form
34190 can be used:
34191 .code
34192 external_smtp_batv:
34193   driver = smtp
34194   return_path = ${prvs {$return_path} \
34195                        {${lookup mysql{SELECT \
34196                        secret FROM batv_prvs WHERE \
34197                        sender='${quote_mysql:$sender_address}'} \
34198                        {$value}fail}}}
34199 .endd
34200 If no key can be found for the existing return path, no signing takes place.
34201
34202
34203
34204 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34205 .cindex "&ACL;" "relay control"
34206 .cindex "relaying" "control by ACL"
34207 .cindex "policy control" "relay control"
34208 An MTA is said to &'relay'& a message if it receives it from some host and
34209 delivers it directly to another host as a result of a remote address contained
34210 within it. Redirecting a local address via an alias or forward file and then
34211 passing the message on to another host is not relaying,
34212 .cindex "&""percent hack""&"
34213 but a redirection as a result of the &"percent hack"& is.
34214
34215 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34216 A host which is acting as a gateway or an MX backup is concerned with incoming
34217 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34218 a host which is acting as a smart host for a number of clients is concerned
34219 with outgoing relaying from those clients to the Internet at large. Often the
34220 same host is fulfilling both functions,
34221 . ///
34222 . as illustrated in the diagram below,
34223 . ///
34224 but in principle these two kinds of relaying are entirely independent. What is
34225 not wanted is the transmission of mail from arbitrary remote hosts through your
34226 system to arbitrary domains.
34227
34228
34229 You can implement relay control by means of suitable statements in the ACL that
34230 runs for each RCPT command. For convenience, it is often easiest to use
34231 Exim's named list facility to define the domains and hosts involved. For
34232 example, suppose you want to do the following:
34233
34234 .ilist
34235 Deliver a number of domains to mailboxes on the local host (or process them
34236 locally in some other way). Let's say these are &'my.dom1.example'& and
34237 &'my.dom2.example'&.
34238 .next
34239 Relay mail for a number of other domains for which you are the secondary MX.
34240 These might be &'friend1.example'& and &'friend2.example'&.
34241 .next
34242 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34243 Suppose your LAN is 192.168.45.0/24.
34244 .endlist
34245
34246
34247 In the main part of the configuration, you put the following definitions:
34248 .code
34249 domainlist local_domains    = my.dom1.example : my.dom2.example
34250 domainlist relay_to_domains = friend1.example : friend2.example
34251 hostlist   relay_from_hosts = 192.168.45.0/24
34252 .endd
34253 Now you can use these definitions in the ACL that is run for every RCPT
34254 command:
34255 .code
34256 acl_check_rcpt:
34257   accept domains = +local_domains : +relay_to_domains
34258   accept hosts   = +relay_from_hosts
34259 .endd
34260 The first statement accepts any RCPT command that contains an address in
34261 the local or relay domains. For any other domain, control passes to the second
34262 statement, which accepts the command only if it comes from one of the relay
34263 hosts. In practice, you will probably want to make your ACL more sophisticated
34264 than this, for example, by including sender and recipient verification. The
34265 default configuration includes a more comprehensive example, which is described
34266 in chapter &<<CHAPdefconfil>>&.
34267
34268
34269
34270 .section "Checking a relay configuration" "SECTcheralcon"
34271 .cindex "relaying" "checking control of"
34272 You can check the relay characteristics of your configuration in the same way
34273 that you can test any ACL behaviour for an incoming SMTP connection, by using
34274 the &%-bh%& option to run a fake SMTP session with which you interact.
34275 .ecindex IIDacl
34276
34277
34278
34279 . ////////////////////////////////////////////////////////////////////////////
34280 . ////////////////////////////////////////////////////////////////////////////
34281
34282 .chapter "Content scanning at ACL time" "CHAPexiscan"
34283 .scindex IIDcosca "content scanning" "at ACL time"
34284 The extension of Exim to include content scanning at ACL time, formerly known
34285 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34286 was integrated into the main source for Exim release 4.50, and Tom continues to
34287 maintain it. Most of the wording of this chapter is taken from Tom's
34288 specification.
34289
34290 It is also possible to scan the content of messages at other times. The
34291 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34292 scanning after all the ACLs have run. A transport filter can be used to scan
34293 messages at delivery time (see the &%transport_filter%& option, described in
34294 chapter &<<CHAPtransportgeneric>>&).
34295
34296 If you want to include the ACL-time content-scanning features when you compile
34297 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34298 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34299
34300 .ilist
34301 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34302 for all MIME parts for SMTP and non-SMTP messages, respectively.
34303 .next
34304 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34305 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34306 run at the end of message reception (the &%acl_smtp_data%& ACL).
34307 .next
34308 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34309 of messages, or parts of messages, for debugging purposes.
34310 .next
34311 Additional expansion variables that are set in the new ACL and by the new
34312 conditions.
34313 .next
34314 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34315 .endlist
34316
34317 Content-scanning is continually evolving, and new features are still being
34318 added. While such features are still unstable and liable to incompatible
34319 changes, they are made available in Exim by setting options whose names begin
34320 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34321 this manual. You can find out about them by reading the file called
34322 &_doc/experimental.txt_&.
34323
34324 All the content-scanning facilities work on a MBOX copy of the message that is
34325 temporarily created in a file called:
34326 .display
34327 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34328 .endd
34329 The &_.eml_& extension is a friendly hint to virus scanners that they can
34330 expect an MBOX-like structure inside that file. The file is created when the
34331 first content scanning facility is called. Subsequent calls to content
34332 scanning conditions open the same file again. The directory is recursively
34333 removed when the &%acl_smtp_data%& ACL has finished running, unless
34334 .code
34335 control = no_mbox_unspool
34336 .endd
34337 has been encountered. When the MIME ACL decodes files, they are put into the
34338 same directory by default.
34339
34340
34341
34342 .section "Scanning for viruses" "SECTscanvirus"
34343 .cindex "virus scanning"
34344 .cindex "content scanning" "for viruses"
34345 .cindex "content scanning" "the &%malware%& condition"
34346 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34347 It supports a &"generic"& interface to scanners called via the shell, and
34348 specialized interfaces for &"daemon"& type virus scanners, which are resident
34349 in memory and thus are much faster.
34350
34351 Since message data needs to have arrived,
34352 the condition may be only called in ACL defined by
34353 &%acl_smtp_data%&,
34354 &%acl_smtp_data_prdr%&,
34355 &%acl_smtp_mime%& or
34356 &%acl_smtp_dkim%&
34357
34358 A timeout of 2 minutes is applied to a scanner call (by default);
34359 if it expires then a defer action is taken.
34360
34361 .oindex "&%av_scanner%&"
34362 You can set the &%av_scanner%& option in the main part of the configuration
34363 to specify which scanner to use, together with any additional options that
34364 are needed. The basic syntax is as follows:
34365 .display
34366 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34367 .endd
34368 If you do not set &%av_scanner%&, it defaults to
34369 .code
34370 av_scanner = sophie:/var/run/sophie
34371 .endd
34372 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34373 before use.
34374 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34375 The following scanner types are supported in this release,
34376 though individual ones can be included or not at build time:
34377
34378 .vlist
34379 .vitem &%avast%&
34380 .cindex "virus scanners" "avast"
34381 This is the scanner daemon of Avast. It has been tested with Avast Core
34382 Security (currently at version 2.2.0).
34383 You can get a trial version at &url(https://www.avast.com) or for Linux
34384 at &url(https://www.avast.com/linux-server-antivirus).
34385 This scanner type takes one option,
34386 which can be either a full path to a UNIX socket,
34387 or host and port specifiers separated by white space.
34388 The host may be a name or an IP address; the port is either a
34389 single number or a pair of numbers with a dash between.
34390 A list of options may follow. These options are interpreted on the
34391 Exim's side of the malware scanner, or are given on separate lines to
34392 the daemon as options before the main scan command.
34393
34394 .cindex &`pass_unscanned`& "avast"
34395 If &`pass_unscanned`&
34396 is set, any files the Avast scanner can't scan (e.g.
34397 decompression bombs, or invalid archives) are considered clean. Use with
34398 care.
34399
34400 For example:
34401 .code
34402 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34403 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34404 av_scanner = avast:192.168.2.22 5036
34405 .endd
34406 If you omit the argument, the default path
34407 &_/var/run/avast/scan.sock_&
34408 is used.
34409 If you use a remote host,
34410 you need to make Exim's spool directory available to it,
34411 as the scanner is passed a file path, not file contents.
34412 For information about available commands and their options you may use
34413 .code
34414 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34415     FLAGS
34416     SENSITIVITY
34417     PACK
34418 .endd
34419
34420 If the scanner returns a temporary failure (e.g. license issues, or
34421 permission problems), the message is deferred and a paniclog entry is
34422 written.  The usual &`defer_ok`& option is available.
34423
34424 .vitem &%aveserver%&
34425 .cindex "virus scanners" "Kaspersky"
34426 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34427 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34428 which is the path to the daemon's UNIX socket. The default is shown in this
34429 example:
34430 .code
34431 av_scanner = aveserver:/var/run/aveserver
34432 .endd
34433
34434
34435 .vitem &%clamd%&
34436 .cindex "virus scanners" "clamd"
34437 This daemon-type scanner is GPL and free. You can get it at
34438 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34439 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34440 in the MIME ACL. This is no longer believed to be necessary.
34441
34442 The options are a list of server specifiers, which may be
34443 a UNIX socket specification,
34444 a TCP socket specification,
34445 or a (global) option.
34446
34447 A socket specification consists of a space-separated list.
34448 For a Unix socket the first element is a full path for the socket,
34449 for a TCP socket the first element is the IP address
34450 and the second a port number,
34451 Any further elements are per-server (non-global) options.
34452 These per-server options are supported:
34453 .code
34454 retry=<timespec>        Retry on connect fail
34455 .endd
34456
34457 The &`retry`& option specifies a time after which a single retry for
34458 a failed connect is made.  The default is to not retry.
34459
34460 If a Unix socket file is specified, only one server is supported.
34461
34462 Examples:
34463 .code
34464 av_scanner = clamd:/opt/clamd/socket
34465 av_scanner = clamd:192.0.2.3 1234
34466 av_scanner = clamd:192.0.2.3 1234:local
34467 av_scanner = clamd:192.0.2.3 1234 retry=10s
34468 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34469 .endd
34470 If the value of av_scanner points to a UNIX socket file or contains the
34471 &`local`&
34472 option, then the ClamAV interface will pass a filename containing the data
34473 to be scanned, which should normally result in less I/O happening and be
34474 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34475 Exim does not assume that there is a common filesystem with the remote host.
34476
34477 The final example shows that multiple TCP targets can be specified.  Exim will
34478 randomly use one for each incoming email (i.e. it load balances them).  Note
34479 that only TCP targets may be used if specifying a list of scanners; a UNIX
34480 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34481 unavailable, Exim will try the remaining one(s) until it finds one that works.
34482 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34483 not keep track of scanner state between multiple messages, and the scanner
34484 selection is random, so the message will get logged in the mainlog for each
34485 email that the down scanner gets chosen first (message wrapped to be readable):
34486 .code
34487 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34488    clamd: connection to localhost, port 3310 failed
34489    (Connection refused)
34490 .endd
34491
34492 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34493 contributing the code for this scanner.
34494
34495 .vitem &%cmdline%&
34496 .cindex "virus scanners" "command line interface"
34497 This is the keyword for the generic command line scanner interface. It can be
34498 used to attach virus scanners that are invoked from the shell. This scanner
34499 type takes 3 mandatory options:
34500
34501 .olist
34502 The full path and name of the scanner binary, with all command line options,
34503 and a placeholder (&`%s`&) for the directory to scan.
34504
34505 .next
34506 A regular expression to match against the STDOUT and STDERR output of the
34507 virus scanner. If the expression matches, a virus was found. You must make
34508 absolutely sure that this expression matches on &"virus found"&. This is called
34509 the &"trigger"& expression.
34510
34511 .next
34512 Another regular expression, containing exactly one pair of parentheses, to
34513 match the name of the virus found in the scanners output. This is called the
34514 &"name"& expression.
34515 .endlist olist
34516
34517 For example, Sophos Sweep reports a virus on a line like this:
34518 .code
34519 Virus 'W32/Magistr-B' found in file ./those.bat
34520 .endd
34521 For the trigger expression, we can match the phrase &"found in file"&. For the
34522 name expression, we want to extract the W32/Magistr-B string, so we can match
34523 for the single quotes left and right of it. Altogether, this makes the
34524 configuration setting:
34525 .code
34526 av_scanner = cmdline:\
34527              /path/to/sweep -ss -all -rec -archive %s:\
34528              found in file:'(.+)'
34529 .endd
34530 .vitem &%drweb%&
34531 .cindex "virus scanners" "DrWeb"
34532 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34533 takes one option,
34534 either a full path to a UNIX socket,
34535 or host and port specifiers separated by white space.
34536 The host may be a name or an IP address; the port is either a
34537 single number or a pair of numbers with a dash between.
34538 For example:
34539 .code
34540 av_scanner = drweb:/var/run/drwebd.sock
34541 av_scanner = drweb:192.168.2.20 31337
34542 .endd
34543 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34544 is used. Thanks to Alex Miller for contributing the code for this scanner.
34545
34546 .vitem &%f-protd%&
34547 .cindex "virus scanners" "f-protd"
34548 The f-protd scanner is accessed via HTTP over TCP.
34549 One argument is taken, being a space-separated hostname and port number
34550 (or port-range).
34551 For example:
34552 .code
34553 av_scanner = f-protd:localhost 10200-10204
34554 .endd
34555 If you omit the argument, the default values shown above are used.
34556
34557 .vitem &%f-prot6d%&
34558 .cindex "virus scanners" "f-prot6d"
34559 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34560 One argument is taken, being a space-separated hostname and port number.
34561 For example:
34562 .code
34563 av_scanner = f-prot6d:localhost 10200
34564 .endd
34565 If you omit the argument, the default values show above are used.
34566
34567 .vitem &%fsecure%&
34568 .cindex "virus scanners" "F-Secure"
34569 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34570 argument which is the path to a UNIX socket. For example:
34571 .code
34572 av_scanner = fsecure:/path/to/.fsav
34573 .endd
34574 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34575 Thelmen for contributing the code for this scanner.
34576
34577 .vitem &%kavdaemon%&
34578 .cindex "virus scanners" "Kaspersky"
34579 This is the scanner daemon of Kaspersky Version 4. This version of the
34580 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34581 scanner type takes one option, which is the path to the daemon's UNIX socket.
34582 For example:
34583 .code
34584 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34585 .endd
34586 The default path is &_/var/run/AvpCtl_&.
34587
34588 .vitem &%mksd%&
34589 .cindex "virus scanners" "mksd"
34590 This was a daemon type scanner that is aimed mainly at Polish users,
34591 though some documentation was available in English.
34592 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34593 and this appears to be a candidate for removal from Exim, unless
34594 we are informed of other virus scanners which use the same protocol
34595 to integrate.
34596 The only option for this scanner type is
34597 the maximum number of processes used simultaneously to scan the attachments,
34598 provided that mksd has
34599 been run with at least the same number of child processes. For example:
34600 .code
34601 av_scanner = mksd:2
34602 .endd
34603 You can safely omit this option (the default value is 1).
34604
34605 .vitem &%sock%&
34606 .cindex "virus scanners" "simple socket-connected"
34607 This is a general-purpose way of talking to simple scanner daemons
34608 running on the local machine.
34609 There are four options:
34610 an address (which may be an IP address and port, or the path of a Unix socket),
34611 a commandline to send (may include a single %s which will be replaced with
34612 the path to the mail file to be scanned),
34613 an RE to trigger on from the returned data,
34614 and an RE to extract malware_name from the returned data.
34615 For example:
34616 .code
34617 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34618 .endd
34619 Note that surrounding whitespace is stripped from each option, meaning
34620 there is no way to specify a trailing newline.
34621 The socket specifier and both regular-expressions are required.
34622 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34623 specify an empty element to get this.
34624
34625 .vitem &%sophie%&
34626 .cindex "virus scanners" "Sophos and Sophie"
34627 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34628 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34629 for this scanner type is the path to the UNIX socket that Sophie uses for
34630 client communication. For example:
34631 .code
34632 av_scanner = sophie:/tmp/sophie
34633 .endd
34634 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34635 the option.
34636 .endlist
34637
34638 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34639 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34640 ACL.
34641
34642 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34643 makes it possible to use different scanners. See further below for an example.
34644 The &%malware%& condition caches its results, so when you use it multiple times
34645 for the same message, the actual scanning process is only carried out once.
34646 However, using expandable items in &%av_scanner%& disables this caching, in
34647 which case each use of the &%malware%& condition causes a new scan of the
34648 message.
34649
34650 The &%malware%& condition takes a right-hand argument that is expanded before
34651 use and taken as a list, slash-separated by default.
34652 The first element can then be one of
34653
34654 .ilist
34655 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34656 The condition succeeds if a virus was found, and fail otherwise. This is the
34657 recommended usage.
34658 .next
34659 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34660 the condition fails immediately.
34661 .next
34662 A regular expression, in which case the message is scanned for viruses. The
34663 condition succeeds if a virus is found and its name matches the regular
34664 expression. This allows you to take special actions on certain types of virus.
34665 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34666 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34667 .endlist
34668
34669 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34670 messages even if there is a problem with the virus scanner.
34671 Otherwise, such a problem causes the ACL to defer.
34672
34673 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34674 specify a non-default timeout.  The default is two minutes.
34675 For example:
34676 .code
34677 malware = * / defer_ok / tmo=10s
34678 .endd
34679 A timeout causes the ACL to defer.
34680
34681 .vindex "&$callout_address$&"
34682 When a connection is made to the scanner the expansion variable &$callout_address$&
34683 is set to record the actual address used.
34684
34685 .vindex "&$malware_name$&"
34686 When a virus is found, the condition sets up an expansion variable called
34687 &$malware_name$& that contains the name of the virus. You can use it in a
34688 &%message%& modifier that specifies the error returned to the sender, and/or in
34689 logging data.
34690
34691 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34692 imposed by your anti-virus scanner.
34693
34694 Here is a very simple scanning example:
34695 .code
34696 deny malware = *
34697      message = This message contains malware ($malware_name)
34698 .endd
34699 The next example accepts messages when there is a problem with the scanner:
34700 .code
34701 deny malware = */defer_ok
34702      message = This message contains malware ($malware_name)
34703 .endd
34704 The next example shows how to use an ACL variable to scan with both sophie and
34705 aveserver. It assumes you have set:
34706 .code
34707 av_scanner = $acl_m0
34708 .endd
34709 in the main Exim configuration.
34710 .code
34711 deny set acl_m0 = sophie
34712      malware = *
34713      message = This message contains malware ($malware_name)
34714
34715 deny set acl_m0 = aveserver
34716      malware = *
34717      message = This message contains malware ($malware_name)
34718 .endd
34719
34720
34721 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34722 .cindex "content scanning" "for spam"
34723 .cindex "spam scanning"
34724 .cindex "SpamAssassin"
34725 .cindex "Rspamd"
34726 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34727 score and a report for the message.
34728 Support is also provided for Rspamd.
34729
34730 For more information about installation and configuration of SpamAssassin or
34731 Rspamd refer to their respective websites at
34732 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34733
34734 SpamAssassin can be installed with CPAN by running:
34735 .code
34736 perl -MCPAN -e 'install Mail::SpamAssassin'
34737 .endd
34738 SpamAssassin has its own set of configuration files. Please review its
34739 documentation to see how you can tweak it. The default installation should work
34740 nicely, however.
34741
34742 .oindex "&%spamd_address%&"
34743 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34744 intend to use an instance running on the local host you do not need to set
34745 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34746 you must set the &%spamd_address%& option in the global part of the Exim
34747 configuration as follows (example):
34748 .code
34749 spamd_address = 192.168.99.45 783
34750 .endd
34751 The SpamAssassin protocol relies on a TCP half-close from the client.
34752 If your SpamAssassin client side is running a Linux system with an
34753 iptables firewall, consider setting
34754 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34755 timeout, Exim uses when waiting for a response from the SpamAssassin
34756 server (currently defaulting to 120s).  With a lower value the Linux
34757 connection tracking may consider your half-closed connection as dead too
34758 soon.
34759
34760
34761 To use Rspamd (which by default listens on all local addresses
34762 on TCP port 11333)
34763 you should add &%variant=rspamd%& after the address/port pair, for example:
34764 .code
34765 spamd_address = 127.0.0.1 11333 variant=rspamd
34766 .endd
34767
34768 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34769 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34770 filename instead of an address/port pair:
34771 .code
34772 spamd_address = /var/run/spamd_socket
34773 .endd
34774 You can have multiple &%spamd%& servers to improve scalability. These can
34775 reside on other hardware reachable over the network. To specify multiple
34776 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34777 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34778 .code
34779 spamd_address = 192.168.2.10 783 : \
34780                 192.168.2.11 783 : \
34781                 192.168.2.12 783
34782 .endd
34783 Up to 32 &%spamd%& servers are supported.
34784 When a server fails to respond to the connection attempt, all other
34785 servers are tried until one succeeds. If no server responds, the &%spam%&
34786 condition defers.
34787
34788 Unix and TCP socket specifications may be mixed in any order.
34789 Each element of the list is a list itself, space-separated by default
34790 and changeable in the usual way (&<<SECTlistsepchange>>&);
34791 take care to not double the separator.
34792
34793 For TCP socket specifications a host name or IP (v4 or v6, but
34794 subject to list-separator quoting rules) address can be used,
34795 and the port can be one or a dash-separated pair.
34796 In the latter case, the range is tried in strict order.
34797
34798 Elements after the first for Unix sockets, or second for TCP socket,
34799 are options.
34800 The supported options are:
34801 .code
34802 pri=<priority>      Selection priority
34803 weight=<value>      Selection bias
34804 time=<start>-<end>  Use only between these times of day
34805 retry=<timespec>    Retry on connect fail
34806 tmo=<timespec>      Connection time limit
34807 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34808 .endd
34809
34810 The &`pri`& option specifies a priority for the server within the list,
34811 higher values being tried first.
34812 The default priority is 1.
34813
34814 The &`weight`& option specifies a selection bias.
34815 Within a priority set
34816 servers are queried in a random fashion, weighted by this value.
34817 The default value for selection bias is 1.
34818
34819 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34820 in the local time zone; each element being one or more digits.
34821 Either the seconds or both minutes and seconds, plus the leading &`.`&
34822 characters, may be omitted and will be taken as zero.
34823
34824 Timeout specifications for the &`retry`& and &`tmo`& options
34825 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34826
34827 The &`tmo`& option specifies an overall timeout for communication.
34828 The default value is two minutes.
34829
34830 The &`retry`& option specifies a time after which a single retry for
34831 a failed connect is made.
34832 The default is to not retry.
34833
34834 The &%spamd_address%& variable is expanded before use if it starts with
34835 a dollar sign. In this case, the expansion may return a string that is
34836 used as the list so that multiple spamd servers can be the result of an
34837 expansion.
34838
34839 .vindex "&$callout_address$&"
34840 When a connection is made to the server the expansion variable &$callout_address$&
34841 is set to record the actual address used.
34842
34843 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34844 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34845 .code
34846 deny spam = joe
34847      message = This message was classified as SPAM
34848 .endd
34849 The right-hand side of the &%spam%& condition specifies a name. This is
34850 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34851 to scan using a specific profile, but rather use the SpamAssassin system-wide
34852 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34853 Rspamd does not use this setting. However, you must put something on the
34854 right-hand side.
34855
34856 The name allows you to use per-domain or per-user antispam profiles in
34857 principle, but this is not straightforward in practice, because a message may
34858 have multiple recipients, not necessarily all in the same domain. Because the
34859 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34860 read the contents of the message, the variables &$local_part$& and &$domain$&
34861 are not set.
34862 Careful enforcement of single-recipient messages
34863 (e.g. by responding with defer in the recipient ACL for all recipients
34864 after the first),
34865 or the use of PRDR,
34866 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34867 are needed to use this feature.
34868
34869 The right-hand side of the &%spam%& condition is expanded before being used, so
34870 you can put lookups or conditions there. When the right-hand side evaluates to
34871 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34872
34873
34874 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34875 large ones may cause significant performance degradation. As most spam messages
34876 are quite small, it is recommended that you do not scan the big ones. For
34877 example:
34878 .code
34879 deny condition = ${if < {$message_size}{10K}}
34880      spam = nobody
34881      message = This message was classified as SPAM
34882 .endd
34883
34884 The &%spam%& condition returns true if the threshold specified in the user's
34885 SpamAssassin profile has been matched or exceeded. If you want to use the
34886 &%spam%& condition for its side effects (see the variables below), you can make
34887 it always return &"true"& by appending &`:true`& to the username.
34888
34889 .cindex "spam scanning" "returned variables"
34890 When the &%spam%& condition is run, it sets up a number of expansion
34891 variables.
34892 Except for &$spam_report$&,
34893 these variables are saved with the received message so are
34894 available for use at delivery time.
34895
34896 .vlist
34897 .vitem &$spam_score$&
34898 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34899 for inclusion in log or reject messages.
34900
34901 .vitem &$spam_score_int$&
34902 The spam score of the message, multiplied by ten, as an integer value. For
34903 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34904 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34905 The integer value is useful for numeric comparisons in conditions.
34906
34907 .vitem &$spam_bar$&
34908 A string consisting of a number of &"+"& or &"-"& characters, representing the
34909 integer part of the spam score value. A spam score of 4.4 would have a
34910 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34911 headers, since MUAs can match on such strings. The maximum length of the
34912 spam bar is 50 characters.
34913
34914 .vitem &$spam_report$&
34915 A multiline text table, containing the full SpamAssassin report for the
34916 message. Useful for inclusion in headers or reject messages.
34917 This variable is only usable in a DATA-time ACL.
34918 Beware that SpamAssassin may return non-ASCII characters, especially
34919 when running in country-specific locales, which are not legal
34920 unencoded in headers.
34921
34922 .vitem &$spam_action$&
34923 For SpamAssassin either 'reject' or 'no action' depending on the
34924 spam score versus threshold.
34925 For Rspamd, the recommended action.
34926
34927 .endlist
34928
34929 The &%spam%& condition caches its results unless expansion in
34930 spamd_address was used. If you call it again with the same user name, it
34931 does not scan again, but rather returns the same values as before.
34932
34933 The &%spam%& condition returns DEFER if there is any error while running
34934 the message through SpamAssassin or if the expansion of spamd_address
34935 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34936 statement block), append &`/defer_ok`& to the right-hand side of the
34937 spam condition, like this:
34938 .code
34939 deny spam    = joe/defer_ok
34940      message = This message was classified as SPAM
34941 .endd
34942 This causes messages to be accepted even if there is a problem with &%spamd%&.
34943
34944 Here is a longer, commented example of the use of the &%spam%&
34945 condition:
34946 .code
34947 # put headers in all messages (no matter if spam or not)
34948 warn  spam = nobody:true
34949       add_header = X-Spam-Score: $spam_score ($spam_bar)
34950       add_header = X-Spam-Report: $spam_report
34951
34952 # add second subject line with *SPAM* marker when message
34953 # is over threshold
34954 warn  spam = nobody
34955       add_header = Subject: *SPAM* $h_Subject:
34956
34957 # reject spam at high scores (> 12)
34958 deny  spam = nobody:true
34959       condition = ${if >{$spam_score_int}{120}{1}{0}}
34960       message = This message scored $spam_score spam points.
34961 .endd
34962
34963
34964
34965 .section "Scanning MIME parts" "SECTscanmimepart"
34966 .cindex "content scanning" "MIME parts"
34967 .cindex "MIME content scanning"
34968 .oindex "&%acl_smtp_mime%&"
34969 .oindex "&%acl_not_smtp_mime%&"
34970 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34971 each MIME part of an SMTP message, including multipart types, in the sequence
34972 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34973 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34974 options may both refer to the same ACL if you want the same processing in both
34975 cases.
34976
34977 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34978 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34979 the case of a non-SMTP message. However, a MIME ACL is called only if the
34980 message contains a &'Content-Type:'& header line. When a call to a MIME
34981 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34982 result code is sent to the client. In the case of an SMTP message, the
34983 &%acl_smtp_data%& ACL is not called when this happens.
34984
34985 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34986 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34987 condition to match against the raw MIME part. You can also use the
34988 &%mime_regex%& condition to match against the decoded MIME part (see section
34989 &<<SECTscanregex>>&).
34990
34991 At the start of a MIME ACL, a number of variables are set from the header
34992 information for the relevant MIME part. These are described below. The contents
34993 of the MIME part are not by default decoded into a disk file except for MIME
34994 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34995 part into a disk file, you can use the &%decode%& condition. The general
34996 syntax is:
34997 .display
34998 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34999 .endd
35000 The right hand side is expanded before use. After expansion,
35001 the value can be:
35002
35003 .olist
35004 &"0"& or &"false"&, in which case no decoding is done.
35005 .next
35006 The string &"default"&. In that case, the file is put in the temporary
35007 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35008 a sequential filename consisting of the message id and a sequence number. The
35009 full path and name is available in &$mime_decoded_filename$& after decoding.
35010 .next
35011 A full path name starting with a slash. If the full name is an existing
35012 directory, it is used as a replacement for the default directory. The filename
35013 is then sequentially assigned. If the path does not exist, it is used as
35014 the full path and filename.
35015 .next
35016 If the string does not start with a slash, it is used as the
35017 filename, and the default path is then used.
35018 .endlist
35019 The &%decode%& condition normally succeeds. It is only false for syntax
35020 errors or unusual circumstances such as memory shortages. You can easily decode
35021 a file with its original, proposed filename using
35022 .code
35023 decode = $mime_filename
35024 .endd
35025 However, you should keep in mind that &$mime_filename$& might contain
35026 anything. If you place files outside of the default path, they are not
35027 automatically unlinked.
35028
35029 For RFC822 attachments (these are messages attached to messages, with a
35030 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35031 as for the primary message, only that the &$mime_is_rfc822$& expansion
35032 variable is set (see below). Attached messages are always decoded to disk
35033 before being checked, and the files are unlinked once the check is done.
35034
35035 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35036 used to match regular expressions against raw and decoded MIME parts,
35037 respectively. They are described in section &<<SECTscanregex>>&.
35038
35039 .cindex "MIME content scanning" "returned variables"
35040 The following list describes all expansion variables that are
35041 available in the MIME ACL:
35042
35043 .vlist
35044 .vitem &$mime_anomaly_level$& &&&
35045        &$mime_anomaly_text$&
35046 .vindex &$mime_anomaly_level$&
35047 .vindex &$mime_anomaly_text$&
35048 If there are problems decoding, these variables contain information on
35049 the detected issue.
35050
35051 .vitem &$mime_boundary$&
35052 .vindex &$mime_boundary$&
35053 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35054 have a boundary string, which is stored in this variable. If the current part
35055 has no boundary parameter in the &'Content-Type:'& header, this variable
35056 contains the empty string.
35057
35058 .vitem &$mime_charset$&
35059 .vindex &$mime_charset$&
35060 This variable contains the character set identifier, if one was found in the
35061 &'Content-Type:'& header. Examples for charset identifiers are:
35062 .code
35063 us-ascii
35064 gb2312 (Chinese)
35065 iso-8859-1
35066 .endd
35067 Please note that this value is not normalized, so you should do matches
35068 case-insensitively.
35069
35070 .vitem &$mime_content_description$&
35071 .vindex &$mime_content_description$&
35072 This variable contains the normalized content of the &'Content-Description:'&
35073 header. It can contain a human-readable description of the parts content. Some
35074 implementations repeat the filename for attachments here, but they are usually
35075 only used for display purposes.
35076
35077 .vitem &$mime_content_disposition$&
35078 .vindex &$mime_content_disposition$&
35079 This variable contains the normalized content of the &'Content-Disposition:'&
35080 header. You can expect strings like &"attachment"& or &"inline"& here.
35081
35082 .vitem &$mime_content_id$&
35083 .vindex &$mime_content_id$&
35084 This variable contains the normalized content of the &'Content-ID:'& header.
35085 This is a unique ID that can be used to reference a part from another part.
35086
35087 .vitem &$mime_content_size$&
35088 .vindex &$mime_content_size$&
35089 This variable is set only after the &%decode%& modifier (see above) has been
35090 successfully run. It contains the size of the decoded part in kilobytes. The
35091 size is always rounded up to full kilobytes, so only a completely empty part
35092 has a &$mime_content_size$& of zero.
35093
35094 .vitem &$mime_content_transfer_encoding$&
35095 .vindex &$mime_content_transfer_encoding$&
35096 This variable contains the normalized content of the
35097 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35098 type. Typical values are &"base64"& and &"quoted-printable"&.
35099
35100 .vitem &$mime_content_type$&
35101 .vindex &$mime_content_type$&
35102 If the MIME part has a &'Content-Type:'& header, this variable contains its
35103 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35104 are some examples of popular MIME types, as they may appear in this variable:
35105 .code
35106 text/plain
35107 text/html
35108 application/octet-stream
35109 image/jpeg
35110 audio/midi
35111 .endd
35112 If the MIME part has no &'Content-Type:'& header, this variable contains the
35113 empty string.
35114
35115 .vitem &$mime_decoded_filename$&
35116 .vindex &$mime_decoded_filename$&
35117 This variable is set only after the &%decode%& modifier (see above) has been
35118 successfully run. It contains the full path and filename of the file
35119 containing the decoded data.
35120 .endlist
35121
35122 .cindex "RFC 2047"
35123 .vlist
35124 .vitem &$mime_filename$&
35125 .vindex &$mime_filename$&
35126 This is perhaps the most important of the MIME variables. It contains a
35127 proposed filename for an attachment, if one was found in either the
35128 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35129 RFC2047
35130 or RFC2231
35131 decoded, but no additional sanity checks are done.
35132  If no filename was
35133 found, this variable contains the empty string.
35134
35135 .vitem &$mime_is_coverletter$&
35136 .vindex &$mime_is_coverletter$&
35137 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35138 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35139 content in the cover letter, while not restricting attachments at all.
35140
35141 The variable contains 1 (true) for a MIME part believed to be part of the
35142 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35143 follows:
35144
35145 .olist
35146 The outermost MIME part of a message is always a cover letter.
35147
35148 .next
35149 If a multipart/alternative or multipart/related MIME part is a cover letter,
35150 so are all MIME subparts within that multipart.
35151
35152 .next
35153 If any other multipart is a cover letter, the first subpart is a cover letter,
35154 and the rest are attachments.
35155
35156 .next
35157 All parts contained within an attachment multipart are attachments.
35158 .endlist olist
35159
35160 As an example, the following will ban &"HTML mail"& (including that sent with
35161 alternative plain text), while allowing HTML files to be attached. HTML
35162 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35163 .code
35164 deny !condition = $mime_is_rfc822
35165      condition = $mime_is_coverletter
35166      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35167      message = HTML mail is not accepted here
35168 .endd
35169
35170 .vitem &$mime_is_multipart$&
35171 .vindex &$mime_is_multipart$&
35172 This variable has the value 1 (true) when the current part has the main type
35173 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35174 Since multipart entities only serve as containers for other parts, you may not
35175 want to carry out specific actions on them.
35176
35177 .vitem &$mime_is_rfc822$&
35178 .vindex &$mime_is_rfc822$&
35179 This variable has the value 1 (true) if the current part is not a part of the
35180 checked message itself, but part of an attached message. Attached message
35181 decoding is fully recursive.
35182
35183 .vitem &$mime_part_count$&
35184 .vindex &$mime_part_count$&
35185 This variable is a counter that is raised for each processed MIME part. It
35186 starts at zero for the very first part (which is usually a multipart). The
35187 counter is per-message, so it is reset when processing RFC822 attachments (see
35188 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35189 complete, so you can use it in the DATA ACL to determine the number of MIME
35190 parts of a message. For non-MIME messages, this variable contains the value -1.
35191 .endlist
35192
35193
35194
35195 .section "Scanning with regular expressions" "SECTscanregex"
35196 .cindex "content scanning" "with regular expressions"
35197 .cindex "regular expressions" "content scanning with"
35198 You can specify your own custom regular expression matches on the full body of
35199 the message, or on individual MIME parts.
35200
35201 The &%regex%& condition takes one or more regular expressions as arguments and
35202 matches them against the full message (when called in the DATA ACL) or a raw
35203 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35204 linewise, with a maximum line length of 32K characters. That means you cannot
35205 have multiline matches with the &%regex%& condition.
35206
35207 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35208 to 32K of decoded content (the whole content at once, not linewise). If the
35209 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35210 is decoded automatically when &%mime_regex%& is executed (using default path
35211 and filename values). If the decoded data is larger than  32K, only the first
35212 32K characters are checked.
35213
35214 The regular expressions are passed as a colon-separated list. To include a
35215 literal colon, you must double it. Since the whole right-hand side string is
35216 expanded before being used, you must also escape dollar signs and backslashes
35217 with more backslashes, or use the &`\N`& facility to disable expansion.
35218 Here is a simple example that contains two regular expressions:
35219 .code
35220 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35221      message = contains blacklisted regex ($regex_match_string)
35222 .endd
35223 The conditions returns true if any one of the regular expressions matches. The
35224 &$regex_match_string$& expansion variable is then set up and contains the
35225 matching regular expression.
35226 The expansion variables &$regex1$& &$regex2$& etc
35227 are set to any substrings captured by the regular expression.
35228
35229 &*Warning*&: With large messages, these conditions can be fairly
35230 CPU-intensive.
35231
35232 .ecindex IIDcosca
35233
35234
35235
35236
35237 . ////////////////////////////////////////////////////////////////////////////
35238 . ////////////////////////////////////////////////////////////////////////////
35239
35240 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35241          "Local scan function"
35242 .scindex IIDlosca "&[local_scan()]& function" "description of"
35243 .cindex "customizing" "input scan using C function"
35244 .cindex "policy control" "by local scan function"
35245 In these days of email worms, viruses, and ever-increasing spam, some sites
35246 want to apply a lot of checking to messages before accepting them.
35247
35248 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35249 passing messages to external virus and spam scanning software. You can also do
35250 a certain amount in Exim itself through string expansions and the &%condition%&
35251 condition in the ACL that runs after the SMTP DATA command or the ACL for
35252 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35253
35254 To allow for further customization to a site's own requirements, there is the
35255 possibility of linking Exim with a private message scanning function, written
35256 in C. If you want to run code that is written in something other than C, you
35257 can of course use a little C stub to call it.
35258
35259 The local scan function is run once for every incoming message, at the point
35260 when Exim is just about to accept the message.
35261 It can therefore be used to control non-SMTP messages from local processes as
35262 well as messages arriving via SMTP.
35263
35264 Exim applies a timeout to calls of the local scan function, and there is an
35265 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35266 Zero means &"no timeout"&.
35267 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35268 before calling the local scan function, so that the most common types of crash
35269 are caught. If the timeout is exceeded or one of those signals is caught, the
35270 incoming message is rejected with a temporary error if it is an SMTP message.
35271 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35272 code. The incident is logged on the main and reject logs.
35273
35274
35275
35276 .section "Building Exim to use a local scan function" "SECID207"
35277 .cindex "&[local_scan()]& function" "building Exim to use"
35278 To make use of the local scan function feature, you must tell Exim where your
35279 function is before building Exim, by setting
35280 both HAVE_LOCAL_SCAN and
35281 LOCAL_SCAN_SOURCE in your
35282 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35283 directory, so you might set
35284 .code
35285 HAVE_LOCAL_SCAN=yes
35286 LOCAL_SCAN_SOURCE=Local/local_scan.c
35287 .endd
35288 for example. The function must be called &[local_scan()]&;
35289 the source file(s) for it should first #define LOCAL_SCAN
35290 and then #include "local_scan.h".
35291 It is called by
35292 Exim after it has received a message, when the success return code is about to
35293 be sent. This is after all the ACLs have been run. The return code from your
35294 function controls whether the message is actually accepted or not. There is a
35295 commented template function (that just accepts the message) in the file
35296 _src/local_scan.c_.
35297
35298 If you want to make use of Exim's runtime configuration file to set options
35299 for your &[local_scan()]& function, you must also set
35300 .code
35301 LOCAL_SCAN_HAS_OPTIONS=yes
35302 .endd
35303 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35304
35305
35306
35307
35308 .section "API for local_scan()" "SECTapiforloc"
35309 .cindex "&[local_scan()]& function" "API description"
35310 .cindex &%dlfunc%& "API description"
35311 You must include this line near the start of your code:
35312 .code
35313 #define LOCAL_SCAN
35314 #include "local_scan.h"
35315 .endd
35316 This header file defines a number of variables and other values, and the
35317 prototype for the function itself. Exim is coded to use unsigned char values
35318 almost exclusively, and one of the things this header defines is a shorthand
35319 for &`unsigned char`& called &`uschar`&.
35320 It also makes available the following macro definitions, to simplify casting character
35321 strings and pointers to character strings:
35322 .code
35323 #define CS   (char *)
35324 #define CCS  (const char *)
35325 #define CSS  (char **)
35326 #define US   (unsigned char *)
35327 #define CUS  (const unsigned char *)
35328 #define USS  (unsigned char **)
35329 .endd
35330 The function prototype for &[local_scan()]& is:
35331 .code
35332 extern int local_scan(int fd, uschar **return_text);
35333 .endd
35334 The arguments are as follows:
35335
35336 .ilist
35337 &%fd%& is a file descriptor for the file that contains the body of the message
35338 (the -D file). The file is open for reading and writing, but updating it is not
35339 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35340
35341 The descriptor is positioned at character 19 of the file, which is the first
35342 character of the body itself, because the first 19 characters are the message
35343 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35344 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35345 case this changes in some future version.
35346 .next
35347 &%return_text%& is an address which you can use to return a pointer to a text
35348 string at the end of the function. The value it points to on entry is NULL.
35349 .endlist
35350
35351 The function must return an &%int%& value which is one of the following macros:
35352
35353 .vlist
35354 .vitem &`LOCAL_SCAN_ACCEPT`&
35355 .vindex "&$local_scan_data$&"
35356 The message is accepted. If you pass back a string of text, it is saved with
35357 the message, and made available in the variable &$local_scan_data$&. No
35358 newlines are permitted (if there are any, they are turned into spaces) and the
35359 maximum length of text is 1000 characters.
35360
35361 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35362 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35363 queued without immediate delivery, and is frozen.
35364
35365 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35366 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35367 queued without immediate delivery.
35368
35369 .vitem &`LOCAL_SCAN_REJECT`&
35370 The message is rejected; the returned text is used as an error message which is
35371 passed back to the sender and which is also logged. Newlines are permitted &--
35372 they cause a multiline response for SMTP rejections, but are converted to
35373 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35374 used.
35375
35376 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35377 The message is temporarily rejected; the returned text is used as an error
35378 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35379 problem"& is used.
35380
35381 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35382 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35383 message is not written to the reject log. It has the effect of unsetting the
35384 &%rejected_header%& log selector for just this rejection. If
35385 &%rejected_header%& is already unset (see the discussion of the
35386 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35387 same as LOCAL_SCAN_REJECT.
35388
35389 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35390 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35391 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35392 .endlist
35393
35394 If the message is not being received by interactive SMTP, rejections are
35395 reported by writing to &%stderr%& or by sending an email, as configured by the
35396 &%-oe%& command line options.
35397
35398
35399
35400 .section "Configuration options for local_scan()" "SECTconoptloc"
35401 .cindex "&[local_scan()]& function" "configuration options"
35402 It is possible to have option settings in the main configuration file
35403 that set values in static variables in the &[local_scan()]& module. If you
35404 want to do this, you must have the line
35405 .code
35406 LOCAL_SCAN_HAS_OPTIONS=yes
35407 .endd
35408 in your &_Local/Makefile_& when you build Exim. (This line is in
35409 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35410 file, you must define static variables to hold the option values, and a table
35411 to define them.
35412
35413 The table must be a vector called &%local_scan_options%&, of type
35414 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35415 and a pointer to the variable that holds the value. The entries must appear in
35416 alphabetical order. Following &%local_scan_options%& you must also define a
35417 variable called &%local_scan_options_count%& that contains the number of
35418 entries in the table. Here is a short example, showing two kinds of option:
35419 .code
35420 static int my_integer_option = 42;
35421 static uschar *my_string_option = US"a default string";
35422
35423 optionlist local_scan_options[] = {
35424   { "my_integer", opt_int,       &my_integer_option },
35425   { "my_string",  opt_stringptr, &my_string_option }
35426 };
35427
35428 int local_scan_options_count =
35429   sizeof(local_scan_options)/sizeof(optionlist);
35430 .endd
35431 The values of the variables can now be changed from Exim's runtime
35432 configuration file by including a local scan section as in this example:
35433 .code
35434 begin local_scan
35435 my_integer = 99
35436 my_string = some string of text...
35437 .endd
35438 The available types of option data are as follows:
35439
35440 .vlist
35441 .vitem &*opt_bool*&
35442 This specifies a boolean (true/false) option. The address should point to a
35443 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35444 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35445 whether such a variable has been set at all, you can initialize it to
35446 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35447 values.)
35448
35449 .vitem &*opt_fixed*&
35450 This specifies a fixed point number, such as is used for load averages.
35451 The address should point to a variable of type &`int`&. The value is stored
35452 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35453
35454 .vitem &*opt_int*&
35455 This specifies an integer; the address should point to a variable of type
35456 &`int`&. The value may be specified in any of the integer formats accepted by
35457 Exim.
35458
35459 .vitem &*opt_mkint*&
35460 This is the same as &%opt_int%&, except that when such a value is output in a
35461 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35462 printed with the suffix K or M.
35463
35464 .vitem &*opt_octint*&
35465 This also specifies an integer, but the value is always interpreted as an
35466 octal integer, whether or not it starts with the digit zero, and it is
35467 always output in octal.
35468
35469 .vitem &*opt_stringptr*&
35470 This specifies a string value; the address must be a pointer to a
35471 variable that points to a string (for example, of type &`uschar *`&).
35472
35473 .vitem &*opt_time*&
35474 This specifies a time interval value. The address must point to a variable of
35475 type &`int`&. The value that is placed there is a number of seconds.
35476 .endlist
35477
35478 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35479 out the values of all the &[local_scan()]& options.
35480
35481
35482
35483 .section "Available Exim variables" "SECID208"
35484 .cindex "&[local_scan()]& function" "available Exim variables"
35485 The header &_local_scan.h_& gives you access to a number of C variables. These
35486 are the only ones that are guaranteed to be maintained from release to release.
35487 Note, however, that you can obtain the value of any Exim expansion variable,
35488 including &$recipients$&, by calling &'expand_string()'&. The exported
35489 C variables are as follows:
35490
35491 .vlist
35492 .vitem &*int&~body_linecount*&
35493 This variable contains the number of lines in the message's body.
35494 It is not valid if the &%spool_wireformat%& option is used.
35495
35496 .vitem &*int&~body_zerocount*&
35497 This variable contains the number of binary zero bytes in the message's body.
35498 It is not valid if the &%spool_wireformat%& option is used.
35499
35500 .vitem &*unsigned&~int&~debug_selector*&
35501 This variable is set to zero when no debugging is taking place. Otherwise, it
35502 is a bitmap of debugging selectors. Two bits are identified for use in
35503 &[local_scan()]&; they are defined as macros:
35504
35505 .ilist
35506 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35507 testing option that is not privileged &-- any caller may set it. All the
35508 other selector bits can be set only by admin users.
35509
35510 .next
35511 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35512 by the &`+local_scan`& debug selector. It is not included in the default set
35513 of debugging bits.
35514 .endlist ilist
35515
35516 Thus, to write to the debugging output only when &`+local_scan`& has been
35517 selected, you should use code like this:
35518 .code
35519 if ((debug_selector & D_local_scan) != 0)
35520   debug_printf("xxx", ...);
35521 .endd
35522 .vitem &*uschar&~*expand_string_message*&
35523 After a failing call to &'expand_string()'& (returned value NULL), the
35524 variable &%expand_string_message%& contains the error message, zero-terminated.
35525
35526 .vitem &*header_line&~*header_list*&
35527 A pointer to a chain of header lines. The &%header_line%& structure is
35528 discussed below.
35529
35530 .vitem &*header_line&~*header_last*&
35531 A pointer to the last of the header lines.
35532
35533 .vitem &*const&~uschar&~*headers_charset*&
35534 The value of the &%headers_charset%& configuration option.
35535
35536 .vitem &*BOOL&~host_checking*&
35537 This variable is TRUE during a host checking session that is initiated by the
35538 &%-bh%& command line option.
35539
35540 .vitem &*uschar&~*interface_address*&
35541 The IP address of the interface that received the message, as a string. This
35542 is NULL for locally submitted messages.
35543
35544 .vitem &*int&~interface_port*&
35545 The port on which this message was received. When testing with the &%-bh%&
35546 command line option, the value of this variable is -1 unless a port has been
35547 specified via the &%-oMi%& option.
35548
35549 .vitem &*uschar&~*message_id*&
35550 This variable contains Exim's message id for the incoming message (the value of
35551 &$message_exim_id$&) as a zero-terminated string.
35552
35553 .vitem &*uschar&~*received_protocol*&
35554 The name of the protocol by which the message was received.
35555
35556 .vitem &*int&~recipients_count*&
35557 The number of accepted recipients.
35558
35559 .vitem &*recipient_item&~*recipients_list*&
35560 .cindex "recipient" "adding in local scan"
35561 .cindex "recipient" "removing in local scan"
35562 The list of accepted recipients, held in a vector of length
35563 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35564 can add additional recipients by calling &'receive_add_recipient()'& (see
35565 below). You can delete recipients by removing them from the vector and
35566 adjusting the value in &%recipients_count%&. In particular, by setting
35567 &%recipients_count%& to zero you remove all recipients. If you then return the
35568 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35569 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35570 and then call &'receive_add_recipient()'& as often as needed.
35571
35572 .vitem &*uschar&~*sender_address*&
35573 The envelope sender address. For bounce messages this is the empty string.
35574
35575 .vitem &*uschar&~*sender_host_address*&
35576 The IP address of the sending host, as a string. This is NULL for
35577 locally-submitted messages.
35578
35579 .vitem &*uschar&~*sender_host_authenticated*&
35580 The name of the authentication mechanism that was used, or NULL if the message
35581 was not received over an authenticated SMTP connection.
35582
35583 .vitem &*uschar&~*sender_host_name*&
35584 The name of the sending host, if known.
35585
35586 .vitem &*int&~sender_host_port*&
35587 The port on the sending host.
35588
35589 .vitem &*BOOL&~smtp_input*&
35590 This variable is TRUE for all SMTP input, including BSMTP.
35591
35592 .vitem &*BOOL&~smtp_batched_input*&
35593 This variable is TRUE for BSMTP input.
35594
35595 .vitem &*int&~store_pool*&
35596 The contents of this variable control which pool of memory is used for new
35597 requests. See section &<<SECTmemhanloc>>& for details.
35598 .endlist
35599
35600
35601 .section "Structure of header lines" "SECID209"
35602 The &%header_line%& structure contains the members listed below.
35603 You can add additional header lines by calling the &'header_add()'& function
35604 (see below). You can cause header lines to be ignored (deleted) by setting
35605 their type to *.
35606
35607
35608 .vlist
35609 .vitem &*struct&~header_line&~*next*&
35610 A pointer to the next header line, or NULL for the last line.
35611
35612 .vitem &*int&~type*&
35613 A code identifying certain headers that Exim recognizes. The codes are printing
35614 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35615 Notice in particular that any header line whose type is * is not transmitted
35616 with the message. This flagging is used for header lines that have been
35617 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35618 lines.) Effectively, * means &"deleted"&.
35619
35620 .vitem &*int&~slen*&
35621 The number of characters in the header line, including the terminating and any
35622 internal newlines.
35623
35624 .vitem &*uschar&~*text*&
35625 A pointer to the text of the header. It always ends with a newline, followed by
35626 a zero byte. Internal newlines are preserved.
35627 .endlist
35628
35629
35630
35631 .section "Structure of recipient items" "SECID210"
35632 The &%recipient_item%& structure contains these members:
35633
35634 .vlist
35635 .vitem &*uschar&~*address*&
35636 This is a pointer to the recipient address as it was received.
35637
35638 .vitem &*int&~pno*&
35639 This is used in later Exim processing when top level addresses are created by
35640 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35641 and must always contain -1 at this stage.
35642
35643 .vitem &*uschar&~*errors_to*&
35644 If this value is not NULL, bounce messages caused by failing to deliver to the
35645 recipient are sent to the address it contains. In other words, it overrides the
35646 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35647 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35648 an unqualified address, Exim qualifies it using the domain from
35649 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35650 is NULL for all recipients.
35651 .endlist
35652
35653
35654
35655 .section "Available Exim functions" "SECID211"
35656 .cindex "&[local_scan()]& function" "available Exim functions"
35657 The header &_local_scan.h_& gives you access to a number of Exim functions.
35658 These are the only ones that are guaranteed to be maintained from release to
35659 release:
35660
35661 .vlist
35662 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35663        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35664
35665 This function creates a child process that runs the command specified by
35666 &%argv%&. The environment for the process is specified by &%envp%&, which can
35667 be NULL if no environment variables are to be passed. A new umask is supplied
35668 for the process in &%newumask%&.
35669
35670 Pipes to the standard input and output of the new process are set up
35671 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35672 standard error is cloned to the standard output. If there are any file
35673 descriptors &"in the way"& in the new process, they are closed. If the final
35674 argument is TRUE, the new process is made into a process group leader.
35675
35676 The function returns the pid of the new process, or -1 if things go wrong.
35677
35678 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35679 This function waits for a child process to terminate, or for a timeout (in
35680 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35681 return value is as follows:
35682
35683 .ilist
35684 >= 0
35685
35686 The process terminated by a normal exit and the value is the process
35687 ending status.
35688
35689 .next
35690 < 0 and > &--256
35691
35692 The process was terminated by a signal and the value is the negation of the
35693 signal number.
35694
35695 .next
35696 &--256
35697
35698 The process timed out.
35699 .next
35700 &--257
35701
35702 The was some other error in wait(); &%errno%& is still set.
35703 .endlist
35704
35705 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35706 This function provide you with a means of submitting a new message to
35707 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35708 want, but this packages it all up for you.) The function creates a pipe,
35709 forks a subprocess that is running
35710 .code
35711 exim -t -oem -oi -f <>
35712 .endd
35713 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35714 that is connected to the standard input. The yield of the function is the PID
35715 of the subprocess. You can then write a message to the file descriptor, with
35716 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35717
35718 When you have finished, call &'child_close()'& to wait for the process to
35719 finish and to collect its ending status. A timeout value of zero is usually
35720 fine in this circumstance. Unless you have made a mistake with the recipient
35721 addresses, you should get a return code of zero.
35722
35723
35724 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35725        *sender_authentication)*&
35726 This function is a more sophisticated version of &'child_open()'&. The command
35727 that it runs is:
35728 .display
35729 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35730 .endd
35731 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35732
35733
35734 .vitem &*void&~debug_printf(char&~*,&~...)*&
35735 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35736 output is written to the standard error stream. If no debugging is selected,
35737 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35738 conditional on the &`local_scan`& debug selector by coding like this:
35739 .code
35740 if ((debug_selector & D_local_scan) != 0)
35741   debug_printf("xxx", ...);
35742 .endd
35743
35744 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35745 This is an interface to Exim's string expansion code. The return value is the
35746 expanded string, or NULL if there was an expansion failure.
35747 The C variable &%expand_string_message%& contains an error message after an
35748 expansion failure. If expansion does not change the string, the return value is
35749 the pointer to the input string. Otherwise, the return value points to a new
35750 block of memory that was obtained by a call to &'store_get()'&. See section
35751 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35752
35753 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35754 This function allows you to an add additional header line at the end of the
35755 existing ones. The first argument is the type, and should normally be a space
35756 character. The second argument is a format string and any number of
35757 substitution arguments as for &[sprintf()]&. You may include internal newlines
35758 if you want, and you must ensure that the string ends with a newline.
35759
35760 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35761         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35762 This function adds a new header line at a specified point in the header
35763 chain. The header itself is specified as for &'header_add()'&.
35764
35765 If &%name%& is NULL, the new header is added at the end of the chain if
35766 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35767 NULL, the header lines are searched for the first non-deleted header that
35768 matches the name. If one is found, the new header is added before it if
35769 &%after%& is false. If &%after%& is true, the new header is added after the
35770 found header and any adjacent subsequent ones with the same name (even if
35771 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35772 option controls where the header is added. If it is true, addition is at the
35773 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35774 headers, or at the top if there are no &'Received:'& headers, you could use
35775 .code
35776 header_add_at_position(TRUE, US"Received", TRUE,
35777   ' ', "X-xxx: ...");
35778 .endd
35779 Normally, there is always at least one non-deleted &'Received:'& header, but
35780 there may not be if &%received_header_text%& expands to an empty string.
35781
35782
35783 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35784 This function removes header lines. If &%occurrence%& is zero or negative, all
35785 occurrences of the header are removed. If occurrence is greater than zero, that
35786 particular instance of the header is removed. If no header(s) can be found that
35787 match the specification, the function does nothing.
35788
35789
35790 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35791         int&~length,&~BOOL&~notdel)*&"
35792 This function tests whether the given header has the given name. It is not just
35793 a string comparison, because white space is permitted between the name and the
35794 colon. If the &%notdel%& argument is true, a false return is forced for all
35795 &"deleted"& headers; otherwise they are not treated specially. For example:
35796 .code
35797 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35798 .endd
35799 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35800 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35801 This function base64-encodes a string, which is passed by address and length.
35802 The text may contain bytes of any value, including zero. The result is passed
35803 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35804 zero-terminated.
35805
35806 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35807 This function decodes a base64-encoded string. Its arguments are a
35808 zero-terminated base64-encoded string and the address of a variable that is set
35809 to point to the result, which is in dynamic memory. The length of the decoded
35810 string is the yield of the function. If the input is invalid base64 data, the
35811 yield is -1. A zero byte is added to the end of the output string to make it
35812 easy to interpret as a C string (assuming it contains no zeros of its own). The
35813 added zero byte is not included in the returned count.
35814
35815 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35816 This function checks for a match in a domain list. Domains are always
35817 matched caselessly. The return value is one of the following:
35818 .itable none 0 0 2 15* left 85* left
35819 .irow &`OK`&    "match succeeded"
35820 .irow &`FAIL`&  "match failed"
35821 .irow &`DEFER`& "match deferred"
35822 .endtable
35823 DEFER is usually caused by some kind of lookup defer, such as the
35824 inability to contact a database.
35825
35826 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35827         BOOL&~caseless)*&"
35828 This function checks for a match in a local part list. The third argument
35829 controls case-sensitivity. The return values are as for
35830 &'lss_match_domain()'&.
35831
35832 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35833         BOOL&~caseless)*&"
35834 This function checks for a match in an address list. The third argument
35835 controls the case-sensitivity of the local part match. The domain is always
35836 matched caselessly. The return values are as for &'lss_match_domain()'&.
35837
35838 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35839         uschar&~*list)*&"
35840 This function checks for a match in a host list. The most common usage is
35841 expected to be
35842 .code
35843 lss_match_host(sender_host_name, sender_host_address, ...)
35844 .endd
35845 .vindex "&$sender_host_address$&"
35846 An empty address field matches an empty item in the host list. If the host name
35847 is NULL, the name corresponding to &$sender_host_address$& is automatically
35848 looked up if a host name is required to match an item in the list. The return
35849 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35850 returns ERROR in the case when it had to look up a host name, but the lookup
35851 failed.
35852
35853 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35854         *format,&~...)*&"
35855 This function writes to Exim's log files. The first argument should be zero (it
35856 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35857 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35858 them. It specifies to which log or logs the message is written. The remaining
35859 arguments are a format and relevant insertion arguments. The string should not
35860 contain any newlines, not even at the end.
35861
35862
35863 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35864 This function adds an additional recipient to the message. The first argument
35865 is the recipient address. If it is unqualified (has no domain), it is qualified
35866 with the &%qualify_recipient%& domain. The second argument must always be -1.
35867
35868 This function does not allow you to specify a private &%errors_to%& address (as
35869 described with the structure of &%recipient_item%& above), because it pre-dates
35870 the addition of that field to the structure. However, it is easy to add such a
35871 value afterwards. For example:
35872 .code
35873  receive_add_recipient(US"monitor@mydom.example", -1);
35874  recipients_list[recipients_count-1].errors_to =
35875    US"postmaster@mydom.example";
35876 .endd
35877
35878 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35879 This is a convenience function to remove a named recipient from the list of
35880 recipients. It returns true if a recipient was removed, and false if no
35881 matching recipient could be found. The argument must be a complete email
35882 address.
35883 .endlist
35884
35885
35886 .cindex "RFC 2047"
35887 .vlist
35888 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35889   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35890 This function decodes strings that are encoded according to RFC 2047. Typically
35891 these are the contents of header lines. First, each &"encoded word"& is decoded
35892 from the Q or B encoding into a byte-string. Then, if provided with the name of
35893 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35894 made  to translate the result to the named character set. If this fails, the
35895 binary string is returned with an error message.
35896
35897 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35898 maximum MIME word length is enforced. The third argument is the target
35899 encoding, or NULL if no translation is wanted.
35900
35901 .cindex "binary zero" "in RFC 2047 decoding"
35902 .cindex "RFC 2047" "binary zero in"
35903 If a binary zero is encountered in the decoded string, it is replaced by the
35904 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35905 not be 0 because header lines are handled as zero-terminated strings.
35906
35907 The function returns the result of processing the string, zero-terminated; if
35908 &%lenptr%& is not NULL, the length of the result is set in the variable to
35909 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35910
35911 If an error is encountered, the function returns NULL and uses the &%error%&
35912 argument to return an error message. The variable pointed to by &%error%& is
35913 set to NULL if there is no error; it may be set non-NULL even when the function
35914 returns a non-NULL value if decoding was successful, but there was a problem
35915 with translation.
35916
35917
35918 .vitem &*int&~smtp_fflush(void)*&
35919 This function is used in conjunction with &'smtp_printf()'&, as described
35920 below.
35921
35922 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35923 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35924 output stream. You should use this function only when there is an SMTP output
35925 stream, that is, when the incoming message is being received via interactive
35926 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35927 is FALSE. If you want to test for an incoming message from another host (as
35928 opposed to a local process that used the &%-bs%& command line option), you can
35929 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35930 is involved.
35931
35932 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35933 output function, so it can be used for all forms of SMTP connection.
35934
35935 The second argument is used to request that the data be buffered
35936 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35937 This is advisory only, but likely to save on system-calls and packets
35938 sent when a sequence of calls to the function are made.
35939
35940 The argument was added in Exim version 4.90 - changing the API/ABI.
35941 Nobody noticed until 4.93 was imminent, at which point the
35942 ABI version number was incremented.
35943
35944 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35945 must start with an appropriate response code: 550 if you are going to return
35946 LOCAL_SCAN_REJECT, 451 if you are going to return
35947 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35948 initial lines of a multi-line response, the code must be followed by a hyphen
35949 to indicate that the line is not the final response line. You must also ensure
35950 that the lines you write terminate with CRLF. For example:
35951 .code
35952 smtp_printf("550-this is some extra info\r\n");
35953 return LOCAL_SCAN_REJECT;
35954 .endd
35955 Note that you can also create multi-line responses by including newlines in
35956 the data returned via the &%return_text%& argument. The added value of using
35957 &'smtp_printf()'& is that, for instance, you could introduce delays between
35958 multiple output lines.
35959
35960 The &'smtp_printf()'& function does not return any error indication, because it
35961 does not
35962 guarantee a flush of
35963 pending output, and therefore does not test
35964 the state of the stream. (In the main code of Exim, flushing and error
35965 detection is done when Exim is ready for the next SMTP input command.) If
35966 you want to flush the output and check for an error (for example, the
35967 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35968 arguments. It flushes the output stream, and returns a non-zero value if there
35969 is an error.
35970
35971 .vitem &*void&~*store_get(int,BOOL)*&
35972 This function accesses Exim's internal store (memory) manager. It gets a new
35973 chunk of memory whose size is given by the first argument.
35974 The second argument should be given as TRUE if the memory will be used for
35975 data possibly coming from an attacker (eg. the message content),
35976 FALSE if it is locally-sourced.
35977 Exim bombs out if it ever
35978 runs out of memory. See the next section for a discussion of memory handling.
35979
35980 .vitem &*void&~*store_get_perm(int,BOOL)*&
35981 This function is like &'store_get()'&, but it always gets memory from the
35982 permanent pool. See the next section for a discussion of memory handling.
35983
35984 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35985 See below.
35986
35987 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35988 See below.
35989
35990 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35991 These three functions create strings using Exim's dynamic memory facilities.
35992 The first makes a copy of an entire string. The second copies up to a maximum
35993 number of characters, indicated by the second argument. The third uses a format
35994 and insertion arguments to create a new string. In each case, the result is a
35995 pointer to a new string in the current memory pool. See the next section for
35996 more discussion.
35997 .endlist
35998
35999
36000
36001 .section "More about Exim's memory handling" "SECTmemhanloc"
36002 .cindex "&[local_scan()]& function" "memory handling"
36003 No function is provided for freeing memory, because that is never needed.
36004 The dynamic memory that Exim uses when receiving a message is automatically
36005 recycled if another message is received by the same process (this applies only
36006 to incoming SMTP connections &-- other input methods can supply only one
36007 message at a time). After receiving the last message, a reception process
36008 terminates.
36009
36010 Because it is recycled, the normal dynamic memory cannot be used for holding
36011 data that must be preserved over a number of incoming messages on the same SMTP
36012 connection. However, Exim in fact uses two pools of dynamic memory; the second
36013 one is not recycled, and can be used for this purpose.
36014
36015 If you want to allocate memory that remains available for subsequent messages
36016 in the same SMTP connection, you should set
36017 .code
36018 store_pool = POOL_PERM
36019 .endd
36020 before calling the function that does the allocation. There is no need to
36021 restore the value if you do not need to; however, if you do want to revert to
36022 the normal pool, you can either restore the previous value of &%store_pool%& or
36023 set it explicitly to POOL_MAIN.
36024
36025 The pool setting applies to all functions that get dynamic memory, including
36026 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36027 There is also a convenience function called &'store_get_perm()'& that gets a
36028 block of memory from the permanent pool while preserving the value of
36029 &%store_pool%&.
36030 .ecindex IIDlosca
36031
36032
36033
36034
36035 . ////////////////////////////////////////////////////////////////////////////
36036 . ////////////////////////////////////////////////////////////////////////////
36037
36038 .chapter "System-wide message filtering" "CHAPsystemfilter"
36039 .scindex IIDsysfil1 "filter" "system filter"
36040 .scindex IIDsysfil2 "filtering all mail"
36041 .scindex IIDsysfil3 "system filter"
36042 The previous chapters (on ACLs and the local scan function) describe checks
36043 that can be applied to messages before they are accepted by a host. There is
36044 also a mechanism for checking messages once they have been received, but before
36045 they are delivered. This is called the &'system filter'&.
36046
36047 The system filter operates in a similar manner to users' filter files, but it
36048 is run just once per message (however many recipients the message has).
36049 It should not normally be used as a substitute for routing, because &%deliver%&
36050 commands in a system router provide new envelope recipient addresses.
36051 The system filter must be an Exim filter. It cannot be a Sieve filter.
36052
36053 The system filter is run at the start of a delivery attempt, before any routing
36054 is done. If a message fails to be completely delivered at the first attempt,
36055 the system filter is run again at the start of every retry.
36056 If you want your filter to do something only once per message, you can make use
36057 .cindex retry condition
36058 of the &%first_delivery%& condition in an &%if%& command in the filter to
36059 prevent it happening on retries.
36060
36061 .vindex "&$domain$&"
36062 .vindex "&$local_part$&"
36063 &*Warning*&: Because the system filter runs just once, variables that are
36064 specific to individual recipient addresses, such as &$local_part$& and
36065 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36066 you want to run a centrally-specified filter for each recipient address
36067 independently, you can do so by setting up a suitable &(redirect)& router, as
36068 described in section &<<SECTperaddfil>>& below.
36069
36070
36071 .section "Specifying a system filter" "SECID212"
36072 .cindex "uid (user id)" "system filter"
36073 .cindex "gid (group id)" "system filter"
36074 The name of the file that contains the system filter must be specified by
36075 setting &%system_filter%&. If you want the filter to run under a uid and gid
36076 other than root, you must also set &%system_filter_user%& and
36077 &%system_filter_group%& as appropriate. For example:
36078 .code
36079 system_filter = /etc/mail/exim.filter
36080 system_filter_user = exim
36081 .endd
36082 If a system filter generates any deliveries directly to files or pipes (via the
36083 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36084 specified by setting &%system_filter_file_transport%& and
36085 &%system_filter_pipe_transport%&, respectively. Similarly,
36086 &%system_filter_reply_transport%& must be set to handle any messages generated
36087 by the &%reply%& command.
36088
36089
36090 .section "Testing a system filter" "SECID213"
36091 You can run simple tests of a system filter in the same way as for a user
36092 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36093 are permitted only in system filters are recognized.
36094
36095 If you want to test the combined effect of a system filter and a user filter,
36096 you can use both &%-bF%& and &%-bf%& on the same command line.
36097
36098
36099
36100 .section "Contents of a system filter" "SECID214"
36101 The language used to specify system filters is the same as for users' filter
36102 files. It is described in the separate end-user document &'Exim's interface to
36103 mail filtering'&. However, there are some additional features that are
36104 available only in system filters; these are described in subsequent sections.
36105 If they are encountered in a user's filter file or when testing with &%-bf%&,
36106 they cause errors.
36107
36108 .cindex "frozen messages" "manual thaw; testing in filter"
36109 There are two special conditions which, though available in users' filter
36110 files, are designed for use in system filters. The condition &%first_delivery%&
36111 is true only for the first attempt at delivering a message, and
36112 &%manually_thawed%& is true only if the message has been frozen, and
36113 subsequently thawed by an admin user. An explicit forced delivery counts as a
36114 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36115
36116 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36117 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36118 succeed, it will not be tried again.
36119 If you want Exim to retry an unseen delivery until it succeeds, you should
36120 arrange to set it up every time the filter runs.
36121
36122 When a system filter finishes running, the values of the variables &$n0$& &--
36123 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36124 users' filter files. Thus a system filter can, for example, set up &"scores"&
36125 to which users' filter files can refer.
36126
36127
36128
36129 .section "Additional variable for system filters" "SECID215"
36130 .vindex "&$recipients$&"
36131 The expansion variable &$recipients$&, containing a list of all the recipients
36132 of the message (separated by commas and white space), is available in system
36133 filters. It is not available in users' filters for privacy reasons.
36134
36135
36136
36137 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36138 .cindex "freezing messages"
36139 .cindex "message" "freezing"
36140 .cindex "message" "forced failure"
36141 .cindex "&%fail%&" "in system filter"
36142 .cindex "&%freeze%& in system filter"
36143 .cindex "&%defer%& in system filter"
36144 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36145 always available in system filters, but are not normally enabled in users'
36146 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36147 for the &(redirect)& router.) These commands can optionally be followed by the
36148 word &%text%& and a string containing an error message, for example:
36149 .code
36150 fail text "this message looks like spam to me"
36151 .endd
36152 The keyword &%text%& is optional if the next character is a double quote.
36153
36154 The &%defer%& command defers delivery of the original recipients of the
36155 message. The &%fail%& command causes all the original recipients to be failed,
36156 and a bounce message to be created. The &%freeze%& command suspends all
36157 delivery attempts for the original recipients. In all cases, any new deliveries
36158 that are specified by the filter are attempted as normal after the filter has
36159 run.
36160
36161 The &%freeze%& command is ignored if the message has been manually unfrozen and
36162 not manually frozen since. This means that automatic freezing by a system
36163 filter can be used as a way of checking out suspicious messages. If a message
36164 is found to be all right, manually unfreezing it allows it to be delivered.
36165
36166 .cindex "log" "&%fail%& command log line"
36167 .cindex "&%fail%&" "log line; reducing"
36168 The text given with a fail command is used as part of the bounce message as
36169 well as being written to the log. If the message is quite long, this can fill
36170 up a lot of log space when such failures are common. To reduce the size of the
36171 log message, Exim interprets the text in a special way if it starts with the
36172 two characters &`<<`& and contains &`>>`& later. The text between these two
36173 strings is written to the log, and the rest of the text is used in the bounce
36174 message. For example:
36175 .code
36176 fail "<<filter test 1>>Your message is rejected \
36177      because it contains attachments that we are \
36178      not prepared to receive."
36179 .endd
36180
36181 .cindex "loop" "caused by &%fail%&"
36182 Take great care with the &%fail%& command when basing the decision to fail on
36183 the contents of the message, because the bounce message will of course include
36184 the contents of the original message and will therefore trigger the &%fail%&
36185 command again (causing a mail loop) unless steps are taken to prevent this.
36186 Testing the &%error_message%& condition is one way to prevent this. You could
36187 use, for example
36188 .code
36189 if $message_body contains "this is spam" and not error_message
36190 then fail text "spam is not wanted here" endif
36191 .endd
36192 though of course that might let through unwanted bounce messages. The
36193 alternative is clever checking of the body and/or headers to detect bounces
36194 generated by the filter.
36195
36196 The interpretation of a system filter file ceases after a
36197 &%defer%&,
36198 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36199 set up earlier in the filter file are honoured, so you can use a sequence such
36200 as
36201 .code
36202 mail ...
36203 freeze
36204 .endd
36205 to send a specified message when the system filter is freezing (or deferring or
36206 failing) a message. The normal deliveries for the message do not, of course,
36207 take place.
36208
36209
36210
36211 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36212 .cindex "header lines" "adding; in system filter"
36213 .cindex "header lines" "removing; in system filter"
36214 .cindex "filter" "header lines; adding/removing"
36215 Two filter commands that are available only in system filters are:
36216 .code
36217 headers add <string>
36218 headers remove <string>
36219 .endd
36220 The argument for the &%headers add%& is a string that is expanded and then
36221 added to the end of the message's headers. It is the responsibility of the
36222 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36223 space is ignored, and if the string is otherwise empty, or if the expansion is
36224 forced to fail, the command has no effect.
36225
36226 You can use &"\n"& within the string, followed by white space, to specify
36227 continued header lines. More than one header may be added in one command by
36228 including &"\n"& within the string without any following white space. For
36229 example:
36230 .code
36231 headers add "X-header-1: ....\n  \
36232              continuation of X-header-1 ...\n\
36233              X-header-2: ...."
36234 .endd
36235 Note that the header line continuation white space after the first newline must
36236 be placed before the backslash that continues the input string, because white
36237 space after input continuations is ignored.
36238
36239 The argument for &%headers remove%& is a colon-separated list of header names.
36240 This command applies only to those headers that are stored with the message;
36241 those that are added at delivery time (such as &'Envelope-To:'& and
36242 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36243 header with the same name, they are all removed.
36244
36245 The &%headers%& command in a system filter makes an immediate change to the set
36246 of header lines that was received with the message (with possible additions
36247 from ACL processing). Subsequent commands in the system filter operate on the
36248 modified set, which also forms the basis for subsequent message delivery.
36249 Unless further modified during routing or transporting, this set of headers is
36250 used for all recipients of the message.
36251
36252 During routing and transporting, the variables that refer to the contents of
36253 header lines refer only to those lines that are in this set. Thus, header lines
36254 that are added by a system filter are visible to users' filter files and to all
36255 routers and transports. This contrasts with the manipulation of header lines by
36256 routers and transports, which is not immediate, but which instead is saved up
36257 until the message is actually being written (see section
36258 &<<SECTheadersaddrem>>&).
36259
36260 If the message is not delivered at the first attempt, header lines that were
36261 added by the system filter are stored with the message, and so are still
36262 present at the next delivery attempt. Header lines that were removed are still
36263 present, but marked &"deleted"& so that they are not transported with the
36264 message. For this reason, it is usual to make the &%headers%& command
36265 conditional on &%first_delivery%& so that the set of header lines is not
36266 modified more than once.
36267
36268 Because header modification in a system filter acts immediately, you have to
36269 use an indirect approach if you want to modify the contents of a header line.
36270 For example:
36271 .code
36272 headers add "Old-Subject: $h_subject:"
36273 headers remove "Subject"
36274 headers add "Subject: new subject (was: $h_old-subject:)"
36275 headers remove "Old-Subject"
36276 .endd
36277
36278
36279
36280 .section "Setting an errors address in a system filter" "SECID217"
36281 .cindex "envelope from"
36282 .cindex "envelope sender"
36283 In a system filter, if a &%deliver%& command is followed by
36284 .code
36285 errors_to <some address>
36286 .endd
36287 in order to change the envelope sender (and hence the error reporting) for that
36288 delivery, any address may be specified. (In a user filter, only the current
36289 user's address can be set.) For example, if some mail is being monitored, you
36290 might use
36291 .code
36292 unseen deliver monitor@spying.example errors_to root@local.example
36293 .endd
36294 to take a copy which would not be sent back to the normal error reporting
36295 address if its delivery failed.
36296
36297
36298
36299 .section "Per-address filtering" "SECTperaddfil"
36300 .vindex "&$domain_data$&"
36301 .vindex "&$local_part_data$&"
36302 In contrast to the system filter, which is run just once per message for each
36303 delivery attempt, it is also possible to set up a system-wide filtering
36304 operation that runs once for each recipient address. In this case, variables
36305 such as &$local_part_data$& and &$domain_data$& can be used,
36306 and indeed, the choice of filter file could be made dependent on them.
36307 This is an example of a router which implements such a filter:
36308 .code
36309 central_filter:
36310   check_local_user
36311   driver = redirect
36312   domains = +local_domains
36313   file = /central/filters/$local_part_data
36314   no_verify
36315   allow_filter
36316   allow_freeze
36317 .endd
36318 The filter is run in a separate process under its own uid. Therefore, either
36319 &%check_local_user%& must be set (as above), in which case the filter is run as
36320 the local user, or the &%user%& option must be used to specify which user to
36321 use. If both are set, &%user%& overrides.
36322
36323 Care should be taken to ensure that none of the commands in the filter file
36324 specify a significant delivery if the message is to go on to be delivered to
36325 its intended recipient. The router will not then claim to have dealt with the
36326 address, so it will be passed on to subsequent routers to be delivered in the
36327 normal way.
36328 .ecindex IIDsysfil1
36329 .ecindex IIDsysfil2
36330 .ecindex IIDsysfil3
36331
36332
36333
36334
36335
36336
36337 . ////////////////////////////////////////////////////////////////////////////
36338 . ////////////////////////////////////////////////////////////////////////////
36339
36340 .chapter "Message processing" "CHAPmsgproc"
36341 .scindex IIDmesproc "message" "general processing"
36342 Exim performs various transformations on the sender and recipient addresses of
36343 all messages that it handles, and also on the messages' header lines. Some of
36344 these are optional and configurable, while others always take place. All of
36345 this processing, except rewriting as a result of routing, and the addition or
36346 removal of header lines while delivering, happens when a message is received,
36347 before it is placed on Exim's queue.
36348
36349 Some of the automatic processing takes place by default only for
36350 &"locally-originated"& messages. This adjective is used to describe messages
36351 that are not received over TCP/IP, but instead are passed to an Exim process on
36352 its standard input. This includes the interactive &"local SMTP"& case that is
36353 set up by the &%-bs%& command line option.
36354
36355 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36356 or ::1) are not considered to be locally-originated. Exim does not treat the
36357 loopback interface specially in any way.
36358
36359 If you want the loopback interface to be treated specially, you must ensure
36360 that there are appropriate entries in your ACLs.
36361
36362
36363
36364
36365 .section "Submission mode for non-local messages" "SECTsubmodnon"
36366 .cindex "message" "submission"
36367 .cindex "submission mode"
36368 Processing that happens automatically for locally-originated messages (unless
36369 &%suppress_local_fixups%& is set) can also be requested for messages that are
36370 received over TCP/IP. The term &"submission mode"& is used to describe this
36371 state. Submission mode is set by the modifier
36372 .code
36373 control = submission
36374 .endd
36375 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36376 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36377 a local submission, and is normally used when the source of the message is
36378 known to be an MUA running on a client host (as opposed to an MTA). For
36379 example, to set submission mode for messages originating on the IPv4 loopback
36380 interface, you could include the following in the MAIL ACL:
36381 .code
36382 warn  hosts = 127.0.0.1
36383       control = submission
36384 .endd
36385 .cindex "&%sender_retain%& submission option"
36386 There are some options that can be used when setting submission mode. A slash
36387 is used to separate options. For example:
36388 .code
36389 control = submission/sender_retain
36390 .endd
36391 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36392 true and &%local_from_check%& false for the current incoming message. The first
36393 of these allows an existing &'Sender:'& header in the message to remain, and
36394 the second suppresses the check to ensure that &'From:'& matches the
36395 authenticated sender. With this setting, Exim still fixes up messages by adding
36396 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36397 attempt to check sender authenticity in header lines.
36398
36399 When &%sender_retain%& is not set, a submission mode setting may specify a
36400 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36401 example:
36402 .code
36403 control = submission/domain=some.domain
36404 .endd
36405 The domain may be empty. How this value is used is described in sections
36406 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36407 that allows you to specify the user's full name for inclusion in a created
36408 &'Sender:'& or &'From:'& header line. For example:
36409 .code
36410 accept authenticated = *
36411        control = submission/domain=wonderland.example/\
36412                             name=${lookup {$authenticated_id} \
36413                                    lsearch {/etc/exim/namelist}}
36414 .endd
36415 Because the name may contain any characters, including slashes, the &%name%&
36416 option must be given last. The remainder of the string is used as the name. For
36417 the example above, if &_/etc/exim/namelist_& contains:
36418 .code
36419 bigegg:  Humpty Dumpty
36420 .endd
36421 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36422 line would be:
36423 .code
36424 Sender: Humpty Dumpty <bigegg@wonderland.example>
36425 .endd
36426 .cindex "return path" "in submission mode"
36427 By default, submission mode forces the return path to the same address as is
36428 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36429 specified, the return path is also left unchanged.
36430
36431 &*Note*&: The changes caused by submission mode take effect after the predata
36432 ACL. This means that any sender checks performed before the fix-ups use the
36433 untrusted sender address specified by the user, not the trusted sender address
36434 specified by submission mode. Although this might be slightly unexpected, it
36435 does mean that you can configure ACL checks to spot that a user is trying to
36436 spoof another's address.
36437
36438 .section "Line endings" "SECTlineendings"
36439 .cindex "line endings"
36440 .cindex "carriage return"
36441 .cindex "linefeed"
36442 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36443 linefeed) is the line ending for messages transmitted over the Internet using
36444 SMTP over TCP/IP. However, within individual operating systems, different
36445 conventions are used. For example, Unix-like systems use just LF, but others
36446 use CRLF or just CR.
36447
36448 Exim was designed for Unix-like systems, and internally, it stores messages
36449 using the system's convention of a single LF as a line terminator. When
36450 receiving a message, all line endings are translated to this standard format.
36451 Originally, it was thought that programs that passed messages directly to an
36452 MTA within an operating system would use that system's convention. Experience
36453 has shown that this is not the case; for example, there are Unix applications
36454 that use CRLF in this circumstance. For this reason, and for compatibility with
36455 other MTAs, the way Exim handles line endings for all messages is now as
36456 follows:
36457
36458 .ilist
36459 LF not preceded by CR is treated as a line ending.
36460 .next
36461 CR is treated as a line ending; if it is immediately followed by LF, the LF
36462 is ignored.
36463 .next
36464 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36465 nor a local message in the state where a line containing only a dot is a
36466 terminator.
36467 .next
36468 If a bare CR is encountered within a header line, an extra space is added after
36469 the line terminator so as not to end the header line. The reasoning behind this
36470 is that bare CRs in header lines are most likely either to be mistakes, or
36471 people trying to play silly games.
36472 .next
36473 If the first header line received in a message ends with CRLF, a subsequent
36474 bare LF in a header line is treated in the same way as a bare CR in a header
36475 line.
36476 .endlist
36477
36478
36479
36480
36481
36482 .section "Unqualified addresses" "SECID218"
36483 .cindex "unqualified addresses"
36484 .cindex "address" "qualification"
36485 By default, Exim expects every envelope address it receives from an external
36486 host to be fully qualified. Unqualified addresses cause negative responses to
36487 SMTP commands. However, because SMTP is used as a means of transporting
36488 messages from MUAs running on personal workstations, there is sometimes a
36489 requirement to accept unqualified addresses from specific hosts or IP networks.
36490
36491 Exim has two options that separately control which hosts may send unqualified
36492 sender or recipient addresses in SMTP commands, namely
36493 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36494 cases, if an unqualified address is accepted, it is qualified by adding the
36495 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36496
36497 .oindex "&%qualify_domain%&"
36498 .oindex "&%qualify_recipient%&"
36499 Unqualified addresses in header lines are automatically qualified for messages
36500 that are locally originated, unless the &%-bnq%& option is given on the command
36501 line. For messages received over SMTP, unqualified addresses in header lines
36502 are qualified only if unqualified addresses are permitted in SMTP commands. In
36503 other words, such qualification is also controlled by
36504 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36505
36506
36507
36508
36509 .section "The UUCP From line" "SECID219"
36510 .cindex "&""From""& line"
36511 .cindex "UUCP" "&""From""& line"
36512 .cindex "sender" "address"
36513 .oindex "&%uucp_from_pattern%&"
36514 .oindex "&%uucp_from_sender%&"
36515 .cindex "envelope from"
36516 .cindex "envelope sender"
36517 .cindex "Sendmail compatibility" "&""From""& line"
36518 Messages that have come from UUCP (and some other applications) often begin
36519 with a line containing the envelope sender and a timestamp, following the word
36520 &"From"&. Examples of two common formats are:
36521 .code
36522 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36523 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36524 .endd
36525 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36526 Exim recognizes such lines at the start of messages that are submitted to it
36527 via the command line (that is, on the standard input). It does not recognize
36528 such lines in incoming SMTP messages, unless the sending host matches
36529 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36530 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36531 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36532 default value matches the two common cases shown above and puts the address
36533 that follows &"From"& into &$1$&.
36534
36535 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36536 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36537 a trusted user, the message's sender address is constructed by expanding the
36538 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36539 then parsed as an RFC 2822 address. If there is no domain, the local part is
36540 qualified with &%qualify_domain%& unless it is the empty string. However, if
36541 the command line &%-f%& option is used, it overrides the &"From"& line.
36542
36543 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36544 sender address is not changed. This is also the case for incoming SMTP messages
36545 that are permitted to contain &"From"& lines.
36546
36547 Only one &"From"& line is recognized. If there is more than one, the second is
36548 treated as a data line that starts the body of the message, as it is not valid
36549 as a header line. This also happens if a &"From"& line is present in an
36550 incoming SMTP message from a source that is not permitted to send them.
36551
36552
36553
36554 .section "Header lines"
36555 .subsection "Resent- header lines" SECID220
36556 .chindex Resent-
36557 RFC 2822 makes provision for sets of header lines starting with the string
36558 &`Resent-`& to be added to a message when it is resent by the original
36559 recipient to somebody else. These headers are &'Resent-Date:'&,
36560 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36561 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36562
36563 .blockquote
36564 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36565 processing of replies or other such automatic actions on messages.'&
36566 .endblockquote
36567
36568 This leaves things a bit vague as far as other processing actions such as
36569 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36570 follows:
36571
36572 .ilist
36573 A &'Resent-From:'& line that just contains the login id of the submitting user
36574 is automatically rewritten in the same way as &'From:'& (see below).
36575 .next
36576 If there's a rewriting rule for a particular header line, it is also applied to
36577 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36578 &'From:'& also rewrites &'Resent-From:'&.
36579 .next
36580 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36581 also removed.
36582 .next
36583 For a locally-submitted message,
36584 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36585 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36586 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36587 included in log lines in this case.
36588 .next
36589 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36590 &%Resent-%& header lines are present.
36591 .endlist
36592
36593
36594
36595
36596 .subsection Auto-Submitted: SECID221
36597 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36598 includes the header line:
36599 .code
36600 Auto-Submitted: auto-replied
36601 .endd
36602
36603 .subsection Bcc: SECID222
36604 .cindex "&'Bcc:'& header line"
36605 If Exim is called with the &%-t%& option, to take recipient addresses from a
36606 message's header, it removes any &'Bcc:'& header line that may exist (after
36607 extracting its addresses). If &%-t%& is not present on the command line, any
36608 existing &'Bcc:'& is not removed.
36609
36610
36611 .subsection Date: SECID223
36612 .cindex Date:
36613 If a locally-generated or submission-mode message has no &'Date:'& header line,
36614 Exim adds one, using the current date and time, unless the
36615 &%suppress_local_fixups%& control has been specified.
36616
36617 .subsection Delivery-date: SECID224
36618 .cindex "&'Delivery-date:'& header line"
36619 .oindex "&%delivery_date_remove%&"
36620 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36621 set. Exim can be configured to add them to the final delivery of messages. (See
36622 the generic &%delivery_date_add%& transport option.) They should not be present
36623 in messages in transit. If the &%delivery_date_remove%& configuration option is
36624 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36625 messages.
36626
36627
36628 .subsection Envelope-to: SECID225
36629 .chindex Envelope-to:
36630 .oindex "&%envelope_to_remove%&"
36631 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36632 Exim can be configured to add them to the final delivery of messages. (See the
36633 generic &%envelope_to_add%& transport option.) They should not be present in
36634 messages in transit. If the &%envelope_to_remove%& configuration option is set
36635 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36636 messages.
36637
36638
36639 .subsection From: SECTthefrohea
36640 .chindex From:
36641 .cindex "Sendmail compatibility" "&""From""& line"
36642 .cindex "message" "submission"
36643 .cindex "submission mode"
36644 If a submission-mode message does not contain a &'From:'& header line, Exim
36645 adds one if either of the following conditions is true:
36646
36647 .ilist
36648 The envelope sender address is not empty (that is, this is not a bounce
36649 message). The added header line copies the envelope sender address.
36650 .next
36651 .vindex "&$authenticated_id$&"
36652 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36653 .olist
36654 .vindex "&$qualify_domain$&"
36655 If no domain is specified by the submission control, the local part is
36656 &$authenticated_id$& and the domain is &$qualify_domain$&.
36657 .next
36658 If a non-empty domain is specified by the submission control, the local
36659 part is &$authenticated_id$&, and the domain is the specified domain.
36660 .next
36661 If an empty domain is specified by the submission control,
36662 &$authenticated_id$& is assumed to be the complete address.
36663 .endlist
36664 .endlist
36665
36666 A non-empty envelope sender takes precedence.
36667
36668 If a locally-generated incoming message does not contain a &'From:'& header
36669 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36670 containing the sender's address. The calling user's login name and full name
36671 are used to construct the address, as described in section &<<SECTconstr>>&.
36672 They are obtained from the password data by calling &[getpwuid()]& (but see the
36673 &%unknown_login%& configuration option). The address is qualified with
36674 &%qualify_domain%&.
36675
36676 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36677 &'From:'& header line containing just the unqualified login name of the calling
36678 user, this is replaced by an address containing the user's login name and full
36679 name as described in section &<<SECTconstr>>&.
36680
36681
36682 .subsection Message-ID: SECID226
36683 .chindex Message-ID:
36684 .cindex "message" "submission"
36685 .oindex "&%message_id_header_text%&"
36686 If a locally-generated or submission-mode incoming message does not contain a
36687 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36688 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36689 to the message. If there are any &'Resent-:'& headers in the message, it
36690 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36691 message id, preceded by the letter E to ensure it starts with a letter, and
36692 followed by @ and the primary host name. Additional information can be included
36693 in this header line by setting the &%message_id_header_text%& and/or
36694 &%message_id_header_domain%& options.
36695
36696
36697 .subsection Received: SECID227
36698 .chindex Received:
36699 A &'Received:'& header line is added at the start of every message. The
36700 contents are defined by the &%received_header_text%& configuration option, and
36701 Exim automatically adds a semicolon and a timestamp to the configured string.
36702
36703 The &'Received:'& header is generated as soon as the message's header lines
36704 have been received. At this stage, the timestamp in the &'Received:'& header
36705 line is the time that the message started to be received. This is the value
36706 that is seen by the DATA ACL and by the &[local_scan()]& function.
36707
36708 Once a message is accepted, the timestamp in the &'Received:'& header line is
36709 changed to the time of acceptance, which is (apart from a small delay while the
36710 -H spool file is written) the earliest time at which delivery could start.
36711
36712
36713 .subsection References: SECID228
36714 .chindex References:
36715 Messages created by the &(autoreply)& transport include a &'References:'&
36716 header line. This is constructed according to the rules that are described in
36717 section 3.64 of RFC 2822 (which states that replies should contain such a
36718 header line), and section 3.14 of RFC 3834 (which states that automatic
36719 responses are not different in this respect). However, because some mail
36720 processing software does not cope well with very long header lines, no more
36721 than 12 message IDs are copied from the &'References:'& header line in the
36722 incoming message. If there are more than 12, the first one and then the final
36723 11 are copied, before adding the message ID of the incoming message.
36724
36725
36726
36727 .subsection Return-path: SECID229
36728 .chindex Return-path:
36729 .oindex "&%return_path_remove%&"
36730 &'Return-path:'& header lines are defined as something an MTA may insert when
36731 it does the final delivery of messages. (See the generic &%return_path_add%&
36732 transport option.) Therefore, they should not be present in messages in
36733 transit. If the &%return_path_remove%& configuration option is set (the
36734 default), Exim removes &'Return-path:'& header lines from incoming messages.
36735
36736
36737
36738 .subsection Sender: SECTthesenhea
36739 .cindex "&'Sender:'& header line"
36740 .cindex "message" "submission"
36741 .chindex Sender:
36742 For a locally-originated message from an untrusted user, Exim may remove an
36743 existing &'Sender:'& header line, and it may add a new one. You can modify
36744 these actions by setting the &%local_sender_retain%& option true, the
36745 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36746 control setting.
36747
36748 When a local message is received from an untrusted user and
36749 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36750 control has not been set, a check is made to see if the address given in the
36751 &'From:'& header line is the correct (local) sender of the message. The address
36752 that is expected has the login name as the local part and the value of
36753 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36754 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36755 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36756 line is added to the message.
36757
36758 If you set &%local_from_check%& false, this checking does not occur. However,
36759 the removal of an existing &'Sender:'& line still happens, unless you also set
36760 &%local_sender_retain%& to be true. It is not possible to set both of these
36761 options true at the same time.
36762
36763 .cindex "submission mode"
36764 By default, no processing of &'Sender:'& header lines is done for messages
36765 received over TCP/IP or for messages submitted by trusted users. However, when
36766 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36767 not specified on the submission control, the following processing takes place:
36768
36769 .vindex "&$authenticated_id$&"
36770 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36771 authenticated, and &$authenticated_id$& is not empty, a sender address is
36772 created as follows:
36773
36774 .ilist
36775 .vindex "&$qualify_domain$&"
36776 If no domain is specified by the submission control, the local part is
36777 &$authenticated_id$& and the domain is &$qualify_domain$&.
36778 .next
36779 If a non-empty domain is specified by the submission control, the local part
36780 is &$authenticated_id$&, and the domain is the specified domain.
36781 .next
36782 If an empty domain is specified by the submission control,
36783 &$authenticated_id$& is assumed to be the complete address.
36784 .endlist
36785
36786 This address is compared with the address in the &'From:'& header line. If they
36787 are different, a &'Sender:'& header line containing the created address is
36788 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36789 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36790
36791 .cindex "return path" "created from &'Sender:'&"
36792 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36793 the message (the envelope sender address) is changed to be the same address,
36794 except in the case of submission mode when &%sender_retain%& is specified.
36795
36796
36797
36798 .section "Adding and removing header lines in routers and transports" &&&
36799          "SECTheadersaddrem"
36800 .cindex "header lines" "adding; in router or transport"
36801 .cindex "header lines" "removing; in router or transport"
36802 When a message is delivered, the addition and removal of header lines can be
36803 specified in a system filter, or on any of the routers and transports that
36804 process the message. Section &<<SECTaddremheasys>>& contains details about
36805 modifying headers in a system filter. Header lines can also be added in an ACL
36806 as a message is received (see section &<<SECTaddheadacl>>&).
36807
36808 In contrast to what happens in a system filter, header modifications that are
36809 specified on routers and transports apply only to the particular recipient
36810 addresses that are being processed by those routers and transports. These
36811 changes do not actually take place until a copy of the message is being
36812 transported. Therefore, they do not affect the basic set of header lines, and
36813 they do not affect the values of the variables that refer to header lines.
36814
36815 &*Note*&: In particular, this means that any expansions in the configuration of
36816 the transport cannot refer to the modified header lines, because such
36817 expansions all occur before the message is actually transported.
36818
36819 For both routers and transports, the argument of a &%headers_add%&
36820 option must be in the form of one or more RFC 2822 header lines, separated by
36821 newlines (coded as &"\n"&). For example:
36822 .code
36823 headers_add = X-added-header: added by $primary_hostname\n\
36824               X-added-second: another added header line
36825 .endd
36826 Exim does not check the syntax of these added header lines.
36827
36828 Multiple &%headers_add%& options for a single router or transport can be
36829 specified; the values will append to a single list of header lines.
36830 Each header-line is separately expanded.
36831
36832 The argument of a &%headers_remove%& option must consist of a colon-separated
36833 list of header names. This is confusing, because header names themselves are
36834 often terminated by colons. In this case, the colons are the list separators,
36835 not part of the names. For example:
36836 .code
36837 headers_remove = return-receipt-to:acknowledge-to
36838 .endd
36839
36840 Multiple &%headers_remove%& options for a single router or transport can be
36841 specified; the arguments will append to a single header-names list.
36842 Each item is separately expanded.
36843 Note that colons in complex expansions which are used to
36844 form all or part of a &%headers_remove%& list
36845 will act as list separators.
36846
36847 When &%headers_add%& or &%headers_remove%& is specified on a router,
36848 items are expanded at routing time,
36849 and then associated with all addresses that are
36850 accepted by that router, and also with any new addresses that it generates. If
36851 an address passes through several routers as a result of aliasing or
36852 forwarding, the changes are cumulative.
36853
36854 .oindex "&%unseen%&"
36855 However, this does not apply to multiple routers that result from the use of
36856 the &%unseen%& option. Any header modifications that were specified by the
36857 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36858
36859 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36860 settings cannot be delivered together in a batch, so a transport is always
36861 dealing with a set of addresses that have the same header-processing
36862 requirements.
36863
36864 The transport starts by writing the original set of header lines that arrived
36865 with the message, possibly modified by the system filter. As it writes out
36866 these lines, it consults the list of header names that were attached to the
36867 recipient address(es) by &%headers_remove%& options in routers, and it also
36868 consults the transport's own &%headers_remove%& option. Header lines whose
36869 names are on either of these lists are not written out. If there are multiple
36870 instances of any listed header, they are all skipped.
36871
36872 After the remaining original header lines have been written, new header
36873 lines that were specified by routers' &%headers_add%& options are written, in
36874 the order in which they were attached to the address. These are followed by any
36875 header lines specified by the transport's &%headers_add%& option.
36876
36877 This way of handling header line modifications in routers and transports has
36878 the following consequences:
36879
36880 .ilist
36881 The original set of header lines, possibly modified by the system filter,
36882 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36883 to it, at all times.
36884 .next
36885 Header lines that are added by a router's
36886 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36887 expansion syntax in subsequent routers or the transport.
36888 .next
36889 Conversely, header lines that are specified for removal by &%headers_remove%&
36890 in a router remain visible to subsequent routers and the transport.
36891 .next
36892 Headers added to an address by &%headers_add%& in a router cannot be removed by
36893 a later router or by a transport.
36894 .next
36895 An added header can refer to the contents of an original header that is to be
36896 removed, even it has the same name as the added header. For example:
36897 .code
36898 headers_remove = subject
36899 headers_add = Subject: new subject (was: $h_subject:)
36900 .endd
36901 .endlist
36902
36903 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36904 for a &(redirect)& router that has the &%one_time%& option set.
36905
36906
36907
36908
36909
36910 .section "Constructed addresses" "SECTconstr"
36911 .cindex "address" "constructed"
36912 .cindex "constructed address"
36913 When Exim constructs a sender address for a locally-generated message, it uses
36914 the form
36915 .display
36916 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36917 .endd
36918 For example:
36919 .code
36920 Zaphod Beeblebrox <zaphod@end.univ.example>
36921 .endd
36922 The user name is obtained from the &%-F%& command line option if set, or
36923 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36924 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36925 ampersand character, this is replaced by the login name with the first letter
36926 upper cased, as is conventional in a number of operating systems. See the
36927 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36928 The &%unknown_username%& option can be used to specify user names in cases when
36929 there is no password file entry.
36930
36931 .cindex "RFC 2047"
36932 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36933 parts of it if necessary. In addition, if it contains any non-printing
36934 characters, it is encoded as described in RFC 2047, which defines a way of
36935 including non-ASCII characters in header lines. The value of the
36936 &%headers_charset%& option specifies the name of the encoding that is used (the
36937 characters are assumed to be in this encoding). The setting of
36938 &%print_topbitchars%& controls whether characters with the top bit set (that
36939 is, with codes greater than 127) count as printing characters or not.
36940
36941
36942
36943 .section "Case of local parts" "SECID230"
36944 .cindex "case of local parts"
36945 .cindex "local part" "case of"
36946 RFC 2822 states that the case of letters in the local parts of addresses cannot
36947 be assumed to be non-significant. Exim preserves the case of local parts of
36948 addresses, but by default it uses a lower-cased form when it is routing,
36949 because on most Unix systems, usernames are in lower case and case-insensitive
36950 routing is required. However, any particular router can be made to use the
36951 original case for local parts by setting the &%caseful_local_part%& generic
36952 router option.
36953
36954 .cindex "mixed-case login names"
36955 If you must have mixed-case user names on your system, the best way to proceed,
36956 assuming you want case-independent handling of incoming email, is to set up
36957 your first router to convert incoming local parts in your domains to the
36958 correct case by means of a file lookup. For example:
36959 .code
36960 correct_case:
36961   driver = redirect
36962   domains = +local_domains
36963   data = ${lookup{$local_part}cdb\
36964               {/etc/usercased.cdb}{$value}fail}\
36965               @$domain
36966 .endd
36967 For this router, the local part is forced to lower case by the default action
36968 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36969 up a new local part in the correct case. If you then set &%caseful_local_part%&
36970 on any subsequent routers which process your domains, they will operate on
36971 local parts with the correct case in a case-sensitive manner.
36972
36973
36974
36975 .section "Dots in local parts" "SECID231"
36976 .cindex "dot" "in local part"
36977 .cindex "local part" "dots in"
36978 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36979 part may not begin or end with a dot, nor have two consecutive dots in the
36980 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36981 empty components for compatibility.
36982
36983
36984
36985 .section "Rewriting addresses" "SECID232"
36986 .cindex "rewriting" "addresses"
36987 Rewriting of sender and recipient addresses, and addresses in headers, can
36988 happen automatically, or as the result of configuration options, as described
36989 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36990 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36991
36992 Automatic rewriting includes qualification, as mentioned above. The other case
36993 in which it can happen is when an incomplete non-local domain is given. The
36994 routing process may cause this to be expanded into the full domain name. For
36995 example, a header such as
36996 .code
36997 To: hare@teaparty
36998 .endd
36999 might get rewritten as
37000 .code
37001 To: hare@teaparty.wonderland.fict.example
37002 .endd
37003 Rewriting as a result of routing is the one kind of message processing that
37004 does not happen at input time, as it cannot be done until the address has
37005 been routed.
37006
37007 Strictly, one should not do &'any'& deliveries of a message until all its
37008 addresses have been routed, in case any of the headers get changed as a
37009 result of routing. However, doing this in practice would hold up many
37010 deliveries for unreasonable amounts of time, just because one address could not
37011 immediately be routed. Exim therefore does not delay other deliveries when
37012 routing of one or more addresses is deferred.
37013 .ecindex IIDmesproc
37014
37015
37016
37017 . ////////////////////////////////////////////////////////////////////////////
37018 . ////////////////////////////////////////////////////////////////////////////
37019
37020 .chapter "SMTP processing" "CHAPSMTP"
37021 .scindex IIDsmtpproc1 "SMTP" "processing details"
37022 .scindex IIDsmtpproc2 "LMTP" "processing details"
37023 Exim supports a number of different ways of using the SMTP protocol, and its
37024 LMTP variant, which is an interactive protocol for transferring messages into a
37025 closed mail store application. This chapter contains details of how SMTP is
37026 processed. For incoming mail, the following are available:
37027
37028 .ilist
37029 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37030 .next
37031 SMTP over the standard input and output (the &%-bs%& option);
37032 .next
37033 Batched SMTP on the standard input (the &%-bS%& option).
37034 .endlist
37035
37036 For mail delivery, the following are available:
37037
37038 .ilist
37039 SMTP over TCP/IP (the &(smtp)& transport);
37040 .next
37041 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37042 &"lmtp"&);
37043 .next
37044 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37045 transport);
37046 .next
37047 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37048 the &%use_bsmtp%& option set).
37049 .endlist
37050
37051 &'Batched SMTP'& is the name for a process in which batches of messages are
37052 stored in or read from files (or pipes), in a format in which SMTP commands are
37053 used to contain the envelope information.
37054
37055
37056
37057 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37058 .cindex "SMTP" "outgoing over TCP/IP"
37059 .cindex "outgoing SMTP over TCP/IP"
37060 .cindex "LMTP" "over TCP/IP"
37061 .cindex "outgoing LMTP over TCP/IP"
37062 .cindex "EHLO"
37063 .cindex "HELO"
37064 .cindex "SIZE" "option on MAIL command"
37065 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37066 The &%protocol%& option selects which protocol is to be used, but the actual
37067 processing is the same in both cases.
37068
37069 .cindex "ESMTP extensions" SIZE
37070 If, in response to its EHLO command, Exim is told that the SIZE
37071 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37072 command. The value of <&'n'&> is the message size plus the value of the
37073 &%size_addition%& option (default 1024) to allow for additions to the message
37074 such as per-transport header lines, or changes made in a
37075 .cindex "transport" "filter"
37076 .cindex "filter" "transport filter"
37077 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37078 suppressed.
37079
37080 If the remote server advertises support for PIPELINING, Exim uses the
37081 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37082 required for the transaction.
37083
37084 If the remote server advertises support for the STARTTLS command, and Exim
37085 was built to support TLS encryption, it tries to start a TLS session unless the
37086 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37087 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37088 is called for verification.
37089
37090 If the remote server advertises support for the AUTH command, Exim scans
37091 the authenticators configuration for any suitable client settings, as described
37092 in chapter &<<CHAPSMTPAUTH>>&.
37093
37094 .cindex "carriage return"
37095 .cindex "linefeed"
37096 Responses from the remote host are supposed to be terminated by CR followed by
37097 LF. However, there are known to be hosts that do not send CR characters, so in
37098 order to be able to interwork with such hosts, Exim treats LF on its own as a
37099 line terminator.
37100
37101 If a message contains a number of different addresses, all those with the same
37102 characteristics (for example, the same envelope sender) that resolve to the
37103 same set of hosts, in the same order, are sent in a single SMTP transaction,
37104 even if they are for different domains, unless there are more than the setting
37105 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37106 they are split into groups containing no more than &%max_rcpt%&s addresses
37107 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37108 in parallel sessions. The order of hosts with identical MX values is not
37109 significant when checking whether addresses can be batched in this way.
37110
37111 When the &(smtp)& transport suffers a temporary failure that is not
37112 message-related, Exim updates its transport-specific database, which contains
37113 records indexed by host name that remember which messages are waiting for each
37114 particular host. It also updates the retry database with new retry times.
37115
37116 .cindex "hints database" "retry keys"
37117 Exim's retry hints are based on host name plus IP address, so if one address of
37118 a multi-homed host is broken, it will soon be skipped most of the time.
37119 See the next section for more detail about error handling.
37120
37121 .cindex "SMTP" "passed connection"
37122 .cindex "SMTP" "batching over TCP/IP"
37123 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37124 looks in the hints database for the transport to see if there are any queued
37125 messages waiting for the host to which it is connected. If it finds one, it
37126 creates a new Exim process using the &%-MC%& option (which can only be used by
37127 a process running as root or the Exim user) and passes the TCP/IP socket to it
37128 so that it can deliver another message using the same socket. The new process
37129 does only those deliveries that are routed to the connected host, and may in
37130 turn pass the socket on to a third process, and so on.
37131
37132 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37133 limit the number of messages sent down a single TCP/IP connection.
37134
37135 .cindex "asterisk" "after IP address"
37136 The second and subsequent messages delivered down an existing connection are
37137 identified in the main log by the addition of an asterisk after the closing
37138 square bracket of the IP address.
37139
37140
37141
37142
37143 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37144 .cindex "error" "in outgoing SMTP"
37145 .cindex "SMTP" "errors in outgoing"
37146 .cindex "host" "error"
37147 Three different kinds of error are recognized for outgoing SMTP: host errors,
37148 message errors, and recipient errors.
37149
37150 .vlist
37151 .vitem "&*Host errors*&"
37152 A host error is not associated with a particular message or with a
37153 particular recipient of a message. The host errors are:
37154
37155 .ilist
37156 Connection refused or timed out,
37157 .next
37158 Any error response code on connection,
37159 .next
37160 Any error response code to EHLO or HELO,
37161 .next
37162 Loss of connection at any time, except after &"."&,
37163 .next
37164 I/O errors at any time,
37165 .next
37166 Timeouts during the session, other than in response to MAIL, RCPT or
37167 the &"."& at the end of the data.
37168 .endlist ilist
37169
37170 For a host error, a permanent error response on connection, or in response to
37171 EHLO, causes all addresses routed to the host to be failed. Any other host
37172 error causes all addresses to be deferred, and retry data to be created for the
37173 host. It is not tried again, for any message, until its retry time arrives. If
37174 the current set of addresses are not all delivered in this run (to some
37175 alternative host), the message is added to the list of those waiting for this
37176 host, so if it is still undelivered when a subsequent successful delivery is
37177 made to the host, it will be sent down the same SMTP connection.
37178
37179 .vitem "&*Message errors*&"
37180 .cindex "message" "error"
37181 A message error is associated with a particular message when sent to a
37182 particular host, but not with a particular recipient of the message. The
37183 message errors are:
37184
37185 .ilist
37186 Any error response code to MAIL, DATA, or the &"."& that terminates
37187 the data,
37188 .next
37189 Timeout after MAIL,
37190 .next
37191 Timeout or loss of connection after the &"."& that terminates the data. A
37192 timeout after the DATA command itself is treated as a host error, as is loss of
37193 connection at any other time.
37194 .endlist ilist
37195
37196 For a message error, a permanent error response (5&'xx'&) causes all addresses
37197 to be failed, and a delivery error report to be returned to the sender. A
37198 temporary error response (4&'xx'&), or one of the timeouts, causes all
37199 addresses to be deferred. Retry data is not created for the host, but instead,
37200 a retry record for the combination of host plus message id is created. The
37201 message is not added to the list of those waiting for this host. This ensures
37202 that the failing message will not be sent to this host again until the retry
37203 time arrives. However, other messages that are routed to the host are not
37204 affected, so if it is some property of the message that is causing the error,
37205 it will not stop the delivery of other mail.
37206
37207 If the remote host specified support for the SIZE parameter in its response
37208 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37209 over-large message will cause a message error because the error arrives as a
37210 response to MAIL.
37211
37212 .vitem "&*Recipient errors*&"
37213 .cindex "recipient" "error"
37214 A recipient error is associated with a particular recipient of a message. The
37215 recipient errors are:
37216
37217 .ilist
37218 Any error response to RCPT,
37219 .next
37220 Timeout after RCPT.
37221 .endlist
37222
37223 For a recipient error, a permanent error response (5&'xx'&) causes the
37224 recipient address to be failed, and a bounce message to be returned to the
37225 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37226 address to be deferred, and routing retry data to be created for it. This is
37227 used to delay processing of the address in subsequent queue runs, until its
37228 routing retry time arrives. This applies to all messages, but because it
37229 operates only in queue runs, one attempt will be made to deliver a new message
37230 to the failing address before the delay starts to operate. This ensures that,
37231 if the failure is really related to the message rather than the recipient
37232 (&"message too big for this recipient"& is a possible example), other messages
37233 have a chance of getting delivered. If a delivery to the address does succeed,
37234 the retry information gets cleared, so all stuck messages get tried again, and
37235 the retry clock is reset.
37236
37237 The message is not added to the list of those waiting for this host. Use of the
37238 host for other messages is unaffected, and except in the case of a timeout,
37239 other recipients are processed independently, and may be successfully delivered
37240 in the current SMTP session. After a timeout it is of course impossible to
37241 proceed with the session, so all addresses get deferred. However, those other
37242 than the one that failed do not suffer any subsequent retry delays. Therefore,
37243 if one recipient is causing trouble, the others have a chance of getting
37244 through when a subsequent delivery attempt occurs before the failing
37245 recipient's retry time.
37246 .endlist
37247
37248 In all cases, if there are other hosts (or IP addresses) available for the
37249 current set of addresses (for example, from multiple MX records), they are
37250 tried in this run for any undelivered addresses, subject of course to their
37251 own retry data. In other words, recipient error retry data does not take effect
37252 until the next delivery attempt.
37253
37254 Some hosts have been observed to give temporary error responses to every
37255 MAIL command at certain times (&"insufficient space"& has been seen). It
37256 would be nice if such circumstances could be recognized, and defer data for the
37257 host itself created, but this is not possible within the current Exim design.
37258 What actually happens is that retry data for every (host, message) combination
37259 is created.
37260
37261 The reason that timeouts after MAIL and RCPT are treated specially is that
37262 these can sometimes arise as a result of the remote host's verification
37263 procedures. Exim makes this assumption, and treats them as if a temporary error
37264 response had been received. A timeout after &"."& is treated specially because
37265 it is known that some broken implementations fail to recognize the end of the
37266 message if the last character of the last line is a binary zero. Thus, it is
37267 helpful to treat this case as a message error.
37268
37269 Timeouts at other times are treated as host errors, assuming a problem with the
37270 host, or the connection to it. If a timeout after MAIL, RCPT,
37271 or &"."& is really a connection problem, the assumption is that at the next try
37272 the timeout is likely to occur at some other point in the dialogue, causing it
37273 then to be treated as a host error.
37274
37275 There is experimental evidence that some MTAs drop the connection after the
37276 terminating &"."& if they do not like the contents of the message for some
37277 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37278 should be given. That is why Exim treats this case as a message rather than a
37279 host error, in order not to delay other messages to the same host.
37280
37281
37282
37283
37284 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37285 .cindex "SMTP" "incoming over TCP/IP"
37286 .cindex "incoming SMTP over TCP/IP"
37287 .cindex "inetd"
37288 .cindex "daemon"
37289 Incoming SMTP messages can be accepted in one of two ways: by running a
37290 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37291 &_/etc/inetd.conf_& should be like this:
37292 .code
37293 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37294 .endd
37295 Exim distinguishes between this case and the case of a locally running user
37296 agent using the &%-bs%& option by checking whether or not the standard input is
37297 a socket. When it is, either the port must be privileged (less than 1024), or
37298 the caller must be root or the Exim user. If any other user passes a socket
37299 with an unprivileged port number, Exim prints a message on the standard error
37300 stream and exits with an error code.
37301
37302 By default, Exim does not make a log entry when a remote host connects or
37303 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37304 unexpected. It can be made to write such log entries by setting the
37305 &%smtp_connection%& log selector.
37306
37307 .cindex "carriage return"
37308 .cindex "linefeed"
37309 Commands from the remote host are supposed to be terminated by CR followed by
37310 LF. However, there are known to be hosts that do not send CR characters. In
37311 order to be able to interwork with such hosts, Exim treats LF on its own as a
37312 line terminator.
37313 Furthermore, because common code is used for receiving messages from all
37314 sources, a CR on its own is also interpreted as a line terminator. However, the
37315 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37316
37317 .cindex "EHLO" "invalid data"
37318 .cindex "HELO" "invalid data"
37319 One area that sometimes gives rise to problems concerns the EHLO or
37320 HELO commands. Some clients send syntactically invalid versions of these
37321 commands, which Exim rejects by default. (This is nothing to do with verifying
37322 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37323 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37324 match the broken hosts that send invalid commands.
37325
37326 .cindex "SIZE option on MAIL command"
37327 .cindex "MAIL" "SIZE option"
37328 The amount of disk space available is checked whenever SIZE is received on
37329 a MAIL command, independently of whether &%message_size_limit%& or
37330 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37331 false. A temporary error is given if there is not enough space. If
37332 &%check_spool_space%& is set, the check is for that amount of space plus the
37333 value given with SIZE, that is, it checks that the addition of the incoming
37334 message will not reduce the space below the threshold.
37335
37336 When a message is successfully received, Exim includes the local message id in
37337 its response to the final &"."& that terminates the data. If the remote host
37338 logs this text it can help with tracing what has happened to a message.
37339
37340 The Exim daemon can limit the number of simultaneous incoming connections it is
37341 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37342 number of simultaneous incoming connections from a single remote host (see the
37343 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37344 rejected using the SMTP temporary error code 421.
37345
37346 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37347 subprocess has finished, as this can get lost at busy times. Instead, it looks
37348 for completed subprocesses every time it wakes up. Provided there are other
37349 things happening (new incoming calls, starts of queue runs), completed
37350 processes will be noticed and tidied away. On very quiet systems you may
37351 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37352 it will be noticed when the daemon next wakes up.
37353
37354 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37355 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37356 high system load &-- for details see the &%smtp_accept_reserve%&,
37357 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37358 applies in both the daemon and &'inetd'& cases.
37359
37360 Exim normally starts a delivery process for each message received, though this
37361 can be varied by means of the &%-odq%& command line option and the
37362 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37363 number of simultaneously running delivery processes started in this way from
37364 SMTP input can be limited by the &%smtp_accept_queue%& and
37365 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37366 subsequently received messages are just put on the input queue without starting
37367 a delivery process.
37368
37369 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37370 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37371 started up from the &'inetd'& daemon, because in that case each connection is
37372 handled by an entirely independent Exim process. Control by load average is,
37373 however, available with &'inetd'&.
37374
37375 Exim can be configured to verify addresses in incoming SMTP commands as they
37376 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37377 to rewrite addresses at this time &-- before any syntax checking is done. See
37378 section &<<SSECTrewriteS>>&.
37379
37380 Exim can also be configured to limit the rate at which a client host submits
37381 MAIL and RCPT commands in a single SMTP session. See the
37382 &%smtp_ratelimit_hosts%& option.
37383
37384
37385
37386 .subsection "Unrecognized SMTP commands" SECID234
37387 .cindex "SMTP" "unrecognized commands"
37388 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37389 commands during a single SMTP connection, it drops the connection after sending
37390 the error response to the last command. The default value for
37391 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37392 abuse that subvert web servers into making connections to SMTP ports; in these
37393 circumstances, a number of non-SMTP lines are sent first.
37394
37395
37396 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37397 .cindex "SMTP" "syntax errors"
37398 .cindex "SMTP" "protocol errors"
37399 A syntax error is detected if an SMTP command is recognized, but there is
37400 something syntactically wrong with its data, for example, a malformed email
37401 address in a RCPT command. Protocol errors include invalid command
37402 sequencing such as RCPT before MAIL. If Exim receives more than
37403 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37404 drops the connection after sending the error response to the last command. The
37405 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37406 broken clients that loop sending bad commands (yes, it has been seen).
37407
37408
37409
37410 .subsection "Use of non-mail SMTP commands" SECID236
37411 .cindex "SMTP" "non-mail commands"
37412 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37413 DATA. Exim counts such commands, and drops the connection if there are too
37414 many of them in a single SMTP session. This action catches some
37415 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37416 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37417 defines what &"too many"& means. Its default value is 10.
37418
37419 When a new message is expected, one occurrence of RSET is not counted. This
37420 allows a client to send one RSET between messages (this is not necessary,
37421 but some clients do it). Exim also allows one uncounted occurrence of HELO
37422 or EHLO, and one occurrence of STARTTLS between messages. After
37423 starting up a TLS session, another EHLO is expected, and so it too is not
37424 counted.
37425
37426 The first occurrence of AUTH in a connection, or immediately following
37427 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37428 RCPT, DATA, and QUIT are counted.
37429
37430 You can control which hosts are subject to the limit set by
37431 &%smtp_accept_max_nonmail%& by setting
37432 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37433 the limit apply to all hosts. This option means that you can exclude any
37434 specific badly-behaved hosts that you have to live with.
37435
37436
37437
37438
37439 .subsection "The VRFY and EXPN commands" SECID237
37440 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37441 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37442 appropriate) in order to decide whether the command should be accepted or not.
37443
37444 .cindex "VRFY" "processing"
37445 When no ACL is defined for VRFY, or if it rejects without
37446 setting an explicit response code, the command is accepted
37447 (with a 252 SMTP response code)
37448 in order to support awkward clients that do a VRFY before every RCPT.
37449 When VRFY is accepted, it runs exactly the same code as when Exim is
37450 called with the &%-bv%& option, and returns 250/451/550
37451 SMTP response codes.
37452
37453 .cindex "EXPN" "processing"
37454 If no ACL for EXPN is defined, the command is rejected.
37455 When EXPN is accepted, a single-level expansion of the address is done.
37456 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37457 than a verification (the &%-bv%& option). If an unqualified local part is given
37458 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37459 of VRFY and EXPN commands are logged on the main and reject logs, and
37460 VRFY verification failures are logged in the main log for consistency with
37461 RCPT failures.
37462
37463
37464
37465 .subsection "The ETRN command" SECTETRN
37466 .cindex "ETRN" "processing"
37467 .cindex "ESMTP extensions" ETRN
37468 RFC 1985 describes an ESMTP command called ETRN that is designed to
37469 overcome the security problems of the TURN command (which has fallen into
37470 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37471 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37472 should be accepted or not. If no ACL is defined, the command is rejected.
37473
37474 The ETRN command is concerned with &"releasing"& messages that are awaiting
37475 delivery to certain hosts. As Exim does not organize its message queue by host,
37476 the only form of ETRN that is supported by default is the one where the
37477 text starts with the &"#"& prefix, in which case the remainder of the text is
37478 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37479 the &%-R%& option to happen, with the remainder of the ETRN text as its
37480 argument. For example,
37481 .code
37482 ETRN #brigadoon
37483 .endd
37484 runs the command
37485 .code
37486 exim -R brigadoon
37487 .endd
37488 which causes a delivery attempt on all messages with undelivered addresses
37489 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37490 default), Exim prevents the simultaneous execution of more than one queue run
37491 for the same argument string as a result of an ETRN command. This stops
37492 a misbehaving client from starting more than one queue runner at once.
37493
37494 .cindex "hints database" "ETRN serialization"
37495 Exim implements the serialization by means of a hints database in which a
37496 record is written whenever a process is started by ETRN, and deleted when
37497 the process completes. However, Exim does not keep the SMTP session waiting for
37498 the ETRN process to complete. Once ETRN is accepted, the client is sent
37499 a &"success"& return code. Obviously there is scope for hints records to get
37500 left lying around if there is a system or program crash. To guard against this,
37501 Exim ignores any records that are more than six hours old.
37502
37503 .oindex "&%smtp_etrn_command%&"
37504 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37505 used. This specifies a command that is run whenever ETRN is received,
37506 whatever the form of its argument. For
37507 example:
37508 .code
37509 smtp_etrn_command = /etc/etrn_command $domain \
37510                     $sender_host_address
37511 .endd
37512 .vindex "&$domain$&"
37513 The string is split up into arguments which are independently expanded. The
37514 expansion variable &$domain$& is set to the argument of the ETRN command,
37515 and no syntax checking is done on the contents of this argument. Exim does not
37516 wait for the command to complete, so its status code is not checked. Exim runs
37517 under its own uid and gid when receiving incoming SMTP, so it is not possible
37518 for it to change them before running the command.
37519
37520
37521
37522 .section "Incoming local SMTP" "SECID238"
37523 .cindex "SMTP" "local incoming"
37524 Some user agents use SMTP to pass messages to their local MTA using the
37525 standard input and output, as opposed to passing the envelope on the command
37526 line and writing the message to the standard input. This is supported by the
37527 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37528 messages over TCP/IP (including the use of ACLs), except that the envelope
37529 sender given in a MAIL command is ignored unless the caller is trusted. In
37530 an ACL you can detect this form of SMTP input by testing for an empty host
37531 identification. It is common to have this as the first line in the ACL that
37532 runs for RCPT commands:
37533 .code
37534 accept hosts = :
37535 .endd
37536 This accepts SMTP messages from local processes without doing any other tests.
37537
37538
37539
37540 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37541 .cindex "SMTP" "batched outgoing"
37542 .cindex "batched SMTP output"
37543 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37544 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37545 be output in BSMTP format. No SMTP responses are possible for this form of
37546 delivery. All it is doing is using SMTP commands as a way of transmitting the
37547 envelope along with the message.
37548
37549 The message is written to the file or pipe preceded by the SMTP commands
37550 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37551 the message that start with a dot have an extra dot added. The SMTP command
37552 HELO is not normally used. If it is required, the &%message_prefix%& option
37553 can be used to specify it.
37554
37555 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37556 one recipient address at a time by default. However, you can arrange for them
37557 to handle several addresses at once by setting the &%batch_max%& option. When
37558 this is done for BSMTP, messages may contain multiple RCPT commands. See
37559 chapter &<<CHAPbatching>>& for more details.
37560
37561 .vindex "&$host$&"
37562 When one or more addresses are routed to a BSMTP transport by a router that
37563 sets up a host list, the name of the first host on the list is available to the
37564 transport in the variable &$host$&. Here is an example of such a transport and
37565 router:
37566 .code
37567 begin routers
37568 route_append:
37569   driver = manualroute
37570   transport = smtp_appendfile
37571   route_list = domain.example  batch.host.example
37572
37573 begin transports
37574 smtp_appendfile:
37575   driver = appendfile
37576   directory = /var/bsmtp/$host
37577   batch_max = 1000
37578   use_bsmtp
37579   user = exim
37580 .endd
37581 This causes messages addressed to &'domain.example'& to be written in BSMTP
37582 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37583 message (unless there are more than 1000 recipients).
37584
37585
37586
37587 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37588 .cindex "SMTP" "batched incoming"
37589 .cindex "batched SMTP input"
37590 The &%-bS%& command line option causes Exim to accept one or more messages by
37591 reading SMTP on the standard input, but to generate no responses. If the caller
37592 is trusted, the senders in the MAIL commands are believed; otherwise the
37593 sender is always the caller of Exim. Unqualified senders and receivers are not
37594 rejected (there seems little point) but instead just get qualified. HELO
37595 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37596 as NOOP; QUIT quits.
37597
37598 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37599 ACL is run in the same way as for non-SMTP local input.
37600
37601 If an error is detected while reading a message, including a missing &"."& at
37602 the end, Exim gives up immediately. It writes details of the error to the
37603 standard output in a stylized way that the calling program should be able to
37604 make some use of automatically, for example:
37605 .code
37606 554 Unexpected end of file
37607 Transaction started in line 10
37608 Error detected in line 14
37609 .endd
37610 It writes a more verbose version, for human consumption, to the standard error
37611 file, for example:
37612 .code
37613 An error was detected while processing a file of BSMTP input.
37614 The error message was:
37615
37616 501 '>' missing at end of address
37617
37618 The SMTP transaction started in line 10.
37619 The error was detected in line 12.
37620 The SMTP command at fault was:
37621
37622 rcpt to:<malformed@in.com.plete
37623
37624 1 previous message was successfully processed.
37625 The rest of the batch was abandoned.
37626 .endd
37627 The return code from Exim is zero only if there were no errors. It is 1 if some
37628 messages were accepted before an error was detected, and 2 if no messages were
37629 accepted.
37630 .ecindex IIDsmtpproc1
37631 .ecindex IIDsmtpproc2
37632
37633
37634
37635 . ////////////////////////////////////////////////////////////////////////////
37636 . ////////////////////////////////////////////////////////////////////////////
37637
37638 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37639          "Customizing messages"
37640 When a message fails to be delivered, or remains in the queue for more than a
37641 configured amount of time, Exim sends a message to the original sender, or
37642 to an alternative configured address. The text of these messages is built into
37643 the code of Exim, but it is possible to change it, either by adding a single
37644 string, or by replacing each of the paragraphs by text supplied in a file.
37645
37646 The &'From:'& and &'To:'& header lines are automatically generated; you can
37647 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37648 option. Exim also adds the line
37649 .code
37650 Auto-Submitted: auto-generated
37651 .endd
37652 to all warning and bounce messages,
37653
37654
37655 .section "Customizing bounce messages" "SECID239"
37656 .cindex "customizing" "bounce message"
37657 .cindex "bounce message" "customizing"
37658 If &%bounce_message_text%& is set, its contents are included in the default
37659 message immediately after &"This message was created automatically by mail
37660 delivery software."& The string is not expanded. It is not used if
37661 &%bounce_message_file%& is set.
37662
37663 When &%bounce_message_file%& is set, it must point to a template file for
37664 constructing error messages. The file consists of a series of text items,
37665 separated by lines consisting of exactly four asterisks. If the file cannot be
37666 opened, default text is used and a message is written to the main and panic
37667 logs. If any text item in the file is empty, default text is used for that
37668 item.
37669
37670 .vindex "&$bounce_recipient$&"
37671 .vindex "&$bounce_return_size_limit$&"
37672 Each item of text that is read from the file is expanded, and there are two
37673 expansion variables which can be of use here: &$bounce_recipient$& is set to
37674 the recipient of an error message while it is being created, and
37675 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37676 option, rounded to a whole number.
37677
37678 The items must appear in the file in the following order:
37679
37680 .ilist
37681 The first item is included in the headers, and should include at least a
37682 &'Subject:'& header. Exim does not check the syntax of these headers.
37683 .next
37684 The second item forms the start of the error message. After it, Exim lists the
37685 failing addresses with their error messages.
37686 .next
37687 The third item is used to introduce any text from pipe transports that is to be
37688 returned to the sender. It is omitted if there is no such text.
37689 .next
37690 The fourth, fifth and sixth items will be ignored and may be empty.
37691 The fields exist for back-compatibility
37692 .endlist
37693
37694 The default state (&%bounce_message_file%& unset) is equivalent to the
37695 following file, in which the sixth item is empty. The &'Subject:'& and some
37696 other lines have been split in order to fit them on the page:
37697 .code
37698 Subject: Mail delivery failed
37699   ${if eq{$sender_address}{$bounce_recipient}
37700   {: returning message to sender}}
37701 ****
37702 This message was created automatically by mail delivery software.
37703
37704 A message ${if eq{$sender_address}{$bounce_recipient}
37705   {that you sent }{sent by
37706
37707 <$sender_address>
37708
37709 }}could not be delivered to all of its recipients.
37710 This is a permanent error. The following address(es) failed:
37711 ****
37712 The following text was generated during the delivery attempt(s):
37713 ****
37714 ------ This is a copy of the message, including all the headers.
37715   ------
37716 ****
37717 ------ The body of the message is $message_size characters long;
37718   only the first
37719 ------ $bounce_return_size_limit or so are included here.
37720 ****
37721 .endd
37722 .section "Customizing warning messages" "SECTcustwarn"
37723 .cindex "customizing" "warning message"
37724 .cindex "warning of delay" "customizing the message"
37725 The option &%warn_message_file%& can be pointed at a template file for use when
37726 warnings about message delays are created. In this case there are only three
37727 text sections:
37728
37729 .ilist
37730 The first item is included in the headers, and should include at least a
37731 &'Subject:'& header. Exim does not check the syntax of these headers.
37732 .next
37733 The second item forms the start of the warning message. After it, Exim lists
37734 the delayed addresses.
37735 .next
37736 The third item then ends the message.
37737 .endlist
37738
37739 The default state is equivalent to the following file, except that some lines
37740 have been split here, in order to fit them on the page:
37741 .code
37742 Subject: Warning: message $message_exim_id delayed
37743   $warn_message_delay
37744 ****
37745 This message was created automatically by mail delivery software.
37746
37747 A message ${if eq{$sender_address}{$warn_message_recipients}
37748 {that you sent }{sent by
37749
37750 <$sender_address>
37751
37752 }}has not been delivered to all of its recipients after
37753 more than $warn_message_delay in the queue on $primary_hostname.
37754
37755 The message identifier is:     $message_exim_id
37756 The subject of the message is: $h_subject
37757 The date of the message is:    $h_date
37758
37759 The following address(es) have not yet been delivered:
37760 ****
37761 No action is required on your part. Delivery attempts will
37762 continue for some time, and this warning may be repeated at
37763 intervals if the message remains undelivered. Eventually the
37764 mail delivery software will give up, and when that happens,
37765 the message will be returned to you.
37766 .endd
37767 .vindex "&$warn_message_delay$&"
37768 .vindex "&$warn_message_recipients$&"
37769 However, in the default state the subject and date lines are omitted if no
37770 appropriate headers exist. During the expansion of this file,
37771 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37772 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37773 of recipients for the warning message. There may be more than one if there are
37774 multiple addresses with different &%errors_to%& settings on the routers that
37775 handled them.
37776
37777
37778
37779
37780 . ////////////////////////////////////////////////////////////////////////////
37781 . ////////////////////////////////////////////////////////////////////////////
37782
37783 .chapter "Some common configuration settings" "CHAPcomconreq"
37784 This chapter discusses some configuration settings that seem to be fairly
37785 common. More examples and discussion can be found in the Exim book.
37786
37787
37788
37789 .section "Sending mail to a smart host" "SECID240"
37790 .cindex "smart host" "example router"
37791 If you want to send all mail for non-local domains to a &"smart host"&, you
37792 should replace the default &(dnslookup)& router with a router which does the
37793 routing explicitly:
37794 .code
37795 send_to_smart_host:
37796   driver = manualroute
37797   route_list = !+local_domains smart.host.name
37798   transport = remote_smtp
37799 .endd
37800 You can use the smart host's IP address instead of the name if you wish.
37801 If you are using Exim only to submit messages to a smart host, and not for
37802 receiving incoming messages, you can arrange for it to do the submission
37803 synchronously by setting the &%mua_wrapper%& option (see chapter
37804 &<<CHAPnonqueueing>>&).
37805
37806
37807
37808
37809 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37810 .cindex "mailing lists"
37811 Exim can be used to run simple mailing lists, but for large and/or complicated
37812 requirements, the use of additional specialized mailing list software such as
37813 Majordomo or Mailman is recommended.
37814
37815 The &(redirect)& router can be used to handle mailing lists where each list
37816 is maintained in a separate file, which can therefore be managed by an
37817 independent manager. The &%domains%& router option can be used to run these
37818 lists in a separate domain from normal mail. For example:
37819 .code
37820 lists:
37821   driver = redirect
37822   domains = lists.example
37823   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37824   forbid_pipe
37825   forbid_file
37826   errors_to = ${quote_local_part:$local_part-request}@lists.example
37827   no_more
37828 .endd
37829 This router is skipped for domains other than &'lists.example'&. For addresses
37830 in that domain, it looks for a file that matches the local part. If there is no
37831 such file, the router declines, but because &%no_more%& is set, no subsequent
37832 routers are tried, and so the whole delivery fails.
37833
37834 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37835 expanded into a filename or a pipe delivery, which is usually inappropriate in
37836 a mailing list.
37837
37838 .oindex "&%errors_to%&"
37839 The &%errors_to%& option specifies that any delivery errors caused by addresses
37840 taken from a mailing list are to be sent to the given address rather than the
37841 original sender of the message. However, before acting on this, Exim verifies
37842 the error address, and ignores it if verification fails.
37843
37844 For example, using the configuration above, mail sent to
37845 &'dicts@lists.example'& is passed on to those addresses contained in
37846 &_/usr/lists/dicts_&, with error reports directed to
37847 &'dicts-request@lists.example'&, provided that this address can be verified.
37848 There could be a file called &_/usr/lists/dicts-request_& containing
37849 the address(es) of this particular list's manager(s), but other approaches,
37850 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37851 or &%local_part_suffix%& options) to handle addresses of the form
37852 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37853
37854
37855
37856 .section "Syntax errors in mailing lists" "SECID241"
37857 .cindex "mailing lists" "syntax errors in"
37858 If an entry in redirection data contains a syntax error, Exim normally defers
37859 delivery of the original address. That means that a syntax error in a mailing
37860 list holds up all deliveries to the list. This may not be appropriate when a
37861 list is being maintained automatically from data supplied by users, and the
37862 addresses are not rigorously checked.
37863
37864 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37865 entries that fail to parse, noting the incident in the log. If in addition
37866 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37867 whenever a broken address is skipped. It is usually appropriate to set
37868 &%syntax_errors_to%& to the same address as &%errors_to%&.
37869
37870
37871
37872 .section "Re-expansion of mailing lists" "SECID242"
37873 .cindex "mailing lists" "re-expansion of"
37874 Exim remembers every individual address to which a message has been delivered,
37875 in order to avoid duplication, but it normally stores only the original
37876 recipient addresses with a message. If all the deliveries to a mailing list
37877 cannot be done at the first attempt, the mailing list is re-expanded when the
37878 delivery is next tried. This means that alterations to the list are taken into
37879 account at each delivery attempt, so addresses that have been added to
37880 the list since the message arrived will therefore receive a copy of the
37881 message, even though it pre-dates their subscription.
37882
37883 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37884 on the &(redirect)& router. If this is done, any addresses generated by the
37885 router that fail to deliver at the first attempt are added to the message as
37886 &"top level"& addresses, and the parent address that generated them is marked
37887 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37888 subsequent delivery attempts. The disadvantage of this is that if any of the
37889 failing addresses are incorrect, correcting them in the file has no effect on
37890 pre-existing messages.
37891
37892 The original top-level address is remembered with each of the generated
37893 addresses, and is output in any log messages. However, any intermediate parent
37894 addresses are not recorded. This makes a difference to the log only if the
37895 &%all_parents%& selector is set, but for mailing lists there is normally only
37896 one level of expansion anyway.
37897
37898
37899
37900 .section "Closed mailing lists" "SECID243"
37901 .cindex "mailing lists" "closed"
37902 The examples so far have assumed open mailing lists, to which anybody may
37903 send mail. It is also possible to set up closed lists, where mail is accepted
37904 from specified senders only. This is done by making use of the generic
37905 &%senders%& option to restrict the router that handles the list.
37906
37907 The following example uses the same file as a list of recipients and as a list
37908 of permitted senders. It requires three routers:
37909 .code
37910 lists_request:
37911   driver = redirect
37912   domains = lists.example
37913   local_part_suffix = -request
37914   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37915   file = /usr/lists/${local_part_data}-request
37916   no_more
37917
37918 lists_post:
37919   driver = redirect
37920   domains = lists.example
37921   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37922   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37923   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37924   forbid_pipe
37925   forbid_file
37926   errors_to = ${quote_local_part:$local_part-request}@lists.example
37927   no_more
37928
37929 lists_closed:
37930   driver = redirect
37931   domains = lists.example
37932   allow_fail
37933   data = :fail: $local_part@lists.example is a closed mailing list
37934 .endd
37935 All three routers have the same &%domains%& setting, so for any other domains,
37936 they are all skipped. The first router runs only if the local part ends in
37937 &%-request%&. It handles messages to the list manager(s) by means of an open
37938 mailing list.
37939
37940 The second router runs only if the &%senders%& precondition is satisfied. It
37941 checks for the existence of a list that corresponds to the local part, and then
37942 checks that the sender is on the list by means of a linear search. It is
37943 necessary to check for the existence of the file before trying to search it,
37944 because otherwise Exim thinks there is a configuration error. If the file does
37945 not exist, the expansion of &%senders%& is *, which matches all senders. This
37946 means that the router runs, but because there is no list, declines, and
37947 &%no_more%& ensures that no further routers are run. The address fails with an
37948 &"unrouteable address"& error.
37949
37950 The third router runs only if the second router is skipped, which happens when
37951 a mailing list exists, but the sender is not on it. This router forcibly fails
37952 the address, giving a suitable error message.
37953
37954
37955
37956
37957 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37958 .cindex "VERP"
37959 .cindex "Variable Envelope Return Paths"
37960 .cindex "envelope from"
37961 .cindex "envelope sender"
37962 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37963 are a way of helping mailing list administrators discover which subscription
37964 address is the cause of a particular delivery failure. The idea is to encode
37965 the original recipient address in the outgoing envelope sender address, so that
37966 if the message is forwarded by another host and then subsequently bounces, the
37967 original recipient can be extracted from the recipient address of the bounce.
37968
37969 .oindex &%errors_to%&
37970 .oindex &%return_path%&
37971 Envelope sender addresses can be modified by Exim using two different
37972 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37973 list examples), or the &%return_path%& option on a transport. The second of
37974 these is effective only if the message is successfully delivered to another
37975 host; it is not used for errors detected on the local host (see the description
37976 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37977 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37978 .code
37979 verp_smtp:
37980   driver = smtp
37981   max_rcpt = 1
37982   return_path = \
37983     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37984       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37985 .endd
37986 This has the effect of rewriting the return path (envelope sender) on outgoing
37987 SMTP messages, if the local part of the original return path ends in
37988 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37989 local part and domain of the recipient into the return path. Suppose, for
37990 example, that a message whose return path has been set to
37991 &'somelist-request@your.dom.example'& is sent to
37992 &'subscriber@other.dom.example'&. In the transport, the return path is
37993 rewritten as
37994 .code
37995 somelist-request+subscriber=other.dom.example@your.dom.example
37996 .endd
37997 .vindex "&$local_part$&"
37998 For this to work, you must tell Exim to send multiple copies of messages that
37999 have more than one recipient, so that each copy has just one recipient. This is
38000 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38001 might be sent to several different recipients in the same domain, in which case
38002 &$local_part$& is not available in the transport, because it is not unique.
38003
38004 Unless your host is doing nothing but mailing list deliveries, you should
38005 probably use a separate transport for the VERP deliveries, so as not to use
38006 extra resources in making one-per-recipient copies for other deliveries. This
38007 can easily be done by expanding the &%transport%& option in the router:
38008 .code
38009 dnslookup:
38010   driver = dnslookup
38011   domains = ! +local_domains
38012   transport = \
38013     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38014       {verp_smtp}{remote_smtp}}
38015   no_more
38016 .endd
38017 If you want to change the return path using &%errors_to%& in a router instead
38018 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38019 routers that handle mailing list addresses. This will ensure that all delivery
38020 errors, including those detected on the local host, are sent to the VERP
38021 address.
38022
38023 On a host that does no local deliveries and has no manual routing, only the
38024 &(dnslookup)& router needs to be changed. A special transport is not needed for
38025 SMTP deliveries. Every mailing list recipient has its own return path value,
38026 and so Exim must hand them to the transport one at a time. Here is an example
38027 of a &(dnslookup)& router that implements VERP:
38028 .code
38029 verp_dnslookup:
38030   driver = dnslookup
38031   domains = ! +local_domains
38032   transport = remote_smtp
38033   errors_to = \
38034     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38035      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38036   no_more
38037 .endd
38038 Before you start sending out messages with VERPed return paths, you must also
38039 configure Exim to accept the bounce messages that come back to those paths.
38040 Typically this is done by setting a &%local_part_suffix%& option for a
38041 router, and using this to route the messages to wherever you want to handle
38042 them.
38043
38044 The overhead incurred in using VERP depends very much on the size of the
38045 message, the number of recipient addresses that resolve to the same remote
38046 host, and the speed of the connection over which the message is being sent. If
38047 a lot of addresses resolve to the same host and the connection is slow, sending
38048 a separate copy of the message for each address may take substantially longer
38049 than sending a single copy with many recipients (for which VERP cannot be
38050 used).
38051
38052
38053
38054
38055
38056
38057 .section "Virtual domains" "SECTvirtualdomains"
38058 .cindex "virtual domains"
38059 .cindex "domain" "virtual"
38060 The phrase &'virtual domain'& is unfortunately used with two rather different
38061 meanings:
38062
38063 .ilist
38064 A domain for which there are no real mailboxes; all valid local parts are
38065 aliases for other email addresses. Common examples are organizational
38066 top-level domains and &"vanity"& domains.
38067 .next
38068 One of a number of independent domains that are all handled by the same host,
38069 with mailboxes on that host, but where the mailbox owners do not necessarily
38070 have login accounts on that host.
38071 .endlist
38072
38073 The first usage is probably more common, and does seem more &"virtual"& than
38074 the second. This kind of domain can be handled in Exim with a straightforward
38075 aliasing router. One approach is to create a separate alias file for each
38076 virtual domain. Exim can test for the existence of the alias file to determine
38077 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38078 to a router of this form:
38079 .code
38080 virtual:
38081   driver = redirect
38082   domains = dsearch;/etc/mail/virtual
38083   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38084   no_more
38085 .endd
38086 The &%domains%& option specifies that the router is to be skipped, unless there
38087 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38088 domain that is being processed.
38089 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38090 being placed into the &$domain_data$& variable.
38091
38092 When the router runs, it looks up the local
38093 part in the file to find a new address (or list of addresses). The &%no_more%&
38094 setting ensures that if the lookup fails (leading to &%data%& being an empty
38095 string), Exim gives up on the address without trying any subsequent routers.
38096
38097 This one router can handle all the virtual domains because the alias filenames
38098 follow a fixed pattern. Permissions can be arranged so that appropriate people
38099 can edit the different alias files. A successful aliasing operation results in
38100 a new envelope recipient address, which is then routed from scratch.
38101
38102 The other kind of &"virtual"& domain can also be handled in a straightforward
38103 way. One approach is to create a file for each domain containing a list of
38104 valid local parts, and use it in a router like this:
38105 .code
38106 my_domains:
38107   driver = accept
38108   domains = dsearch;/etc/mail/domains
38109   local_parts = lsearch;/etc/mail/domains/$domain
38110   transport = my_mailboxes
38111 .endd
38112 The address is accepted if there is a file for the domain, and the local part
38113 can be found in the file. The &%domains%& option is used to check for the
38114 file's existence because &%domains%& is tested before the &%local_parts%&
38115 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38116 because that option is tested after &%local_parts%&. The transport is as
38117 follows:
38118 .code
38119 my_mailboxes:
38120   driver = appendfile
38121   file = /var/mail/$domain_data/$local_part_data
38122   user = mail
38123 .endd
38124 This uses a directory of mailboxes for each domain. The &%user%& setting is
38125 required, to specify which uid is to be used for writing to the mailboxes.
38126
38127 The configuration shown here is just one example of how you might support this
38128 requirement. There are many other ways this kind of configuration can be set
38129 up, for example, by using a database instead of separate files to hold all the
38130 information about the domains.
38131
38132
38133
38134 .section "Multiple user mailboxes" "SECTmulbox"
38135 .cindex "multiple mailboxes"
38136 .cindex "mailbox" "multiple"
38137 .cindex "local part" "prefix"
38138 .cindex "local part" "suffix"
38139 Heavy email users often want to operate with multiple mailboxes, into which
38140 incoming mail is automatically sorted. A popular way of handling this is to
38141 allow users to use multiple sender addresses, so that replies can easily be
38142 identified. Users are permitted to add prefixes or suffixes to their local
38143 parts for this purpose. The wildcard facility of the generic router options
38144 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38145 example, consider this router:
38146 .code
38147 userforward:
38148   driver = redirect
38149   check_local_user
38150   file = $home/.forward
38151   local_part_suffix = -*
38152   local_part_suffix_optional
38153   allow_filter
38154 .endd
38155 .vindex "&$local_part_suffix$&"
38156 It runs a user's &_.forward_& file for all local parts of the form
38157 &'username-*'&. Within the filter file the user can distinguish different
38158 cases by testing the variable &$local_part_suffix$&. For example:
38159 .code
38160 if $local_part_suffix contains -special then
38161 save /home/$local_part_data/Mail/special
38162 endif
38163 .endd
38164 If the filter file does not exist, or does not deal with such addresses, they
38165 fall through to subsequent routers, and, assuming no subsequent use of the
38166 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38167 control over which suffixes are valid.
38168
38169 Alternatively, a suffix can be used to trigger the use of a different
38170 &_.forward_& file &-- which is the way a similar facility is implemented in
38171 another MTA:
38172 .code
38173 userforward:
38174   driver = redirect
38175   check_local_user
38176   local_part_suffix = -*
38177   local_part_suffix_optional
38178   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38179   allow_filter
38180 .endd
38181 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38182 example, &_.forward-special_& is used. Once again, if the appropriate file
38183 does not exist, or does not deal with the address, it is passed on to
38184 subsequent routers, which could, if required, look for an unqualified
38185 &_.forward_& file to use as a default.
38186
38187
38188
38189 .section "Simplified vacation processing" "SECID244"
38190 .cindex "vacation processing"
38191 The traditional way of running the &'vacation'& program is for a user to set up
38192 a pipe command in a &_.forward_& file
38193 (see section &<<SECTspecitredli>>& for syntax details).
38194 This is prone to error by inexperienced users. There are two features of Exim
38195 that can be used to make this process simpler for users:
38196
38197 .ilist
38198 A local part prefix such as &"vacation-"& can be specified on a router which
38199 can cause the message to be delivered directly to the &'vacation'& program, or
38200 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38201 &_.forward_& file are then much simpler. For example:
38202 .code
38203 spqr, vacation-spqr
38204 .endd
38205 .next
38206 The &%require_files%& generic router option can be used to trigger a
38207 vacation delivery by checking for the existence of a certain file in the
38208 user's home directory. The &%unseen%& generic option should also be used, to
38209 ensure that the original delivery also proceeds. In this case, all the user has
38210 to do is to create a file called, say, &_.vacation_&, containing a vacation
38211 message.
38212 .endlist
38213
38214 Another advantage of both these methods is that they both work even when the
38215 use of arbitrary pipes by users is locked out.
38216
38217
38218
38219 .section "Taking copies of mail" "SECID245"
38220 .cindex "message" "copying every"
38221 Some installations have policies that require archive copies of all messages to
38222 be made. A single copy of each message can easily be taken by an appropriate
38223 command in a system filter, which could, for example, use a different file for
38224 each day's messages.
38225
38226 There is also a shadow transport mechanism that can be used to take copies of
38227 messages that are successfully delivered by local transports, one copy per
38228 delivery. This could be used, &'inter alia'&, to implement automatic
38229 notification of delivery by sites that insist on doing such things.
38230
38231
38232
38233 .section "Intermittently connected hosts" "SECID246"
38234 .cindex "intermittently connected hosts"
38235 It has become quite common (because it is cheaper) for hosts to connect to the
38236 Internet periodically rather than remain connected all the time. The normal
38237 arrangement is that mail for such hosts accumulates on a system that is
38238 permanently connected.
38239
38240 Exim was designed for use on permanently connected hosts, and so it is not
38241 particularly well-suited to use in an intermittently connected environment.
38242 Nevertheless there are some features that can be used.
38243
38244
38245 .section "Exim on the upstream server host" "SECID247"
38246 It is tempting to arrange for incoming mail for the intermittently connected
38247 host to remain in Exim's queue until the client connects. However, this
38248 approach does not scale very well. Two different kinds of waiting message are
38249 being mixed up in the same queue &-- those that cannot be delivered because of
38250 some temporary problem, and those that are waiting for their destination host
38251 to connect. This makes it hard to manage the queue, as well as wasting
38252 resources, because each queue runner scans the entire queue.
38253
38254 A better approach is to separate off those messages that are waiting for an
38255 intermittently connected host. This can be done by delivering these messages
38256 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38257 format, from where they are transmitted by other software when their
38258 destination connects. This makes it easy to collect all the mail for one host
38259 in a single directory, and to apply local timeout rules on a per-message basis
38260 if required.
38261
38262 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38263 you are doing this, you should configure Exim with a long retry period for the
38264 intermittent host. For example:
38265 .code
38266 cheshire.wonderland.fict.example    *   F,5d,24h
38267 .endd
38268 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38269 which messages it has queued up for that host. Once the intermittent host comes
38270 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38271 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38272 causes all the queued up messages to be delivered, often down a single SMTP
38273 connection. While the host remains connected, any new messages get delivered
38274 immediately.
38275
38276 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38277 issued with a different IP address each time it connects, Exim's retry
38278 mechanisms on the holding host get confused, because the IP address is normally
38279 used as part of the key string for holding retry information. This can be
38280 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38281 Since this has disadvantages for permanently connected hosts, it is best to
38282 arrange a separate transport for the intermittently connected ones.
38283
38284
38285
38286 .section "Exim on the intermittently connected client host" "SECID248"
38287 The value of &%smtp_accept_queue_per_connection%& should probably be
38288 increased, or even set to zero (that is, disabled) on the intermittently
38289 connected host, so that all incoming messages down a single connection get
38290 delivered immediately.
38291
38292 .cindex "SMTP" "passed connection"
38293 .cindex "SMTP" "multiple deliveries"
38294 .cindex "multiple SMTP deliveries"
38295 .cindex "first pass routing"
38296 Mail waiting to be sent from an intermittently connected host will probably
38297 not have been routed, because without a connection DNS lookups are not
38298 possible. This means that if a normal queue run is done at connection time,
38299 each message is likely to be sent in a separate SMTP session. This can be
38300 avoided by starting the queue run with a command line option beginning with
38301 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38302 first pass, routing is done but no deliveries take place. The second pass is a
38303 normal queue run; since all the messages have been previously routed, those
38304 destined for the same host are likely to get sent as multiple deliveries in a
38305 single SMTP connection.
38306
38307
38308
38309 . ////////////////////////////////////////////////////////////////////////////
38310 . ////////////////////////////////////////////////////////////////////////////
38311
38312 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38313          "Exim as a non-queueing client"
38314 .cindex "client, non-queueing"
38315 .cindex "smart host" "suppressing queueing"
38316 On a personal computer, it is a common requirement for all
38317 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38318 configured to operate that way, for all the popular operating systems.
38319 However, there are some MUAs for Unix-like systems that cannot be so
38320 configured: they submit messages using the command line interface of
38321 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38322 messages this way.
38323
38324 If the personal computer runs continuously, there is no problem, because it can
38325 run a conventional MTA that handles delivery to the smart host, and deal with
38326 any delays via its queueing mechanism. However, if the computer does not run
38327 continuously or runs different operating systems at different times, queueing
38328 email is not desirable.
38329
38330 There is therefore a requirement for something that can provide the
38331 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38332 any queueing or retrying facilities. Furthermore, the delivery to the smart
38333 host should be synchronous, so that if it fails, the sending MUA is immediately
38334 informed. In other words, we want something that extends an MUA that submits
38335 to a local MTA via the command line so that it behaves like one that submits
38336 to a remote smart host using TCP/SMTP.
38337
38338 There are a number of applications (for example, there is one called &'ssmtp'&)
38339 that do this job. However, people have found them to be lacking in various
38340 ways. For instance, you might want to allow aliasing and forwarding to be done
38341 before sending a message to the smart host.
38342
38343 Exim already had the necessary infrastructure for doing this job. Just a few
38344 tweaks were needed to make it behave as required, though it is somewhat of an
38345 overkill to use a fully-featured MTA for this purpose.
38346
38347 .oindex "&%mua_wrapper%&"
38348 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38349 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38350 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38351 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38352 compatible router and transport configuration. Typically there will be just one
38353 router and one transport, sending everything to a smart host.
38354
38355 When run in MUA wrapping mode, the behaviour of Exim changes in the
38356 following ways:
38357
38358 .ilist
38359 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38360 In other words, the only way to submit messages is via the command line.
38361 .next
38362 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38363 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38364 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38365 does not finish until the delivery attempt is complete. If the delivery is
38366 successful, a zero return code is given.
38367 .next
38368 Address redirection is permitted, but the final routing for all addresses must
38369 be to the same remote transport, and to the same list of hosts. Furthermore,
38370 the return address (envelope sender) must be the same for all recipients, as
38371 must any added or deleted header lines. In other words, it must be possible to
38372 deliver the message in a single SMTP transaction, however many recipients there
38373 are.
38374 .next
38375 If these conditions are not met, or if routing any address results in a
38376 failure or defer status, or if Exim is unable to deliver all the recipients
38377 successfully to one of the smart hosts, delivery of the entire message fails.
38378 .next
38379 Because no queueing is allowed, all failures are treated as permanent; there
38380 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38381 smart host. Furthermore, because only a single yes/no response can be given to
38382 the caller, it is not possible to deliver to some recipients and not others. If
38383 there is an error (temporary or permanent) for any recipient, all are failed.
38384 .next
38385 If more than one smart host is listed, Exim will try another host after a
38386 connection failure or a timeout, in the normal way. However, if this kind of
38387 failure happens for all the hosts, the delivery fails.
38388 .next
38389 When delivery fails, an error message is written to the standard error stream
38390 (as well as to Exim's log), and Exim exits to the caller with a return code
38391 value 1. The message is expunged from Exim's spool files. No bounce messages
38392 are ever generated.
38393 .next
38394 No retry data is maintained, and any retry rules are ignored.
38395 .next
38396 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38397 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38398 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38399 .endlist
38400
38401 The overall effect is that Exim makes a single synchronous attempt to deliver
38402 the message, failing if there is any kind of problem. Because no local
38403 deliveries are done and no daemon can be run, Exim does not need root
38404 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38405 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38406 the advantages and disadvantages of running without root privilege.
38407
38408
38409
38410
38411 . ////////////////////////////////////////////////////////////////////////////
38412 . ////////////////////////////////////////////////////////////////////////////
38413
38414 .chapter "Log files" "CHAPlog"
38415 .scindex IIDloggen "log" "general description"
38416 .cindex "log" "types of"
38417 Exim writes three different logs, referred to as the main log, the reject log,
38418 and the panic log:
38419
38420 .ilist
38421 .cindex "main log"
38422 The main log records the arrival of each message and each delivery in a single
38423 line in each case. The format is as compact as possible, in an attempt to keep
38424 down the size of log files. Two-character flag sequences make it easy to pick
38425 out these lines. A number of other events are recorded in the main log. Some of
38426 them are optional, in which case the &%log_selector%& option controls whether
38427 they are included or not. A Perl script called &'eximstats'&, which does simple
38428 analysis of main log files, is provided in the Exim distribution (see section
38429 &<<SECTmailstat>>&).
38430 .next
38431 .cindex "reject log"
38432 The reject log records information from messages that are rejected as a result
38433 of a configuration option (that is, for policy reasons).
38434 The first line of each rejection is a copy of the line that is also written to
38435 the main log. Then, if the message's header has been read at the time the log
38436 is written, its contents are written to this log. Only the original header
38437 lines are available; header lines added by ACLs are not logged. You can use the
38438 reject log to check that your policy controls are working correctly; on a busy
38439 host this may be easier than scanning the main log for rejection messages. You
38440 can suppress the writing of the reject log by setting &%write_rejectlog%&
38441 false.
38442 .next
38443 .cindex "panic log"
38444 .cindex "system log"
38445 When certain serious errors occur, Exim writes entries to its panic log. If the
38446 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38447 are usually written to the main log as well, but can get lost amid the mass of
38448 other entries. The panic log should be empty under normal circumstances. It is
38449 therefore a good idea to check it (or to have a &'cron'& script check it)
38450 regularly, in order to become aware of any problems. When Exim cannot open its
38451 panic log, it tries as a last resort to write to the system log (syslog). This
38452 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38453 message itself is written at priority LOG_CRIT.
38454 .endlist
38455
38456 Every log line starts with a timestamp, in the format shown in the following
38457 example. Note that many of the examples shown in this chapter are line-wrapped.
38458 In the log file, this would be all on one line:
38459 .code
38460 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38461   by QUIT
38462 .endd
38463 By default, the timestamps are in the local timezone. There are two
38464 ways of changing this:
38465
38466 .ilist
38467 You can set the &%timezone%& option to a different time zone; in particular, if
38468 you set
38469 .code
38470 timezone = UTC
38471 .endd
38472 the timestamps will be in UTC (aka GMT).
38473 .next
38474 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38475 example:
38476 .code
38477 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38478 .endd
38479 .endlist
38480
38481 .cindex "log" "process ids in"
38482 .cindex "pid (process id)" "in log lines"
38483 Exim does not include its process id in log lines by default, but you can
38484 request that it does so by specifying the &`pid`& log selector (see section
38485 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38486 brackets, immediately after the time and date.
38487
38488
38489
38490
38491 .section "Where the logs are written" "SECTwhelogwri"
38492 .cindex "log" "destination"
38493 .cindex "log" "to file"
38494 .cindex "log" "to syslog"
38495 .cindex "syslog"
38496 The logs may be written to local files, or to syslog, or both. However, it
38497 should be noted that many syslog implementations use UDP as a transport, and
38498 are therefore unreliable in the sense that messages are not guaranteed to
38499 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38500 It has also been reported that on large log files (tens of megabytes) you may
38501 need to tweak syslog to prevent it syncing the file with each write &-- on
38502 Linux this has been seen to make syslog take 90% plus of CPU time.
38503
38504 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38505 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38506 configuration. This latter string is expanded, so it can contain, for example,
38507 references to the host name:
38508 .code
38509 log_file_path = /var/log/$primary_hostname/exim_%slog
38510 .endd
38511 It is generally advisable, however, to set the string in &_Local/Makefile_&
38512 rather than at runtime, because then the setting is available right from the
38513 start of Exim's execution. Otherwise, if there's something it wants to log
38514 before it has read the configuration file (for example, an error in the
38515 configuration file) it will not use the path you want, and may not be able to
38516 log at all.
38517
38518 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38519 list, currently limited to at most two items. This is one option where the
38520 facility for changing a list separator may not be used. The list must always be
38521 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38522 otherwise the item must either be an absolute path, containing &`%s`& at the
38523 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38524 implying the use of a default path.
38525
38526 When Exim encounters an empty item in the list, it searches the list defined by
38527 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38528 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38529 mean &"use the path specified at build time"&. If no such item exists, log
38530 files are written in the &_log_& subdirectory of the spool directory. This is
38531 equivalent to the configuration file setting:
38532 .code
38533 log_file_path = $spool_directory/log/%slog
38534 .endd
38535 If you do not specify anything at build time or runtime,
38536 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38537 that is where the logs are written.
38538
38539 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38540 are in use &-- see section &<<SECTdatlogfil>>& below.
38541
38542 Here are some examples of possible Makefile settings:
38543 .display
38544 &`LOG_FILE_PATH=syslog                    `& syslog only
38545 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38546 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38547 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38548 .endd
38549 If there are more than two paths in the list, the first is used and a panic
38550 error is logged.
38551
38552
38553
38554 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38555 .cindex "log" "cycling local files"
38556 .cindex "cycling logs"
38557 .cindex "&'exicyclog'&"
38558 .cindex "log" "local files; writing to"
38559 Some operating systems provide centralized and standardized methods for cycling
38560 log files. For those that do not, a utility script called &'exicyclog'& is
38561 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38562 main and reject logs each time it is called. The maximum number of old logs to
38563 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38564
38565 An Exim delivery process opens the main log when it first needs to write to it,
38566 and it keeps the file open in case subsequent entries are required &-- for
38567 example, if a number of different deliveries are being done for the same
38568 message. However, remote SMTP deliveries can take a long time, and this means
38569 that the file may be kept open long after it is renamed if &'exicyclog'& or
38570 something similar is being used to rename log files on a regular basis. To
38571 ensure that a switch of log files is noticed as soon as possible, Exim calls
38572 &[stat()]& on the main log's name before reusing an open file, and if the file
38573 does not exist, or its inode has changed, the old file is closed and Exim
38574 tries to open the main log from scratch. Thus, an old log file may remain open
38575 for quite some time, but no Exim processes should write to it once it has been
38576 renamed.
38577
38578
38579
38580 .section "Datestamped log files" "SECTdatlogfil"
38581 .cindex "log" "datestamped files"
38582 Instead of cycling the main and reject log files by renaming them
38583 periodically, some sites like to use files whose names contain a datestamp,
38584 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38585 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38586 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38587 point where the datestamp is required. For example:
38588 .code
38589 log_file_path = /var/spool/exim/log/%slog-%D
38590 log_file_path = /var/log/exim-%s-%D.log
38591 log_file_path = /var/spool/exim/log/%D-%slog
38592 log_file_path = /var/log/exim/%s.%M
38593 .endd
38594 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38595 examples of names generated by the above examples:
38596 .code
38597 /var/spool/exim/log/mainlog-20021225
38598 /var/log/exim-reject-20021225.log
38599 /var/spool/exim/log/20021225-mainlog
38600 /var/log/exim/main.200212
38601 .endd
38602 When this form of log file is specified, Exim automatically switches to new
38603 files at midnight. It does not make any attempt to compress old logs; you
38604 will need to write your own script if you require this. You should not
38605 run &'exicyclog'& with this form of logging.
38606
38607 The location of the panic log is also determined by &%log_file_path%&, but it
38608 is not datestamped, because rotation of the panic log does not make sense.
38609 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38610 the string. In addition, if it immediately follows a slash, a following
38611 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38612 character is removed. Thus, the four examples above would give these panic
38613 log names:
38614 .code
38615 /var/spool/exim/log/paniclog
38616 /var/log/exim-panic.log
38617 /var/spool/exim/log/paniclog
38618 /var/log/exim/panic
38619 .endd
38620
38621
38622 .section "Logging to syslog" "SECID249"
38623 .cindex "log" "syslog; writing to"
38624 The use of syslog does not change what Exim logs or the format of its messages,
38625 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38626 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38627 that, the same strings are written to syslog as to log files. The syslog
38628 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38629 by default, but you can change these by setting the &%syslog_facility%& and
38630 &%syslog_processname%& options, respectively. If Exim was compiled with
38631 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38632 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38633 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38634 the time and host name to each line.
38635 The three log streams are mapped onto syslog priorities as follows:
38636
38637 .ilist
38638 &'mainlog'& is mapped to LOG_INFO
38639 .next
38640 &'rejectlog'& is mapped to LOG_NOTICE
38641 .next
38642 &'paniclog'& is mapped to LOG_ALERT
38643 .endlist
38644
38645 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38646 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38647 these are routed by syslog to the same place. You can suppress this duplication
38648 by setting &%syslog_duplication%& false.
38649
38650 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38651 entries contain multiple lines when headers are included. To cope with both
38652 these cases, entries written to syslog are split into separate &[syslog()]&
38653 calls at each internal newline, and also after a maximum of
38654 870 data characters. (This allows for a total syslog line length of 1024, when
38655 additions such as timestamps are added.) If you are running a syslog
38656 replacement that can handle lines longer than the 1024 characters allowed by
38657 RFC 3164, you should set
38658 .code
38659 SYSLOG_LONG_LINES=yes
38660 .endd
38661 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38662 lines, but it still splits at internal newlines in &'reject'& log entries.
38663
38664 To make it easy to re-assemble split lines later, each component of a split
38665 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38666 where <&'n'&> is the component number and <&'m'&> is the total number of
38667 components in the entry. The / delimiter is used when the line was split
38668 because it was too long; if it was split because of an internal newline, the \
38669 delimiter is used. For example, supposing the length limit to be 50 instead of
38670 870, the following would be the result of a typical rejection message to
38671 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38672 name, and pid as added by syslog:
38673 .code
38674 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38675 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38676 [3/5]  when scanning for sender: missing or malformed lo
38677 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38678 [5/5] mple>)
38679 .endd
38680 The same error might cause the following lines to be written to &"rejectlog"&
38681 (LOG_NOTICE):
38682 .code
38683 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38684 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38685 [3/18] er when scanning for sender: missing or malformed
38686 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38687 [5\18] .example>)
38688 [6\18] Recipients: ph10@some.domain.cam.example
38689 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38690 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38691 [9\18]        id 16RdAL-0006pc-00
38692 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38693 [11\18] 09:43 +0100
38694 [12\18] F From: <>
38695 [13\18]   Subject: this is a test header
38696 [18\18]   X-something: this is another header
38697 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38698 [16\18] le>
38699 [17\18] B Bcc:
38700 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38701 .endd
38702 Log lines that are neither too long nor contain newlines are written to syslog
38703 without modification.
38704
38705 If only syslog is being used, the Exim monitor is unable to provide a log tail
38706 display, unless syslog is routing &'mainlog'& to a file on the local host and
38707 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38708 where it is.
38709
38710
38711
38712 .section "Log line flags" "SECID250"
38713 One line is written to the main log for each message received, and for each
38714 successful, unsuccessful, and delayed delivery. These lines can readily be
38715 picked out by the distinctive two-character flags that immediately follow the
38716 timestamp. The flags are:
38717 .itable none 0 0 2 10* left 90* left
38718 .irow &%<=%&     "message arrival"
38719 .irow &%(=%&     "message fakereject"
38720 .irow &%=>%&     "normal message delivery"
38721 .irow &%->%&     "additional address in same delivery"
38722 .irow &%>>%&     "cutthrough message delivery"
38723 .irow &%*>%&     "delivery suppressed by &%-N%&"
38724 .irow &%**%&     "delivery failed; address bounced"
38725 .irow &%==%&     "delivery deferred; temporary problem"
38726 .endtable
38727
38728
38729 .section "Logging message reception" "SECID251"
38730 .cindex "log" "reception line"
38731 The format of the single-line entry in the main log that is written for every
38732 message received is shown in the basic example below, which is split over
38733 several lines in order to fit it on the page:
38734 .code
38735 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38736   H=mailer.fict.example [192.168.123.123] U=exim
38737   P=smtp S=5678 id=<incoming message id>
38738 .endd
38739 The address immediately following &"<="& is the envelope sender address. A
38740 bounce message is shown with the sender address &"<>"&, and if it is locally
38741 generated, this is followed by an item of the form
38742 .code
38743 R=<message id>
38744 .endd
38745 which is a reference to the message that caused the bounce to be sent.
38746
38747 .cindex "HELO"
38748 .cindex "EHLO"
38749 For messages from other hosts, the H and U fields identify the remote host and
38750 record the RFC 1413 identity of the user that sent the message, if one was
38751 received. The number given in square brackets is the IP address of the sending
38752 host. If there is a single, unparenthesized  host name in the H field, as
38753 above, it has been verified to correspond to the IP address (see the
38754 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38755 by the remote host in the SMTP HELO or EHLO command, and has not been
38756 verified. If verification yields a different name to that given for HELO or
38757 EHLO, the verified name appears first, followed by the HELO or EHLO
38758 name in parentheses.
38759
38760 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38761 without brackets, in the HELO or EHLO command, leading to entries in
38762 the log containing text like these examples:
38763 .code
38764 H=(10.21.32.43) [192.168.8.34]
38765 H=([10.21.32.43]) [192.168.8.34]
38766 .endd
38767 This can be confusing. Only the final address in square brackets can be relied
38768 on.
38769
38770 For locally generated messages (that is, messages not received over TCP/IP),
38771 the H field is omitted, and the U field contains the login name of the caller
38772 of Exim.
38773
38774 .cindex "authentication" "logging"
38775 .cindex "AUTH" "logging"
38776 For all messages, the P field specifies the protocol used to receive the
38777 message. This is the value that is stored in &$received_protocol$&. In the case
38778 of incoming SMTP messages, the value indicates whether or not any SMTP
38779 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38780 session was encrypted, there is an additional X field that records the cipher
38781 suite that was used.
38782
38783 .cindex log protocol
38784 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38785 hosts that have authenticated themselves using the SMTP AUTH command. The first
38786 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38787 there is an additional item A= followed by the name of the authenticator that
38788 was used. If an authenticated identification was set up by the authenticator's
38789 &%server_set_id%& option, this is logged too, separated by a colon from the
38790 authenticator name.
38791
38792 .cindex "size" "of message"
38793 The id field records the existing message id, if present. The size of the
38794 received message is given by the S field. When the message is delivered,
38795 headers may be removed or added, so that the size of delivered copies of the
38796 message may not correspond with this value (and indeed may be different to each
38797 other).
38798
38799 The &%log_selector%& option can be used to request the logging of additional
38800 data when a message is received. See section &<<SECTlogselector>>& below.
38801
38802
38803
38804 .section "Logging deliveries" "SECID252"
38805 .cindex "log" "delivery line"
38806 The format of the single-line entry in the main log that is written for every
38807 delivery is shown in one of the examples below, for local and remote
38808 deliveries, respectively. Each example has been split into multiple lines in order
38809 to fit it on the page:
38810 .code
38811 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38812   <marv@hitch.fict.example> R=localuser T=local_delivery
38813 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38814   monk@holistic.fict.example R=dnslookup T=remote_smtp
38815   H=holistic.fict.example [192.168.234.234]
38816 .endd
38817 For ordinary local deliveries, the original address is given in angle brackets
38818 after the final delivery address, which might be a pipe or a file. If
38819 intermediate address(es) exist between the original and the final address, the
38820 last of these is given in parentheses after the final address. The R and T
38821 fields record the router and transport that were used to process the address.
38822
38823 If SMTP AUTH was used for the delivery there is an additional item A=
38824 followed by the name of the authenticator that was used.
38825 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38826 option, this is logged too, as a second colon-separated list item.
38827 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38828
38829 If a shadow transport was run after a successful local delivery, the log line
38830 for the successful delivery has an item added on the end, of the form
38831 .display
38832 &`ST=<`&&'shadow transport name'&&`>`&
38833 .endd
38834 If the shadow transport did not succeed, the error message is put in
38835 parentheses afterwards.
38836
38837 .cindex "asterisk" "after IP address"
38838 When more than one address is included in a single delivery (for example, two
38839 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38840 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38841 down a single SMTP connection, an asterisk follows the
38842 remote IP address (and port if enabled)
38843 in the log lines for the second and subsequent messages.
38844 When two or more messages are delivered down a single TLS connection, the
38845 DNS and some TLS-related information logged for the first message delivered
38846 will not be present in the log lines for the second and subsequent messages.
38847 TLS cipher information is still available.
38848
38849 .cindex "delivery" "cutthrough; logging"
38850 .cindex "cutthrough" "logging"
38851 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38852 line precedes the reception line, since cutthrough waits for a possible
38853 rejection from the destination in case it can reject the sourced item.
38854
38855 The generation of a reply message by a filter file gets logged as a
38856 &"delivery"& to the addressee, preceded by &">"&.
38857
38858 The &%log_selector%& option can be used to request the logging of additional
38859 data when a message is delivered. See section &<<SECTlogselector>>& below.
38860
38861
38862 .section "Discarded deliveries" "SECID253"
38863 .cindex "discarded messages"
38864 .cindex "message" "discarded"
38865 .cindex "delivery" "discarded; logging"
38866 When a message is discarded as a result of the command &"seen finish"& being
38867 obeyed in a filter file which generates no deliveries, a log entry of the form
38868 .code
38869 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38870   <low.club@bridge.example> R=userforward
38871 .endd
38872 is written, to record why no deliveries are logged. When a message is discarded
38873 because it is aliased to &":blackhole:"& the log line is like this:
38874 .code
38875 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38876   <hole@nowhere.example> R=blackhole_router
38877 .endd
38878
38879
38880 .section "Deferred deliveries" "SECID254"
38881 When a delivery is deferred, a line of the following form is logged:
38882 .code
38883 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38884   R=dnslookup T=smtp defer (146): Connection refused
38885 .endd
38886 In the case of remote deliveries, the error is the one that was given for the
38887 last IP address that was tried. Details of individual SMTP failures are also
38888 written to the log, so the above line would be preceded by something like
38889 .code
38890 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38891   mail1.endrest.example [192.168.239.239]: Connection refused
38892 .endd
38893 When a deferred address is skipped because its retry time has not been reached,
38894 a message is written to the log, but this can be suppressed by setting an
38895 appropriate value in &%log_selector%&.
38896
38897
38898
38899 .section "Delivery failures" "SECID255"
38900 .cindex "delivery" "failure; logging"
38901 If a delivery fails because an address cannot be routed, a line of the
38902 following form is logged:
38903 .code
38904 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38905   <jim@trek99.example>: unknown mail domain
38906 .endd
38907 If a delivery fails at transport time, the router and transport are shown, and
38908 the response from the remote host is included, as in this example:
38909 .code
38910 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38911   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38912   after pipelined RCPT TO:<ace400@pb.example>: host
38913   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38914   <ace400@pb.example>...Addressee unknown
38915 .endd
38916 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38917 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38918 disabling PIPELINING. The log lines for all forms of delivery failure are
38919 flagged with &`**`&.
38920
38921
38922
38923 .section "Fake deliveries" "SECID256"
38924 .cindex "delivery" "fake; logging"
38925 If a delivery does not actually take place because the &%-N%& option has been
38926 used to suppress it, a normal delivery line is written to the log, except that
38927 &"=>"& is replaced by &"*>"&.
38928
38929
38930
38931 .section "Completion" "SECID257"
38932 A line of the form
38933 .code
38934 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38935 .endd
38936 is written to the main log when a message is about to be removed from the spool
38937 at the end of its processing.
38938
38939
38940
38941
38942 .section "Summary of Fields in Log Lines" "SECID258"
38943 .cindex "log" "summary of fields"
38944 A summary of the field identifiers that are used in log lines is shown in
38945 the following table:
38946 .display
38947 &`A   `&        authenticator name (and optional id and sender)
38948 &`C   `&        SMTP confirmation on delivery
38949 &`    `&        command list for &"no mail in SMTP session"&
38950 &`CV  `&        certificate verification status
38951 &`D   `&        duration of &"no mail in SMTP session"&
38952 &`DKIM`&        domain verified in incoming message
38953 &`DN  `&        distinguished name from peer certificate
38954 &`DS  `&        DNSSEC secured lookups
38955 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38956 &`F   `&        sender address (on delivery lines)
38957 &`H   `&        host name and IP address
38958 &`I   `&        local interface used
38959 &`id  `&        message id (from header) for incoming message
38960 &`K   `&        CHUNKING extension used
38961 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38962 &`M8S `&        8BITMIME status for incoming message
38963 &`P   `&        on &`<=`& lines: protocol used
38964 &`    `&        on &`=>`& and &`**`& lines: return path
38965 &`PRDR`&        PRDR extension used
38966 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38967 &`Q   `&        alternate queue name
38968 &`QT  `&        on &`=>`& lines: time spent on queue so far
38969 &`    `&        on &"Completed"& lines: time spent on queue
38970 &`R   `&        on &`<=`& lines: reference for local bounce
38971 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38972 &`RT  `&        on &`<=`& lines: time taken for reception
38973 &`S   `&        size of message in bytes
38974 &`SNI `&        server name indication from TLS client hello
38975 &`ST  `&        shadow transport name
38976 &`T   `&        on &`<=`& lines: message subject (topic)
38977 &`TFO `&        connection took advantage of TCP Fast Open
38978 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38979 &`U   `&        local user or RFC 1413 identity
38980 &`X   `&        TLS cipher suite
38981 .endd
38982
38983
38984 .section "Other log entries" "SECID259"
38985 Various other types of log entry are written from time to time. Most should be
38986 self-explanatory. Among the more common are:
38987
38988 .ilist
38989 .cindex "retry" "time not reached"
38990 &'retry time not reached'&&~&~An address previously suffered a temporary error
38991 during routing or local delivery, and the time to retry has not yet arrived.
38992 This message is not written to an individual message log file unless it happens
38993 during the first delivery attempt.
38994 .next
38995 &'retry time not reached for any host'&&~&~An address previously suffered
38996 temporary errors during remote delivery, and the retry time has not yet arrived
38997 for any of the hosts to which it is routed.
38998 .next
38999 .cindex "spool directory" "file locked"
39000 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39001 some other Exim process is already working on the message. This can be quite
39002 common if queue running processes are started at frequent intervals. The
39003 &'exiwhat'& utility script can be used to find out what Exim processes are
39004 doing.
39005 .next
39006 .cindex "error" "ignored"
39007 &'error ignored'&&~&~There are several circumstances that give rise to this
39008 message:
39009 .olist
39010 Exim failed to deliver a bounce message whose age was greater than
39011 &%ignore_bounce_errors_after%&. The bounce was discarded.
39012 .next
39013 A filter file set up a delivery using the &"noerror"& option, and the delivery
39014 failed. The delivery was discarded.
39015 .next
39016 A delivery set up by a router configured with
39017 . ==== As this is a nested list, any displays it contains must be indented
39018 . ==== as otherwise they are too far to the left.
39019 .code
39020     errors_to = <>
39021 .endd
39022 failed. The delivery was discarded.
39023 .endlist olist
39024 .next
39025 .cindex DKIM "log line"
39026 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39027 logging and the message has a DKIM signature header.
39028 .endlist ilist
39029
39030
39031
39032
39033
39034 .section "Reducing or increasing what is logged" "SECTlogselector"
39035 .cindex "log" "selectors"
39036 By setting the &%log_selector%& global option, you can disable some of Exim's
39037 default logging to the main log, or you can request additional logging. The value of
39038 &%log_selector%& is made up of names preceded by plus or minus characters. For
39039 example:
39040 .code
39041 log_selector = +arguments -retry_defer
39042 .endd
39043 The list of optional log items is in the following table, with the default
39044 selection marked by asterisks:
39045 .itable none 0 0 3 2.8in left 10pt center 3in left
39046 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39047 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39048 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39049 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39050 .irow &`arguments`&                     &nbsp; "command line arguments"
39051 .irow &`connection_reject`&             *       "connection rejections"
39052 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39053 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39054 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39055 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39056 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
39057 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39058 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39059 .irow &`etrn`&                          *       "ETRN commands"
39060 .irow &`host_lookup_failed`&            *       "as it says"
39061 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39062 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39063 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39064 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39065 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39066 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39067 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39068 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39069 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39070 .irow &`queue_run`&                     *       "start and end queue runs"
39071 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39072 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39073 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39074 .irow &`pid`&                           &nbsp; "Exim process id"
39075 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39076 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39077 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39078 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39079 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39080 .irow &`rejected_header`&               *       "header contents on reject log"
39081 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39082 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39083 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39084 .irow &`sender_verify_fail`&            *       "sender verification failures"
39085 .irow &`size_reject`&                   *       "rejection because too big"
39086 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39087 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39088 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39089 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39090 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39091 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39092 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39093 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39094 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39095 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39096 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39097 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39098 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39099 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39100 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39101 .irow &`all`&                           &nbsp; "&*all of the above*&"
39102 .endtable
39103 See also the &%slow_lookup_log%& main configuration option,
39104 section &<<SECID99>>&
39105
39106 More details on each of these items follows:
39107
39108 .ilist
39109 .cindex "8BITMIME"
39110 .cindex "log" "8BITMIME"
39111 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39112 which may help in tracking down interoperability issues with ancient MTAs
39113 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39114 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39115 &`7BIT`& and &`8BITMIME`& respectively.
39116 .next
39117 .cindex "&%warn%& ACL verb" "log when skipping"
39118 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39119 its conditions cannot be evaluated, a log line to this effect is written if
39120 this log selector is set.
39121 .next
39122 .cindex "log" "rewriting"
39123 .cindex "rewriting" "logging"
39124 &%address_rewrite%&: This applies both to global rewrites and per-transport
39125 rewrites, but not to rewrites in filters run as an unprivileged user (because
39126 such users cannot access the log).
39127 .next
39128 .cindex "log" "full parentage"
39129 &%all_parents%&: Normally only the original and final addresses are logged on
39130 delivery lines; with this selector, intermediate parents are given in
39131 parentheses between them.
39132 .next
39133 .cindex "log" "Exim arguments"
39134 .cindex "Exim arguments, logging"
39135 &%arguments%&: This causes Exim to write the arguments with which it was called
39136 to the main log, preceded by the current working directory. This is a debugging
39137 feature, added to make it easier to find out how certain MUAs call
39138 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39139 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39140 that are empty or that contain white space are quoted. Non-printing characters
39141 are shown as escape sequences. This facility cannot log unrecognized arguments,
39142 because the arguments are checked before the configuration file is read. The
39143 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39144 between the caller and Exim.
39145 .next
39146 .cindex "log" "connection rejections"
39147 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39148 connection is rejected, for whatever reason.
39149 .next
39150 .cindex "log" "delayed delivery"
39151 .cindex "delayed delivery, logging"
39152 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39153 started for an incoming message because the load is too high or too many
39154 messages were received on one connection. Logging does not occur if no delivery
39155 process is started because &%queue_only%& is set or &%-odq%& was used.
39156 .next
39157 .cindex "log" "delivery duration"
39158 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39159 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39160 If millisecond logging is enabled, short times will be shown with greater
39161 precision, eg. &`DT=0.304s`&.
39162 .next
39163 .cindex "log" "message size on delivery"
39164 .cindex "size" "of message"
39165 &%delivery_size%&: For each delivery, the size of message delivered is added to
39166 the &"=>"& line, tagged with S=.
39167 .next
39168 .cindex log "DKIM verification"
39169 .cindex DKIM "verification logging"
39170 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39171 verifies successfully a tag of DKIM is added, with one of the verified domains.
39172 .next
39173 .cindex log "DKIM verification"
39174 .cindex DKIM "verification logging"
39175 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39176 .next
39177 .cindex "log" "dnslist defer"
39178 .cindex "DNS list" "logging defer"
39179 .cindex "black list (DNS)"
39180 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39181 DNS black list suffers a temporary error.
39182 .next
39183 .cindex log dnssec
39184 .cindex dnssec logging
39185 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39186 dns lookups gave secure results a tag of DS is added.
39187 For acceptance this covers the reverse and forward lookups for host name verification.
39188 It does not cover helo-name verification.
39189 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39190 .next
39191 .cindex "log" "ETRN commands"
39192 .cindex "ETRN" "logging"
39193 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39194 is run to determine whether or not it is actually accepted. An invalid ETRN
39195 command, or one received within a message transaction is not logged by this
39196 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39197 .next
39198 .cindex "log" "host lookup failure"
39199 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39200 any addresses, or when a lookup of an IP address fails to find a host name, a
39201 log line is written. This logging does not apply to direct DNS lookups when
39202 routing email addresses, but it does apply to &"byname"& lookups.
39203 .next
39204 .cindex "log" "ident timeout"
39205 .cindex "RFC 1413" "logging timeout"
39206 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39207 client's ident port times out.
39208 .next
39209 .cindex "log" "incoming interface"
39210 .cindex "log" "outgoing interface"
39211 .cindex "log" "local interface"
39212 .cindex "log" "local address and port"
39213 .cindex "TCP/IP" "logging local address and port"
39214 .cindex "interface" "logging"
39215 &%incoming_interface%&: The interface on which a message was received is added
39216 to the &"<="& line as an IP address in square brackets, tagged by I= and
39217 followed by a colon and the port number. The local interface and port are also
39218 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39219 rejection lines, and (despite the name) to outgoing
39220 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39221 The latter can be disabled by turning off the &%outgoing_interface%& option.
39222 .next
39223 .cindex log "incoming proxy address"
39224 .cindex proxy "logging proxy address"
39225 .cindex "TCP/IP" "logging proxy address"
39226 &%proxy%&: The internal (closest to the system running Exim) IP address
39227 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39228 on a proxied connection
39229 or the &"=>"& line for a message delivered on a proxied connection.
39230 See &<<SECTproxyInbound>>& for more information.
39231 .next
39232 .cindex "log" "incoming remote port"
39233 .cindex "port" "logging remote"
39234 .cindex "TCP/IP" "logging incoming remote port"
39235 .vindex "&$sender_fullhost$&"
39236 .vindex "&$sender_rcvhost$&"
39237 &%incoming_port%&: The remote port number from which a message was received is
39238 added to log entries and &'Received:'& header lines, following the IP address
39239 in square brackets, and separated from it by a colon. This is implemented by
39240 changing the value that is put in the &$sender_fullhost$& and
39241 &$sender_rcvhost$& variables. Recording the remote port number has become more
39242 important with the widening use of NAT (see RFC 2505).
39243 .next
39244 .cindex "log" "dropped connection"
39245 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39246 connection is unexpectedly dropped.
39247 .next
39248 .cindex "log" "millisecond timestamps"
39249 .cindex millisecond logging
39250 .cindex timestamps "millisecond, in logs"
39251 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39252 appended to the seconds value.
39253 .next
39254 .cindex "log" "message id"
39255 &%msg_id%&: The value of the Message-ID: header.
39256 .next
39257 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39258 This will be either because the message is a bounce, or was submitted locally
39259 (submission mode) without one.
39260 The field identifier will have an asterix appended: &"id*="&.
39261 .next
39262 .cindex "log" "outgoing interface"
39263 .cindex "log" "local interface"
39264 .cindex "log" "local address and port"
39265 .cindex "TCP/IP" "logging local address and port"
39266 .cindex "interface" "logging"
39267 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39268 interface on which a message was sent is added to delivery lines as an I= tag
39269 followed by IP address in square brackets. You can disable this by turning
39270 off the &%outgoing_interface%& option.
39271 .next
39272 .cindex "log" "outgoing remote port"
39273 .cindex "port" "logging outgoing remote"
39274 .cindex "TCP/IP" "logging outgoing remote port"
39275 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39276 containing => tags) following the IP address.
39277 The local port is also added if &%incoming_interface%& and
39278 &%outgoing_interface%& are both enabled.
39279 This option is not included in the default setting, because for most ordinary
39280 configurations, the remote port number is always 25 (the SMTP port), and the
39281 local port is a random ephemeral port.
39282 .next
39283 .cindex "log" "process ids in"
39284 .cindex "pid (process id)" "in log lines"
39285 &%pid%&: The current process id is added to every log line, in square brackets,
39286 immediately after the time and date.
39287 .next
39288 .cindex log pipelining
39289 .cindex pipelining "logging outgoing"
39290 &%pipelining%&: A field is added to delivery and accept
39291 log lines when the ESMTP PIPELINING extension was used.
39292 The field is a single "L".
39293
39294 On accept lines, where PIPELINING was offered but not used by the client,
39295 the field has a minus appended.
39296
39297 .cindex "pipelining" "early connection"
39298 If Exim is built without the DISABLE_PIPE_CONNECT build option
39299 accept "L" fields have a period appended if the feature was
39300 offered but not used, or an asterisk appended if used.
39301 Delivery "L" fields have an asterisk appended if used.
39302
39303 .next
39304 .cindex "log" "queue run"
39305 .cindex "queue runner" "logging"
39306 &%queue_run%&: The start and end of every queue run are logged.
39307 .next
39308 .cindex "log" "queue time"
39309 &%queue_time%&: The amount of time the message has been in the queue on the
39310 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39311 &`QT=3m45s`&.
39312 If millisecond logging is enabled, short times will be shown with greater
39313 precision, eg. &`QT=1.578s`&.
39314 .next
39315 &%queue_time_overall%&: The amount of time the message has been in the queue on
39316 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39317 example, &`QT=3m45s`&.
39318 .next
39319 .cindex "log" "receive duration"
39320 &%receive_time%&: For each message, the amount of real time it has taken to
39321 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39322 If millisecond logging is enabled, short times will be shown with greater
39323 precision, eg. &`RT=0.204s`&.
39324 .next
39325 .cindex "log" "recipients"
39326 &%received_recipients%&: The recipients of a message are listed in the main log
39327 as soon as the message is received. The list appears at the end of the log line
39328 that is written when a message is received, preceded by the word &"for"&. The
39329 addresses are listed after they have been qualified, but before any rewriting
39330 has taken place.
39331 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39332 in the list.
39333 .next
39334 .cindex "log" "sender reception"
39335 &%received_sender%&: The unrewritten original sender of a message is added to
39336 the end of the log line that records the message's arrival, after the word
39337 &"from"& (before the recipients if &%received_recipients%& is also set).
39338 .next
39339 .cindex "log" "header lines for rejection"
39340 &%rejected_header%&: If a message's header has been received at the time a
39341 rejection is written to the reject log, the complete header is added to the
39342 log. Header logging can be turned off individually for messages that are
39343 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39344 .next
39345 .cindex "log" "retry defer"
39346 &%retry_defer%&: A log line is written if a delivery is deferred because a
39347 retry time has not yet been reached. However, this &"retry time not reached"&
39348 message is always omitted from individual message logs after the first delivery
39349 attempt.
39350 .next
39351 .cindex "log" "return path"
39352 &%return_path_on_delivery%&: The return path that is being transmitted with
39353 the message is included in delivery and bounce lines, using the tag P=.
39354 This is omitted if no delivery actually happens, for example, if routing fails,
39355 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39356 .next
39357 .cindex "log" "sender on delivery"
39358 &%sender_on_delivery%&: The message's sender address is added to every delivery
39359 and bounce line, tagged by F= (for &"from"&).
39360 This is the original sender that was received with the message; it is not
39361 necessarily the same as the outgoing return path.
39362 .next
39363 .cindex "log" "sender verify failure"
39364 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39365 gives details of a sender verification failure is not written. Log lines for
39366 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39367 detail is lost.
39368 .next
39369 .cindex "log" "size rejection"
39370 &%size_reject%&: A log line is written whenever a message is rejected because
39371 it is too big.
39372 .next
39373 .cindex "log" "frozen messages; skipped"
39374 .cindex "frozen messages" "logging skipping"
39375 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39376 queue run because it another process is already delivering it or because
39377 it is frozen.
39378 .cindex "&""spool file is locked""&"
39379 .cindex "&""message is frozen""&"
39380 The message that is written is either &"spool file is locked"& or
39381 &"message is frozen"&.
39382 .next
39383 .cindex "log" "smtp confirmation"
39384 .cindex "SMTP" "logging confirmation"
39385 .cindex "LMTP" "logging confirmation"
39386 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39387 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39388 A number of MTAs (including Exim) return an identifying string in this
39389 response.
39390 .next
39391 .cindex "log" "SMTP connections"
39392 .cindex "SMTP" "logging connections"
39393 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39394 established or closed, unless the connection is from a host that matches
39395 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39396 only when the closure is unexpected.) This applies to connections from local
39397 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39398 dropped in the middle of a message, a log line is always written, whether or
39399 not this selector is set, but otherwise nothing is written at the start and end
39400 of connections unless this selector is enabled.
39401
39402 For TCP/IP connections to an Exim daemon, the current number of connections is
39403 included in the log message for each new connection, but note that the count is
39404 reset if the daemon is restarted.
39405 Also, because connections are closed (and the closure is logged) in
39406 subprocesses, the count may not include connections that have been closed but
39407 whose termination the daemon has not yet noticed. Thus, while it is possible to
39408 match up the opening and closing of connections in the log, the value of the
39409 logged counts may not be entirely accurate.
39410 .next
39411 .cindex "log" "SMTP transaction; incomplete"
39412 .cindex "SMTP" "logging incomplete transactions"
39413 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39414 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39415 and the message sender plus any accepted recipients are included in the log
39416 line. This can provide evidence of dictionary attacks.
39417 .next
39418 .cindex "log" "non-MAIL SMTP sessions"
39419 .cindex "MAIL" "logging session without"
39420 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39421 connection terminates without having issued a MAIL command. This includes both
39422 the case when the connection is dropped, and the case when QUIT is used. It
39423 does not include cases where the connection is rejected right at the start (by
39424 an ACL, or because there are too many connections, or whatever). These cases
39425 already have their own log lines.
39426
39427 The log line that is written contains the identity of the client in the usual
39428 way, followed by D= and a time, which records the duration of the connection.
39429 If the connection was authenticated, this fact is logged exactly as it is for
39430 an incoming message, with an A= item. If the connection was encrypted, CV=,
39431 DN=, and X= items may appear as they do for an incoming message, controlled by
39432 the same logging options.
39433
39434 Finally, if any SMTP commands were issued during the connection, a C= item
39435 is added to the line, listing the commands that were used. For example,
39436 .code
39437 C=EHLO,QUIT
39438 .endd
39439 shows that the client issued QUIT straight after EHLO. If there were fewer
39440 than 20 commands, they are all listed. If there were more than 20 commands,
39441 the last 20 are listed, preceded by &"..."&. However, with the default
39442 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39443 have been aborted before 20 non-mail commands are processed.
39444 .next
39445 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39446 colon-separated, is appended to the A= item for a message arrival or delivery
39447 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39448 was accepted or used.
39449 .next
39450 .cindex "log" "SMTP protocol error"
39451 .cindex "SMTP" "logging protocol error"
39452 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39453 encountered. Exim does not have perfect detection of all protocol errors
39454 because of transmission delays and the use of pipelining. If PIPELINING has
39455 been advertised to a client, an Exim server assumes that the client will use
39456 it, and therefore it does not count &"expected"& errors (for example, RCPT
39457 received after rejecting MAIL) as protocol errors.
39458 .next
39459 .cindex "SMTP" "logging syntax errors"
39460 .cindex "SMTP" "syntax errors; logging"
39461 .cindex "SMTP" "unknown command; logging"
39462 .cindex "log" "unknown SMTP command"
39463 .cindex "log" "SMTP syntax error"
39464 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39465 encountered. An unrecognized command is treated as a syntax error. For an
39466 external connection, the host identity is given; for an internal connection
39467 using &%-bs%& the sender identification (normally the calling user) is given.
39468 .next
39469 .cindex "log" "subject"
39470 .cindex "subject, logging"
39471 &%subject%&: The subject of the message is added to the arrival log line,
39472 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39473 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39474 specifies whether characters with values greater than 127 should be logged
39475 unchanged, or whether they should be rendered as escape sequences.
39476 .next
39477 .cindex "log" "certificate verification"
39478 .cindex log DANE
39479 .cindex DANE logging
39480 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39481 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39482 verified
39483 using a CA trust anchor,
39484 &`CV=dane`& if using a DNS trust anchor,
39485 and &`CV=no`& if not.
39486 .next
39487 .cindex "log" "TLS cipher"
39488 .cindex "TLS" "logging cipher"
39489 &%tls_cipher%&: When a message is sent or received over an encrypted
39490 connection, the cipher suite used is added to the log line, preceded by X=.
39491 .next
39492 .cindex "log" "TLS peer DN"
39493 .cindex "TLS" "logging peer DN"
39494 &%tls_peerdn%&: When a message is sent or received over an encrypted
39495 connection, and a certificate is supplied by the remote host, the peer DN is
39496 added to the log line, preceded by DN=.
39497 .next
39498 .cindex "log" "TLS resumption"
39499 .cindex "TLS" "logging session resumption"
39500 &%tls_resumption%&: When a message is sent or received over an encrypted
39501 connection and the TLS session resumed one used on a previous TCP connection,
39502 an asterisk is appended to the X= cipher field in the log line.
39503 .next
39504 .cindex "log" "TLS SNI"
39505 .cindex "TLS" "logging SNI"
39506 .cindex SNI logging
39507 &%tls_sni%&: When a message is received over an encrypted connection, and
39508 the remote host provided the Server Name Indication extension, the SNI is
39509 added to the log line, preceded by SNI=.
39510 .next
39511 .cindex "log" "DNS failure in list"
39512 &%unknown_in_list%&: This setting causes a log entry to be written when the
39513 result of a list match is failure because a DNS lookup failed.
39514 .endlist
39515
39516
39517 .section "Message log" "SECID260"
39518 .cindex "message" "log file for"
39519 .cindex "log" "message log; description of"
39520 .cindex "&_msglog_& directory"
39521 .oindex "&%preserve_message_logs%&"
39522 In addition to the general log files, Exim writes a log file for each message
39523 that it handles. The names of these per-message logs are the message ids, and
39524 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39525 message log contains copies of the log lines that apply to the message. This
39526 makes it easier to inspect the status of an individual message without having
39527 to search the main log. A message log is deleted when processing of the message
39528 is complete, unless &%preserve_message_logs%& is set, but this should be used
39529 only with great care because they can fill up your disk very quickly.
39530
39531 On a heavily loaded system, it may be desirable to disable the use of
39532 per-message logs, in order to reduce disk I/O. This can be done by setting the
39533 &%message_logs%& option false.
39534 .ecindex IIDloggen
39535
39536
39537
39538
39539 . ////////////////////////////////////////////////////////////////////////////
39540 . ////////////////////////////////////////////////////////////////////////////
39541
39542 .chapter "Exim utilities" "CHAPutils"
39543 .scindex IIDutils "utilities"
39544 A number of utility scripts and programs are supplied with Exim and are
39545 described in this chapter. There is also the Exim Monitor, which is covered in
39546 the next chapter. The utilities described here are:
39547
39548 .itable none 0 0 3  7* left  15* left  40* left
39549 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39550   "list what Exim processes are doing"
39551 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39552 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39553 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39554 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39555                                                 various criteria"
39556 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39557 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39558   "extract statistics from the log"
39559 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39560   "check address acceptance from given IP"
39561 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39562 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39563 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39564 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39565 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39566 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39567 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39568 .endtable
39569
39570 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39571 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39572 &url(https://duncanthrax.net/exilog/) for details.
39573
39574
39575
39576
39577 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39578 .cindex "&'exiwhat'&"
39579 .cindex "process, querying"
39580 .cindex "SIGUSR1"
39581 On operating systems that can restart a system call after receiving a signal
39582 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39583 a line describing what it is doing to the file &_exim-process.info_& in the
39584 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39585 processes it can find, having first emptied the file. It then waits for one
39586 second to allow the Exim processes to react before displaying the results. In
39587 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39588 send the signal to the Exim processes, so it is normally run as root.
39589
39590 &*Warning*&: This is not an efficient process. It is intended for occasional
39591 use by system administrators. It is not sensible, for example, to set up a
39592 script that sends SIGUSR1 signals to Exim processes at short intervals.
39593
39594
39595 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39596 varies in different operating systems. Not only are different options used,
39597 but the format of the output is different. For this reason, there are some
39598 system configuration options that configure exactly how &'exiwhat'& works. If
39599 it doesn't seem to be working for you, check the following compile-time
39600 options:
39601 .itable none 0 0 2 30* left 70* left
39602 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39603 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39604 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39605 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39606 .endtable
39607 An example of typical output from &'exiwhat'& is
39608 .code
39609 164 daemon: -q1h, listening on port 25
39610 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39611 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39612   [10.19.42.42] (editor@ref.example)
39613 10592 handling incoming call from [192.168.243.242]
39614 10628 accepting a local non-SMTP message
39615 .endd
39616 The first number in the output line is the process number. The third line has
39617 been split here, in order to fit it on the page.
39618
39619
39620
39621 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39622 .cindex "&'exiqgrep'&"
39623 .cindex "queue" "grepping"
39624 This utility is a Perl script contributed by Matt Hubbard. It runs
39625 .code
39626 exim -bpu
39627 .endd
39628 or (in case &*-a*& switch is specified)
39629 .code
39630 exim -bp
39631 .endd
39632 to obtain a queue listing, and then greps the output to select messages
39633 that match given criteria. The following selection options are available:
39634
39635 .vlist
39636 .vitem &*-f*&&~<&'regex'&>
39637 Match the sender address using a case-insensitive search. The field that is
39638 tested is enclosed in angle brackets, so you can test for bounce messages with
39639 .code
39640 exiqgrep -f '^<>$'
39641 .endd
39642 .vitem &*-r*&&~<&'regex'&>
39643 Match a recipient address using a case-insensitive search. The field that is
39644 tested is not enclosed in angle brackets.
39645
39646 .vitem &*-s*&&~<&'regex'&>
39647 Match against the size field.
39648
39649 .vitem &*-y*&&~<&'seconds'&>
39650 Match messages that are younger than the given time.
39651
39652 .vitem &*-o*&&~<&'seconds'&>
39653 Match messages that are older than the given time.
39654
39655 .vitem &*-z*&
39656 Match only frozen messages.
39657
39658 .vitem &*-x*&
39659 Match only non-frozen messages.
39660
39661 .vitem &*-G*&&~<&'queuename'&>
39662 Match only messages in the given queue.  Without this, the default queue is searched.
39663 .endlist
39664
39665 The following options control the format of the output:
39666
39667 .vlist
39668 .vitem &*-c*&
39669 Display only the count of matching messages.
39670
39671 .vitem &*-l*&
39672 Long format &-- display the full message information as output by Exim. This is
39673 the default.
39674
39675 .vitem &*-i*&
39676 Display message ids only.
39677
39678 .vitem &*-b*&
39679 Brief format &-- one line per message.
39680
39681 .vitem &*-R*&
39682 Display messages in reverse order.
39683
39684 .vitem &*-a*&
39685 Include delivered recipients in queue listing.
39686 .endlist
39687
39688 The following options give alternates for configuration:
39689
39690 .vlist
39691 .vitem &*-C*&&~<&'config&~file'&>
39692 is used to specify an alternate &_exim.conf_& which might
39693 contain alternate exim configuration the queue management might be using.
39694
39695 .vitem &*-E*&&~<&'path'&>
39696 can be used to specify a path for the exim binary,
39697 overriding the built-in one.
39698 .endlist
39699
39700 There is one more option, &%-h%&, which outputs a list of options.
39701 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39702
39703
39704
39705 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39706 .cindex "&'exiqsumm'&"
39707 .cindex "queue" "summary"
39708 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39709 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39710 running a command such as
39711 .code
39712 exim -bp | exiqsumm
39713 .endd
39714 The output consists of one line for each domain that has messages waiting for
39715 it, as in the following example:
39716 .code
39717 3   2322   74m   66m  msn.com.example
39718 .endd
39719 Each line lists the number of pending deliveries for a domain, their total
39720 volume, and the length of time that the oldest and the newest messages have
39721 been waiting. Note that the number of pending deliveries is greater than the
39722 number of messages when messages have more than one recipient.
39723
39724 A summary line is output at the end. By default the output is sorted on the
39725 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39726 the output to be sorted by oldest message and by count of messages,
39727 respectively. There are also three options that split the messages for each
39728 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39729 separates frozen messages, and &%-s%& separates messages according to their
39730 sender.
39731
39732 The output of &'exim -bp'& contains the original addresses in the message, so
39733 this also applies to the output from &'exiqsumm'&. No domains from addresses
39734 generated by aliasing or forwarding are included (unless the &%one_time%&
39735 option of the &(redirect)& router has been used to convert them into &"top
39736 level"& addresses).
39737
39738
39739
39740
39741 .section "Extracting specific information from the log (exigrep)" &&&
39742          "SECTextspeinf"
39743 .cindex "&'exigrep'&"
39744 .cindex "log" "extracts; grepping for"
39745 The &'exigrep'& utility is a Perl script that searches one or more main log
39746 files for entries that match a given pattern. When it finds a match, it
39747 extracts all the log entries for the relevant message, not just those that
39748 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39749 given message, or all mail for a given user, or for a given host, for example.
39750 The input files can be in Exim log format or syslog format.
39751 If a matching log line is not associated with a specific message, it is
39752 included in &'exigrep'&'s output without any additional lines. The usage is:
39753 .display
39754 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39755 .endd
39756 If no log filenames are given on the command line, the standard input is read.
39757
39758 The &%-t%& argument specifies a number of seconds. It adds an additional
39759 condition for message selection. Messages that are complete are shown only if
39760 they spent more than <&'n'&> seconds in the queue.
39761
39762 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39763 makes it case-sensitive. This may give a performance improvement when searching
39764 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39765 option; with &%-I%& they do not. In both cases it is possible to change the
39766 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39767
39768 The &%-l%& option means &"literal"&, that is, treat all characters in the
39769 pattern as standing for themselves. Otherwise the pattern must be a Perl
39770 regular expression.
39771
39772 The &%-v%& option inverts the matching condition. That is, a line is selected
39773 if it does &'not'& match the pattern.
39774
39775 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39776 that are generated as a result/response to a message that &'exigrep'& matched
39777 normally.
39778
39779 Example of &%-M%&:
39780 user_a sends a message to user_b, which generates a bounce back to user_b. If
39781 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39782 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39783 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39784 when searching for &"user_a"& will show both messages since the bounce is
39785 &"related"& to or a &"result"& of the first message that was found by the
39786 search term.
39787
39788 If the location of a &'zcat'& command is known from the definition of
39789 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39790 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39791 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39792 autodetection of some well known compression extensions.
39793
39794
39795 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39796 .cindex "&'exipick'&"
39797 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39798 lists messages from the queue according to a variety of criteria. For details
39799 of &'exipick'&'s facilities, run &'exipick'& with
39800 the &%--help%& option.
39801
39802
39803 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39804 .cindex "log" "cycling local files"
39805 .cindex "cycling logs"
39806 .cindex "&'exicyclog'&"
39807 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39808 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39809 you are using log files with datestamps in their names (see section
39810 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39811 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39812 There are two command line options for &'exicyclog'&:
39813 .ilist
39814 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39815 default that is set when Exim is built. The default default is 10.
39816 .next
39817 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39818 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39819 overriding the script's default, which is to find the setting from Exim's
39820 configuration.
39821 .endlist
39822
39823 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39824 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39825 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39826 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39827 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39828 logs are handled similarly.
39829
39830 If the limit is greater than 99, the script uses 3-digit numbers such as
39831 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39832 to one that is greater, or &'vice versa'&, you will have to fix the names of
39833 any existing log files.
39834
39835 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39836 the end are deleted. All files with numbers greater than 01 are compressed,
39837 using a compression command which is configured by the COMPRESS_COMMAND
39838 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39839 root &%crontab%& entry of the form
39840 .code
39841 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39842 .endd
39843 assuming you have used the name &"exim"& for the Exim user. You can run
39844 &'exicyclog'& as root if you wish, but there is no need.
39845
39846
39847
39848 .section "Mail statistics (eximstats)" "SECTmailstat"
39849 .cindex "statistics"
39850 .cindex "&'eximstats'&"
39851 A Perl script called &'eximstats'& is provided for extracting statistical
39852 information from log files. The output is either plain text, or HTML.
39853 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39854 . --- 404 error and everything else points to that.
39855
39856 The &'eximstats'& script has been hacked about quite a bit over time. The
39857 latest version is the result of some extensive revision by Steve Campbell. A
39858 lot of information is given by default, but there are options for suppressing
39859 various parts of it. Following any options, the arguments to the script are a
39860 list of files, which should be main log files. For example:
39861 .code
39862 eximstats -nr /var/spool/exim/log/mainlog.01
39863 .endd
39864 By default, &'eximstats'& extracts information about the number and volume of
39865 messages received from or delivered to various hosts. The information is sorted
39866 both by message count and by volume, and the top fifty hosts in each category
39867 are listed on the standard output. Similar information, based on email
39868 addresses or domains instead of hosts can be requested by means of various
39869 options. For messages delivered and received locally, similar statistics are
39870 also produced per user.
39871
39872 The output also includes total counts and statistics about delivery errors, and
39873 histograms showing the number of messages received and deliveries made in each
39874 hour of the day. A delivery with more than one address in its envelope (for
39875 example, an SMTP transaction with more than one RCPT command) is counted
39876 as a single delivery by &'eximstats'&.
39877
39878 Though normally more deliveries than receipts are reported (as messages may
39879 have multiple recipients), it is possible for &'eximstats'& to report more
39880 messages received than delivered, even though the queue is empty at the start
39881 and end of the period in question. If an incoming message contains no valid
39882 recipients, no deliveries are recorded for it. A bounce message is handled as
39883 an entirely separate message.
39884
39885 &'eximstats'& always outputs a grand total summary giving the volume and number
39886 of messages received and deliveries made, and the number of hosts involved in
39887 each case. It also outputs the number of messages that were delayed (that is,
39888 not completely delivered at the first attempt), and the number that had at
39889 least one address that failed.
39890
39891 The remainder of the output is in sections that can be independently disabled
39892 or modified by various options. It consists of a summary of deliveries by
39893 transport, histograms of messages received and delivered per time interval
39894 (default per hour), information about the time messages spent in the queue,
39895 a list of relayed messages, lists of the top fifty sending hosts, local
39896 senders, destination hosts, and destination local users by count and by volume,
39897 and a list of delivery errors that occurred.
39898
39899 The relay information lists messages that were actually relayed, that is, they
39900 came from a remote host and were directly delivered to some other remote host,
39901 without being processed (for example, for aliasing or forwarding) locally.
39902
39903 There are quite a few options for &'eximstats'& to control exactly what it
39904 outputs. These are documented in the Perl script itself, and can be extracted
39905 by running the command &(perldoc)& on the script. For example:
39906 .code
39907 perldoc /usr/exim/bin/eximstats
39908 .endd
39909
39910 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39911 .cindex "&'exim_checkaccess'&"
39912 .cindex "policy control" "checking access"
39913 .cindex "checking access"
39914 The &%-bh%& command line argument allows you to run a fake SMTP session with
39915 debugging output, in order to check what Exim is doing when it is applying
39916 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39917 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39918 sometimes you just want to answer the question &"Does this address have
39919 access?"& without bothering with any further details.
39920
39921 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39922 two arguments, an IP address and an email address:
39923 .code
39924 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39925 .endd
39926 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39927 given email address would be accepted in a RCPT command in a TCP/IP
39928 connection from the host with the given IP address. The output of the utility
39929 is either the word &"accepted"&, or the SMTP error response, for example:
39930 .code
39931 Rejected:
39932 550 Relay not permitted
39933 .endd
39934 When running this test, the utility uses &`<>`& as the envelope sender address
39935 for the MAIL command, but you can change this by providing additional
39936 options. These are passed directly to the Exim command. For example, to specify
39937 that the test is to be run with the sender address &'himself@there.example'&
39938 you can use:
39939 .code
39940 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39941                  -f himself@there.example
39942 .endd
39943 Note that these additional Exim command line items must be given after the two
39944 mandatory arguments.
39945
39946 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39947 while running its checks. You can run checks that include callouts by using
39948 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39949
39950
39951
39952 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39953 .cindex "DBM" "building dbm files"
39954 .cindex "building DBM files"
39955 .cindex "&'exim_dbmbuild'&"
39956 .cindex "lower casing"
39957 .cindex "binary zero" "in lookup key"
39958 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39959 the format used by the &(lsearch)& lookup (see section
39960 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39961 names as keys and the remainder of the information as data. The lower-casing
39962 can be prevented by calling the program with the &%-nolc%& option.
39963
39964 A terminating zero is included as part of the key string. This is expected by
39965 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39966 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39967 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39968 files.
39969
39970 The program requires two arguments: the name of the input file (which can be a
39971 single hyphen to indicate the standard input), and the name of the output file.
39972 It creates the output under a temporary name, and then renames it if all went
39973 well.
39974
39975 .cindex "USE_DB"
39976 If the native DB interface is in use (USE_DB is set in a compile-time
39977 configuration file &-- this is common in free versions of Unix) the two
39978 filenames must be different, because in this mode the Berkeley DB functions
39979 create a single output file using exactly the name given. For example,
39980 .code
39981 exim_dbmbuild /etc/aliases /etc/aliases.db
39982 .endd
39983 reads the system alias file and creates a DBM version of it in
39984 &_/etc/aliases.db_&.
39985
39986 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39987 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39988 environment, the suffixes are added to the second argument of
39989 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39990 when the Berkeley functions are used in compatibility mode (though this is not
39991 recommended), because in that case it adds a &_.db_& suffix to the filename.
39992
39993 If a duplicate key is encountered, the program outputs a warning, and when it
39994 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39995 option is used. By default, only the first of a set of duplicates is used &--
39996 this makes it compatible with &(lsearch)& lookups. There is an option
39997 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39998 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39999 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40000 return code is 2.
40001
40002
40003
40004
40005 .section "Finding individual retry times (exinext)" "SECTfinindret"
40006 .cindex "retry" "times"
40007 .cindex "&'exinext'&"
40008 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40009 fish specific information out of the retry database. Given a mail domain (or a
40010 complete address), it looks up the hosts for that domain, and outputs any retry
40011 information for the hosts or for the domain. At present, the retry information
40012 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40013 output. For example:
40014 .code
40015 $ exinext piglet@milne.fict.example
40016 kanga.milne.example:192.168.8.1 error 146: Connection refused
40017   first failed: 21-Feb-1996 14:57:34
40018   last tried:   21-Feb-1996 14:57:34
40019   next try at:  21-Feb-1996 15:02:34
40020 roo.milne.example:192.168.8.3 error 146: Connection refused
40021   first failed: 20-Jan-1996 13:12:08
40022   last tried:   21-Feb-1996 11:42:03
40023   next try at:  21-Feb-1996 19:42:03
40024   past final cutoff time
40025 .endd
40026 You can also give &'exinext'& a local part, without a domain, and it
40027 will give any retry information for that local part in your default domain.
40028 A message id can be used to obtain retry information pertaining to a specific
40029 message. This exists only when an attempt to deliver a message to a remote host
40030 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40031 &'exinext'& is not particularly efficient, but then it is not expected to be
40032 run very often.
40033
40034 The &'exinext'& utility calls Exim to find out information such as the location
40035 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40036 passed on to the &'exim'& commands. The first specifies an alternate Exim
40037 configuration file, and the second sets macros for use within the configuration
40038 file. These features are mainly to help in testing, but might also be useful in
40039 environments where more than one configuration file is in use.
40040
40041
40042
40043 .section "Hints database maintenance" "SECThindatmai"
40044 .cindex "hints database" "maintenance"
40045 .cindex "maintaining Exim's hints database"
40046 Three utility programs are provided for maintaining the DBM files that Exim
40047 uses to contain its delivery hint information. Each program requires two
40048 arguments. The first specifies the name of Exim's spool directory, and the
40049 second is the name of the database it is to operate on. These are as follows:
40050
40051 .ilist
40052 &'retry'&: the database of retry information
40053 .next
40054 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40055 for remote hosts
40056 .next
40057 &'callout'&: the callout cache
40058 .next
40059 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40060 .next
40061 &'tls'&: TLS session resumption data
40062 .next
40063 &'misc'&: other hints data
40064 .endlist
40065
40066 The &'misc'& database is used for
40067
40068 .ilist
40069 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40070 .next
40071 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40072 &(smtp)& transport)
40073 .next
40074 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40075 in a transport)
40076 .endlist
40077
40078
40079
40080 .section "exim_dumpdb" "SECTdumpdb"
40081 .cindex "&'exim_dumpdb'&"
40082 The entire contents of a database are written to the standard output by the
40083 &'exim_dumpdb'& program,
40084 taking as arguments the spool and database names.
40085 An option &'-z'& may be given to request times in UTC;
40086 otherwise times are in the local timezone.
40087 An option &'-k'& may be given to dump only the record keys.
40088 For example, to dump the retry database:
40089 .code
40090 exim_dumpdb /var/spool/exim retry
40091 .endd
40092 For the retry database
40093 two lines of output are produced for each entry:
40094 .code
40095 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40096 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40097 .endd
40098 The first item on the first line is the key of the record. It starts with one
40099 of the letters R, or T, depending on whether it refers to a routing or
40100 transport retry. For a local delivery, the next part is the local address; for
40101 a remote delivery it is the name of the remote host, followed by its failing IP
40102 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40103 transport). If the remote port is not the standard one (port 25), it is added
40104 to the IP address. Then there follows an error code, an additional error code,
40105 and a textual description of the error.
40106
40107 The three times on the second line are the time of first failure, the time of
40108 the last delivery attempt, and the computed time for the next attempt. The line
40109 ends with an asterisk if the cutoff time for the last retry rule has been
40110 exceeded.
40111
40112 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40113 consists of a host name followed by a list of ids for messages that are or were
40114 waiting to be delivered to that host. If there are a very large number for any
40115 one host, continuation records, with a sequence number added to the host name,
40116 may be seen. The data in these records is often out of date, because a message
40117 may be routed to several alternative hosts, and Exim makes no effort to keep
40118 cross-references.
40119
40120
40121
40122 .section "exim_tidydb" "SECTtidydb"
40123 .cindex "&'exim_tidydb'&"
40124 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40125 database. If run with no options, it removes all records that are more than 30
40126 days old. The age is calculated from the date and time that the record was last
40127 updated. Note that, in the case of the retry database, it is &'not'& the time
40128 since the first delivery failure. Information about a host that has been down
40129 for more than 30 days will remain in the database, provided that the record is
40130 updated sufficiently often.
40131
40132 The cutoff date can be altered by means of the &%-t%& option, which must be
40133 followed by a time. For example, to remove all records older than a week from
40134 the retry database:
40135 .code
40136 exim_tidydb -t 7d /var/spool/exim retry
40137 .endd
40138 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40139 message ids. In the former these appear as data in records keyed by host &--
40140 they were messages that were waiting for that host &-- and in the latter they
40141 are the keys for retry information for messages that have suffered certain
40142 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40143 message ids in database records are those of messages that are still on the
40144 queue. Message ids for messages that no longer exist are removed from
40145 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40146 For the &'retry'& database, records whose keys are non-existent message ids are
40147 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40148 whenever it removes information from the database.
40149
40150 Certain records are automatically removed by Exim when they are no longer
40151 needed, but others are not. For example, if all the MX hosts for a domain are
40152 down, a retry record is created for each one. If the primary MX host comes back
40153 first, its record is removed when Exim successfully delivers to it, but the
40154 records for the others remain because Exim has not tried to use those hosts.
40155
40156 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40157 hints databases. You should do this at a quiet time of day, because it requires
40158 a database to be locked (and therefore inaccessible to Exim) while it does its
40159 work. Removing records from a DBM file does not normally make the file smaller,
40160 but all the common DBM libraries are able to re-use the space that is released.
40161 After an initial phase of increasing in size, the databases normally reach a
40162 point at which they no longer get any bigger, as long as they are regularly
40163 tidied.
40164
40165 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40166 databases is likely to keep on increasing.
40167
40168
40169
40170
40171 .section "exim_fixdb" "SECTfixdb"
40172 .cindex "&'exim_fixdb'&"
40173 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40174 Its main use is for testing Exim, but it might also be occasionally useful for
40175 getting round problems in a live system. Its interface
40176 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40177 key of a database record can then be entered, and the data for that record is
40178 displayed.
40179
40180 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40181 except the &'retry'& database, that is the only operation that can be carried
40182 out. For the &'retry'& database, each field is output preceded by a number, and
40183 data for individual fields can be changed by typing the field number followed
40184 by new data, for example:
40185 .code
40186 > 4 951102:1000
40187 .endd
40188 resets the time of the next delivery attempt. Time values are given as a
40189 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40190 used as optional separators.
40191
40192 Both displayed and input times are in the local timezone by default.
40193 If an option &'-z'& is used on the command line, displayed times
40194 are in UTC.
40195
40196
40197
40198
40199 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40200 .cindex "mailbox" "maintenance"
40201 .cindex "&'exim_lock'&"
40202 .cindex "locking mailboxes"
40203 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40204 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40205 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40206 a user agent while investigating a problem. The utility requires the name of
40207 the file as its first argument. If the locking is successful, the second
40208 argument is run as a command (using C's &[system()]& function); if there is no
40209 second argument, the value of the SHELL environment variable is used; if this
40210 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40211 is unlocked and the utility ends. The following options are available:
40212
40213 .vlist
40214 .vitem &%-fcntl%&
40215 Use &[fcntl()]& locking on the open mailbox.
40216
40217 .vitem &%-flock%&
40218 Use &[flock()]& locking on the open mailbox, provided the operating system
40219 supports it.
40220
40221 .vitem &%-interval%&
40222 This must be followed by a number, which is a number of seconds; it sets the
40223 interval to sleep between retries (default 3).
40224
40225 .vitem &%-lockfile%&
40226 Create a lock file before opening the mailbox.
40227
40228 .vitem &%-mbx%&
40229 Lock the mailbox using MBX rules.
40230
40231 .vitem &%-q%&
40232 Suppress verification output.
40233
40234 .vitem &%-retries%&
40235 This must be followed by a number; it sets the number of times to try to get
40236 the lock (default 10).
40237
40238 .vitem &%-restore_time%&
40239 This option causes &%exim_lock%& to restore the modified and read times to the
40240 locked file before exiting. This allows you to access a locked mailbox (for
40241 example, to take a backup copy) without disturbing the times that the user
40242 subsequently sees.
40243
40244 .vitem &%-timeout%&
40245 This must be followed by a number, which is a number of seconds; it sets a
40246 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40247 default), a non-blocking call is used.
40248
40249 .vitem &%-v%&
40250 Generate verbose output.
40251 .endlist
40252
40253 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40254 default is to create a lock file and also to use &[fcntl()]& locking on the
40255 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40256 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40257 requires that the directory containing the file be writeable. Locking by lock
40258 file does not last forever; Exim assumes that a lock file is expired if it is
40259 more than 30 minutes old.
40260
40261 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40262 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40263 to be taken out on the open mailbox, and an exclusive lock on the file
40264 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40265 number of the mailbox file. When the locking is released, if an exclusive lock
40266 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40267
40268 The default output contains verification of the locking that takes place. The
40269 &%-v%& option causes some additional information to be given. The &%-q%& option
40270 suppresses all output except error messages.
40271
40272 A command such as
40273 .code
40274 exim_lock /var/spool/mail/spqr
40275 .endd
40276 runs an interactive shell while the file is locked, whereas
40277 .display
40278 &`exim_lock -q /var/spool/mail/spqr <<End`&
40279 <&'some commands'&>
40280 &`End`&
40281 .endd
40282 runs a specific non-interactive sequence of commands while the file is locked,
40283 suppressing all verification output. A single command can be run by a command
40284 such as
40285 .code
40286 exim_lock -q /var/spool/mail/spqr \
40287   "cp /var/spool/mail/spqr /some/where"
40288 .endd
40289 Note that if a command is supplied, it must be entirely contained within the
40290 second argument &-- hence the quotes.
40291
40292
40293 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40294 .cindex "exim_msgdate"
40295 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40296 This Perl script converts an Exim Mesage ID back into a human readable form.
40297 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40298
40299 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40300 .ecindex IIDutils
40301 . ////////////////////////////////////////////////////////////////////////////
40302 . ////////////////////////////////////////////////////////////////////////////
40303
40304 .chapter "The Exim monitor" "CHAPeximon"
40305 .scindex IIDeximon "Exim monitor" "description"
40306 .cindex "X-windows"
40307 .cindex "&'eximon'&"
40308 .cindex "Local/eximon.conf"
40309 .cindex "&_exim_monitor/EDITME_&"
40310 The Exim monitor is an application which displays in an X window information
40311 about the state of Exim's queue and what Exim is doing. An admin user can
40312 perform certain operations on messages from this GUI interface; however all
40313 such facilities are also available from the command line, and indeed, the
40314 monitor itself makes use of the command line to perform any actions requested.
40315
40316
40317
40318 .section "Running the monitor" "SECID264"
40319 The monitor is started by running the script called &'eximon'&. This is a shell
40320 script that sets up a number of environment variables, and then runs the
40321 binary called &_eximon.bin_&. The default appearance of the monitor window can
40322 be changed by editing the &_Local/eximon.conf_& file created by editing
40323 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40324 parameters are for.
40325
40326 The parameters that get built into the &'eximon'& script can be overridden for
40327 a particular invocation by setting up environment variables of the same names,
40328 preceded by &`EXIMON_`&. For example, a shell command such as
40329 .code
40330 EXIMON_LOG_DEPTH=400 eximon
40331 .endd
40332 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40333 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40334 overrides the Exim log file configuration. This makes it possible to have
40335 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40336 syslog messages are routed to a file on the local host.
40337
40338 X resources can be used to change the appearance of the window in the normal
40339 way. For example, a resource setting of the form
40340 .code
40341 Eximon*background: gray94
40342 .endd
40343 changes the colour of the background to light grey rather than white. The
40344 stripcharts are drawn with both the data lines and the reference lines in
40345 black. This means that the reference lines are not visible when on top of the
40346 data. However, their colour can be changed by setting a resource called
40347 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40348 For example, if your X server is running Unix, you could set up lighter
40349 reference lines in the stripcharts by obeying
40350 .code
40351 xrdb -merge <<End
40352 Eximon*highlight: gray
40353 End
40354 .endd
40355 .cindex "admin user"
40356 In order to see the contents of messages in the queue, and to operate on them,
40357 &'eximon'& must either be run as root or by an admin user.
40358
40359 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40360 contain X11 resource parameters interpreted by the X11 library.  In addition,
40361 if the first parameter starts with the string "gdb" then it is removed and the
40362 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40363 versioned variants of gdb can be invoked).
40364
40365 The monitor's window is divided into three parts. The first contains one or
40366 more stripcharts and two action buttons, the second contains a &"tail"& of the
40367 main log file, and the third is a display of the queue of messages awaiting
40368 delivery, with two more action buttons. The following sections describe these
40369 different parts of the display.
40370
40371
40372
40373
40374 .section "The stripcharts" "SECID265"
40375 .cindex "stripchart"
40376 The first stripchart is always a count of messages in the queue. Its name can
40377 be configured by setting QUEUE_STRIPCHART_NAME in the
40378 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40379 configuration script by regular expression matches on log file entries, making
40380 it possible to display, for example, counts of messages delivered to certain
40381 hosts or using certain transports. The supplied defaults display counts of
40382 received and delivered messages, and of local and SMTP deliveries. The default
40383 period between stripchart updates is one minute; this can be adjusted by a
40384 parameter in the &_Local/eximon.conf_& file.
40385
40386 The stripchart displays rescale themselves automatically as the value they are
40387 displaying changes. There are always 10 horizontal lines in each chart; the
40388 title string indicates the value of each division when it is greater than one.
40389 For example, &"x2"& means that each division represents a value of 2.
40390
40391 It is also possible to have a stripchart which shows the percentage fullness of
40392 a particular disk partition, which is useful when local deliveries are confined
40393 to a single partition.
40394
40395 .cindex "&%statvfs%& function"
40396 This relies on the availability of the &[statvfs()]& function or equivalent in
40397 the operating system. Most, but not all versions of Unix that support Exim have
40398 this. For this particular stripchart, the top of the chart always represents
40399 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40400 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40401 &_Local/eximon.conf_& file.
40402
40403
40404
40405
40406 .section "Main action buttons" "SECID266"
40407 .cindex "size" "of monitor window"
40408 .cindex "Exim monitor" "window size"
40409 .cindex "window size"
40410 Below the stripcharts there is an action button for quitting the monitor. Next
40411 to this is another button marked &"Size"&. They are placed here so that
40412 shrinking the window to its default minimum size leaves just the queue count
40413 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40414 the window to expand to its maximum size, unless it is already at the maximum,
40415 in which case it is reduced to its minimum.
40416
40417 When expanding to the maximum, if the window cannot be fully seen where it
40418 currently is, it is moved back to where it was the last time it was at full
40419 size. When it is expanding from its minimum size, the old position is
40420 remembered, and next time it is reduced to the minimum it is moved back there.
40421
40422 The idea is that you can keep a reduced window just showing one or two
40423 stripcharts at a convenient place on your screen, easily expand it to show
40424 the full window when required, and just as easily put it back to what it was.
40425 The idea is copied from what the &'twm'& window manager does for its
40426 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40427 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40428
40429 Normally, the monitor starts up with the window at its full size, but it can be
40430 built so that it starts up with the window at its smallest size, by setting
40431 START_SMALL=yes in &_Local/eximon.conf_&.
40432
40433
40434
40435 .section "The log display" "SECID267"
40436 .cindex "log" "tail of; in monitor"
40437 The second section of the window is an area in which a display of the tail of
40438 the main log is maintained.
40439 To save space on the screen, the timestamp on each log line is shortened by
40440 removing the date and, if &%log_timezone%& is set, the timezone.
40441 The log tail is not available when the only destination for logging data is
40442 syslog, unless the syslog lines are routed to a local file whose name is passed
40443 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40444
40445 The log sub-window has a scroll bar at its lefthand side which can be used to
40446 move back to look at earlier text, and the up and down arrow keys also have a
40447 scrolling effect. The amount of log that is kept depends on the setting of
40448 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40449 to use. When this is full, the earlier 50% of data is discarded &-- this is
40450 much more efficient than throwing it away line by line. The sub-window also has
40451 a horizontal scroll bar for accessing the ends of long log lines. This is the
40452 only means of horizontal scrolling; the right and left arrow keys are not
40453 available. Text can be cut from this part of the window using the mouse in the
40454 normal way. The size of this subwindow is controlled by parameters in the
40455 configuration file &_Local/eximon.conf_&.
40456
40457 Searches of the text in the log window can be carried out by means of the ^R
40458 and ^S keystrokes, which default to a reverse and a forward search,
40459 respectively. The search covers only the text that is displayed in the window.
40460 It cannot go further back up the log.
40461
40462 The point from which the search starts is indicated by a caret marker. This is
40463 normally at the end of the text in the window, but can be positioned explicitly
40464 by pointing and clicking with the left mouse button, and is moved automatically
40465 by a successful search. If new text arrives in the window when it is scrolled
40466 back, the caret remains where it is, but if the window is not scrolled back,
40467 the caret is moved to the end of the new text.
40468
40469 Pressing ^R or ^S pops up a window into which the search text can be typed.
40470 There are buttons for selecting forward or reverse searching, for carrying out
40471 the search, and for cancelling. If the &"Search"& button is pressed, the search
40472 happens and the window remains so that further searches can be done. If the
40473 &"Return"& key is pressed, a single search is done and the window is closed. If
40474 ^C is typed the search is cancelled.
40475
40476 The searching facility is implemented using the facilities of the Athena text
40477 widget. By default this pops up a window containing both &"search"& and
40478 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40479 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40480 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40481 provided version of &%TextPop%& when the remaining parts of the text widget
40482 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40483 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40484 on these systems, at the expense of having unwanted items in the search popup
40485 window.
40486
40487
40488
40489 .section "The queue display" "SECID268"
40490 .cindex "queue" "display in monitor"
40491 The bottom section of the monitor window contains a list of all messages that
40492 are in the queue, which includes those currently being received or delivered,
40493 as well as those awaiting delivery. The size of this subwindow is controlled by
40494 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40495 at which it is updated is controlled by another parameter in the same file &--
40496 the default is 5 minutes, since queue scans can be quite expensive. However,
40497 there is an &"Update"& action button just above the display which can be used
40498 to force an update of the queue display at any time.
40499
40500 When a host is down for some time, a lot of pending mail can build up for it,
40501 and this can make it hard to deal with other messages in the queue. To help
40502 with this situation there is a button next to &"Update"& called &"Hide"&. If
40503 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40504 type anything in here and press &"Return"&, the text is added to a chain of
40505 such texts, and if every undelivered address in a message matches at least one
40506 of the texts, the message is not displayed.
40507
40508 If there is an address that does not match any of the texts, all the addresses
40509 are displayed as normal. The matching happens on the ends of addresses so, for
40510 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40511 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40512 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40513 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40514 a hide request is automatically cancelled after one hour.
40515
40516 While the dialogue box is displayed, you can't press any buttons or do anything
40517 else to the monitor window. For this reason, if you want to cut text from the
40518 queue display to use in the dialogue box, you have to do the cutting before
40519 pressing the &"Hide"& button.
40520
40521 The queue display contains, for each unhidden queued message, the length of
40522 time it has been in the queue, the size of the message, the message id, the
40523 message sender, and the first undelivered recipient, all on one line. If it is
40524 a bounce message, the sender is shown as &"<>"&. If there is more than one
40525 recipient to which the message has not yet been delivered, subsequent ones are
40526 listed on additional lines, up to a maximum configured number, following which
40527 an ellipsis is displayed. Recipients that have already received the message are
40528 not shown.
40529
40530 .cindex "frozen messages" "display"
40531 If a message is frozen, an asterisk is displayed at the left-hand side.
40532
40533 The queue display has a vertical scroll bar, and can also be scrolled by means
40534 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40535 The text searching facilities, as described above for the log window, are also
40536 available, but the caret is always moved to the end of the text when the queue
40537 display is updated.
40538
40539
40540
40541 .section "The queue menu" "SECID269"
40542 .cindex "queue" "menu in monitor"
40543 If the &%shift%& key is held down and the left button is clicked when the mouse
40544 pointer is over the text for any message, an action menu pops up, and the first
40545 line of the queue display for the message is highlighted. This does not affect
40546 any selected text.
40547
40548 If you want to use some other event for popping up the menu, you can set the
40549 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40550 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40551 value set in this parameter is a standard X event description. For example, to
40552 run eximon using &%ctrl%& rather than &%shift%& you could use
40553 .code
40554 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40555 .endd
40556 The title of the menu is the message id, and it contains entries which act as
40557 follows:
40558
40559 .ilist
40560 &'message log'&: The contents of the message log for the message are displayed
40561 in a new text window.
40562 .next
40563 &'headers'&: Information from the spool file that contains the envelope
40564 information and headers is displayed in a new text window. See chapter
40565 &<<CHAPspool>>& for a description of the format of spool files.
40566 .next
40567 &'body'&: The contents of the spool file containing the body of the message are
40568 displayed in a new text window. There is a default limit of 20,000 bytes to the
40569 amount of data displayed. This can be changed by setting the BODY_MAX
40570 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40571 .next
40572 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40573 delivery of the message. This causes an automatic thaw if the message is
40574 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40575 a new text window. The delivery is run in a separate process, to avoid holding
40576 up the monitor while the delivery proceeds.
40577 .next
40578 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40579 that the message be frozen.
40580 .next
40581 .cindex "thawing messages"
40582 .cindex "unfreezing messages"
40583 .cindex "frozen messages" "thawing"
40584 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40585 that the message be thawed.
40586 .next
40587 .cindex "delivery" "forcing failure"
40588 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40589 that Exim gives up trying to deliver the message. A bounce message is generated
40590 for any remaining undelivered addresses.
40591 .next
40592 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40593 that the message be deleted from the system without generating a bounce
40594 message.
40595 .next
40596 &'add recipient'&: A dialog box is displayed into which a recipient address can
40597 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40598 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40599 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40600 causes a call to Exim to be made using the &%-Mar%& option to request that an
40601 additional recipient be added to the message, unless the entry box is empty, in
40602 which case no action is taken.
40603 .next
40604 &'mark delivered'&: A dialog box is displayed into which a recipient address
40605 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40606 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40607 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40608 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40609 recipient address as already delivered, unless the entry box is empty, in which
40610 case no action is taken.
40611 .next
40612 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40613 mark all recipient addresses as already delivered.
40614 .next
40615 &'edit sender'&: A dialog box is displayed initialized with the current
40616 sender's address. Pressing RETURN causes a call to Exim to be made using the
40617 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40618 in which case no action is taken. If you want to set an empty sender (as in
40619 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40620 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40621 the address is qualified with that domain.
40622 .endlist
40623
40624 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40625 other cases when a call to Exim is made, if there is any output from Exim (in
40626 particular, if the command fails) a window containing the command and the
40627 output is displayed. Otherwise, the results of the action are normally apparent
40628 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40629 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40630 if no output is generated.
40631
40632 The queue display is automatically updated for actions such as freezing and
40633 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40634 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40635 force an update of the display after one of these actions.
40636
40637 In any text window that is displayed as result of a menu action, the normal
40638 cut-and-paste facility is available, and searching can be carried out using ^R
40639 and ^S, as described above for the log tail window.
40640 .ecindex IIDeximon
40641
40642
40643
40644
40645
40646 . ////////////////////////////////////////////////////////////////////////////
40647 . ////////////////////////////////////////////////////////////////////////////
40648
40649 .chapter "Security considerations" "CHAPsecurity"
40650 .scindex IIDsecurcon "security" "discussion of"
40651 This chapter discusses a number of issues concerned with security, some of
40652 which are also covered in other parts of this manual.
40653
40654 For reasons that this author does not understand, some people have promoted
40655 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40656 existence of this chapter in the documentation. However, the intent of the
40657 chapter is simply to describe the way Exim works in relation to certain
40658 security concerns, not to make any specific claims about the effectiveness of
40659 its security as compared with other MTAs.
40660
40661 What follows is a description of the way Exim is supposed to be. Best efforts
40662 have been made to try to ensure that the code agrees with the theory, but an
40663 absence of bugs can never be guaranteed. Any that are reported will get fixed
40664 as soon as possible.
40665
40666
40667 .section "Building a more &""hardened""& Exim" "SECID286"
40668 .cindex "security" "build-time features"
40669 There are a number of build-time options that can be set in &_Local/Makefile_&
40670 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40671 Exim administrator who does not have the root password, or by someone who has
40672 penetrated the Exim (but not the root) account. These options are as follows:
40673
40674 .ilist
40675 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40676 start of any filenames used with the &%-C%& option. When it is set, these
40677 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40678 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40679 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40680 default setting for &%ALT_CONFIG_PREFIX%&.
40681
40682 If the permitted configuration files are confined to a directory to
40683 which only root has access, this guards against someone who has broken
40684 into the Exim account from running a privileged Exim with an arbitrary
40685 configuration file, and using it to break into other accounts.
40686 .next
40687
40688 If a non-trusted configuration file (i.e. not the default configuration file
40689 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40690 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40691 the next item), then root privilege is retained only if the caller of Exim is
40692 root. This locks out the possibility of testing a configuration using &%-C%&
40693 right through message reception and delivery, even if the caller is root. The
40694 reception works, but by that time, Exim is running as the Exim user, so when
40695 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40696 privilege to be lost. However, root can test reception and delivery using two
40697 separate commands.
40698
40699 .next
40700 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40701 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40702 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40703 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40704 the restrictive side.  Requiring build-time selection of safe macros is onerous
40705 but this option is intended solely as a transition mechanism to permit
40706 previously-working configurations to continue to work after release 4.73.
40707 .next
40708 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40709 is disabled.
40710 .next
40711 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40712 never to be used for any deliveries. This is like the &%never_users%& runtime
40713 option, but it cannot be overridden; the runtime option adds additional users
40714 to the list. The default setting is &"root"&; this prevents a non-root user who
40715 is permitted to modify the runtime file from using Exim as a way to get root.
40716 .endlist
40717
40718
40719
40720 .section "Root privilege" "SECID270"
40721 .cindex "setuid"
40722 .cindex "root privilege"
40723 The Exim binary is normally setuid to root, which means that it gains root
40724 privilege (runs as root) when it starts execution. In some special cases (for
40725 example, when the daemon is not in use and there are no local deliveries), it
40726 may be possible to run Exim setuid to some user other than root. This is
40727 discussed in the next section. However, in most installations, root privilege
40728 is required for two things:
40729
40730 .ilist
40731 To set up a socket connected to the standard SMTP port (25) when initialising
40732 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40733 not required.
40734 .next
40735 To be able to change uid and gid in order to read users' &_.forward_& files and
40736 perform local deliveries as the receiving user or as specified in the
40737 configuration.
40738 .endlist
40739
40740 It is not necessary to be root to do any of the other things Exim does, such as
40741 receiving messages and delivering them externally over SMTP, and it is
40742 obviously more secure if Exim does not run as root except when necessary.
40743 For this reason, a user and group for Exim to use must be defined in
40744 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40745 group"&. Their values can be changed by the runtime configuration, though this
40746 is not recommended. Often a user called &'exim'& is used, but some sites use
40747 &'mail'& or another user name altogether.
40748
40749 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40750 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40751 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40752
40753 After a new Exim process has interpreted its command line options, it changes
40754 uid and gid in the following cases:
40755
40756 .ilist
40757 .oindex "&%-C%&"
40758 .oindex "&%-D%&"
40759 If the &%-C%& option is used to specify an alternate configuration file, or if
40760 the &%-D%& option is used to define macro values for the configuration, and the
40761 calling process is not running as root, the uid and gid are changed to those of
40762 the calling process.
40763 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40764 option may not be used at all.
40765 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40766 can be supplied if the calling process is running as root, the Exim run-time
40767 user or CONFIGURE_OWNER, if defined.
40768 .next
40769 .oindex "&%-be%&"
40770 .oindex "&%-bf%&"
40771 .oindex "&%-bF%&"
40772 If the expansion test option (&%-be%&) or one of the filter testing options
40773 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40774 calling process.
40775 .next
40776 If the process is not a daemon process or a queue runner process or a delivery
40777 process or a process for testing address routing (started with &%-bt%&), the
40778 uid and gid are changed to the Exim user and group. This means that Exim always
40779 runs under its own uid and gid when receiving messages. This also applies when
40780 testing address verification
40781 .oindex "&%-bv%&"
40782 .oindex "&%-bh%&"
40783 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40784 option).
40785 .next
40786 For a daemon, queue runner, delivery, or address testing process, the uid
40787 remains as root at this stage, but the gid is changed to the Exim group.
40788 .endlist
40789
40790 The processes that initially retain root privilege behave as follows:
40791
40792 .ilist
40793 A daemon process changes the gid to the Exim group and the uid to the Exim
40794 user after setting up one or more listening sockets. The &[initgroups()]&
40795 function is called, so that if the Exim user is in any additional groups, they
40796 will be used during message reception.
40797 .next
40798 A queue runner process retains root privilege throughout its execution. Its
40799 job is to fork a controlled sequence of delivery processes.
40800 .next
40801 A delivery process retains root privilege throughout most of its execution,
40802 but any actual deliveries (that is, the transports themselves) are run in
40803 subprocesses which always change to a non-root uid and gid. For local
40804 deliveries this is typically the uid and gid of the owner of the mailbox; for
40805 remote deliveries, the Exim uid and gid are used. Once all the delivery
40806 subprocesses have been run, a delivery process changes to the Exim uid and gid
40807 while doing post-delivery tidying up such as updating the retry database and
40808 generating bounce and warning messages.
40809
40810 While the recipient addresses in a message are being routed, the delivery
40811 process runs as root. However, if a user's filter file has to be processed,
40812 this is done in a subprocess that runs under the individual user's uid and
40813 gid. A system filter is run as root unless &%system_filter_user%& is set.
40814 .next
40815 A process that is testing addresses (the &%-bt%& option) runs as root so that
40816 the routing is done in the same environment as a message delivery.
40817 .endlist
40818
40819
40820
40821
40822 .section "Running Exim without privilege" "SECTrunexiwitpri"
40823 .cindex "privilege, running without"
40824 .cindex "unprivileged running"
40825 .cindex "root privilege" "running without"
40826 Some installations like to run Exim in an unprivileged state for more of its
40827 operation, for added security. Support for this mode of operation is provided
40828 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40829 gid are changed to the Exim user and group at the start of a delivery process
40830 (and also queue runner and address testing processes). This means that address
40831 routing is no longer run as root, and the deliveries themselves cannot change
40832 to any other uid.
40833
40834 .cindex SIGHUP
40835 .cindex "daemon" "restarting"
40836 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40837 that the daemon can still be started in the usual way, and it can respond
40838 correctly to SIGHUP because the re-invocation regains root privilege.
40839
40840 An alternative approach is to make Exim setuid to the Exim user and also setgid
40841 to the Exim group. If you do this, the daemon must be started from a root
40842 process. (Calling Exim from a root process makes it behave in the way it does
40843 when it is setuid root.) However, the daemon cannot restart itself after a
40844 SIGHUP signal because it cannot regain privilege.
40845
40846 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40847 stops Exim from trying to re-invoke itself to do a delivery after a message has
40848 been received. Such a re-invocation is a waste of resources because it has no
40849 effect.
40850
40851 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40852 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40853 to the Exim user seems a clean approach, but there is one complication:
40854
40855 In this style of operation, Exim is running with the real uid and gid set to
40856 those of the calling process, and the effective uid/gid set to Exim's values.
40857 Ideally, any association with the calling process' uid/gid should be dropped,
40858 that is, the real uid/gid should be reset to the effective values so as to
40859 discard any privileges that the caller may have. While some operating systems
40860 have a function that permits this action for a non-root effective uid, quite a
40861 number of them do not. Because of this lack of standardization, Exim does not
40862 address this problem at this time.
40863
40864 For this reason, the recommended approach for &"mostly unprivileged"& running
40865 is to keep the Exim binary setuid to root, and to set
40866 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40867 be used in the most straightforward way.
40868
40869 If you configure Exim not to run delivery processes as root, there are a
40870 number of restrictions on what you can do:
40871
40872 .ilist
40873 You can deliver only as the Exim user/group. You should  explicitly use the
40874 &%user%& and &%group%& options to override routers or local transports that
40875 normally deliver as the recipient. This makes sure that configurations that
40876 work in this mode function the same way in normal mode. Any implicit or
40877 explicit specification of another user causes an error.
40878 .next
40879 Use of &_.forward_& files is severely restricted, such that it is usually
40880 not worthwhile to include them in the configuration.
40881 .next
40882 Users who wish to use &_.forward_& would have to make their home directory and
40883 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40884 and their equivalents in Exim filters, cannot be used. While they could be
40885 enabled in the Exim user's name, that would be insecure and not very useful.
40886 .next
40887 Unless the local user mailboxes are all owned by the Exim user (possible in
40888 some POP3 or IMAP-only environments):
40889
40890 .olist
40891 They must be owned by the Exim group and be writeable by that group. This
40892 implies you must set &%mode%& in the appendfile configuration, as well as the
40893 mode of the mailbox files themselves.
40894 .next
40895 You must set &%no_check_owner%&, since most or all of the files will not be
40896 owned by the Exim user.
40897 .next
40898 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40899 on a newly created mailbox when unprivileged. This also implies that new
40900 mailboxes need to be created manually.
40901 .endlist olist
40902 .endlist ilist
40903
40904
40905 These restrictions severely restrict what can be done in local deliveries.
40906 However, there are no restrictions on remote deliveries. If you are running a
40907 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40908 gives more security at essentially no cost.
40909
40910 If you are using the &%mua_wrapper%& facility (see chapter
40911 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40912
40913
40914
40915
40916 .section "Delivering to local files" "SECID271"
40917 Full details of the checks applied by &(appendfile)& before it writes to a file
40918 are given in chapter &<<CHAPappendfile>>&.
40919
40920
40921
40922 .section "Running local commands" "SECTsecconslocalcmds"
40923 .cindex "security" "local commands"
40924 .cindex "security" "command injection attacks"
40925 There are a number of ways in which an administrator can configure Exim to run
40926 commands based upon received, untrustworthy, data. Further, in some
40927 configurations a user who can control a &_.forward_& file can also arrange to
40928 run commands. Configuration to check includes, but is not limited to:
40929
40930 .ilist
40931 Use of &%use_shell%& in the pipe transport: various forms of shell command
40932 injection may be possible with this option present. It is dangerous and should
40933 be used only with considerable caution. Consider constraints which whitelist
40934 allowed characters in a variable which is to be used in a pipe transport that
40935 has &%use_shell%& enabled.
40936 .next
40937 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40938 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40939 &_.forward_& files in a redirect router. If Exim is running on a central mail
40940 hub to which ordinary users do not have shell access, but home directories are
40941 NFS mounted (for instance) then administrators should review the list of these
40942 forbid options available, and should bear in mind that the options that may
40943 need forbidding can change as new features are added between releases.
40944 .next
40945 The &%${run...}%& expansion item does not use a shell by default, but
40946 administrators can configure use of &_/bin/sh_& as part of the command.
40947 Such invocations should be viewed with prejudicial suspicion.
40948 .next
40949 Administrators who use embedded Perl are advised to explore how Perl's
40950 taint checking might apply to their usage.
40951 .next
40952 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40953 administrators are well advised to view its use with suspicion, in case (for
40954 instance) it allows a local-part to contain embedded Exim directives.
40955 .next
40956 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40957 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40958 each can reference arbitrary lists and files, rather than just being a list
40959 of opaque strings.
40960 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40961 real-world security vulnerabilities caused by its use with untrustworthy data
40962 injected in, for SQL injection attacks.
40963 Consider the use of the &%inlisti%& expansion condition instead.
40964 .endlist
40965
40966
40967
40968
40969 .section "Trust in configuration data" "SECTsecconfdata"
40970 .cindex "security" "data sources"
40971 .cindex "security" "regular expressions"
40972 .cindex "regular expressions" "security"
40973 .cindex "PCRE2" "security"
40974 If configuration data for Exim can come from untrustworthy sources, there
40975 are some issues to be aware of:
40976
40977 .ilist
40978 Use of &%${expand...}%& may provide a path for shell injection attacks.
40979 .next
40980 Letting untrusted data provide a regular expression is unwise.
40981 .next
40982 Using &%${match...}%& to apply a fixed regular expression against untrusted
40983 data may result in pathological behaviour within PCRE2.  Be aware of what
40984 "backtracking" means and consider options for being more strict with a regular
40985 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40986 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40987 possessive quantifiers or just not using regular expressions against untrusted
40988 data.
40989 .next
40990 It can be important to correctly use &%${quote:...}%&,
40991 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40992 items to ensure that data is correctly constructed.
40993 .next
40994 Some lookups might return multiple results, even though normal usage is only
40995 expected to yield one result.
40996 .endlist
40997
40998
40999
41000
41001 .section "IPv4 source routing" "SECID272"
41002 .cindex "source routing" "in IP packets"
41003 .cindex "IP source routing"
41004 Many operating systems suppress IP source-routed packets in the kernel, but
41005 some cannot be made to do this, so Exim does its own check. It logs incoming
41006 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41007 IPv6. No special checking is currently done.
41008
41009
41010
41011 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41012 Support for these SMTP commands is disabled by default. If required, they can
41013 be enabled by defining suitable ACLs.
41014
41015
41016
41017
41018 .section "Privileged users" "SECID274"
41019 .cindex "trusted users"
41020 .cindex "admin user"
41021 .cindex "privileged user"
41022 .cindex "user" "trusted"
41023 .cindex "user" "admin"
41024 Exim recognizes two sets of users with special privileges. Trusted users are
41025 able to submit new messages to Exim locally, but supply their own sender
41026 addresses and information about a sending host. For other users submitting
41027 local messages, Exim sets up the sender address from the uid, and doesn't
41028 permit a remote host to be specified.
41029
41030 .oindex "&%-f%&"
41031 However, an untrusted user is permitted to use the &%-f%& command line option
41032 in the special form &%-f <>%& to indicate that a delivery failure for the
41033 message should not cause an error report. This affects the message's envelope,
41034 but it does not affect the &'Sender:'& header. Untrusted users may also be
41035 permitted to use specific forms of address with the &%-f%& option by setting
41036 the &%untrusted_set_sender%& option.
41037
41038 Trusted users are used to run processes that receive mail messages from some
41039 other mail domain and pass them on to Exim for delivery either locally, or over
41040 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41041 as any user listed in the &%trusted_users%& configuration option, or under any
41042 group listed in the &%trusted_groups%& option.
41043
41044 Admin users are permitted to do things to the messages on Exim's queue. They
41045 can freeze or thaw messages, cause them to be returned to their senders, remove
41046 them entirely, or modify them in various ways. In addition, admin users can run
41047 the Exim monitor and see all the information it is capable of providing, which
41048 includes the contents of files on the spool.
41049
41050 .oindex "&%-M%&"
41051 .oindex "&%-q%&"
41052 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41053 delivery of messages on its queue is restricted to admin users. This
41054 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41055 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41056 queue is also restricted to admin users. This restriction can be relaxed by
41057 setting &%no_queue_list_requires_admin%&.
41058
41059 Exim recognizes an admin user if the calling process is running as root or as
41060 the Exim user or if any of the groups associated with the calling process is
41061 the Exim group. It is not necessary actually to be running under the Exim
41062 group. However, if admin users who are not root or the Exim user are to access
41063 the contents of files on the spool via the Exim monitor (which runs
41064 unprivileged), Exim must be built to allow group read access to its spool
41065 files.
41066
41067 By default, regular users are trusted to perform basic testing and
41068 introspection commands, as themselves.  This setting can be tightened by
41069 setting the &%commandline_checks_require_admin%& option.
41070 This affects most of the checking options,
41071 such as &%-be%& and anything else &%-b*%&.
41072
41073
41074 .section "Spool files" "SECID275"
41075 .cindex "spool directory" "files"
41076 Exim's spool directory and everything it contains is owned by the Exim user and
41077 set to the Exim group. The mode for spool files is defined in the
41078 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41079 any user who is a member of the Exim group can access these files.
41080
41081
41082
41083 .section "Use of argv[0]" "SECID276"
41084 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41085 of specific strings, Exim assumes certain options. For example, calling Exim
41086 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41087 to calling it with the option &%-bS%&. There are no security implications in
41088 this.
41089
41090
41091
41092 .section "Use of %f formatting" "SECID277"
41093 The only use made of &"%f"& by Exim is in formatting load average values. These
41094 are actually stored in integer variables as 1000 times the load average.
41095 Consequently, their range is limited and so therefore is the length of the
41096 converted output.
41097
41098
41099
41100 .section "Embedded Exim path" "SECID278"
41101 Exim uses its own path name, which is embedded in the code, only when it needs
41102 to re-exec in order to regain root privilege. Therefore, it is not root when it
41103 does so. If some bug allowed the path to get overwritten, it would lead to an
41104 arbitrary program's being run as exim, not as root.
41105
41106
41107
41108 .section "Dynamic module directory" "SECTdynmoddir"
41109 Any dynamically loadable modules must be installed into the directory
41110 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41111 loading it.
41112
41113
41114 .section "Use of sprintf()" "SECID279"
41115 .cindex "&[sprintf()]&"
41116 A large number of occurrences of &"sprintf"& in the code are actually calls to
41117 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41118 The intermediate formatting is done into a large fixed buffer by a function
41119 that runs through the format string itself, and checks the length of each
41120 conversion before performing it, thus preventing buffer overruns.
41121
41122 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41123 the output buffer is known to be sufficiently long to contain the converted
41124 string.
41125
41126
41127
41128 .section "Use of debug_printf() and log_write()" "SECID280"
41129 Arbitrary strings are passed to both these functions, but they do their
41130 formatting by calling the function &'string_vformat()'&, which runs through
41131 the format string itself, and checks the length of each conversion.
41132
41133
41134
41135 .section "Use of strcat() and strcpy()" "SECID281"
41136 These are used only in cases where the output buffer is known to be large
41137 enough to hold the result.
41138 .ecindex IIDsecurcon
41139
41140
41141
41142
41143 . ////////////////////////////////////////////////////////////////////////////
41144 . ////////////////////////////////////////////////////////////////////////////
41145
41146 .chapter "Format of spool files" "CHAPspool"
41147 .scindex IIDforspo1 "format" "spool files"
41148 .scindex IIDforspo2 "spool directory" "format of files"
41149 .scindex IIDforspo3 "spool files" "format of"
41150 .cindex "spool files" "editing"
41151 A message on Exim's queue consists of two files, whose names are the message id
41152 followed by -D and -H, respectively. The data portion of the message is kept in
41153 the -D file on its own. The message's envelope, status, and headers are all
41154 kept in the -H file, whose format is described in this chapter. Each of these
41155 two files contains the final component of its own name as its first line. This
41156 is insurance against disk crashes where the directory is lost but the files
41157 themselves are recoverable.
41158
41159 The file formats may be changed, or new formats added, at any release.
41160 Spool files are not intended as an interface to other programs
41161 and should not be used as such.
41162
41163 Some people are tempted into editing -D files in order to modify messages. You
41164 need to be extremely careful if you do this; it is not recommended and you are
41165 on your own if you do it. Here are some of the pitfalls:
41166
41167 .ilist
41168 You must ensure that Exim does not try to deliver the message while you are
41169 fiddling with it. The safest way is to take out a write lock on the -D file,
41170 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41171 place, the lock will be retained. If you write a new file and rename it, the
41172 lock will be lost at the instant of rename.
41173 .next
41174 .vindex "&$body_linecount$&"
41175 If you change the number of lines in the file, the value of
41176 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41177 cause incomplete transmission of messages or undeliverable messages.
41178 .next
41179 If the message is in MIME format, you must take care not to break it.
41180 .next
41181 If the message is cryptographically signed, any change will invalidate the
41182 signature.
41183 .endlist
41184 All in all, modifying -D files is fraught with danger.
41185
41186 Files whose names end with -J may also be seen in the &_input_& directory (or
41187 its subdirectories when &%split_spool_directory%& is set). These are journal
41188 files, used to record addresses to which the message has been delivered during
41189 the course of a delivery attempt. If there are still undelivered recipients at
41190 the end, the -H file is updated, and the -J file is deleted. If, however, there
41191 is some kind of crash (for example, a power outage) before this happens, the -J
41192 file remains in existence. When Exim next processes the message, it notices the
41193 -J file and uses it to update the -H file before starting the next delivery
41194 attempt.
41195
41196 Files whose names end with -K or .eml may also be seen in the spool.
41197 These are temporaries used for DKIM or malware processing, when that is used.
41198 They should be tidied up by normal operations; any old ones are probably
41199 relics of crashes and can be removed.
41200
41201 .section "Format of the -H file" "SECID282"
41202 .cindex "uid (user id)" "in spool file"
41203 .cindex "gid (group id)" "in spool file"
41204 The second line of the -H file contains the login name for the uid of the
41205 process that called Exim to read the message, followed by the numerical uid and
41206 gid. For a locally generated message, this is normally the user who sent the
41207 message. For a message received over TCP/IP via the daemon, it is
41208 normally the Exim user.
41209
41210 The third line of the file contains the address of the message's sender as
41211 transmitted in the envelope, contained in angle brackets. The sender address is
41212 empty for bounce messages. For incoming SMTP mail, the sender address is given
41213 in the MAIL command. For locally generated mail, the sender address is
41214 created by Exim from the login name of the current user and the configured
41215 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41216 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41217 &"<>"& or an address that matches &%untrusted_set_senders%&.
41218
41219 The fourth line contains two numbers. The first is the time that the message
41220 was received, in the conventional Unix form &-- the number of seconds since the
41221 start of the epoch. The second number is a count of the number of messages
41222 warning of delayed delivery that have been sent to the sender.
41223
41224 There follow a number of lines starting with a hyphen.
41225 These contain variables, can appear in any
41226 order, and are omitted when not relevant.
41227
41228 If there is a second hyphen after the first,
41229 the corresponding data is tainted.
41230 If there is a value in parentheses, the data is quoted for a lookup.
41231
41232 The following word specifies a variable,
41233 and the remainder of the item depends on the variable.
41234
41235 .vlist
41236 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41237 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41238 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41239 recognized, to provide backward compatibility. In the old format, a line of
41240 this form is present for every ACL variable that is not empty. The number
41241 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41242 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41243 the data string for the variable. The string itself starts at the beginning of
41244 the next line, and is followed by a newline character. It may contain internal
41245 newlines.
41246
41247 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41248 A line of this form is present for every ACL connection variable that is
41249 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41250 The length is the length of the data string for the variable. The string itself
41251 starts at the beginning of the next line, and is followed by a newline
41252 character. It may contain internal newlines.
41253
41254 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41255 A line of this form is present for every ACL message variable that is defined.
41256 Note that there is a space between &%-aclm%& and the rest of the name. The
41257 length is the length of the data string for the variable. The string itself
41258 starts at the beginning of the next line, and is followed by a newline
41259 character. It may contain internal newlines.
41260
41261 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41262 This is present if, when the message was received over SMTP, the value of
41263 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41264
41265 .vitem &%-allow_unqualified_recipient%&
41266 This is present if unqualified recipient addresses are permitted in header
41267 lines (to stop such addresses from being qualified if rewriting occurs at
41268 transport time). Local messages that were input using &%-bnq%& and remote
41269 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41270
41271 .vitem &%-allow_unqualified_sender%&
41272 This is present if unqualified sender addresses are permitted in header lines
41273 (to stop such addresses from being qualified if rewriting occurs at transport
41274 time). Local messages that were input using &%-bnq%& and remote messages from
41275 hosts that match &%sender_unqualified_hosts%& set this flag.
41276
41277 .vitem "&%-auth_id%&&~<&'text'&>"
41278 The id information for a message received on an authenticated SMTP connection
41279 &-- the value of the &$authenticated_id$& variable.
41280
41281 .vitem "&%-auth_sender%&&~<&'address'&>"
41282 The address of an authenticated sender &-- the value of the
41283 &$authenticated_sender$& variable.
41284
41285 .vitem "&%-body_linecount%&&~<&'number'&>"
41286 This records the number of lines in the body of the message, and is
41287 present unless &%-spool_file_wireformat%& is.
41288
41289 .vitem "&%-body_zerocount%&&~<&'number'&>"
41290 This records the number of binary zero bytes in the body of the message, and is
41291 present if the number is greater than zero.
41292
41293 .vitem &%-deliver_firsttime%&
41294 This is written when a new message is first added to the spool. When the spool
41295 file is updated after a deferral, it is omitted.
41296
41297 .vitem "&%-frozen%&&~<&'time'&>"
41298 .cindex "frozen messages" "spool data"
41299 The message is frozen, and the freezing happened at <&'time'&>.
41300
41301 .vitem "&%-helo_name%&&~<&'text'&>"
41302 This records the host name as specified by a remote host in a HELO or EHLO
41303 command.
41304
41305 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41306 This records the IP address of the host from which the message was received and
41307 the remote port number that was used. It is omitted for locally generated
41308 messages.
41309
41310 .vitem "&%-host_auth%&&~<&'text'&>"
41311 If the message was received on an authenticated SMTP connection, this records
41312 the name of the authenticator &-- the value of the
41313 &$sender_host_authenticated$& variable.
41314
41315 .vitem &%-host_lookup_failed%&
41316 This is present if an attempt to look up the sending host's name from its IP
41317 address failed. It corresponds to the &$host_lookup_failed$& variable.
41318
41319 .vitem "&%-host_name%&&~<&'text'&>"
41320 .cindex "reverse DNS lookup"
41321 .cindex "DNS" "reverse lookup"
41322 This records the name of the remote host from which the message was received,
41323 if the host name was looked up from the IP address when the message was being
41324 received. It is not present if no reverse lookup was done.
41325
41326 .vitem "&%-ident%&&~<&'text'&>"
41327 For locally submitted messages, this records the login of the originating user,
41328 unless it was a trusted user and the &%-oMt%& option was used to specify an
41329 ident value. For messages received over TCP/IP, this records the ident string
41330 supplied by the remote host, if any.
41331
41332 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41333 This records the IP address of the local interface and the port number through
41334 which a message was received from a remote host. It is omitted for locally
41335 generated messages.
41336
41337 .vitem &%-local%&
41338 The message is from a local sender.
41339
41340 .vitem &%-localerror%&
41341 The message is a locally-generated bounce message.
41342
41343 .vitem "&%-local_scan%&&~<&'string'&>"
41344 This records the data string that was returned by the &[local_scan()]& function
41345 when the message was received &-- the value of the &$local_scan_data$&
41346 variable. It is omitted if no data was returned.
41347
41348 .vitem &%-manual_thaw%&
41349 The message was frozen but has been thawed manually, that is, by an explicit
41350 Exim command rather than via the auto-thaw process.
41351
41352 .vitem &%-N%&
41353 A testing delivery process was started using the &%-N%& option to suppress any
41354 actual deliveries, but delivery was deferred. At any further delivery attempts,
41355 &%-N%& is assumed.
41356
41357 .vitem &%-received_protocol%&
41358 This records the value of the &$received_protocol$& variable, which contains
41359 the name of the protocol by which the message was received.
41360
41361 .vitem &%-sender_set_untrusted%&
41362 The envelope sender of this message was set by an untrusted local caller (used
41363 to ensure that the caller is displayed in queue listings).
41364
41365 .vitem "&%-spam_score_int%&&~<&'number'&>"
41366 If a message was scanned by SpamAssassin, this is present. It records the value
41367 of &$spam_score_int$&.
41368
41369 .vitem &%-spool_file_wireformat%&
41370 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41371 rather than Unix-format.
41372 The line-ending is CRLF rather than newline.
41373 There is still, however, no leading-dot-stuffing.
41374
41375 .vitem &%-tls_certificate_verified%&
41376 A TLS certificate was received from the client that sent this message, and the
41377 certificate was verified by the server.
41378
41379 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41380 When the message was received over an encrypted connection, this records the
41381 name of the cipher suite that was used.
41382
41383 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41384 When the message was received over an encrypted connection, and a certificate
41385 was received from the client, this records the Distinguished Name from that
41386 certificate.
41387 .endlist
41388
41389 Following the options there is a list of those addresses to which the message
41390 is not to be delivered. This set of addresses is initialized from the command
41391 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41392 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41393 the address is added to this set. The addresses are kept internally as a
41394 balanced binary tree, and it is a representation of that tree which is written
41395 to the spool file. If an address is expanded via an alias or forward file, the
41396 original address is added to the tree when deliveries to all its child
41397 addresses are complete.
41398
41399 If the tree is empty, there is a single line in the spool file containing just
41400 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41401 Y or N, followed by an address. The address is the value for the node of the
41402 tree, and the letters indicate whether the node has a left branch and/or a
41403 right branch attached to it, respectively. If branches exist, they immediately
41404 follow. Here is an example of a three-node tree:
41405 .code
41406 YY darcy@austen.fict.example
41407 NN alice@wonderland.fict.example
41408 NN editor@thesaurus.ref.example
41409 .endd
41410 After the non-recipients tree, there is a list of the message's recipients.
41411 This is a simple list, preceded by a count. It includes all the original
41412 recipients of the message, including those to whom the message has already been
41413 delivered. In the simplest case, the list contains one address per line. For
41414 example:
41415 .code
41416 4
41417 editor@thesaurus.ref.example
41418 darcy@austen.fict.example
41419 rdo@foundation
41420 alice@wonderland.fict.example
41421 .endd
41422 However, when a child address has been added to the top-level addresses as a
41423 result of the use of the &%one_time%& option on a &(redirect)& router, each
41424 line is of the following form:
41425 .display
41426 <&'top-level address'&> <&'errors_to address'&> &&&
41427   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41428 .endd
41429 The 01 flag bit indicates the presence of the three other fields that follow
41430 the top-level address. Other bits may be used in future to support additional
41431 fields. The <&'parent number'&> is the offset in the recipients list of the
41432 original parent of the &"one time"& address. The first two fields are the
41433 envelope sender that is associated with this address and its length. If the
41434 length is zero, there is no special envelope sender (there are then two space
41435 characters in the line). A non-empty field can arise from a &(redirect)& router
41436 that has an &%errors_to%& setting.
41437
41438
41439 A blank line separates the envelope and status information from the headers
41440 which follow. A header may occupy several lines of the file, and to save effort
41441 when reading it in, each header is preceded by a number and an identifying
41442 character. The number is the number of characters in the header, including any
41443 embedded newlines and the terminating newline. The character is one of the
41444 following:
41445
41446 .table2 50pt
41447 .row <&'blank'&>         "header in which Exim has no special interest"
41448 .row &`B`&               "&'Bcc:'& header"
41449 .row &`C`&               "&'Cc:'& header"
41450 .row &`F`&               "&'From:'& header"
41451 .row &`I`&               "&'Message-id:'& header"
41452 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41453 .row &`R`&               "&'Reply-To:'& header"
41454 .row &`S`&               "&'Sender:'& header"
41455 .row &`T`&               "&'To:'& header"
41456 .row &`*`&               "replaced or deleted header"
41457 .endtable
41458
41459 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41460 purposes. They are not transmitted when the message is delivered. Here is a
41461 typical set of headers:
41462 .code
41463 111P Received: by hobbit.fict.example with local (Exim 4.00)
41464 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41465 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41466 038* X-rewrote-sender: bb@hobbit.fict.example
41467 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41468 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41469 099* To: alice@wonderland.fict.example, rdo@foundation,
41470 darcy@austen.fict.example, editor@thesaurus.ref.example
41471 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41472 darcy@austen.fict.example, editor@thesaurus.ref.example
41473 038  Date: Fri, 11 May 2001 10:28:59 +0100
41474 .endd
41475 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41476 &'To:'& header have been rewritten, the last one because routing expanded the
41477 unqualified domain &'foundation'&.
41478 .ecindex IIDforspo1
41479 .ecindex IIDforspo2
41480 .ecindex IIDforspo3
41481
41482 .section "Format of the -D file" "SECID282a"
41483 The data file is traditionally in Unix-standard format: lines are ended with
41484 an ASCII newline character.
41485 However, when the &%spool_wireformat%& main option is used some -D files
41486 can have an alternate format.
41487 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41488 The -D file lines (not including the first name-component line) are
41489 suitable for direct copying to the wire when transmitting using the
41490 ESMTP CHUNKING option, meaning lower processing overhead.
41491 Lines are terminated with an ASCII CRLF pair.
41492 There is no dot-stuffing (and no dot-termination).
41493
41494 . ////////////////////////////////////////////////////////////////////////////
41495 . ////////////////////////////////////////////////////////////////////////////
41496
41497 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41498          "DKIM, SPF, SRS and DMARC Support"
41499
41500 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41501 .cindex "DKIM"
41502
41503 DKIM is a mechanism by which messages sent by some entity can be provably
41504 linked to a domain which that entity controls.  It permits reputation to
41505 be tracked on a per-domain basis, rather than merely upon source IP address.
41506 DKIM is documented in RFC 6376.
41507
41508 As DKIM relies on the message being unchanged in transit, messages handled
41509 by a mailing-list (which traditionally adds to the message) will not match
41510 any original DKIM signature.
41511
41512 DKIM support is compiled into Exim by default if TLS support is present.
41513 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41514
41515 Exim's DKIM implementation allows for
41516 .olist
41517 Signing outgoing messages: This function is implemented in the SMTP transport.
41518 It can co-exist with all other Exim features
41519 (including transport filters)
41520 except cutthrough delivery.
41521 .next
41522 Verifying signatures in incoming messages: This is implemented by an additional
41523 ACL (acl_smtp_dkim), which can be called several times per message, with
41524 different signature contexts.
41525 .endlist
41526
41527 In typical Exim style, the verification implementation does not include any
41528 default "policy". Instead it enables you to build your own policy using
41529 Exim's standard controls.
41530
41531 Please note that verification of DKIM signatures in incoming mail is turned
41532 on by default for logging (in the <= line) purposes.
41533
41534 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41535 When set, for each signature in incoming email,
41536 exim will log a line displaying the most important signature details, and the
41537 signature status. Here is an example (with line-breaks added for clarity):
41538 .code
41539 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41540     d=facebookmail.com s=q1-2009b
41541     c=relaxed/relaxed a=rsa-sha1
41542     i=@facebookmail.com t=1252484542 [verification succeeded]
41543 .endd
41544
41545 You might want to turn off DKIM verification processing entirely for internal
41546 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41547 control modifier. This should typically be done in the RCPT ACL, at points
41548 where you accept mail from relay sources (internal hosts or authenticated
41549 senders).
41550
41551
41552 .subsection "Signing outgoing messages" SECDKIMSIGN
41553 .cindex DKIM signing
41554
41555 For signing to be usable you must have published a DKIM record in DNS.
41556 Note that RFC 8301 (which does not cover EC keys) says:
41557 .code
41558 rsa-sha1 MUST NOT be used for signing or verifying.
41559
41560 Signers MUST use RSA keys of at least 1024 bits for all keys.
41561 Signers SHOULD use RSA keys of at least 2048 bits.
41562 .endd
41563
41564 Note also that the key content (the 'p=' field)
41565 in the DNS record is different between RSA and EC keys;
41566 for the former it is the base64 of the ASN.1 for the RSA public key
41567 (equivalent to the private-key .pem with the header/trailer stripped)
41568 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41569
41570 Signing is enabled by setting private options on the SMTP transport.
41571 These options take (expandable) strings as arguments.
41572
41573 .option dkim_domain smtp "string list&!!" unset
41574 The domain(s) you want to sign with.
41575 After expansion, this can be a list.
41576 Each element in turn,
41577 lowercased,
41578 .vindex "&$dkim_domain$&"
41579 is put into the &%$dkim_domain%& expansion variable
41580 while expanding the remaining signing options.
41581 If it is empty after expansion, DKIM signing is not done,
41582 and no error will result even if &%dkim_strict%& is set.
41583
41584 .option dkim_selector smtp "string list&!!" unset
41585 This sets the key selector string.
41586 After expansion, which can use &$dkim_domain$&, this can be a list.
41587 Each element in turn is put in the expansion
41588 .vindex "&$dkim_selector$&"
41589 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41590 option along with &%$dkim_domain%&.
41591 If the option is empty after expansion, DKIM signing is not done for this domain,
41592 and no error will result even if &%dkim_strict%& is set.
41593
41594 To do, for example, dual-signing with RSA and EC keys
41595 this could be be used:
41596 .code
41597 dkim_selector = ec_sel : rsa_sel
41598 dkim_private_key = KEYS_DIR/$dkim_selector
41599 .endd
41600
41601 .option dkim_private_key smtp string&!! unset
41602 This sets the private key to use.
41603 You can use the &%$dkim_domain%& and
41604 &%$dkim_selector%& expansion variables to determine the private key to use.
41605 The result can either
41606 .ilist
41607 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41608 .next
41609 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41610 be a valid Ed25519 private key (same format as above)
41611 .next
41612 start with a slash, in which case it is treated as a file that contains
41613 the private key
41614 .next
41615 be "0", "false" or the empty string, in which case the message will not
41616 be signed. This case will not result in an error, even if &%dkim_strict%&
41617 is set.
41618 .endlist
41619
41620 To generate keys under OpenSSL:
41621 .code
41622 openssl genrsa -out dkim_rsa.private 2048
41623 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41624 .endd
41625 The result file from the first command should be retained, and
41626 this option set to use it.
41627 Take the base-64 lines from the output of the second command, concatenated,
41628 for the DNS TXT record.
41629 See section 3.6 of RFC6376 for the record specification.
41630
41631 Under GnuTLS:
41632 .code
41633 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41634 certtool --load-privkey=dkim_rsa.private --pubkey-info
41635 .endd
41636
41637 Note that RFC 8301 says:
41638 .code
41639 Signers MUST use RSA keys of at least 1024 bits for all keys.
41640 Signers SHOULD use RSA keys of at least 2048 bits.
41641 .endd
41642
41643 EC keys for DKIM are defined by RFC 8463.
41644 They are considerably smaller than RSA keys for equivalent protection.
41645 As they are a recent development, users should consider dual-signing
41646 (by setting a list of selectors, and an expansion for this option)
41647 for some transition period.
41648 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41649 for EC keys.
41650
41651 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41652 .code
41653 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41654 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41655 .endd
41656
41657 To produce the required public key value for a DNS record:
41658 .code
41659 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41660 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41661 .endd
41662
41663 Exim also supports an alternate format
41664 of Ed25519 keys in DNS which was a candidate during development
41665 of the standard, but not adopted.
41666 A future release will probably drop that support.
41667
41668 .option dkim_hash smtp string&!! sha256
41669 Can be set to any one of the supported hash methods, which are:
41670 .ilist
41671 &`sha1`& &-- should not be used, is old and insecure
41672 .next
41673 &`sha256`& &-- the default
41674 .next
41675 &`sha512`& &-- possibly more secure but less well supported
41676 .endlist
41677
41678 Note that RFC 8301 says:
41679 .code
41680 rsa-sha1 MUST NOT be used for signing or verifying.
41681 .endd
41682
41683 .option dkim_identity smtp string&!! unset
41684 If set after expansion, the value is used to set an "i=" tag in
41685 the signing header.  The DKIM standards restrict the permissible
41686 syntax of this optional tag to a mail address, with possibly-empty
41687 local part, an @, and a domain identical to or subdomain of the "d="
41688 tag value.  Note that Exim does not check the value.
41689
41690 .option dkim_canon smtp string&!! unset
41691 This option sets the canonicalization method used when signing a message.
41692 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41693 The option defaults to "relaxed" when unset. Note: the current implementation
41694 only supports signing with the same canonicalization method for both headers and body.
41695
41696 .option dkim_strict smtp string&!! unset
41697 This  option  defines  how  Exim  behaves  when  signing a message that
41698 should be signed fails for some reason.  When the expansion evaluates to
41699 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41700 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41701 variables here.
41702
41703 .option dkim_sign_headers smtp string&!! "see below"
41704 If set, this option must expand to a colon-separated
41705 list of header names.
41706 Headers with these names, or the absence or such a header, will be included
41707 in the message signature.
41708 When unspecified, the header names listed in RFC4871 will be used,
41709 whether or not each header is present in the message.
41710 The default list is available for the expansion in the macro
41711 &"_DKIM_SIGN_HEADERS"&
41712 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41713
41714 If a name is repeated, multiple headers by that name (or the absence thereof)
41715 will be signed.  The textually later headers in the headers part of the
41716 message are signed first, if there are multiples.
41717
41718 A name can be prefixed with either an &"="& or a &"+"& character.
41719 If an &"="& prefix is used, all headers that are present with this name
41720 will be signed.
41721 If a &"+"& prefix if used, all headers that are present with this name
41722 will be signed, and one signature added for a missing header with the
41723 name will be appended.
41724
41725 .option dkim_timestamps smtp integer&!! unset
41726 This option controls the inclusion of timestamp information in the signature.
41727 If not set, no such information will be included.
41728 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41729 for the expiry tag
41730 (eg. 1209600 for two weeks);
41731 both creation (t=) and expiry (x=) tags will be included.
41732
41733 RFC 6376 lists these tags as RECOMMENDED.
41734
41735
41736 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41737 .cindex DKIM verification
41738
41739 Verification of DKIM signatures in SMTP incoming email is done for all
41740 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41741 .cindex DKIM "selecting signature algorithms"
41742 Individual classes of signature algorithm can be ignored by changing
41743 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41744 The &%dkim_verify_minimal%& option can be set to cease verification
41745 processing for a message once the first passing signature is found.
41746
41747 .cindex authentication "expansion item"
41748 Performing verification sets up information used by the
41749 &%authresults%& expansion item.
41750
41751 For most purposes the default option settings suffice and the remainder
41752 of this section can be ignored.
41753
41754 The results of verification are made available to the
41755 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41756 A missing ACL definition defaults to accept.
41757 By default, the ACL is called once for each
41758 syntactically(!) correct signature in the incoming message.
41759 If any ACL call does not accept, the message is not accepted.
41760 If a cutthrough delivery was in progress for the message, that is
41761 summarily dropped (having wasted the transmission effort).
41762
41763 To evaluate the verification result in the ACL
41764 a large number of expansion variables
41765 containing the signature status and its details are set up during the
41766 runtime of the ACL.
41767
41768 Calling the ACL only for existing signatures is not sufficient to build
41769 more advanced policies. For that reason, the main option
41770 &%dkim_verify_signers%&, and an expansion variable
41771 &%$dkim_signers%& exist.
41772
41773 The main option &%dkim_verify_signers%& can be set to a colon-separated
41774 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41775 called. It is expanded when the message has been received. At this point,
41776 the expansion variable &%$dkim_signers%& already contains a colon-separated
41777 list of signer domains and identities for the message. When
41778 &%dkim_verify_signers%& is not specified in the main configuration,
41779 it defaults as:
41780 .code
41781 dkim_verify_signers = $dkim_signers
41782 .endd
41783 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41784 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41785 call the ACL for known domains or identities. This would be achieved as follows:
41786 .code
41787 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41788 .endd
41789 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41790 and "ebay.com", plus all domains and identities that have signatures in the message.
41791 You can also be more creative in constructing your policy. For example:
41792 .code
41793 dkim_verify_signers = $sender_address_domain:$dkim_signers
41794 .endd
41795
41796 If a domain or identity is listed several times in the (expanded) value of
41797 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41798
41799 Note that if the option is set using untrustworthy data
41800 (such as the From: header)
41801 care should be taken to force lowercase for domains
41802 and for the domain part if identities.
41803 The default setting can be regarded as trustworthy in this respect.
41804
41805 If multiple signatures match a domain (or identity), the ACL is called once
41806 for each matching signature.
41807
41808
41809 Inside the DKIM ACL, the following expansion variables are
41810 available (from most to least important):
41811
41812
41813 .vlist
41814 .vitem &%$dkim_cur_signer%&
41815 The signer that is being evaluated in this ACL run. This can be a domain or
41816 an identity. This is one of the list items from the expanded main option
41817 &%dkim_verify_signers%& (see above).
41818
41819 .vitem &%$dkim_verify_status%&
41820 Within the DKIM ACL,
41821 a string describing the general status of the signature. One of
41822 .ilist
41823 &%none%&: There is no signature in the message for the current domain or
41824 identity (as reflected by &%$dkim_cur_signer%&).
41825 .next
41826 &%invalid%&: The signature could not be verified due to a processing error.
41827 More detail is available in &%$dkim_verify_reason%&.
41828 .next
41829 &%fail%&: Verification of the signature failed.  More detail is
41830 available in &%$dkim_verify_reason%&.
41831 .next
41832 &%pass%&: The signature passed verification. It is valid.
41833 .endlist
41834
41835 This variable can be overwritten using an ACL 'set' modifier.
41836 This might, for instance, be done to enforce a policy restriction on
41837 hash-method or key-size:
41838 .code
41839   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41840        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41841        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41842                                   {< {$dkim_key_length}{1024}}}}
41843        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41844        set dkim_verify_status = fail
41845        set dkim_verify_reason = hash too weak or key too short
41846 .endd
41847
41848 So long as a DKIM ACL is defined (it need do no more than accept),
41849 after all the DKIM ACL runs have completed, the value becomes a
41850 colon-separated list of the values after each run.
41851 This is maintained for the mime, prdr and data ACLs.
41852
41853 .vitem &%$dkim_verify_reason%&
41854 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41855 "fail" or "invalid". One of
41856 .ilist
41857 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41858 key for the domain could not be retrieved. This may be a temporary problem.
41859 .next
41860 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41861 record for the domain is syntactically invalid.
41862 .next
41863 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41864 body hash does not match the one specified in the signature header. This
41865 means that the message body was modified in transit.
41866 .next
41867 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41868 could not be verified. This may mean that headers were modified,
41869 re-written or otherwise changed in a way which is incompatible with
41870 DKIM verification. It may of course also mean that the signature is forged.
41871 .endlist
41872
41873 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41874
41875 .vitem &%$dkim_domain%&
41876 The signing domain. IMPORTANT: This variable is only populated if there is
41877 an actual signature in the message for the current domain or identity (as
41878 reflected by &%$dkim_cur_signer%&).
41879
41880 .vitem &%$dkim_identity%&
41881 The signing identity, if present. IMPORTANT: This variable is only populated
41882 if there is an actual signature in the message for the current domain or
41883 identity (as reflected by &%$dkim_cur_signer%&).
41884
41885 .vitem &%$dkim_selector%&
41886 The key record selector string.
41887
41888 .vitem &%$dkim_algo%&
41889 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41890 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41891 may also be 'ed25519-sha256'.
41892 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41893 for EC keys.
41894
41895 Note that RFC 8301 says:
41896 .code
41897 rsa-sha1 MUST NOT be used for signing or verifying.
41898
41899 DKIM signatures identified as having been signed with historic
41900 algorithms (currently, rsa-sha1) have permanently failed evaluation
41901 .endd
41902
41903 To enforce this you must either have a DKIM ACL which checks this variable
41904 and overwrites the &$dkim_verify_status$& variable as discussed above,
41905 or have set the main option &%dkim_verify_hashes%& to exclude
41906 processing of such signatures.
41907
41908 .vitem &%$dkim_canon_body%&
41909 The body canonicalization method. One of 'relaxed' or 'simple'.
41910
41911 .vitem &%$dkim_canon_headers%&
41912 The header canonicalization method. One of 'relaxed' or 'simple'.
41913
41914 .vitem &%$dkim_copiedheaders%&
41915 A transcript of headers and their values which are included in the signature
41916 (copied from the 'z=' tag of the signature).
41917 Note that RFC6376 requires that verification fail if the From: header is
41918 not included in the signature.  Exim does not enforce this; sites wishing
41919 strict enforcement should code the check explicitly.
41920
41921 .vitem &%$dkim_bodylength%&
41922 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41923 limit was set by the signer, "9999999999999" is returned. This makes sure
41924 that this variable always expands to an integer value.
41925 &*Note:*& The presence of the signature tag specifying a signing body length
41926 is one possible route to spoofing of valid DKIM signatures.
41927 A paranoid implementation might wish to regard signature where this variable
41928 shows less than the "no limit" return as being invalid.
41929
41930 .vitem &%$dkim_created%&
41931 UNIX timestamp reflecting the date and time when the signature was created.
41932 When this was not specified by the signer, "0" is returned.
41933
41934 .vitem &%$dkim_expires%&
41935 UNIX timestamp reflecting the date and time when the signer wants the
41936 signature to be treated as "expired". When this was not specified by the
41937 signer, "9999999999999" is returned. This makes it possible to do useful
41938 integer size comparisons against this value.
41939 Note that Exim does not check this value.
41940
41941 .vitem &%$dkim_headernames%&
41942 A colon-separated list of names of headers included in the signature.
41943
41944 .vitem &%$dkim_key_testing%&
41945 "1" if the key record has the "testing" flag set, "0" if not.
41946
41947 .vitem &%$dkim_key_nosubdomains%&
41948 "1" if the key record forbids subdomaining, "0" otherwise.
41949
41950 .vitem &%$dkim_key_srvtype%&
41951 Service type (tag s=) from the key record. Defaults to "*" if not specified
41952 in the key record.
41953
41954 .vitem &%$dkim_key_granularity%&
41955 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41956 in the key record.
41957
41958 .vitem &%$dkim_key_notes%&
41959 Notes from the key record (tag n=).
41960
41961 .vitem &%$dkim_key_length%&
41962 Number of bits in the key.
41963 Valid only once the key is loaded, which is at the time the header signature
41964 is verified, which is after the body hash is.
41965
41966 Note that RFC 8301 says:
41967 .code
41968 Verifiers MUST NOT consider signatures using RSA keys of
41969 less than 1024 bits as valid signatures.
41970 .endd
41971
41972 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41973 option.
41974
41975 .endlist
41976
41977 In addition, two ACL conditions are provided:
41978
41979 .vlist
41980 .vitem &%dkim_signers%&
41981 ACL condition that checks a colon-separated list of domains or identities
41982 for a match against the domain or identity that the ACL is currently verifying
41983 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41984 verb to a group of domains or identities. For example:
41985
41986 .code
41987 # Warn when Mail purportedly from GMail has no gmail signature
41988 warn sender_domains = gmail.com
41989      dkim_signers = gmail.com
41990      dkim_status = none
41991      log_message = GMail sender without gmail.com DKIM signature
41992 .endd
41993
41994 Note that the above does not check for a total lack of DKIM signing;
41995 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41996
41997 .vitem &%dkim_status%&
41998 ACL condition that checks a colon-separated list of possible DKIM verification
41999 results against the actual result of verification. This is typically used
42000 to restrict an ACL verb to a list of verification outcomes, for example:
42001
42002 .code
42003 deny sender_domains = paypal.com:paypal.de
42004      dkim_signers = paypal.com:paypal.de
42005      dkim_status = none:invalid:fail
42006      message = Mail from Paypal with invalid/missing signature
42007 .endd
42008
42009 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42010 see the documentation of the &%$dkim_verify_status%& expansion variable above
42011 for more information of what they mean.
42012 .endlist
42013
42014
42015
42016
42017 .section "SPF (Sender Policy Framework)" SECSPF
42018 .cindex SPF verification
42019
42020 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42021 messages with its domain in the envelope from, documented by RFC 7208.
42022 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42023 the &url(http://openspf.org).
42024 . --- 2019-10-28: still not https, open-spf.org is told to be a
42025 . --- web-archive copy of the now dead openspf.org site
42026 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42027 . --- discussion.
42028
42029 Messages sent by a system not authorised will fail checking of such assertions.
42030 This includes retransmissions done by traditional forwarders.
42031
42032 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42033 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42034 &url(https://www.libspf2.org/).
42035 There is no Exim involvement in the transmission of messages;
42036 publishing certain DNS records is all that is required.
42037
42038 For verification, an ACL condition and an expansion lookup are provided.
42039 .cindex authentication "expansion item"
42040 Performing verification sets up information used by the
42041 &%authresults%& expansion item.
42042
42043
42044 .cindex SPF "ACL condition"
42045 .cindex ACL "spf condition"
42046 The ACL condition "spf" can be used at or after the MAIL ACL.
42047 It takes as an argument a list of strings giving the outcome of the SPF check,
42048 and will succeed for any matching outcome.
42049 Valid strings are:
42050 .vlist
42051 .vitem &%pass%&
42052 The SPF check passed, the sending host is positively verified by SPF.
42053
42054 .vitem &%fail%&
42055 The SPF check failed, the sending host is NOT allowed to send mail for the
42056 domain in the envelope-from address.
42057
42058 .vitem &%softfail%&
42059 The SPF check failed, but the queried domain can't absolutely confirm that this
42060 is a forgery.
42061
42062 .vitem &%none%&
42063 The queried domain does not publish SPF records.
42064
42065 .vitem &%neutral%&
42066 The SPF check returned a "neutral" state.  This means the queried domain has
42067 published a SPF record, but wants to allow outside servers to send mail under
42068 its domain as well.  This should be treated like "none".
42069
42070 .vitem &%permerror%&
42071 This indicates a syntax error in the SPF record of the queried domain.
42072 You may deny messages when this occurs.
42073
42074 .vitem &%temperror%&
42075 This indicates a temporary error during all processing, including Exim's
42076 SPF processing.  You may defer messages when this occurs.
42077
42078 .vitem &%invalid%&
42079 There was an error during processing of the SPF lookup
42080 .endlist
42081
42082 You can prefix each string with an exclamation mark to  invert
42083 its meaning,  for example  "!fail" will  match all  results but
42084 "fail".  The  string  list is  evaluated  left-to-right,  in a
42085 short-circuit fashion.
42086
42087 Example:
42088 .code
42089 deny spf = fail
42090      message = $sender_host_address is not allowed to send mail from \
42091                ${if def:sender_address_domain \
42092                     {$sender_address_domain}{$sender_helo_name}}.  \
42093                Please see http://www.open-spf.org/Why;\
42094                identity=${if def:sender_address_domain \
42095                              {$sender_address}{$sender_helo_name}};\
42096                ip=$sender_host_address
42097 .endd
42098
42099 Note: The above mentioned URL may not be as helpful as expected. You are
42100 encouraged to replace the link with a link to a site with more
42101 explanations.
42102
42103 When the spf condition has run, it sets up several expansion
42104 variables:
42105
42106 .cindex SPF "verification variables"
42107 .vlist
42108 .vitem &$spf_header_comment$&
42109 .vindex &$spf_header_comment$&
42110   This contains a human-readable string describing the outcome
42111   of the SPF check. You can add it to a custom header or use
42112   it for logging purposes.
42113
42114 .vitem &$spf_received$&
42115 .vindex &$spf_received$&
42116   This contains a complete Received-SPF: header (name and
42117   content) that can be added to the message. Please note that
42118   according to the SPF draft, this header must be added at the
42119   top of the header list, i.e. with
42120 .code
42121 add_header = :at_start:$spf_received
42122 .endd
42123   See section &<<SECTaddheadacl>>& for further details.
42124
42125   Note: in case of "Best-guess" (see below), the convention is
42126   to put this string in a header called X-SPF-Guess: instead.
42127
42128 .vitem &$spf_result$&
42129 .vindex &$spf_result$&
42130   This contains the outcome of the SPF check in string form,
42131   currently one of pass, fail, softfail, none, neutral, permerror,
42132   temperror, or &"(invalid)"&.
42133
42134 .vitem &$spf_result_guessed$&
42135 .vindex &$spf_result_guessed$&
42136   This boolean is true only if a best-guess operation was used
42137   and required in order to obtain a result.
42138
42139 .vitem &$spf_smtp_comment$&
42140 .vindex &$spf_smtp_comment$&
42141 .vindex &%spf_smtp_comment_template%&
42142   This contains a string that can be used in a SMTP response
42143   to the calling party. Useful for "fail".
42144   The string is generated by the SPF library from the template configured in the main config
42145   option &%spf_smtp_comment_template%&.
42146 .endlist
42147
42148
42149 .cindex SPF "ACL condition"
42150 .cindex ACL "spf_guess condition"
42151 .cindex SPF "best guess"
42152 In addition to SPF, you can also perform checks for so-called
42153 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42154 SPF, but it is supported by the same framework that enables SPF
42155 capability.
42156 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42157 for a description of what it means.
42158 . --- 2019-10-28: still not https:
42159
42160 To access this feature, simply use the spf_guess condition in place
42161 of the spf one.  For example:
42162
42163 .code
42164 deny spf_guess = fail
42165      message = $sender_host_address doesn't look trustworthy to me
42166 .endd
42167
42168 In case you decide to reject messages based on this check, you
42169 should note that although it uses the same framework, "Best-guess"
42170 is not SPF, and therefore you should not mention SPF at all in your
42171 reject message.
42172
42173 When the spf_guess condition has run, it sets up the same expansion
42174 variables as when spf condition is run, described above.
42175
42176 Additionally, since Best-guess is not standardized, you may redefine
42177 what "Best-guess" means to you by redefining the main configuration
42178 &%spf_guess%& option.
42179 For example, the following:
42180
42181 .code
42182 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42183 .endd
42184
42185 would relax host matching rules to a broader network range.
42186
42187
42188 .cindex SPF "lookup expansion"
42189 .cindex lookup spf
42190 A lookup expansion is also available. It takes an email
42191 address as the key and an IP address
42192 (v4 or v6)
42193 as the database:
42194
42195 .code
42196   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42197 .endd
42198
42199 The lookup will return the same result strings as can appear in
42200 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42201
42202
42203
42204
42205
42206 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42207 .cindex SRS "sender rewriting scheme"
42208
42209 SRS can be used to modify sender addresses when forwarding so that
42210 SPF verification does not object to them.
42211 It operates by encoding the original envelope sender in a new
42212 sender local part and using a domain run by the forwarding site
42213 as the new domain for the sender.  Any DSN message should be returned
42214 to this new sender at the forwarding site, which can extract the
42215 original sender from the coded local part and forward the DSN to
42216 the originator.
42217
42218 This is a way of avoiding the breakage that SPF does to forwarding.
42219 The constructed local-part will be longer than the original,
42220 leading to possible problems with very long addresses.
42221 The changing of the sender address also hinders the tracing of mail
42222 problems.
42223
42224 Exim can be built to include native SRS support.  To do this
42225 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42226 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42227 will be defined.
42228 The support is limited to SRS0-encoding; SRS1 is not supported.
42229
42230 .cindex SRS excoding
42231 To encode an address use this expansion item:
42232 .vlist
42233 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42234 .cindex "&%srs_encode%& expansion item"
42235 .cindex SRS "expansion item"
42236 The first argument should be a secret known and used by all systems
42237 handling the recipient domain for the original message.
42238 There is no need to periodically change this key; a timestamp is also
42239 encoded.
42240 The second argument should be given as the envelope sender address before this
42241 encoding operation.
42242 If this value is empty the the expansion result will be empty.
42243 The third argument should be the recipient domain of the message when
42244 it arrived at this system.
42245 .endlist
42246
42247 .cindex SRS decoding
42248 To decode an address use this expansion condition:
42249 .vlist
42250 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42251 The first argument should be the recipient local prt as is was received.
42252 The second argument is the site secret.
42253
42254 If the messages is not for an SRS-encoded recipient the condition will
42255 return false.  If it is, the condition will return true and the variable
42256 &$srs_recipient$& will be set to the decoded (original) value.
42257 .endlist
42258
42259 Example usage:
42260 .code
42261   #macro
42262   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42263
42264   #routers
42265
42266   outbound:
42267     driver =    dnslookup
42268     # if outbound, and forwarding has been done, use an alternate transport
42269     domains =   ! +my_domains
42270     transport = ${if eq {$local_part@$domain} \
42271                         {$original_local_part@$original_domain} \
42272                      {remote_smtp} {remote_forwarded_smtp}}
42273
42274   inbound_srs:
42275     driver =    redirect
42276     senders =   :
42277     domains =   +my_domains
42278     # detect inbound bounces which are SRS'd, and decode them
42279     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42280     data =      $srs_recipient
42281
42282   inbound_srs_failure:
42283     driver =    redirect
42284     senders =   :
42285     domains =   +my_domains
42286     # detect inbound bounces which look SRS'd but are invalid
42287     condition = ${if inbound_srs {$local_part} {}}
42288     allow_fail
42289     data =      :fail: Invalid SRS recipient address
42290
42291   #... further routers here
42292
42293
42294   # transport; should look like the non-forward outbound
42295   # one, plus the max_rcpt and return_path options
42296   remote_forwarded_smtp:
42297     driver =              smtp
42298     # single-recipient so that $original_domain is valid
42299     max_rcpt =            1
42300     # modify the envelope from, for mails that we forward
42301     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42302 .endd
42303
42304
42305
42306
42307
42308 .section DMARC SECDMARC
42309 .cindex DMARC verification
42310
42311 DMARC combines feedback from SPF, DKIM, and header From: in order
42312 to attempt to provide better indicators of the authenticity of an
42313 email.  This document does not explain the fundamentals; you
42314 should read and understand how it works by visiting the website at
42315 &url(http://www.dmarc.org/).
42316
42317 If Exim is built with DMARC support,
42318 the libopendmarc library is used.
42319
42320 For building Exim yourself, obtain the library from
42321 &url(http://sourceforge.net/projects/opendmarc/)
42322 to obtain a copy, or find it in your favorite package
42323 repository.  You will need to attend to the local/Makefile feature
42324 SUPPORT_DMARC and the associated LDFLAGS addition.
42325 This description assumes
42326 that headers will be in /usr/local/include, and that the libraries
42327 are in /usr/local/lib.
42328
42329 .subsection Configuration SSECDMARCCONFIG
42330 .cindex DMARC configuration
42331
42332 There are three main-configuration options:
42333 .cindex DMARC "configuration options"
42334
42335 The &%dmarc_tld_file%& option
42336 .oindex &%dmarc_tld_file%&
42337 defines the location of a text file of valid
42338 top level domains the opendmarc library uses
42339 during domain parsing. Maintained by Mozilla,
42340 the most current version can be downloaded
42341 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42342 See also the util/renew-opendmarc-tlds.sh script.
42343 The default for the option is unset.
42344 If not set, DMARC processing is disabled.
42345
42346
42347 The &%dmarc_history_file%& option, if set
42348 .oindex &%dmarc_history_file%&
42349 defines the location of a file to log results
42350 of dmarc verification on inbound emails. The
42351 contents are importable by the opendmarc tools
42352 which will manage the data, send out DMARC
42353 reports, and expire the data. Make sure the
42354 directory of this file is writable by the user
42355 exim runs as.
42356 The default is unset.
42357
42358 The &%dmarc_forensic_sender%& option
42359 .oindex &%dmarc_forensic_sender%&
42360 defines an alternate email address to use when sending a
42361 forensic report detailing alignment failures
42362 if a sender domain's dmarc record specifies it
42363 and you have configured Exim to send them.
42364 If set, this is expanded and used for the
42365 From: header line; the address is extracted
42366 from it and used for the envelope from.
42367 If not set (the default), the From: header is expanded from
42368 the dsn_from option, and <> is used for the
42369 envelope from.
42370
42371 .subsection Controls SSECDMARCCONTROLS
42372 .cindex DMARC controls
42373
42374 By default, the DMARC processing will run for any remote,
42375 non-authenticated user.  It makes sense to only verify DMARC
42376 status of messages coming from remote, untrusted sources.  You can
42377 use standard conditions such as hosts, senders, etc, to decide that
42378 DMARC verification should *not* be performed for them and disable
42379 DMARC with an ACL control modifier:
42380 .code
42381   control = dmarc_disable_verify
42382 .endd
42383 A DMARC record can also specify a "forensic address", which gives
42384 exim an email address to submit reports about failed alignment.
42385 Exim does not do this by default because in certain conditions it
42386 results in unintended information leakage (what lists a user might
42387 be subscribed to, etc).  You must configure exim to submit forensic
42388 reports to the owner of the domain.  If the DMARC record contains a
42389 forensic address and you specify the control statement below, then
42390 exim will send these forensic emails.  It is also advised that you
42391 configure a &%dmarc_forensic_sender%& because the default sender address
42392 construction might be inadequate.
42393 .code
42394   control = dmarc_enable_forensic
42395 .endd
42396 (AGAIN: You can choose not to send these forensic reports by simply
42397 not putting the dmarc_enable_forensic control line at any point in
42398 your exim config.  If you don't tell exim to send them, it will not
42399 send them.)
42400
42401 There are no options to either control.  Both must appear before
42402 the DATA acl.
42403
42404 .subsection ACL SSECDMARCACL
42405 .cindex DMARC "ACL condition"
42406
42407 DMARC checks can be run on incoming SMTP  messages by using the
42408 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42409 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42410 condition.  Putting this condition in the ACLs is required in order
42411 for a DMARC check to actually occur.  All of the variables are set
42412 up before the DATA ACL, but there is no actual DMARC check that
42413 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42414
42415 The &"dmarc_status"& condition takes a list of strings on its
42416 right-hand side.  These strings describe recommended action based
42417 on the DMARC check.  To understand what the policy recommendations
42418 mean, refer to the DMARC website above.  Valid strings are:
42419 .itable none 0 0 2 20* left 80* left
42420 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42421 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42422 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42423 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42424 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42425 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42426 .irow &'temperror'&     "Library error or dns error"
42427 .irow &'off'&           "The DMARC check was disabled for this email"
42428 .endtable
42429 You can prefix each string with an exclamation mark to invert its
42430 meaning, for example "!accept" will match all results but
42431 "accept".  The string list is evaluated left-to-right in a
42432 short-circuit fashion.  When a string matches the outcome of the
42433 DMARC check, the condition succeeds.  If none of the listed
42434 strings matches the outcome of the DMARC check, the condition
42435 fails.
42436
42437 Of course, you can also use any other lookup method that Exim
42438 supports, including LDAP, Postgres, MySQL, etc, as long as the
42439 result is a list of colon-separated strings.
42440
42441 Performing the check sets up information used by the
42442 &%authresults%& expansion item.
42443
42444 Several expansion variables are set before the DATA ACL is
42445 processed, and you can use them in this ACL.  The following
42446 expansion variables are available:
42447
42448 .vlist
42449 .vitem &$dmarc_status$&
42450 .vindex &$dmarc_status$&
42451 .cindex DMARC result
42452 A one word status indicating what the DMARC library
42453 thinks of the email.  It is a combination of the results of
42454 DMARC record lookup and the SPF/DKIM/DMARC processing results
42455 (if a DMARC record was found).  The actual policy declared
42456 in the DMARC record is in a separate expansion variable.
42457
42458 .vitem &$dmarc_status_text$&
42459 .vindex &$dmarc_status_text$&
42460 Slightly longer, human readable status.
42461
42462 .vitem &$dmarc_used_domain$&
42463 .vindex &$dmarc_used_domain$&
42464 The domain which DMARC used to look up the DMARC policy record.
42465
42466 .vitem &$dmarc_domain_policy$&
42467 .vindex &$dmarc_domain_policy$&
42468 The policy declared in the DMARC record.  Valid values
42469 are "none", "reject" and "quarantine".  It is blank when there
42470 is any error, including no DMARC record.
42471 .endlist
42472
42473 .subsection Logging SSECDMARCLOGGING
42474 .cindex DMARC logging
42475
42476 By default, Exim's DMARC configuration is intended to be
42477 non-intrusive and conservative.  To facilitate this, Exim will not
42478 create any type of logging files without explicit configuration by
42479 you, the admin.  Nor will Exim send out any emails/reports about
42480 DMARC issues without explicit configuration by you, the admin (other
42481 than typical bounce messages that may come about due to ACL
42482 processing or failure delivery issues).
42483
42484 In order to log statistics suitable to be imported by the opendmarc
42485 tools, you need to:
42486 .ilist
42487 Configure the global option &%dmarc_history_file%&
42488 .next
42489 Configure cron jobs to call the appropriate opendmarc history
42490 import scripts and truncating the dmarc_history_file
42491 .endlist
42492
42493 In order to send forensic reports, you need to:
42494 .ilist
42495 Configure the global option &%dmarc_forensic_sender%&
42496 .next
42497 Configure, somewhere before the DATA ACL, the control option to
42498 enable sending DMARC forensic reports
42499 .endlist
42500
42501 .subsection Example SSECDMARCEXAMPLE
42502 .cindex DMARC example
42503
42504 Example usage:
42505 .code
42506 (RCPT ACL)
42507   warn    domains        = +local_domains
42508           hosts          = +local_hosts
42509           control        = dmarc_disable_verify
42510
42511   warn    !domains       = +screwed_up_dmarc_records
42512           control        = dmarc_enable_forensic
42513
42514   warn    condition      = (lookup if destined to mailing list)
42515           set acl_m_mailing_list = 1
42516
42517 (DATA ACL)
42518   warn    dmarc_status   = accept : none : off
42519           !authenticated = *
42520           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42521
42522   warn    dmarc_status   = !accept
42523           !authenticated = *
42524           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42525
42526   warn    dmarc_status   = quarantine
42527           !authenticated = *
42528           set $acl_m_quarantine = 1
42529           # Do something in a transport with this flag variable
42530
42531   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42532           condition      = ${if eq{$acl_m_mailing_list}{1}}
42533           message        = Messages from $dmarc_used_domain break mailing lists
42534
42535   deny    dmarc_status   = reject
42536           !authenticated = *
42537           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42538
42539   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42540 .endd
42541
42542
42543
42544
42545
42546 . ////////////////////////////////////////////////////////////////////////////
42547 . ////////////////////////////////////////////////////////////////////////////
42548
42549 .chapter "Proxies" "CHAPproxies" &&&
42550          "Proxy support"
42551 .cindex "proxy support"
42552 .cindex "proxy" "access via"
42553
42554 A proxy is an intermediate system through which communication is passed.
42555 Proxies may provide a security, availability or load-distribution function.
42556
42557
42558 .section "Inbound proxies" SECTproxyInbound
42559 .cindex proxy inbound
42560 .cindex proxy "server side"
42561 .cindex proxy "Proxy protocol"
42562 .cindex "Proxy protocol" proxy
42563
42564 Exim has support for receiving inbound SMTP connections via a proxy
42565 that uses &"Proxy Protocol"& to speak to it.
42566 To include this support, include &"SUPPORT_PROXY=yes"&
42567 in Local/Makefile.
42568
42569 It was built on the HAProxy specification, found at
42570 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42571
42572 The purpose of this facility is so that an application load balancer,
42573 such as HAProxy, can sit in front of several Exim servers
42574 to distribute load.
42575 Exim uses the local protocol communication with the proxy to obtain
42576 the remote SMTP system IP address and port information.
42577 There is no logging if a host passes or
42578 fails Proxy Protocol negotiation, but it can easily be determined and
42579 recorded in an ACL (example is below).
42580
42581 Use of a proxy is enabled by setting the &%hosts_proxy%&
42582 main configuration option to a hostlist; connections from these
42583 hosts will use Proxy Protocol.
42584 Exim supports both version 1 and version 2 of the Proxy Protocol and
42585 automatically determines which version is in use.
42586
42587 The Proxy Protocol header is the first data received on a TCP connection
42588 and is inserted before any TLS-on-connect handshake from the client; Exim
42589 negotiates TLS between Exim-as-server and the remote client, not between
42590 Exim and the proxy server. The Proxy Protocol header must be received
42591 within &%proxy_protocol_timeout%&, which defaults to 3s.
42592
42593 The following expansion variables are usable
42594 (&"internal"& and &"external"& here refer to the interfaces
42595 of the proxy):
42596 .itable none 0 0 2 30* left 70* left
42597 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42598 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42599 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42600 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42601 .irow $proxy_session            "boolean: SMTP connection via proxy"
42602 .endtable
42603 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42604 there was a protocol error.
42605 The variables &$sender_host_address$& and &$sender_host_port$&
42606 will have values for the actual client system, not the proxy.
42607
42608 Since the real connections are all coming from the proxy, and the
42609 per host connection tracking is done before Proxy Protocol is
42610 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42611 handle all of the parallel volume you expect per inbound proxy.
42612 With the option set so high, you lose the ability
42613 to protect your server from many connections from one IP.
42614 In order to prevent your server from overload, you
42615 need to add a per connection ratelimit to your connect ACL.
42616 A possible solution is:
42617 .display
42618   # Set max number of connections per host
42619   LIMIT   = 5
42620   # Or do some kind of IP lookup in a flat file or database
42621   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42622
42623   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42624           message        = Too many connections from this IP right now
42625 .endd
42626
42627
42628
42629 .section "Outbound proxies" SECTproxySOCKS
42630 .cindex proxy outbound
42631 .cindex proxy "client side"
42632 .cindex proxy SOCKS
42633 .cindex SOCKS proxy
42634 Exim has support for sending outbound SMTP via a proxy
42635 using a protocol called SOCKS5 (defined by RFC1928).
42636 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42637 Local/Makefile.
42638
42639 Use of a proxy is enabled by setting the &%socks_proxy%& option
42640 on an smtp transport.
42641 The option value is expanded and should then be a list
42642 (colon-separated by default) of proxy specifiers.
42643 Each proxy specifier is a list
42644 (space-separated by default) where the initial element
42645 is an IP address and any subsequent elements are options.
42646
42647 Options are a string <name>=<value>.
42648 The list of options is in the following table:
42649 .itable none 0 0 2 10* left 90* left
42650 .irow &'auth'&  "authentication method"
42651 .irow &'name'&  "authentication username"
42652 .irow &'pass'&  "authentication password"
42653 .irow &'port'&  "tcp port"
42654 .irow &'tmo'&   "connection timeout"
42655 .irow &'pri'&   "priority"
42656 .irow &'weight'& "selection bias"
42657 .endtable
42658
42659 More details on each of these options follows:
42660
42661 .ilist
42662 .cindex authentication "to proxy"
42663 .cindex proxy authentication
42664 &%auth%&: Either &"none"& (default) or &"name"&.
42665 Using &"name"& selects username/password authentication per RFC 1929
42666 for access to the proxy.
42667 Default is &"none"&.
42668 .next
42669 &%name%&: sets the username for the &"name"& authentication method.
42670 Default is empty.
42671 .next
42672 &%pass%&: sets the password for the &"name"& authentication method.
42673 Default is empty.
42674 .next
42675 &%port%&: the TCP port number to use for the connection to the proxy.
42676 Default is 1080.
42677 .next
42678 &%tmo%&: sets a connection timeout in seconds for this proxy.
42679 Default is 5.
42680 .next
42681 &%pri%&: specifies a priority for the proxy within the list,
42682 higher values being tried first.
42683 The default priority is 1.
42684 .next
42685 &%weight%&: specifies a selection bias.
42686 Within a priority set servers are queried in a random fashion,
42687 weighted by this value.
42688 The default value for selection bias is 1.
42689 .endlist
42690
42691 Proxies from the list are tried according to their priority
42692 and weight settings until one responds.  The timeout for the
42693 overall connection applies to the set of proxied attempts.
42694
42695 .section Logging SECTproxyLog
42696 To log the (local) IP of a proxy in the incoming or delivery logline,
42697 add &"+proxy"& to the &%log_selector%& option.
42698 This will add a component tagged with &"PRX="& to the line.
42699
42700 . ////////////////////////////////////////////////////////////////////////////
42701 . ////////////////////////////////////////////////////////////////////////////
42702
42703 .chapter "Internationalisation" "CHAPi18n" &&&
42704          "Internationalisation""
42705 .cindex internationalisation "email address"
42706 .cindex EAI
42707 .cindex i18n
42708 .cindex utf8 "mail name handling"
42709
42710 Exim has support for Internationalised mail names.
42711 To include this it must be built with SUPPORT_I18N and the libidn library.
42712 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42713
42714 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42715 instead of it) then IDNA2008 is supported; this adds an extra library
42716 requirement, upon libidn2.
42717
42718 .section "MTA operations" SECTi18nMTA
42719 .cindex SMTPUTF8 "ESMTP option"
42720 .cindex "ESMTP extensions" SMTPUTF8
42721 The main configuration option &%smtputf8_advertise_hosts%& specifies
42722 a host list.  If this matches the sending host and
42723 accept_8bitmime is true (the default) then the ESMTP option
42724 SMTPUTF8 will be advertised.
42725
42726 If the sender specifies the SMTPUTF8 option on a MAIL command
42727 international handling for the message is enabled and
42728 the expansion variable &$message_smtputf8$& will have value TRUE.
42729
42730 The option &%allow_utf8_domains%& is set to true for this
42731 message. All DNS lookups are converted to a-label form
42732 whatever the setting of &%allow_utf8_domains%&
42733 when Exim is built with SUPPORT_I18N.
42734
42735 Both localparts and domain are maintained as the original
42736 UTF-8 form internally; any comparison or regular-expression use will
42737 require appropriate care.  Filenames created, eg. by
42738 the appendfile transport, will have UTF-8 names.
42739
42740 HELO names sent by the smtp transport will have any UTF-8
42741 components expanded to a-label form,
42742 and any certificate name checks will be done using the a-label
42743 form of the name.
42744
42745 .cindex log protocol
42746 .cindex SMTPUTF8 logging
42747 .cindex i18n logging
42748 Log lines and Received-by: header lines will acquire a "utf8"
42749 prefix on the protocol element, eg. utf8esmtp.
42750
42751 The following expansion operators can be used:
42752 .code
42753 ${utf8_domain_to_alabel:str}
42754 ${utf8_domain_from_alabel:str}
42755 ${utf8_localpart_to_alabel:str}
42756 ${utf8_localpart_from_alabel:str}
42757 .endd
42758
42759 .cindex utf8 "address downconversion"
42760 .cindex i18n "utf8 address downconversion"
42761 The RCPT ACL
42762 may use the following modifier:
42763 .display
42764 control = utf8_downconvert
42765 control = utf8_downconvert/<value>
42766 .endd
42767 This sets a flag requiring that envelope addresses are converted to
42768 a-label form before smtp delivery.
42769 This is usually for use in a Message Submission Agent context,
42770 but could be used for any message.
42771
42772 If a value is appended it may be:
42773 .itable none 0 0 2 5* right 95* left
42774 .irow &`1`&     "mandatory downconversion"
42775 .irow &`0`&     "no downconversion"
42776 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42777 .endtable
42778 If no value is given, 1 is used.
42779
42780 If mua_wrapper is set, the utf8_downconvert control
42781 is initially set to -1.
42782
42783 The smtp transport has an option &%utf8_downconvert%&.
42784 If set it must expand to one of the three values described above,
42785 or an empty string.
42786 If non-empty it overrides value previously set
42787 (due to mua_wrapper or by an ACL control).
42788
42789
42790 There is no explicit support for VRFY and EXPN.
42791 Configurations supporting these should inspect
42792 &$smtp_command_argument$& for an SMTPUTF8 argument.
42793
42794 There is no support for LMTP on Unix sockets.
42795 Using the "lmtp" protocol option on an smtp transport,
42796 for LMTP over TCP, should work as expected.
42797
42798 There is no support for DSN unitext handling,
42799 and no provision for converting logging from or to UTF-8.
42800
42801
42802
42803 .section "MDA operations" SECTi18nMDA
42804 To aid in constructing names suitable for IMAP folders
42805 the following expansion operator can be used:
42806 .code
42807 ${imapfolder {<string>} {<sep>} {<specials>}}
42808 .endd
42809
42810 The string is converted from the charset specified by
42811 the "headers charset" command (in a filter file)
42812 or &%headers_charset%& main configuration option (otherwise),
42813 to the
42814 modified UTF-7 encoding specified by RFC 2060,
42815 with the following exception: All occurrences of <sep>
42816 (which has to be a single character)
42817 are replaced with periods ("."), and all periods and slashes that are not
42818 <sep> and are not in the <specials> string are BASE64 encoded.
42819
42820 The third argument can be omitted, defaulting to an empty string.
42821 The second argument can be omitted, defaulting to "/".
42822
42823 This is the encoding used by Courier for Maildir names on disk, and followed
42824 by many other IMAP servers.
42825
42826 Examples:
42827 .display
42828 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42829 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42830 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42831 .endd
42832
42833 Note that the source charset setting is vital, and also that characters
42834 must be representable in UTF-16.
42835
42836
42837 . ////////////////////////////////////////////////////////////////////////////
42838 . ////////////////////////////////////////////////////////////////////////////
42839
42840 .chapter "Events" "CHAPevents" &&&
42841          "Events"
42842 .cindex events
42843
42844 The events mechanism in Exim can be used to intercept processing at a number
42845 of points.  It was originally invented to give a way to do customised logging
42846 actions (for example, to a database) but can also be used to modify some
42847 processing actions.
42848
42849 Most installations will never need to use Events.
42850 The support can be left out of a build by defining DISABLE_EVENT=yes
42851 in &_Local/Makefile_&.
42852
42853 There are two major classes of events: main and transport.
42854 The main configuration option &%event_action%& controls reception events;
42855 a transport option &%event_action%& controls delivery events.
42856
42857 Both options are a string which is expanded when the event fires.
42858 An example might look like:
42859 .cindex logging custom
42860 .code
42861 event_action = ${if eq {msg:delivery}{$event_name} \
42862 {${lookup pgsql {SELECT * FROM record_Delivery( \
42863     '${quote_pgsql:$sender_address_domain}',\
42864     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42865     '${quote_pgsql:$domain}', \
42866     '${quote_pgsql:${lc:$local_part}}', \
42867     '${quote_pgsql:$host_address}', \
42868     '${quote_pgsql:${lc:$host}}', \
42869     '${quote_pgsql:$message_exim_id}')}} \
42870 } {}}
42871 .endd
42872
42873 Events have names which correspond to the point in process at which they fire.
42874 The name is placed in the variable &$event_name$& and the event action
42875 expansion must check this, as it will be called for every possible event type.
42876
42877 The current list of events is:
42878 .itable all 0 0 4 25* left 10* center 15* center 50* left
42879 .row auth:fail              after    both       "per driver per authentication attempt"
42880 .row dane:fail              after    transport  "per connection"
42881 .row msg:complete           after    main       "per message"
42882 .row msg:defer              after    transport  "per message per delivery try"
42883 .row msg:delivery           after    transport  "per recipient"
42884 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42885 .row msg:rcpt:defer         after    transport  "per recipient"
42886 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42887 .row msg:fail:delivery      after    transport  "per recipient"
42888 .row msg:fail:internal      after    main       "per recipient"
42889 .row tcp:connect            before   transport  "per connection"
42890 .row tcp:close              after    transport  "per connection"
42891 .row tls:cert               before   both       "per certificate in verification chain"
42892 .row tls:fail:connect       after    main       "per connection"
42893 .row smtp:connect           after    transport  "per connection"
42894 .row smtp:ehlo              after    transport  "per connection"
42895 .endtable
42896 New event types may be added in future.
42897
42898 The event name is a colon-separated list, defining the type of
42899 event in a tree of possibilities.  It may be used as a list
42900 or just matched on as a whole.  There will be no spaces in the name.
42901
42902 The second column in the table above describes whether the event fires
42903 before or after the action is associates with.  Those which fire before
42904 can be used to affect that action (more on this below).
42905
42906 The third column in the table above says what section of the configuration
42907 should define the event action.
42908
42909 An additional variable, &$event_data$&, is filled with information varying
42910 with the event type:
42911 .itable all 0 0 2 20* left 80* left
42912 .row auth:fail            "smtp response"
42913 .row dane:fail            "failure reason"
42914 .row msg:defer            "error string"
42915 .row msg:delivery         "smtp confirmation message"
42916 .row msg:fail:internal    "failure reason"
42917 .row msg:fail:delivery    "smtp error message"
42918 .row msg:host:defer       "error string"
42919 .row msg:rcpt:host:defer  "error string"
42920 .row msg:rcpt:defer       "error string"
42921 .row tls:cert             "verification chain depth"
42922 .row tls:fail:connect     "error string"
42923 .row smtp:connect         "smtp banner"
42924 .row smtp:ehlo            "smtp ehlo response"
42925 .endtable
42926
42927 The :defer events populate one extra variable: &$event_defer_errno$&.
42928
42929 For complex operations an ACL expansion can be used in &%event_action%&,
42930 however due to the multiple contexts that Exim operates in during
42931 the course of its processing:
42932 .ilist
42933 variables set in transport events will not be visible outside that
42934 transport call
42935 .next
42936 acl_m variables in a server context are lost on a new connection,
42937 and after smtp helo/ehlo/mail/starttls/rset commands
42938 .endlist
42939 Using an ACL expansion with the logwrite modifier can be
42940 a useful way of writing to the main log.
42941
42942 The expansion of the event_action option should normally
42943 return an empty string.  Should it return anything else the
42944 following will be forced:
42945 .itable all 0 0 2 20* left 80* left
42946 .row auth:fail        "log information to write"
42947 .row tcp:connect      "do not connect"
42948 .row tls:cert         "refuse verification"
42949 .row smtp:connect     "close connection"
42950 .endtable
42951 All other message types ignore the result string, and
42952 no other use is made of it.
42953
42954 For a tcp:connect event, if the connection is being made to a proxy
42955 then the address and port variables will be that of the proxy and not
42956 the target system.
42957
42958 For tls:cert events, if GnuTLS is in use this will trigger only per
42959 chain element received on the connection.
42960 For OpenSSL it will trigger for every chain element including those
42961 loaded locally.
42962
42963 . ////////////////////////////////////////////////////////////////////////////
42964 . ////////////////////////////////////////////////////////////////////////////
42965
42966 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42967          "Adding drivers or lookups"
42968 .cindex "adding drivers"
42969 .cindex "new drivers, adding"
42970 .cindex "drivers" "adding new"
42971 The following actions have to be taken in order to add a new router, transport,
42972 authenticator, or lookup type to Exim:
42973
42974 .olist
42975 Choose a name for the driver or lookup type that does not conflict with any
42976 existing name; I will use &"newdriver"& in what follows.
42977 .next
42978 Add to &_src/EDITME_& the line:
42979 .display
42980 <&'type'&>&`_NEWDRIVER=yes`&
42981 .endd
42982 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42983 code is not to be included in the binary by default, comment this line out. You
42984 should also add any relevant comments about the driver or lookup type.
42985 .next
42986 Add to &_src/config.h.defaults_& the line:
42987 .code
42988 #define <type>_NEWDRIVER
42989 .endd
42990 .next
42991 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42992 and create a table entry as is done for all the other drivers and lookup types.
42993 .next
42994 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42995 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42996 Add your &`NEWDRIVER`& to that list.
42997 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42998 simple form that most lookups have.
42999 .next
43000 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43001 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43002 driver or lookup type and add it to the definition of OBJ.
43003 .next
43004 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43005 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43006 .next
43007 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43008 &_src_&.
43009 .next
43010 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43011 as for other drivers and lookups.
43012 .endlist
43013
43014 Then all you need to do is write the code! A good way to start is to make a
43015 proforma by copying an existing module of the same type, globally changing all
43016 occurrences of the name, and cutting out most of the code. Note that any
43017 options you create must be listed in alphabetical order, because the tables are
43018 searched using a binary chop procedure.
43019
43020 There is a &_README_& file in each of the sub-directories of &_src_& describing
43021 the interface that is expected.
43022
43023
43024
43025
43026 . ////////////////////////////////////////////////////////////////////////////
43027 . ////////////////////////////////////////////////////////////////////////////
43028
43029 . /////////////////////////////////////////////////////////////////////////////
43030 . These lines are processing instructions for the Simple DocBook Processor that
43031 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43032 . PDFs than using xmlto and fop. They will be ignored by all other XML
43033 . processors.
43034 . /////////////////////////////////////////////////////////////////////////////
43035
43036 .literal xml
43037 <?sdop
43038   format="newpage"
43039   foot_right_recto="&chaptertitle;"
43040   foot_right_verso="&chaptertitle;"
43041 ?>
43042 .literal off
43043
43044 .makeindex "Options index"   "option"
43045 .makeindex "Variables index" "variable"
43046 .makeindex "Concept index"   "concept"
43047
43048
43049 . /////////////////////////////////////////////////////////////////////////////
43050 . /////////////////////////////////////////////////////////////////////////////