GnuTLS: fix crash with "tls_dhparam = none"
[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 way to write the NIS+ query is
7382 .code
7383 [name="${quote_nisplus:$local_part}"]
7384 .endd
7385 .cindex "tainted data" "in lookups"
7386 .new
7387 &*All*& tainted data used in a quoery-style lookup must be quoted
7388 using a mechanism appropriate for the lookup type.
7389 .wen
7390 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7391 operator can be used for all lookup types, but has no effect for single-key
7392 lookups, since no quoting is ever needed in their key strings.
7393
7394
7395
7396
7397 .section "More about dnsdb" "SECTdnsdb"
7398 .cindex "dnsdb lookup"
7399 .cindex "lookup" "dnsdb"
7400 .cindex "DNS" "as a lookup type"
7401 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7402 of a record type and a domain name, separated by an equals sign. For example,
7403 an expansion string could contain:
7404 .code
7405 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7406 .endd
7407 If the lookup succeeds, the result is placed in &$value$&, which in this case
7408 is used on its own as the result. If the lookup does not succeed, the
7409 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7410 &<<SECTforexpfai>>& for an explanation of what this means.
7411
7412 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7413 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7414 If no type is given, TXT is assumed.
7415
7416 For any record type, if multiple records are found, the data is returned as a
7417 concatenation, with newline as the default separator. The order, of course,
7418 depends on the DNS resolver. You can specify a different separator character
7419 between multiple records by putting a right angle-bracket followed immediately
7420 by the new separator at the start of the query. For example:
7421 .code
7422 ${lookup dnsdb{>: a=host1.example}}
7423 .endd
7424 It is permitted to specify a space as the separator character. Further
7425 white space is ignored.
7426 For lookup types that return multiple fields per record,
7427 an alternate field separator can be specified using a comma after the main
7428 separator character, followed immediately by the field separator.
7429
7430 .cindex "PTR record" "in &(dnsdb)& lookup"
7431 When the type is PTR,
7432 the data can be an IP address, written as normal; inversion and the addition of
7433 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7434 .code
7435 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7436 .endd
7437 If the data for a PTR record is not a syntactically valid IP address, it is not
7438 altered and nothing is added.
7439
7440 .cindex "MX record" "in &(dnsdb)& lookup"
7441 .cindex "SRV record" "in &(dnsdb)& lookup"
7442 For an MX lookup, both the preference value and the host name are returned for
7443 each record, separated by a space. For an SRV lookup, the priority, weight,
7444 port, and host name are returned for each record, separated by spaces.
7445 The field separator can be modified as above.
7446
7447 .cindex "TXT record" "in &(dnsdb)& lookup"
7448 .cindex "SPF record" "in &(dnsdb)& lookup"
7449 For TXT records with multiple items of data, only the first item is returned,
7450 unless a field separator is specified.
7451 To concatenate items without a separator, use a semicolon instead.
7452 For SPF records the
7453 default behaviour is to concatenate multiple items without using a separator.
7454 .code
7455 ${lookup dnsdb{>\n,: txt=a.b.example}}
7456 ${lookup dnsdb{>\n; txt=a.b.example}}
7457 ${lookup dnsdb{spf=example.org}}
7458 .endd
7459 It is permitted to specify a space as the separator character. Further
7460 white space is ignored.
7461
7462 .cindex "SOA record" "in &(dnsdb)& lookup"
7463 For an SOA lookup, while no result is obtained the lookup is redone with
7464 successively more leading components dropped from the given domain.
7465 Only the primary-nameserver field is returned unless a field separator is
7466 specified.
7467 .code
7468 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7469 .endd
7470
7471 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7472 .cindex "dnsdb modifiers"
7473 .cindex "modifiers" "dnsdb"
7474 .cindex "options" "dnsdb"
7475 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7476 each followed by a comma,
7477 that may appear before the record type.
7478
7479 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7480 temporary DNS error for any of them, the behaviour is controlled by
7481 a defer-option modifier.
7482 The possible keywords are
7483 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7484 With &"strict"& behaviour, any temporary DNS error causes the
7485 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7486 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7487 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7488 error causes the whole lookup to defer only if none of the other lookups
7489 succeed. The default is &"lax"&, so the following lookups are equivalent:
7490 .code
7491 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7492 ${lookup dnsdb{a=one.host.com:two.host.com}}
7493 .endd
7494 Thus, in the default case, as long as at least one of the DNS lookups
7495 yields some data, the lookup succeeds.
7496
7497 .cindex "DNSSEC" "dns lookup"
7498 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7499 The possible keywords are
7500 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7501 With &"strict"& or &"lax"& DNSSEC information is requested
7502 with the lookup.
7503 With &"strict"& a response from the DNS resolver that
7504 is not labelled as authenticated data
7505 is treated as equivalent to a temporary DNS error.
7506 The default is &"lax"&.
7507
7508 See also the &$lookup_dnssec_authenticated$& variable.
7509
7510 .cindex timeout "dns lookup"
7511 .cindex "DNS" timeout
7512 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7513 The form is &"retrans_VAL"& where VAL is an Exim time specification
7514 (e.g. &"5s"&).
7515 The default value is set by the main configuration option &%dns_retrans%&.
7516
7517 Retries for the dnsdb lookup can be controlled by a retry modifier.
7518 The form if &"retry_VAL"& where VAL is an integer.
7519 The default count is set by the main configuration option &%dns_retry%&.
7520
7521 .cindex caching "of dns lookup"
7522 .cindex TTL "of dns lookup"
7523 .cindex DNS TTL
7524 Dnsdb lookup results are cached within a single process (and its children).
7525 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7526 value of the set of returned DNS records.
7527
7528
7529 .subsection "Pseudo dnsdb record types" SECID66
7530 .cindex "MX record" "in &(dnsdb)& lookup"
7531 By default, both the preference value and the host name are returned for
7532 each MX record, separated by a space. If you want only host names, you can use
7533 the pseudo-type MXH:
7534 .code
7535 ${lookup dnsdb{mxh=a.b.example}}
7536 .endd
7537 In this case, the preference values are omitted, and just the host names are
7538 returned.
7539
7540 .cindex "name server for enclosing domain"
7541 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7542 records on the given domain, but if none are found, it removes the first
7543 component of the domain name, and tries again. This process continues until NS
7544 records are found or there are no more components left (or there is a DNS
7545 error). In other words, it may return the name servers for a top-level domain,
7546 but it never returns the root name servers. If there are no NS records for the
7547 top-level domain, the lookup fails. Consider these examples:
7548 .code
7549 ${lookup dnsdb{zns=xxx.quercite.com}}
7550 ${lookup dnsdb{zns=xxx.edu}}
7551 .endd
7552 Assuming that in each case there are no NS records for the full domain name,
7553 the first returns the name servers for &%quercite.com%&, and the second returns
7554 the name servers for &%edu%&.
7555
7556 You should be careful about how you use this lookup because, unless the
7557 top-level domain does not exist, the lookup always returns some host names. The
7558 sort of use to which this might be put is for seeing if the name servers for a
7559 given domain are on a blacklist. You can probably assume that the name servers
7560 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7561 such a list.
7562
7563 .cindex "CSA" "in &(dnsdb)& lookup"
7564 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7565 records according to the CSA rules, which are described in section
7566 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7567 not sufficient because of the extra parent domain search behaviour of CSA. The
7568 result of a successful lookup such as:
7569 .code
7570 ${lookup dnsdb {csa=$sender_helo_name}}
7571 .endd
7572 has two space-separated fields: an authorization code and a target host name.
7573 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7574 authorization required but absent, or &"?"& for unknown.
7575
7576 .cindex "A+" "in &(dnsdb)& lookup"
7577 The pseudo-type A+ performs an AAAA
7578 and then an A lookup.  All results are returned; defer processing
7579 (see below) is handled separately for each lookup.  Example:
7580 .code
7581 ${lookup dnsdb {>; a+=$sender_helo_name}}
7582 .endd
7583
7584
7585 .subsection "Multiple dnsdb lookups" SECID67
7586 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7587 However, you can specify a list of domains or IP addresses in a single
7588 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7589 the default separator, but with the ability to change this. For example:
7590 .code
7591 ${lookup dnsdb{one.domain.com:two.domain.com}}
7592 ${lookup dnsdb{a=one.host.com:two.host.com}}
7593 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7594 .endd
7595 In order to retain backwards compatibility, there is one special case: if
7596 the lookup type is PTR and no change of separator is specified, Exim looks
7597 to see if the rest of the string is precisely one IPv6 address. In this
7598 case, it does not treat it as a list.
7599
7600 The data from each lookup is concatenated, with newline separators by default,
7601 in the same way that multiple DNS records for a single item are handled. A
7602 different separator can be specified, as described above.
7603
7604
7605
7606
7607 .section "More about LDAP" "SECTldap"
7608 .cindex "LDAP" "lookup, more about"
7609 .cindex "lookup" "LDAP"
7610 .cindex "Solaris" "LDAP"
7611 The original LDAP implementation came from the University of Michigan; this has
7612 become &"Open LDAP"&, and there are now two different releases. Another
7613 implementation comes from Netscape, and Solaris 7 and subsequent releases
7614 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7615 the lookup function level, their error handling is different. For this reason
7616 it is necessary to set a compile-time variable when building Exim with LDAP, to
7617 indicate which LDAP library is in use. One of the following should appear in
7618 your &_Local/Makefile_&:
7619 .code
7620 LDAP_LIB_TYPE=UMICHIGAN
7621 LDAP_LIB_TYPE=OPENLDAP1
7622 LDAP_LIB_TYPE=OPENLDAP2
7623 LDAP_LIB_TYPE=NETSCAPE
7624 LDAP_LIB_TYPE=SOLARIS
7625 .endd
7626 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7627 same interface as the University of Michigan version.
7628
7629 There are three LDAP lookup types in Exim. These behave slightly differently in
7630 the way they handle the results of a query:
7631
7632 .ilist
7633 &(ldap)& requires the result to contain just one entry; if there are more, it
7634 gives an error.
7635 .next
7636 &(ldapdn)& also requires the result to contain just one entry, but it is the
7637 Distinguished Name that is returned rather than any attribute values.
7638 .next
7639 &(ldapm)& permits the result to contain more than one entry; the attributes
7640 from all of them are returned.
7641 .endlist
7642
7643
7644 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7645 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7646 the data returned by a successful lookup is described in the next section.
7647 First we explain how LDAP queries are coded.
7648
7649
7650 .subsection "Format of LDAP queries" SECTforldaque
7651 .cindex "LDAP" "query format"
7652 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7653 the configuration of a &(redirect)& router one might have this setting:
7654 .code
7655 data = ${lookup ldap \
7656   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7657   c=UK?mailbox?base?}}
7658 .endd
7659 .cindex "LDAP" "with TLS"
7660 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7661 secure (encrypted) LDAP connections. The second of these ensures that an
7662 encrypted TLS connection is used.
7663
7664 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7665 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7666 See the &%ldap_start_tls%& option.
7667
7668 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7669 controlled. Every part of the TLS configuration can be configured by settings in
7670 &_exim.conf_&. Depending on the version of the client libraries installed on
7671 your system, some of the initialization may have required setting options in
7672 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7673 certificates. This revealed a nuance where the current UID that exim was
7674 running as could affect which config files it read. With Exim 4.83, these
7675 methods become optional, only taking effect if not specifically set in
7676 &_exim.conf_&.
7677
7678
7679 .subsection "LDAP quoting" SECID68
7680 .cindex "LDAP" "quoting"
7681 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7682 and the second because the LDAP query is represented as a URL. Furthermore,
7683 within an LDAP query, two different kinds of quoting are required. For this
7684 reason, there are two different LDAP-specific quoting operators.
7685
7686 The &%quote_ldap%& operator is designed for use on strings that are part of
7687 filter specifications. Conceptually, it first does the following conversions on
7688 the string:
7689 .code
7690 *   =>   \2A
7691 (   =>   \28
7692 )   =>   \29
7693 \   =>   \5C
7694 .endd
7695 in accordance with RFC 2254. The resulting string is then quoted according
7696 to the rules for URLs, that is, all non-alphanumeric characters except
7697 .code
7698 ! $ ' - . _ ( ) * +
7699 .endd
7700 are converted to their hex values, preceded by a percent sign. For example:
7701 .code
7702 ${quote_ldap: a(bc)*, a<yz>; }
7703 .endd
7704 yields
7705 .code
7706 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7707 .endd
7708 Removing the URL quoting, this is (with a leading and a trailing space):
7709 .code
7710 a\28bc\29\2A, a<yz>;
7711 .endd
7712 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7713 base DN specifications in queries. Conceptually, it first converts the string
7714 by inserting a backslash in front of any of the following characters:
7715 .code
7716 , + " \ < > ;
7717 .endd
7718 It also inserts a backslash before any leading spaces or # characters, and
7719 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7720 is then quoted according to the rules for URLs. For example:
7721 .code
7722 ${quote_ldap_dn: a(bc)*, a<yz>; }
7723 .endd
7724 yields
7725 .code
7726 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7727 .endd
7728 Removing the URL quoting, this is (with a trailing space):
7729 .code
7730 \ a(bc)*\, a\<yz\>\;\
7731 .endd
7732 There are some further comments about quoting in the section on LDAP
7733 authentication below.
7734
7735
7736 .subsection "LDAP connections" SECID69
7737 .cindex "LDAP" "connections"
7738 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7739 is in use, via a Unix domain socket. The example given above does not specify
7740 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7741 by starting it with
7742 .code
7743 ldap://<hostname>:<port>/...
7744 .endd
7745 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7746 used. When no server is specified in a query, a list of default servers is
7747 taken from the &%ldap_default_servers%& configuration option. This supplies a
7748 colon-separated list of servers which are tried in turn until one successfully
7749 handles a query, or there is a serious error. Successful handling either
7750 returns the requested data, or indicates that it does not exist. Serious errors
7751 are syntactical, or multiple values when only a single value is expected.
7752 Errors which cause the next server to be tried are connection failures, bind
7753 failures, and timeouts.
7754
7755 For each server name in the list, a port number can be given. The standard way
7756 of specifying a host and port is to use a colon separator (RFC 1738). Because
7757 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7758 doubled. For example
7759 .code
7760 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7761 .endd
7762 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7763 to the LDAP library with no server name, and the library's default (normally
7764 the local host) is used.
7765
7766 If you are using the OpenLDAP library, you can connect to an LDAP server using
7767 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7768 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7769 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7770 not available.
7771
7772 For this type of connection, instead of a host name for the server, a pathname
7773 for the socket is required, and the port number is not relevant. The pathname
7774 can be specified either as an item in &%ldap_default_servers%&, or inline in
7775 the query. In the former case, you can have settings such as
7776 .code
7777 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7778 .endd
7779 When the pathname is given in the query, you have to escape the slashes as
7780 &`%2F`& to fit in with the LDAP URL syntax. For example:
7781 .code
7782 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7783 .endd
7784 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7785 a pathname, it uses the Unix domain socket code, even if the query actually
7786 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7787 socket connection. This behaviour means that you can use a setting of
7788 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7789 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7790 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7791 backup host.
7792
7793 If an explicit &`ldapi`& type is given in a query when a host name is
7794 specified, an error is diagnosed. However, if there are more items in
7795 &%ldap_default_servers%&, they are tried. In other words:
7796
7797 .ilist
7798 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7799 interface.
7800 .next
7801 Using &`ldapi`& with a host name causes an error.
7802 .endlist
7803
7804
7805 Using &`ldapi`& with no host or path in the query, and no setting of
7806 &%ldap_default_servers%&, does whatever the library does by default.
7807
7808
7809
7810 .subsection "LDAP authentication and control information" SECID70
7811 .cindex "LDAP" "authentication"
7812 The LDAP URL syntax provides no way of passing authentication and other control
7813 information to the server. To make this possible, the URL in an LDAP query may
7814 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7815 spaces. If a value contains spaces it must be enclosed in double quotes, and
7816 when double quotes are used, backslash is interpreted in the usual way inside
7817 them. The following names are recognized:
7818 .itable none 0 0 2 20* left 80* left
7819 .irow DEREFERENCE "set the dereferencing parameter"
7820 .irow NETTIME     "set a timeout for a network operation"
7821 .irow USER        "set the DN, for authenticating the LDAP bind"
7822 .irow PASS        "set the password, likewise"
7823 .irow REFERRALS   "set the referrals parameter"
7824 .irow SERVERS     "set alternate server list for this query only"
7825 .irow SIZE        "set the limit for the number of entries returned"
7826 .irow TIME        "set the maximum waiting time for a query"
7827 .endtable
7828 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7829 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7830 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7831 library from trying to follow referrals issued by the LDAP server.
7832
7833 .cindex LDAP timeout
7834 .cindex timeout "LDAP lookup"
7835 The name CONNECT is an obsolete name for NETTIME, retained for
7836 backwards compatibility. This timeout (specified as a number of seconds) is
7837 enforced from the client end for operations that can be carried out over a
7838 network. Specifically, it applies to network connections and calls to the
7839 &'ldap_result()'& function. If the value is greater than zero, it is used if
7840 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7841 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7842 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7843 Netscape SDK; for OpenLDAP no action is taken.
7844
7845 The TIME parameter (also a number of seconds) is passed to the server to
7846 set a server-side limit on the time taken to complete a search.
7847
7848 The SERVERS parameter allows you to specify an alternate list of ldap servers
7849 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7850 default list of ldap servers, and a single lookup can specify a single ldap
7851 server to use.  But when you need to do a lookup with a list of servers that is
7852 different than the default list (maybe different order, maybe a completely
7853 different set of servers), the SERVERS parameter allows you to specify this
7854 alternate list (colon-separated).
7855
7856 Here is an example of an LDAP query in an Exim lookup that uses some of these
7857 values. This is a single line, folded to fit on the page:
7858 .code
7859 ${lookup ldap
7860   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7861   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7862   {$value}fail}
7863 .endd
7864 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7865 any of the auxiliary data. Exim configuration settings that include lookups
7866 which contain password information should be preceded by &"hide"& to prevent
7867 non-admin users from using the &%-bP%& option to see their values.
7868
7869 The auxiliary data items may be given in any order. The default is no
7870 connection timeout (the system timeout is used), no user or password, no limit
7871 on the number of entries returned, and no time limit on queries.
7872
7873 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7874 removes any URL quoting that it may contain before passing it to the LDAP library.
7875 Apparently
7876 some libraries do this for themselves, but some do not. Removing the URL
7877 quoting has two advantages:
7878
7879 .ilist
7880 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7881 DNs as with DNs inside actual queries.
7882 .next
7883 It permits spaces inside USER= DNs.
7884 .endlist
7885
7886 For example, a setting such as
7887 .code
7888 USER=cn=${quote_ldap_dn:$1}
7889 .endd
7890 should work even if &$1$& contains spaces.
7891
7892 Expanded data for the PASS= value should be quoted using the &%quote%&
7893 expansion operator, rather than the LDAP quote operators. The only reason this
7894 field needs quoting is to ensure that it conforms to the Exim syntax, which
7895 does not allow unquoted spaces. For example:
7896 .code
7897 PASS=${quote:$3}
7898 .endd
7899 The LDAP authentication mechanism can be used to check passwords as part of
7900 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7901 &<<CHAPexpand>>&.
7902
7903
7904
7905 .subsection "Format of data returned by LDAP" SECID71
7906 .cindex "LDAP" "returned data formats"
7907 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7908 as a sequence of values, for example
7909 .code
7910 cn=manager,o=University of Cambridge,c=UK
7911 .endd
7912 The &(ldap)& lookup type generates an error if more than one entry matches the
7913 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7914 the result between the data from different entries. It is possible for multiple
7915 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7916 you know that whatever values are returned all came from a single entry in the
7917 directory.
7918
7919 In the common case where you specify a single attribute in your LDAP query, the
7920 result is not quoted, and does not contain the attribute name. If the attribute
7921 has multiple values, they are separated by commas. Any comma that is
7922 part of an attribute's value is doubled.
7923
7924 If you specify multiple attributes, the result contains space-separated, quoted
7925 strings, each preceded by the attribute name and an equals sign. Within the
7926 quotes, the quote character, backslash, and newline are escaped with
7927 backslashes, and commas are used to separate multiple values for the attribute.
7928 Any commas in attribute values are doubled
7929 (permitting treatment of the values as a comma-separated list).
7930 Apart from the escaping, the string within quotes takes the same form as the
7931 output when a single attribute is requested. Specifying no attributes is the
7932 same as specifying all of an entry's attributes.
7933
7934 Here are some examples of the output format. The first line of each pair is an
7935 LDAP query, and the second is the data that is returned. The attribute called
7936 &%attr1%& has two values, one of them with an embedded comma, whereas
7937 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7938 (they have SUP &%attr%& in their schema definitions).
7939
7940 .code
7941 ldap:///o=base?attr1?sub?(uid=fred)
7942 value1.1,value1,,2
7943
7944 ldap:///o=base?attr2?sub?(uid=fred)
7945 value two
7946
7947 ldap:///o=base?attr?sub?(uid=fred)
7948 value1.1,value1,,2,value two
7949
7950 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7951 attr1="value1.1,value1,,2" attr2="value two"
7952
7953 ldap:///o=base??sub?(uid=fred)
7954 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7955 .endd
7956 You can
7957 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7958 results of LDAP lookups.
7959 The &%extract%& operator in string expansions can be used to pick out
7960 individual fields from data that consists of &'key'&=&'value'& pairs.
7961 The &%listextract%& operator should be used to pick out individual values
7962 of attributes, even when only a single value is expected.
7963 The doubling of embedded commas allows you to use the returned data as a
7964 comma separated list (using the "<," syntax for changing the input list separator).
7965
7966
7967
7968
7969 .section "More about NIS+" "SECTnisplus"
7970 .cindex "NIS+ lookup type"
7971 .cindex "lookup" "NIS+"
7972 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7973 and field name. If this is given, the result of a successful query is the
7974 contents of the named field; otherwise the result consists of a concatenation
7975 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7976 values containing spaces are quoted. For example, the query
7977 .code
7978 [name=mg1456],passwd.org_dir
7979 .endd
7980 might return the string
7981 .code
7982 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7983 home=/home/mg1456 shell=/bin/bash shadow=""
7984 .endd
7985 (split over two lines here to fit on the page), whereas
7986 .code
7987 [name=mg1456],passwd.org_dir:gcos
7988 .endd
7989 would just return
7990 .code
7991 Martin Guerre
7992 .endd
7993 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7994 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7995 operator is to double any quote characters within the text.
7996
7997
7998
7999 .section "SQL lookups" "SECTsql"
8000 .cindex "SQL lookup types"
8001 .cindex "MySQL" "lookup type"
8002 .cindex "PostgreSQL lookup type"
8003 .cindex "lookup" "MySQL"
8004 .cindex "lookup" "PostgreSQL"
8005 .cindex "Oracle" "lookup type"
8006 .cindex "lookup" "Oracle"
8007 .cindex "InterBase lookup type"
8008 .cindex "lookup" "InterBase"
8009 .cindex "Redis lookup type"
8010 .cindex lookup Redis
8011 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8012 and SQLite
8013 databases. Queries for these databases contain SQL statements, so an example
8014 might be
8015 .code
8016 ${lookup mysql{select mailbox from users where id='userx'}\
8017   {$value}fail}
8018 .endd
8019 If the result of the query contains more than one field, the data for each
8020 field in the row is returned, preceded by its name, so the result of
8021 .code
8022 ${lookup pgsql{select home,name from users where id='userx'}\
8023   {$value}}
8024 .endd
8025 might be
8026 .code
8027 home=/home/userx name="Mister X"
8028 .endd
8029 Empty values and values containing spaces are double quoted, with embedded
8030 quotes escaped by a backslash. If the result of the query contains just one
8031 field, the value is passed back verbatim, without a field name, for example:
8032 .code
8033 Mister X
8034 .endd
8035 If the result of the query yields more than one row, it is all concatenated,
8036 with a newline between the data for each row.
8037
8038
8039 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8040 .cindex "MySQL" "lookup type"
8041 .cindex "PostgreSQL lookup type"
8042 .cindex "lookup" "MySQL"
8043 .cindex "lookup" "PostgreSQL"
8044 .cindex "Oracle" "lookup type"
8045 .cindex "lookup" "Oracle"
8046 .cindex "InterBase lookup type"
8047 .cindex "lookup" "InterBase"
8048 .cindex "Redis lookup type"
8049 .cindex lookup Redis
8050 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8051 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8052 or &%redis_servers%&
8053 option (as appropriate) must be set to a colon-separated list of server
8054 information.
8055 .oindex &%mysql_servers%&
8056 .oindex &%pgsql_servers%&
8057 .oindex &%oracle_servers%&
8058 .oindex &%ibase_servers%&
8059 .oindex &%redis_servers%&
8060 (For MySQL and PostgreSQL, the global option need not be set if all
8061 queries contain their own server information &-- see section
8062 &<<SECTspeserque>>&.)
8063 For all but Redis
8064 each item in the list is a slash-separated list of four
8065 items: host name, database name, user name, and password. In the case of
8066 Oracle, the host name field is used for the &"service name"&, and the database
8067 name field is not used and should be empty. For example:
8068 .code
8069 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8070 .endd
8071 Because password data is sensitive, you should always precede the setting with
8072 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8073 option. Here is an example where two MySQL servers are listed:
8074 .code
8075 hide mysql_servers = localhost/users/root/secret:\
8076                      otherhost/users/root/othersecret
8077 .endd
8078 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8079 because this is a colon-separated list, the colon has to be doubled. For each
8080 query, these parameter groups are tried in order until a connection is made and
8081 a query is successfully processed. The result of a query may be that no data is
8082 found, but that is still a successful query. In other words, the list of
8083 servers provides a backup facility, not a list of different places to look.
8084
8085 For Redis the global option need not be specified if all queries contain their
8086 own server information &-- see section &<<SECTspeserque>>&.
8087 If specified, the option must be set to a colon-separated list of server
8088 information.
8089 Each item in the list is a slash-separated list of three items:
8090 host, database number, and password.
8091 .olist
8092 The host is required and may be either an IPv4 address and optional
8093 port number (separated by a colon, which needs doubling due to the
8094 higher-level list), or a Unix socket pathname enclosed in parentheses
8095 .next
8096 The database number is optional; if present that number is selected in the backend
8097 .next
8098 The password is optional; if present it is used to authenticate to the backend
8099 .endlist
8100
8101 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8102 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8103 respectively, and the characters single-quote, double-quote, and backslash
8104 itself are escaped with backslashes.
8105
8106 The &%quote_redis%& expansion operator
8107 escapes whitespace and backslash characters with a backslash.
8108
8109 .subsection "Specifying the server in the query" SECTspeserque
8110 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8111 it is possible to specify a list of servers with an individual query. This is
8112 done by appending a comma-separated option to the query type:
8113 .display
8114 &`,servers=`&&'server1:server2:server3:...'&
8115 .endd
8116 Each item in the list may take one of two forms:
8117 .olist
8118 If it contains no slashes it is assumed to be just a host name. The appropriate
8119 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8120 of the same name, and the remaining parameters (database, user, password) are
8121 taken from there.
8122 .next
8123 If it contains any slashes, it is taken as a complete parameter set.
8124 .endlist
8125 The list of servers is used in exactly the same way as the global list.
8126 Once a connection to a server has happened and a query has been
8127 successfully executed, processing of the lookup ceases.
8128
8129 This feature is intended for use in master/slave situations where updates
8130 are occurring and you want to update the master rather than a slave. If the
8131 master is in the list as a backup for reading, you might have a global setting
8132 like this:
8133 .code
8134 mysql_servers = slave1/db/name/pw:\
8135                 slave2/db/name/pw:\
8136                 master/db/name/pw
8137 .endd
8138 In an updating lookup, you could then write:
8139 .code
8140 ${lookup mysql,servers=master {UPDATE ...} }
8141 .endd
8142 That query would then be sent only to the master server. If, on the other hand,
8143 the master is not to be used for reading, and so is not present in the global
8144 option, you can still update it by a query of this form:
8145 .code
8146 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8147 .endd
8148
8149 An older syntax places the servers specification before the query,
8150 semicolon separated:
8151 .code
8152 ${lookup mysql{servers=master; UPDATE ...} }
8153 .endd
8154 The new version avoids potential issues with tainted
8155 arguments in the query, for explicit expansion.
8156 &*Note*&: server specifications in list-style lookups are still problematic.
8157
8158
8159 .subsection "Special MySQL features" SECID73
8160 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8161 causes a connection to the server on the local host by means of a Unix domain
8162 socket. An alternate socket can be specified in parentheses.
8163 An option group name for MySQL option files can be specified in square brackets;
8164 the default value is &"exim"&.
8165 The full syntax of each item in &%mysql_servers%& is:
8166 .display
8167 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8168   <&'database'&>/<&'user'&>/<&'password'&>
8169 .endd
8170 Any of the four sub-parts of the first field can be omitted. For normal use on
8171 the local host it can be left blank or set to just &"localhost"&.
8172
8173 No database need be supplied &-- but if it is absent here, it must be given in
8174 the queries.
8175
8176 If a MySQL query is issued that does not request any data (an insert, update,
8177 or delete command), the result of the lookup is the number of rows affected.
8178
8179 &*Warning*&: This can be misleading. If an update does not actually change
8180 anything (for example, setting a field to the value it already has), the result
8181 is zero because no rows are affected.
8182
8183
8184 .subsection "Special PostgreSQL features" SECID74
8185 PostgreSQL lookups can also use Unix domain socket connections to the database.
8186 This is usually faster and costs less CPU time than a TCP/IP connection.
8187 However it can be used only if the mail server runs on the same machine as the
8188 database server. A configuration line for PostgreSQL via Unix domain sockets
8189 looks like this:
8190 .code
8191 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8192 .endd
8193 In other words, instead of supplying a host name, a path to the socket is
8194 given. The path name is enclosed in parentheses so that its slashes aren't
8195 visually confused with the delimiters for the other server parameters.
8196
8197 If a PostgreSQL query is issued that does not request any data (an insert,
8198 update, or delete command), the result of the lookup is the number of rows
8199 affected.
8200
8201 .subsection "More about SQLite" SECTsqlite
8202 .cindex "lookup" "SQLite"
8203 .cindex "sqlite lookup type"
8204 SQLite is different to the other SQL lookups because a filename is required in
8205 addition to the SQL query. An SQLite database is a single file, and there is no
8206 daemon as in the other SQL databases.
8207
8208 .oindex &%sqlite_dbfile%&
8209 There are two ways of
8210 specifying the file.
8211 The first is is by using the &%sqlite_dbfile%& main option.
8212 The second, which allows separate files for each query,
8213 is to use an option appended, comma-separated, to the &"sqlite"&
8214 lookup type word.  The option is the word &"file"&, then an equals,
8215 then the filename.
8216 The filename in this case cannot contain whitespace or open-brace charachters.
8217
8218 A deprecated method is available, prefixing the query with the filename
8219 separated by white space.
8220 This means that
8221 .cindex "tainted data" "sqlite file"
8222 the query cannot use any tainted values, as that taints
8223 the entire query including the filename - resulting in a refusal to open
8224 the file.
8225
8226 In all the above cases the filename must be an absolute path.
8227
8228 Here is a lookup expansion example:
8229 .code
8230 sqlite_dbfile = /some/thing/sqlitedb
8231 ...
8232 ${lookup sqlite {select name from aliases where id='userx';}}
8233 .endd
8234 In a list, the syntax is similar. For example:
8235 .code
8236 domainlist relay_to_domains = sqlite;\
8237    select * from relays where ip='$sender_host_address';
8238 .endd
8239 The only character affected by the &%quote_sqlite%& operator is a single
8240 quote, which it doubles.
8241
8242 .cindex timeout SQLite
8243 .cindex sqlite "lookup timeout"
8244 The SQLite library handles multiple simultaneous accesses to the database
8245 internally. Multiple readers are permitted, but only one process can
8246 update at once. Attempts to access the database while it is being updated
8247 are rejected after a timeout period, during which the SQLite library
8248 waits for the lock to be released. In Exim, the default timeout is set
8249 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8250 option.
8251
8252 .subsection "More about Redis" SECTredis
8253 .cindex "lookup" "Redis"
8254 .cindex "redis lookup type"
8255 Redis is a non-SQL database. Commands are simple get and set.
8256 Examples:
8257 .code
8258 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8259 ${lookup redis{get keyname}}
8260 .endd
8261
8262 As of release 4.91, "lightweight" support for Redis Cluster is available.
8263 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8264 of which must be reachable from the running exim instance. If the cluster has
8265 master/slave replication, the list must contain all the master and slave
8266 servers.
8267
8268 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8269 immediately follow the redirection but treats the response as a DEFER, moving on
8270 to the next server in the &%redis_servers%& list until the correct server is
8271 reached.
8272
8273 .ecindex IIDfidalo1
8274 .ecindex IIDfidalo2
8275
8276
8277 . ////////////////////////////////////////////////////////////////////////////
8278 . ////////////////////////////////////////////////////////////////////////////
8279
8280 .chapter "Domain, host, address, and local part lists" &&&
8281          "CHAPdomhosaddlists" &&&
8282          "Domain, host, and address lists"
8283 .scindex IIDdohoadli "lists of domains; hosts; etc."
8284 A number of Exim configuration options contain lists of domains, hosts,
8285 email addresses, or local parts. For example, the &%hold_domains%& option
8286 contains a list of domains whose delivery is currently suspended. These lists
8287 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8288 arguments to expansion conditions such as &%match_domain%&.
8289
8290 Each item in one of these lists is a pattern to be matched against a domain,
8291 host, email address, or local part, respectively. In the sections below, the
8292 different types of pattern for each case are described, but first we cover some
8293 general facilities that apply to all four kinds of list.
8294
8295 Note that other parts of Exim use a &'string list'& which does not
8296 support all the complexity available in
8297 domain, host, address and local part lists.
8298
8299
8300
8301 .section "Results of list checking" SECTlistresults
8302 The primary result of doing a list check is a truth value.
8303 In some contexts additional information is stored
8304 about the list element that matched:
8305 .vlist
8306 .vitem hosts
8307 A &%hosts%& ACL condition
8308 will store a result in the &$host_data$& variable.
8309 .vitem local_parts
8310 A &%local_parts%& router option or &%local_parts%& ACL condition
8311 will store a result in the &$local_part_data$& variable.
8312 .vitem domains
8313 A &%domains%& router option or &%domains%& ACL condition
8314 will store a result in the &$domain_data$& variable.
8315 .vitem senders
8316 A &%senders%& router option or &%senders%& ACL condition
8317 will store a result in the &$sender_data$& variable.
8318 .vitem recipients
8319 A &%recipients%& ACL condition
8320 will store a result in the &$recipient_data$& variable.
8321 .endlist
8322
8323 The detail of the additional information depends on the
8324 type of match and is given below as the &*value*& information.
8325
8326
8327
8328
8329 .section "Expansion of lists" "SECTlistexpand"
8330 .cindex "expansion" "of lists"
8331 Each list is expanded as a single string before it is used.
8332
8333 &'Exception: the router headers_remove option, where list-item
8334 splitting is done before string-expansion.'&
8335
8336 The result of
8337 expansion must be a list, possibly containing empty items, which is split up
8338 into separate items for matching. By default, colon is the separator character,
8339 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8340 &<<SECTempitelis>>& for details of the list syntax; the second of these
8341 discusses the way to specify empty list items.
8342
8343
8344 If the string expansion is forced to fail, Exim behaves as if the item it is
8345 testing (domain, host, address, or local part) is not in the list. Other
8346 expansion failures cause temporary errors.
8347
8348 If an item in a list is a regular expression, backslashes, dollars and possibly
8349 other special characters in the expression must be protected against
8350 misinterpretation by the string expander. The easiest way to do this is to use
8351 the &`\N`& expansion feature to indicate that the contents of the regular
8352 expression should not be expanded. For example, in an ACL you might have:
8353 .code
8354 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8355                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8356 .endd
8357 The first item is a regular expression that is protected from expansion by
8358 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8359 senders based on the receiving domain.
8360
8361
8362
8363
8364 .subsection "Negated items in lists" SECID76
8365 .cindex "list" "negation"
8366 .cindex "negation" "in lists"
8367 Items in a list may be positive or negative. Negative items are indicated by a
8368 leading exclamation mark, which may be followed by optional white space. A list
8369 defines a set of items (domains, etc). When Exim processes one of these lists,
8370 it is trying to find out whether a domain, host, address, or local part
8371 (respectively) is in the set that is defined by the list. It works like this:
8372
8373 The list is scanned from left to right. If a positive item is matched, the
8374 subject that is being checked is in the set; if a negative item is matched, the
8375 subject is not in the set. If the end of the list is reached without the
8376 subject having matched any of the patterns, it is in the set if the last item
8377 was a negative one, but not if it was a positive one. For example, the list in
8378 .code
8379 domainlist relay_to_domains = !a.b.c : *.b.c
8380 .endd
8381 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8382 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8383 list is positive. However, if the setting were
8384 .code
8385 domainlist relay_to_domains = !a.b.c
8386 .endd
8387 then all domains other than &'a.b.c'& would match because the last item in the
8388 list is negative. In other words, a list that ends with a negative item behaves
8389 as if it had an extra item &`:*`& on the end.
8390
8391 Another way of thinking about positive and negative items in lists is to read
8392 the connector as &"or"& after a positive item and as &"and"& after a negative
8393 item.
8394
8395
8396
8397 .subsection "File names in lists" SECTfilnamlis
8398 .cindex "list" "filename in"
8399 If an item in a domain, host, address, or local part list is an absolute
8400 filename (beginning with a slash character), each line of the file is read and
8401 processed as if it were an independent item in the list, except that further
8402 filenames are not allowed,
8403 and no expansion of the data from the file takes place.
8404 Empty lines in the file are ignored, and the file may also contain comment
8405 lines:
8406
8407 .ilist
8408 For domain and host lists, if a # character appears anywhere in a line of the
8409 file, it and all following characters are ignored.
8410 .next
8411 Because local parts may legitimately contain # characters, a comment in an
8412 address list or local part list file is recognized only if # is preceded by
8413 white space or the start of the line. For example:
8414 .code
8415 not#comment@x.y.z   # but this is a comment
8416 .endd
8417 .endlist
8418
8419 Putting a filename in a list has the same effect as inserting each line of the
8420 file as an item in the list (blank lines and comments excepted). However, there
8421 is one important difference: the file is read each time the list is processed,
8422 so if its contents vary over time, Exim's behaviour changes.
8423
8424 If a filename is preceded by an exclamation mark, the sense of any match
8425 within the file is inverted. For example, if
8426 .code
8427 hold_domains = !/etc/nohold-domains
8428 .endd
8429 and the file contains the lines
8430 .code
8431 !a.b.c
8432 *.b.c
8433 .endd
8434 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8435 any domain matching &`*.b.c`& is not.
8436
8437
8438
8439 .subsection "An lsearch file is not an out-of-line list" SECID77
8440 As will be described in the sections that follow, lookups can be used in lists
8441 to provide indexed methods of checking list membership. There has been some
8442 confusion about the way &(lsearch)& lookups work in lists. Because
8443 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8444 sometimes thought that it is allowed to contain wild cards and other kinds of
8445 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8446 always fixed strings, just as for any other single-key lookup type.
8447
8448 If you want to use a file to contain wild-card patterns that form part of a
8449 list, just give the filename on its own, without a search type, as described
8450 in the previous section. You could also use the &(wildlsearch)& or
8451 &(nwildlsearch)&, but there is no advantage in doing this.
8452
8453
8454
8455
8456 .subsection "Named lists" SECTnamedlists
8457 .cindex "named lists"
8458 .cindex "list" "named"
8459 A list of domains, hosts, email addresses, or local parts can be given a name
8460 which is then used to refer to the list elsewhere in the configuration. This is
8461 particularly convenient if the same list is required in several different
8462 places. It also allows lists to be given meaningful names, which can improve
8463 the readability of the configuration. For example, it is conventional to define
8464 a domain list called &'local_domains'& for all the domains that are handled
8465 locally on a host, using a configuration line such as
8466 .code
8467 domainlist local_domains = localhost:my.dom.example
8468 .endd
8469 Named lists are referenced by giving their name preceded by a plus sign, so,
8470 for example, a router that is intended to handle local domains would be
8471 configured with the line
8472 .code
8473 domains = +local_domains
8474 .endd
8475 The first router in a configuration is often one that handles all domains
8476 except the local ones, using a configuration with a negated item like this:
8477 .code
8478 dnslookup:
8479   driver = dnslookup
8480   domains = ! +local_domains
8481   transport = remote_smtp
8482   no_more
8483 .endd
8484 The four kinds of named list are created by configuration lines starting with
8485 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8486 respectively. Then there follows the name that you are defining, followed by an
8487 equals sign and the list itself. For example:
8488 .code
8489 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8490 addresslist bad_senders = cdb;/etc/badsenders
8491 .endd
8492 A named list may refer to other named lists:
8493 .code
8494 domainlist  dom1 = first.example : second.example
8495 domainlist  dom2 = +dom1 : third.example
8496 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8497 .endd
8498 &*Warning*&: If the last item in a referenced list is a negative one, the
8499 effect may not be what you intended, because the negation does not propagate
8500 out to the higher level. For example, consider:
8501 .code
8502 domainlist  dom1 = !a.b
8503 domainlist  dom2 = +dom1 : *.b
8504 .endd
8505 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8506 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8507 means it matches the second list as well. The effect is not the same as
8508 .code
8509 domainlist  dom2 = !a.b : *.b
8510 .endd
8511 where &'x.y'& does not match. It's best to avoid negation altogether in
8512 referenced lists if you can.
8513
8514 .cindex "hiding named list values"
8515 .cindex "named lists" "hiding value of"
8516 Some named list definitions may contain sensitive data, for example, passwords for
8517 accessing databases. To stop non-admin users from using the &%-bP%& command
8518 line option to read these values, you can precede the definition with the
8519 word &"hide"&. For example:
8520 .code
8521 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8522 .endd
8523
8524
8525 Named lists may have a performance advantage. When Exim is routing an
8526 address or checking an incoming message, it caches the result of tests on named
8527 lists. So, if you have a setting such as
8528 .code
8529 domains = +local_domains
8530 .endd
8531 on several of your routers
8532 or in several ACL statements,
8533 the actual test is done only for the first one. However, the caching works only
8534 if there are no expansions within the list itself or any sublists that it
8535 references. In other words, caching happens only for lists that are known to be
8536 the same each time they are referenced.
8537
8538 By default, there may be up to 16 named lists of each type. This limit can be
8539 extended by changing a compile-time variable. The use of domain and host lists
8540 is recommended for concepts such as local domains, relay domains, and relay
8541 hosts. The default configuration is set up like this.
8542
8543
8544
8545 .subsection "Named lists compared with macros" SECID78
8546 .cindex "list" "named compared with macro"
8547 .cindex "macro" "compared with named list"
8548 At first sight, named lists might seem to be no different from macros in the
8549 configuration file. However, macros are just textual substitutions. If you
8550 write
8551 .code
8552 ALIST = host1 : host2
8553 auth_advertise_hosts = !ALIST
8554 .endd
8555 it probably won't do what you want, because that is exactly the same as
8556 .code
8557 auth_advertise_hosts = !host1 : host2
8558 .endd
8559 Notice that the second host name is not negated. However, if you use a host
8560 list, and write
8561 .code
8562 hostlist alist = host1 : host2
8563 auth_advertise_hosts = ! +alist
8564 .endd
8565 the negation applies to the whole list, and so that is equivalent to
8566 .code
8567 auth_advertise_hosts = !host1 : !host2
8568 .endd
8569
8570
8571 .subsection "Named list caching" SECID79
8572 .cindex "list" "caching of named"
8573 .cindex "caching" "named lists"
8574 While processing a message, Exim caches the result of checking a named list if
8575 it is sure that the list is the same each time. In practice, this means that
8576 the cache operates only if the list contains no $ characters, which guarantees
8577 that it will not change when it is expanded. Sometimes, however, you may have
8578 an expanded list that you know will be the same each time within a given
8579 message. For example:
8580 .code
8581 domainlist special_domains = \
8582            ${lookup{$sender_host_address}cdb{/some/file}}
8583 .endd
8584 This provides a list of domains that depends only on the sending host's IP
8585 address. If this domain list is referenced a number of times (for example,
8586 in several ACL lines, or in several routers) the result of the check is not
8587 cached by default, because Exim does not know that it is going to be the
8588 same list each time.
8589
8590 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8591 cache the result anyway. For example:
8592 .code
8593 domainlist_cache special_domains = ${lookup{...
8594 .endd
8595 If you do this, you should be absolutely sure that caching is going to do
8596 the right thing in all cases. When in doubt, leave it out.
8597
8598
8599
8600 .section "Domain lists" "SECTdomainlist"
8601 .cindex "domain list" "patterns for"
8602 .cindex "list" "domain list"
8603 Domain lists contain patterns that are to be matched against a mail domain.
8604 The following types of item may appear in domain lists:
8605
8606 .ilist
8607 .cindex "primary host name"
8608 .cindex "host name" "matched in domain list"
8609 .oindex "&%primary_hostname%&"
8610 .cindex "domain list" "matching primary host name"
8611 .cindex "@ in a domain list"
8612 If a pattern consists of a single @ character, it matches the local host name,
8613 as set by the &%primary_hostname%& option (or defaulted). This makes it
8614 possible to use the same configuration file on several different hosts that
8615 differ only in their names.
8616
8617 The value for a match will be the primary host name.
8618
8619
8620 .next
8621 .cindex "@[] in a domain list"
8622 .cindex "domain list" "matching local IP interfaces"
8623 .cindex "domain literal"
8624 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8625 in square brackets (as in an email address that contains a domain literal), but
8626 only if that IP address is recognized as local for email routing purposes. The
8627 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8628 control which of a host's several IP addresses are treated as local.
8629 In today's Internet, the use of domain literals is controversial;
8630 see the &%allow_domain_literals%& main option.
8631
8632 The value for a match will be the string &`@[]`&.
8633
8634
8635 .next
8636 .cindex "@mx_any"
8637 .cindex "@mx_primary"
8638 .cindex "@mx_secondary"
8639 .cindex "domain list" "matching MX pointers to local host"
8640 If a pattern consists of the string &`@mx_any`& it matches any domain that
8641 has an MX record pointing to the local host or to any host that is listed in
8642 .oindex "&%hosts_treat_as_local%&"
8643 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8644 are similar, except that the first matches only when a primary MX target is the
8645 local host, and the second only when no primary MX target is the local host,
8646 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8647 preference value &-- there may of course be more than one of them.
8648
8649 The MX lookup that takes place when matching a pattern of this type is
8650 performed with the resolver options for widening names turned off. Thus, for
8651 example, a single-component domain will &'not'& be expanded by adding the
8652 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8653 options of the &(dnslookup)& router for a discussion of domain widening.
8654
8655 Sometimes you may want to ignore certain IP addresses when using one of these
8656 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8657 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8658 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8659 on a router). For example:
8660 .code
8661 domains = @mx_any/ignore=127.0.0.1
8662 .endd
8663 This example matches any domain that has an MX record pointing to one of
8664 the local host's IP addresses other than 127.0.0.1.
8665
8666 The list of IP addresses is in fact processed by the same code that processes
8667 host lists, so it may contain CIDR-coded network specifications and it may also
8668 contain negative items.
8669
8670 Because the list of IP addresses is a sublist within a domain list, you have to
8671 be careful about delimiters if there is more than one address. Like any other
8672 list, the default delimiter can be changed. Thus, you might have:
8673 .code
8674 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8675           an.other.domain : ...
8676 .endd
8677 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8678 involved, it is easiest to change the delimiter for the main list as well:
8679 .code
8680 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8681           an.other.domain ? ...
8682 .endd
8683 The value for a match will be the list element string (starting &`@mx_`&).
8684
8685
8686 .next
8687 .cindex "asterisk" "in domain list"
8688 .cindex "domain list" "asterisk in"
8689 .cindex "domain list" "matching &""ends with""&"
8690 If a pattern starts with an asterisk, the remaining characters of the pattern
8691 are compared with the terminating characters of the domain. The use of &"*"& in
8692 domain lists differs from its use in partial matching lookups. In a domain
8693 list, the character following the asterisk need not be a dot, whereas partial
8694 matching works only in terms of dot-separated components. For example, a domain
8695 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8696 &'cipher.key.ex'&.
8697
8698 The value for a match will be the list element string (starting with the asterisk).
8699 Additionally, &$0$& will be set to the matched string
8700 and &$1$& to the variable portion which the asterisk matched.
8701
8702 .next
8703 .cindex "regular expressions" "in domain list"
8704 .cindex "domain list" "matching regular expression"
8705 If a pattern starts with a circumflex character, it is treated as a regular
8706 expression, and matched against the domain using a regular expression matching
8707 function. The circumflex is treated as part of the regular expression.
8708 Email domains are case-independent, so this regular expression match is by
8709 default case-independent, but you can make it case-dependent by starting it
8710 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8711 are given in chapter &<<CHAPregexp>>&.
8712
8713 &*Warning*&: Because domain lists are expanded before being processed, you
8714 must escape any backslash and dollar characters in the regular expression, or
8715 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8716 it is not to be expanded (unless you really do want to build a regular
8717 expression by expansion, of course).
8718
8719 The value for a match will be the list element string (starting with the circumflex).
8720 Additionally, &$0$& will be set to the string matching the regular expression,
8721 and &$1$& (onwards) to any submatches identified by parentheses.
8722
8723
8724
8725 .next
8726 .cindex "lookup" "in domain list"
8727 .cindex "domain list" "matching by lookup"
8728 If a pattern starts with the name of a single-key lookup type followed by a
8729 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8730 must be a filename in a suitable format for the lookup type. For example, for
8731 &"cdb;"& it must be an absolute path:
8732 .code
8733 domains = cdb;/etc/mail/local_domains.cdb
8734 .endd
8735 The appropriate type of lookup is done on the file using the domain name as the
8736 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8737 only in whether or not the key is present in the file. However, when a lookup
8738 is used for the &%domains%& option on a router
8739 or a &%domains%& condition in an ACL statement, the value is preserved in the
8740 &$domain_data$& variable and can be referred to in other router options or
8741 other statements in the same ACL.
8742 .cindex "tainted data" "de-tainting"
8743 .cindex "de-tainting" "using ACL domains condition"
8744 The value will be untainted.
8745
8746 &*Note*&: If the data result of the lookup (as opposed to the key)
8747 is empty, then this empty value is stored in &$domain_data$&.
8748 The option to return the key for the lookup, as the value,
8749 may be what is wanted.
8750
8751
8752 .next
8753 Any of the single-key lookup type names may be preceded by
8754 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8755 .code
8756 domains = partial-dbm;/partial/domains
8757 .endd
8758 This causes partial matching logic to be invoked; a description of how this
8759 works is given in section &<<SECTpartiallookup>>&.
8760
8761 .next
8762 .cindex "asterisk" "in lookup type"
8763 Any of the single-key lookup types may be followed by an asterisk. This causes
8764 a default lookup for a key consisting of a single asterisk to be done if the
8765 original lookup fails. This is not a useful feature when using a domain list to
8766 select particular domains (because any domain would match), but it might have
8767 value if the result of the lookup is being used via the &$domain_data$&
8768 expansion variable.
8769
8770 .next
8771 If the pattern starts with the name of a query-style lookup type followed by a
8772 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8773 pattern must be an appropriate query for the lookup type, as described in
8774 chapter &<<CHAPfdlookup>>&. For example:
8775 .code
8776 hold_domains = mysql;select domain from holdlist \
8777   where domain = '${quote_mysql:$domain}';
8778 .endd
8779 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8780 example, it doesn't matter what field you select). Exim is interested only in
8781 whether or not the query succeeds. However, when a lookup is used for the
8782 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8783 variable and can be referred to in other options.
8784 .cindex "tainted data" "de-tainting"
8785 .cindex "de-tainting" "using router domains option"
8786 The value will be untainted.
8787
8788 .next
8789 If the pattern starts with the name of a lookup type
8790 of either kind (single-key or query-style) it may be
8791 followed by a comma and options,
8792 The options are lookup-type specific and consist of a comma-separated list.
8793 Each item starts with a tag and and equals "=" sign.
8794
8795 .next
8796 .cindex "domain list" "matching literal domain name"
8797 If none of the above cases apply, a caseless textual comparison is made
8798 between the pattern and the domain.
8799
8800 The value for a match will be the list element string.
8801 .cindex "tainted data" "de-tainting"
8802 Note that this is commonly untainted
8803 (depending on the way the list was created).
8804 Specifically, explicit text in the configuration file in not tainted.
8805 This is a useful way of obtaining an untainted equivalent to
8806 the domain, for later operations.
8807
8808 However if the list (including one-element lists)
8809 is created by expanding a variable containing tainted data,
8810 it is tainted and so will the match value be.
8811 .endlist
8812
8813
8814 Here is an example that uses several different kinds of pattern:
8815 .code
8816 domainlist funny_domains = \
8817   @ : \
8818   lib.unseen.edu : \
8819   *.foundation.fict.example : \
8820   \N^[1-2]\d{3}\.fict\.example$\N : \
8821   partial-dbm;/opt/data/penguin/book : \
8822   nis;domains.byname : \
8823   nisplus;[name=$domain,status=local],domains.org_dir
8824 .endd
8825 There are obvious processing trade-offs among the various matching modes. Using
8826 an asterisk is faster than a regular expression, and listing a few names
8827 explicitly probably is too. The use of a file or database lookup is expensive,
8828 but may be the only option if hundreds of names are required. Because the
8829 patterns are tested in order, it makes sense to put the most commonly matched
8830 patterns earlier.
8831
8832
8833
8834 .section "Host lists" "SECThostlist"
8835 .cindex "host list" "patterns in"
8836 .cindex "list" "host list"
8837 Host lists are used to control what remote hosts are allowed to do. For
8838 example, some hosts may be allowed to use the local host as a relay, and some
8839 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8840 two different ways, by name or by IP address. In a host list, some types of
8841 pattern are matched to a host name, and some are matched to an IP address.
8842 You need to be particularly careful with this when single-key lookups are
8843 involved, to ensure that the right value is being used as the key.
8844
8845
8846 .subsection "Special host list patterns" SECID80
8847 .cindex "empty item in hosts list"
8848 .cindex "host list" "empty string in"
8849 If a host list item is the empty string, it matches only when no remote host is
8850 involved. This is the case when a message is being received from a local
8851 process using SMTP on the standard input, that is, when a TCP/IP connection is
8852 not used.
8853
8854 .cindex "asterisk" "in host list"
8855 The special pattern &"*"& in a host list matches any host or no host. Neither
8856 the IP address nor the name is actually inspected.
8857
8858
8859
8860 .subsection "Host list patterns that match by IP address" SECThoslispatip
8861 .cindex "host list" "matching IP addresses"
8862 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8863 the incoming address actually appears in the IPv6 host as
8864 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8865 list, it is converted into a traditional IPv4 address first. (Not all operating
8866 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8867 concerns.)
8868
8869 The following types of pattern in a host list check the remote host by
8870 inspecting its IP address:
8871
8872 .ilist
8873 If the pattern is a plain domain name (not a regular expression, not starting
8874 with *, not a lookup of any kind), Exim calls the operating system function
8875 to find the associated IP address(es). Exim uses the newer
8876 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8877 This typically causes a forward DNS lookup of the name. The result is compared
8878 with the IP address of the subject host.
8879
8880 If there is a temporary problem (such as a DNS timeout) with the host name
8881 lookup, a temporary error occurs. For example, if the list is being used in an
8882 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8883 temporary SMTP error code. If no IP address can be found for the host name,
8884 what happens is described in section &<<SECTbehipnot>>& below.
8885
8886 .next
8887 .cindex "@ in a host list"
8888 If the pattern is &"@"&, the primary host name is substituted and used as a
8889 domain name, as just described.
8890
8891 .next
8892 If the pattern is an IP address, it is matched against the IP address of the
8893 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8894 IPv6 addresses can be given in colon-separated format, but the colons have to
8895 be doubled so as not to be taken as item separators when the default list
8896 separator is used. IPv6 addresses are recognized even when Exim is compiled
8897 without IPv6 support. This means that if they appear in a host list on an
8898 IPv4-only host, Exim will not treat them as host names. They are just addresses
8899 that can never match a client host.
8900
8901 .next
8902 .cindex "@[] in a host list"
8903 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8904 the local host. For example, if the local host is an IPv4 host with one
8905 interface address 10.45.23.56, these two ACL statements have the same effect:
8906 .code
8907 accept hosts = 127.0.0.1 : 10.45.23.56
8908 accept hosts = @[]
8909 .endd
8910 .next
8911 .cindex "CIDR notation"
8912 If the pattern is an IP address followed by a slash and a mask length, for
8913 example
8914 .code
8915 10.11.42.0/24
8916 .endd
8917 , it is matched against the IP address of the subject
8918 host under the given mask. This allows an entire network of hosts to be
8919 included (or excluded) by a single item. The mask uses CIDR notation; it
8920 specifies the number of address bits that must match, starting from the most
8921 significant end of the address.
8922
8923 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8924 of a range of addresses. It is the number of bits in the network portion of the
8925 address. The above example specifies a 24-bit netmask, so it matches all 256
8926 addresses in the 10.11.42.0 network. An item such as
8927 .code
8928 192.168.23.236/31
8929 .endd
8930 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8931 32 for an IPv4 address is the same as no mask at all; just a single address
8932 matches.
8933
8934 Here is another example which shows an IPv4 and an IPv6 network:
8935 .code
8936 recipient_unqualified_hosts = 192.168.0.0/16: \
8937                               3ffe::ffff::836f::::/48
8938 .endd
8939 The doubling of list separator characters applies only when these items
8940 appear inline in a host list. It is not required when indirecting via a file.
8941 For example:
8942 .code
8943 recipient_unqualified_hosts = /opt/exim/unqualnets
8944 .endd
8945 could make use of a file containing
8946 .code
8947 172.16.0.0/12
8948 3ffe:ffff:836f::/48
8949 .endd
8950 to have exactly the same effect as the previous example. When listing IPv6
8951 addresses inline, it is usually more convenient to use the facility for
8952 changing separator characters. This list contains the same two networks:
8953 .code
8954 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8955                                  3ffe:ffff:836f::/48
8956 .endd
8957 The separator is changed to semicolon by the leading &"<;"& at the start of the
8958 list.
8959 .endlist
8960
8961
8962
8963 .subsection "Host list patterns for single-key lookups by host address" &&&
8964          SECThoslispatsikey
8965 .cindex "host list" "lookup of IP address"
8966 When a host is to be identified by a single-key lookup of its complete IP
8967 address, the pattern takes this form:
8968 .display
8969 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8970 .endd
8971 For example:
8972 .code
8973 hosts_lookup = net-cdb;/hosts-by-ip.db
8974 .endd
8975 The text form of the IP address of the subject host is used as the lookup key.
8976 IPv6 addresses are converted to an unabbreviated form, using lower case
8977 letters, with dots as separators because colon is the key terminator in
8978 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8979 quoting the keys, but this is a facility that was added later.] The data
8980 returned by the lookup is not used.
8981
8982 .cindex "IP address" "masking"
8983 .cindex "host list" "masked IP address"
8984 Single-key lookups can also be performed using masked IP addresses, using
8985 patterns of this form:
8986 .display
8987 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8988 .endd
8989 For example:
8990 .code
8991 net24-dbm;/networks.db
8992 .endd
8993 The IP address of the subject host is masked using <&'number'&> as the mask
8994 length. A textual string is constructed from the masked value, followed by the
8995 mask, and this is used as the lookup key. For example, if the host's IP address
8996 is 192.168.34.6, the key that is looked up for the above example is
8997 &"192.168.34.0/24"&.
8998
8999 When an IPv6 address is converted to a string, dots are normally used instead
9000 of colons, so that keys in &(lsearch)& files need not contain colons (which
9001 terminate &(lsearch)& keys). This was implemented some time before the ability
9002 to quote keys was made available in &(lsearch)& files. However, the more
9003 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9004 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9005 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9006 converted using colons and not dots.
9007 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9008 addresses are always used.
9009 The latter are converted to IPv4 addresses, in dotted-quad form.
9010
9011 Ideally, it would be nice to tidy up this anomalous situation by changing to
9012 colons in all cases, given that quoting is now available for &(lsearch)&.
9013 However, this would be an incompatible change that might break some existing
9014 configurations.
9015
9016 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9017 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9018 the former case the key strings include the mask value, whereas in the latter
9019 case the IP address is used on its own.
9020
9021
9022
9023 .subsection "Host list patterns that match by host name" SECThoslispatnam
9024 .cindex "host" "lookup failures"
9025 .cindex "unknown host name"
9026 .cindex "host list" "matching host name"
9027 There are several types of pattern that require Exim to know the name of the
9028 remote host. These are either wildcard patterns or lookups by name. (If a
9029 complete hostname is given without any wildcarding, it is used to find an IP
9030 address to match against, as described in section &<<SECThoslispatip>>&
9031 above.)
9032
9033 If the remote host name is not already known when Exim encounters one of these
9034 patterns, it has to be found from the IP address.
9035 Although many sites on the Internet are conscientious about maintaining reverse
9036 DNS data for their hosts, there are also many that do not do this.
9037 Consequently, a name cannot always be found, and this may lead to unwanted
9038 effects. Take care when configuring host lists with wildcarded name patterns.
9039 Consider what will happen if a name cannot be found.
9040
9041 Because of the problems of determining host names from IP addresses, matching
9042 against host names is not as common as matching against IP addresses.
9043
9044 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9045 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9046 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9047 are done can be changed by setting the &%host_lookup_order%& option. For
9048 security, once Exim has found one or more names, it looks up the IP addresses
9049 for these names and compares them with the IP address that it started with.
9050 Only those names whose IP addresses match are accepted. Any other names are
9051 discarded. If no names are left, Exim behaves as if the host name cannot be
9052 found. In the most common case there is only one name and one IP address.
9053
9054 There are some options that control what happens if a host name cannot be
9055 found. These are described in section &<<SECTbehipnot>>& below.
9056
9057 .cindex "host" "alias for"
9058 .cindex "alias for host"
9059 As a result of aliasing, hosts may have more than one name. When processing any
9060 of the following types of pattern, all the host's names are checked:
9061
9062 .ilist
9063 .cindex "asterisk" "in host list"
9064 If a pattern starts with &"*"& the remainder of the item must match the end of
9065 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9066 &'.b.c'&. This special simple form is provided because this is a very common
9067 requirement. Other kinds of wildcarding require the use of a regular
9068 expression.
9069 .next
9070 .cindex "regular expressions" "in host list"
9071 .cindex "host list" "regular expression in"
9072 If the item starts with &"^"& it is taken to be a regular expression which is
9073 matched against the host name. Host names are case-independent, so this regular
9074 expression match is by default case-independent, but you can make it
9075 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9076 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9077 example,
9078 .code
9079 ^(a|b)\.c\.d$
9080 .endd
9081 is a regular expression that matches either of the two hosts &'a.c.d'& or
9082 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9083 that backslash and dollar characters are not misinterpreted as part of the
9084 string expansion. The simplest way to do this is to use &`\N`& to mark that
9085 part of the string as non-expandable. For example:
9086 .code
9087 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9088 .endd
9089 &*Warning*&: If you want to match a complete host name, you must include the
9090 &`$`& terminating metacharacter in the regular expression, as in the above
9091 example. Without it, a match at the start of the host name is all that is
9092 required.
9093 .endlist
9094
9095
9096
9097
9098 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9099 .cindex "host" "lookup failures, permanent"
9100 While processing a host list, Exim may need to look up an IP address from a
9101 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9102 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9103 behaviour when it fails to find the information it is seeking is the same.
9104
9105 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9106 apply to temporary DNS errors, whose handling is described in the next section.
9107
9108 .cindex "&`+include_unknown`&"
9109 .cindex "&`+ignore_unknown`&"
9110 Exim parses a host list from left to right. If it encounters a permanent
9111 lookup failure in any item in the host list before it has found a match,
9112 Exim treats it as a failure and the default behavior is as if the host
9113 does not match the list. This may not always be what you want to happen.
9114 To change Exim's behaviour, the special items &`+include_unknown`& or
9115 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9116 not recognized in an indirected file).
9117
9118 .ilist
9119 If any item that follows &`+include_unknown`& requires information that
9120 cannot found, Exim behaves as if the host does match the list. For example,
9121 .code
9122 host_reject_connection = +include_unknown:*.enemy.ex
9123 .endd
9124 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9125 any hosts whose name it cannot find.
9126
9127 .next
9128 If any item that follows &`+ignore_unknown`& requires information that cannot
9129 be found, Exim ignores that item and proceeds to the rest of the list. For
9130 example:
9131 .code
9132 accept hosts = +ignore_unknown : friend.example : \
9133                192.168.4.5
9134 .endd
9135 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9136 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9137 name can be found for 192.168.4.5, it is rejected.
9138 .endlist
9139
9140 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9141 list. The effect of each one lasts until the next, or until the end of the
9142 list.
9143
9144 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9145          SECTmixwilhos
9146 .cindex "host list" "mixing names and addresses in"
9147
9148 This section explains the host/ip processing logic with the same concepts
9149 as the previous section, but specifically addresses what happens when a
9150 wildcarded hostname is one of the items in the hostlist.
9151
9152 .ilist
9153 If you have name lookups or wildcarded host names and
9154 IP addresses in the same host list, you should normally put the IP
9155 addresses first. For example, in an ACL you could have:
9156 .code
9157 accept hosts = 10.9.8.7 : *.friend.example
9158 .endd
9159 The reason you normally would order it this way lies in the
9160 left-to-right way that Exim processes lists.  It can test IP addresses
9161 without doing any DNS lookups, but when it reaches an item that requires
9162 a host name, it fails if it cannot find a host name to compare with the
9163 pattern. If the above list is given in the opposite order, the
9164 &%accept%& statement fails for a host whose name cannot be found, even
9165 if its IP address is 10.9.8.7.
9166
9167 .next
9168 If you really do want to do the name check first, and still recognize the IP
9169 address, you can rewrite the ACL like this:
9170 .code
9171 accept hosts = *.friend.example
9172 accept hosts = 10.9.8.7
9173 .endd
9174 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9175 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9176 &`+ignore_unknown`&, which was discussed in depth in the first example in
9177 this section.
9178 .endlist
9179
9180
9181 .subsection "Temporary DNS errors when looking up host information" &&&
9182          SECTtemdnserr
9183 .cindex "host" "lookup failures, temporary"
9184 .cindex "&`+include_defer`&"
9185 .cindex "&`+ignore_defer`&"
9186 A temporary DNS lookup failure normally causes a defer action (except when
9187 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9188 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9189 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9190 section. These options should be used with care, probably only in non-critical
9191 host lists such as whitelists.
9192
9193
9194
9195 .subsection "Host list patterns for single-key lookups by host name" &&&
9196          SECThoslispatnamsk
9197 .cindex "unknown host name"
9198 .cindex "host list" "matching host name"
9199 If a pattern is of the form
9200 .display
9201 <&'single-key-search-type'&>;<&'search-data'&>
9202 .endd
9203 for example
9204 .code
9205 dbm;/host/accept/list
9206 .endd
9207 a single-key lookup is performed, using the host name as its key. If the
9208 lookup succeeds, the host matches the item. The actual data that is looked up
9209 is not used.
9210
9211 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9212 keys in the file, not IP addresses. If you want to do lookups based on IP
9213 addresses, you must precede the search type with &"net-"& (see section
9214 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9215 two items in the same list, one doing an address lookup and one doing a name
9216 lookup, both using the same file.
9217
9218
9219
9220 .subsection "Host list patterns for query-style lookups" SECID81
9221 If a pattern is of the form
9222 .display
9223 <&'query-style-search-type'&>;<&'query'&>
9224 .endd
9225 the query is obeyed, and if it succeeds, the host matches the item. The actual
9226 data that is looked up is not used. The variables &$sender_host_address$& and
9227 &$sender_host_name$& can be used in the query. For example:
9228 .code
9229 hosts_lookup = pgsql;\
9230   select ip from hostlist where ip='$sender_host_address'
9231 .endd
9232 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9233 can use the &%sg%& expansion item to change this if you need to. If you want to
9234 use masked IP addresses in database queries, you can use the &%mask%& expansion
9235 operator.
9236
9237 If the query contains a reference to &$sender_host_name$&, Exim automatically
9238 looks up the host name if it has not already done so. (See section
9239 &<<SECThoslispatnam>>& for comments on finding host names.)
9240
9241 Historical note: prior to release 4.30, Exim would always attempt to find a
9242 host name before running the query, unless the search type was preceded by
9243 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9244 still recognized for query-style lookups, but its presence or absence has no
9245 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9246 See section &<<SECThoslispatsikey>>&.)
9247
9248
9249
9250
9251
9252 .section "Address lists" "SECTaddresslist"
9253 .cindex "list" "address list"
9254 .cindex "address list" "empty item"
9255 .cindex "address list" "patterns"
9256 Address lists contain patterns that are matched against mail addresses. There
9257 is one special case to be considered: the sender address of a bounce message is
9258 always empty. You can test for this by providing an empty item in an address
9259 list. For example, you can set up a router to process bounce messages by
9260 using this option setting:
9261 .code
9262 senders = :
9263 .endd
9264 The presence of the colon creates an empty item. If you do not provide any
9265 data, the list is empty and matches nothing. The empty sender can also be
9266 detected by a regular expression that matches an empty string,
9267 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9268
9269 Non-empty items in an address list can be straightforward email addresses. For
9270 example:
9271 .code
9272 senders = jbc@askone.example : hs@anacreon.example
9273 .endd
9274 A certain amount of wildcarding is permitted. If a pattern contains an @
9275 character, but is not a regular expression and does not begin with a
9276 semicolon-terminated lookup type (described below), the local part of the
9277 subject address is compared with the local part of the pattern, which may start
9278 with an asterisk. If the local parts match, the domain is checked in exactly
9279 the same way as for a pattern in a domain list. For example, the domain can be
9280 wildcarded, refer to a named list, or be a lookup:
9281 .code
9282 deny senders = *@*.spamming.site:\
9283                *@+hostile_domains:\
9284                bozo@partial-lsearch;/list/of/dodgy/sites:\
9285                *@dbm;/bad/domains.db
9286 .endd
9287 .cindex "local part" "starting with !"
9288 .cindex "address list" "local part starting with !"
9289 If a local part that begins with an exclamation mark is required, it has to be
9290 specified using a regular expression, because otherwise the exclamation mark is
9291 treated as a sign of negation, as is standard in lists.
9292
9293 If a non-empty pattern that is not a regular expression or a lookup does not
9294 contain an @ character, it is matched against the domain part of the subject
9295 address. The only two formats that are recognized this way are a literal
9296 domain, or a domain pattern that starts with *. In both these cases, the effect
9297 is the same as if &`*@`& preceded the pattern. For example:
9298 .code
9299 deny senders = enemy.domain : *.enemy.domain
9300 .endd
9301
9302 The following kinds of more complicated address list pattern can match any
9303 address, including the empty address that is characteristic of bounce message
9304 senders:
9305
9306 .ilist
9307 .cindex "regular expressions" "in address list"
9308 .cindex "address list" "regular expression in"
9309 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9310 done against the complete address, with the pattern as the regular expression.
9311 You must take care that backslash and dollar characters are not misinterpreted
9312 as part of the string expansion. The simplest way to do this is to use &`\N`&
9313 to mark that part of the string as non-expandable. For example:
9314 .code
9315 deny senders = \N^.*this.*@example\.com$\N : \
9316                \N^\d{8}.+@spamhaus.example$\N : ...
9317 .endd
9318 The &`\N`& sequences are removed by the expansion, so these items do indeed
9319 start with &"^"& by the time they are being interpreted as address patterns.
9320
9321 .next
9322 .cindex "address list" "lookup for complete address"
9323 Complete addresses can be looked up by using a pattern that starts with a
9324 lookup type terminated by a semicolon, followed by the data for the lookup. For
9325 example:
9326 .code
9327 deny senders = cdb;/etc/blocked.senders : \
9328   mysql;select address from blocked where \
9329   address='${quote_mysql:$sender_address}'
9330 .endd
9331 Both query-style and single-key lookup types can be used. For a single-key
9332 lookup type, Exim uses the complete address as the key. However, empty keys are
9333 not supported for single-key lookups, so a match against the empty address
9334 always fails. This restriction does not apply to query-style lookups.
9335
9336 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9337 cannot be used, and is ignored if specified, with an entry being written to the
9338 panic log.
9339 .cindex "*@ with single-key lookup"
9340 However, you can configure lookup defaults, as described in section
9341 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9342 default. For example, with this lookup:
9343 .code
9344 accept senders = lsearch*@;/some/file
9345 .endd
9346 the file could contains lines like this:
9347 .code
9348 user1@domain1.example
9349 *@domain2.example
9350 .endd
9351 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9352 that are tried is:
9353 .code
9354 nimrod@jaeger.example
9355 *@jaeger.example
9356 *
9357 .endd
9358 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9359 would mean that every address matches, thus rendering the test useless.
9360
9361 &*Warning 2*&: Do not confuse these two kinds of item:
9362 .code
9363 deny recipients = dbm*@;/some/file
9364 deny recipients = *@dbm;/some/file
9365 .endd
9366 The first does a whole address lookup, with defaulting, as just described,
9367 because it starts with a lookup type. The second matches the local part and
9368 domain independently, as described in a bullet point below.
9369 .endlist
9370
9371
9372 The following kinds of address list pattern can match only non-empty addresses.
9373 If the subject address is empty, a match against any of these pattern types
9374 always fails.
9375
9376
9377 .ilist
9378 .cindex "@@ with single-key lookup"
9379 .cindex "address list" "@@ lookup type"
9380 .cindex "address list" "split local part and domain"
9381 If a pattern starts with &"@@"& followed by a single-key lookup item
9382 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9383 split into a local part and a domain. The domain is looked up in the file. If
9384 it is not found, there is no match. If it is found, the data that is looked up
9385 from the file is treated as a colon-separated list of local part patterns, each
9386 of which is matched against the subject local part in turn.
9387
9388 .cindex "asterisk" "in address list"
9389 The lookup may be a partial one, and/or one involving a search for a default
9390 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9391 patterns that are looked up can be regular expressions or begin with &"*"&, or
9392 even be further lookups. They may also be independently negated. For example,
9393 with
9394 .code
9395 deny senders = @@dbm;/etc/reject-by-domain
9396 .endd
9397 the data from which the DBM file is built could contain lines like
9398 .code
9399 baddomain.com:  !postmaster : *
9400 .endd
9401 to reject all senders except &%postmaster%& from that domain.
9402
9403 .cindex "local part" "starting with !"
9404 If a local part that actually begins with an exclamation mark is required, it
9405 has to be specified using a regular expression. In &(lsearch)& files, an entry
9406 may be split over several lines by indenting the second and subsequent lines,
9407 but the separating colon must still be included at line breaks. White space
9408 surrounding the colons is ignored. For example:
9409 .code
9410 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9411   spammer3 : spammer4
9412 .endd
9413 As in all colon-separated lists in Exim, a colon can be included in an item by
9414 doubling.
9415
9416 If the last item in the list starts with a right angle-bracket, the remainder
9417 of the item is taken as a new key to look up in order to obtain a continuation
9418 list of local parts. The new key can be any sequence of characters. Thus one
9419 might have entries like
9420 .code
9421 aol.com: spammer1 : spammer 2 : >*
9422 xyz.com: spammer3 : >*
9423 *:       ^\d{8}$
9424 .endd
9425 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9426 local parts for all domains, in addition to the specific local parts listed for
9427 each domain. Of course, using this feature costs another lookup each time a
9428 chain is followed, but the effort needed to maintain the data is reduced.
9429
9430 .cindex "loop" "in lookups"
9431 It is possible to construct loops using this facility, and in order to catch
9432 them, the chains may be no more than fifty items long.
9433
9434 .next
9435 The @@<&'lookup'&> style of item can also be used with a query-style
9436 lookup, but in this case, the chaining facility is not available. The lookup
9437 can only return a single list of local parts.
9438 .endlist
9439
9440 &*Warning*&: There is an important difference between the address list items
9441 in these two examples:
9442 .code
9443 senders = +my_list
9444 senders = *@+my_list
9445 .endd
9446 In the first one, &`my_list`& is a named address list, whereas in the second
9447 example it is a named domain list.
9448
9449
9450
9451
9452 .subsection "Case of letters in address lists" SECTcasletadd
9453 .cindex "case of local parts"
9454 .cindex "address list" "case forcing"
9455 .cindex "case forcing in address lists"
9456 Domains in email addresses are always handled caselessly, but for local parts
9457 case may be significant on some systems (see &%caseful_local_part%& for how
9458 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9459 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9460 blocking lists should be done in a case-independent manner. Since most address
9461 lists in Exim are used for this kind of control, Exim attempts to do this by
9462 default.
9463
9464 The domain portion of an address is always lowercased before matching it to an
9465 address list. The local part is lowercased by default, and any string
9466 comparisons that take place are done caselessly. This means that the data in
9467 the address list itself, in files included as plain filenames, and in any file
9468 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9469 keys in files that are looked up by a search type other than &(lsearch)& (which
9470 works caselessly) must be in lower case, because these lookups are not
9471 case-independent.
9472
9473 .cindex "&`+caseful`&"
9474 To allow for the possibility of caseful address list matching, if an item in
9475 an address list is the string &"+caseful"&, the original case of the local
9476 part is restored for any comparisons that follow, and string comparisons are no
9477 longer case-independent. This does not affect the domain, which remains in
9478 lower case. However, although independent matches on the domain alone are still
9479 performed caselessly, regular expressions that match against an entire address
9480 become case-sensitive after &"+caseful"& has been seen.
9481
9482
9483
9484 .section "Local part lists" "SECTlocparlis"
9485 .cindex "list" "local part list"
9486 .cindex "local part" "list"
9487 These behave in the same way as domain and host lists, with the following
9488 changes:
9489
9490 Case-sensitivity in local part lists is handled in the same way as for address
9491 lists, as just described. The &"+caseful"& item can be used if required. In a
9492 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9493 set false, the subject is lowercased and the matching is initially
9494 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9495 matching in the local part list, but not elsewhere in the router. If
9496 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9497 option is case-sensitive from the start.
9498
9499 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9500 comments are handled in the same way as address lists &-- they are recognized
9501 only if the # is preceded by white space or the start of the line.
9502 Otherwise, local part lists are matched in the same way as domain lists, except
9503 that the special items that refer to the local host (&`@`&, &`@[]`&,
9504 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9505 Refer to section &<<SECTdomainlist>>& for details of the other available item
9506 types.
9507 .ecindex IIDdohoadli
9508
9509
9510
9511
9512 . ////////////////////////////////////////////////////////////////////////////
9513 . ////////////////////////////////////////////////////////////////////////////
9514
9515 .chapter "String expansions" "CHAPexpand"
9516 .scindex IIDstrexp "expansion" "of strings"
9517 Many strings in Exim's runtime configuration are expanded before use. Some of
9518 them are expanded every time they are used; others are expanded only once.
9519
9520 When a string is being expanded it is copied verbatim from left to right except
9521 .cindex expansion "string concatenation"
9522 when a dollar or backslash character is encountered. A dollar specifies the
9523 start of a portion of the string that is interpreted and replaced as described
9524 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9525 escape character, as described in the following section.
9526
9527 Whether a string is expanded depends upon the context.  Usually this is solely
9528 dependent upon the option for which a value is sought; in this documentation,
9529 options for which string expansion is performed are marked with &dagger; after
9530 the data type.  ACL rules always expand strings.  A couple of expansion
9531 conditions do not expand some of the brace-delimited branches, for security
9532 reasons,
9533 .cindex "tainted data" expansion
9534 .cindex "tainted data" definition
9535 .cindex expansion "tainted data"
9536 and expansion of data deriving from the sender (&"tainted data"&)
9537 is not permitted (including acessing a file using a tainted name).
9538
9539 Common ways of obtaining untainted equivalents of variables with
9540 tainted values
9541 .cindex "tainted data" "de-tainting"
9542 come down to using the tainted value as a lookup key in a trusted database.
9543 This database could be the filesystem structure,
9544 or the password file,
9545 or accessed via a DBMS.
9546 Specific methods are indexed under &"de-tainting"&.
9547
9548
9549
9550 .section "Literal text in expanded strings" "SECTlittext"
9551 .cindex "expansion" "including literal text"
9552 An uninterpreted dollar can be included in an expanded string by putting a
9553 backslash in front of it. A backslash can be used to prevent any special
9554 character being treated specially in an expansion, including backslash itself.
9555 If the string appears in quotes in the configuration file, two backslashes are
9556 required because the quotes themselves cause interpretation of backslashes when
9557 the string is read in (see section &<<SECTstrings>>&).
9558
9559 .cindex "expansion" "non-expandable substrings"
9560 A portion of the string can specified as non-expandable by placing it between
9561 two occurrences of &`\N`&. This is particularly useful for protecting regular
9562 expressions, which often contain backslashes and dollar signs. For example:
9563 .code
9564 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9565 .endd
9566 On encountering the first &`\N`&, the expander copies subsequent characters
9567 without interpretation until it reaches the next &`\N`& or the end of the
9568 string.
9569
9570
9571
9572 .section "Character escape sequences in expanded strings" "SECID82"
9573 .cindex "expansion" "escape sequences"
9574 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9575 expanded string is recognized as an escape sequence for the character newline,
9576 carriage return, or tab, respectively. A backslash followed by up to three
9577 octal digits is recognized as an octal encoding for a single character, and a
9578 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9579 encoding.
9580
9581 These escape sequences are also recognized in quoted strings when they are read
9582 in. Their interpretation in expansions as well is useful for unquoted strings,
9583 and for other cases such as looked-up strings that are then expanded.
9584
9585
9586 .section "Testing string expansions" "SECID83"
9587 .cindex "expansion" "testing"
9588 .cindex "testing" "string expansion"
9589 .oindex "&%-be%&"
9590 Many expansions can be tested by calling Exim with the &%-be%& option. This
9591 takes the command arguments, or lines from the standard input if there are no
9592 arguments, runs them through the string expansion code, and writes the results
9593 to the standard output. Variables based on configuration values are set up, but
9594 since no message is being processed, variables such as &$local_part$& have no
9595 value. Nevertheless the &%-be%& option can be useful for checking out file and
9596 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9597 and &%nhash%&.
9598
9599 .new
9600 When reading lines from the standard input,
9601 macros can be defined and ACL variables can be set.
9602 For example:
9603 .code
9604 MY_MACRO = foo
9605 set acl_m_myvar = bar
9606 .endd
9607 Such macros and variables can then be used in later input lines.
9608 .wen
9609
9610 Exim gives up its root privilege when it is called with the &%-be%& option, and
9611 instead runs under the uid and gid it was called with, to prevent users from
9612 using &%-be%& for reading files to which they do not have access.
9613
9614 .oindex "&%-bem%&"
9615 If you want to test expansions that include variables whose values are taken
9616 from a message, there are two other options that can be used. The &%-bem%&
9617 option is like &%-be%& except that it is followed by a filename. The file is
9618 read as a message before doing the test expansions. For example:
9619 .code
9620 exim -bem /tmp/test.message '$h_subject:'
9621 .endd
9622 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9623 Exim message identifier. For example:
9624 .code
9625 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9626 .endd
9627 This loads the message from Exim's spool before doing the test expansions, and
9628 is therefore restricted to admin users.
9629
9630
9631 .section "Forced expansion failure" "SECTforexpfai"
9632 .cindex "expansion" "forced failure"
9633 A number of expansions that are described in the following section have
9634 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9635 (which are sometimes called &"curly brackets"&). Which of the two strings is
9636 used depends on some condition that is evaluated as part of the expansion. If,
9637 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9638 the entire string expansion fails in a way that can be detected by the code
9639 that requested the expansion. This is called &"forced expansion failure"&, and
9640 its consequences depend on the circumstances. In some cases it is no different
9641 from any other expansion failure, but in others a different action may be
9642 taken. Such variations are mentioned in the documentation of the option that is
9643 being expanded.
9644
9645
9646
9647
9648 .section "Expansion items" "SECTexpansionitems"
9649 The following items are recognized in expanded strings. White space may be used
9650 between sub-items that are keywords or substrings enclosed in braces inside an
9651 outer set of braces, to improve readability. &*Warning*&: Within braces,
9652 white space is significant.
9653
9654 .vlist
9655 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9656 .cindex "expansion" "variables"
9657 Substitute the contents of the named variable, for example:
9658 .code
9659 $local_part
9660 ${domain}
9661 .endd
9662 The second form can be used to separate the name from subsequent alphanumeric
9663 characters. This form (using braces) is available only for variables; it does
9664 &'not'& apply to message headers. The names of the variables are given in
9665 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9666 given, the expansion fails.
9667
9668 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9669 .cindex "expansion" "operators"
9670 The string is first itself expanded, and then the operation specified by
9671 <&'op'&> is applied to it. For example:
9672 .code
9673 ${lc:$local_part}
9674 .endd
9675 The string starts with the first character after the colon, which may be
9676 leading white space. A list of operators is given in section &<<SECTexpop>>&
9677 below. The operator notation is used for simple expansion items that have just
9678 one argument, because it reduces the number of braces and therefore makes the
9679 string easier to understand.
9680
9681 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9682 This item inserts &"basic"& header lines. It is described with the &%header%&
9683 expansion item below.
9684
9685
9686 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9687 .cindex "expansion" "calling an acl"
9688 .cindex "&%acl%&" "call from expansion"
9689 The name and zero to nine argument strings are first expanded separately.  The expanded
9690 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9691 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9692 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9693 and may use the variables; if another acl expansion is used the values
9694 are restored after it returns.  If the ACL sets
9695 a value using a "message =" modifier and returns accept or deny, the value becomes
9696 the result of the expansion.
9697 If no message is set and the ACL returns accept or deny
9698 the expansion result is an empty string.
9699 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9700
9701
9702 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9703 .cindex authentication "results header"
9704 .chindex Authentication-Results:
9705 .cindex authentication "expansion item"
9706 This item returns a string suitable for insertion as an
9707 &'Authentication-Results:'&
9708 header line.
9709 The given <&'authserv-id'&> is included in the result; typically this
9710 will be a domain name identifying the system performing the authentications.
9711 Methods that might be present in the result include:
9712 .code
9713 none
9714 iprev
9715 auth
9716 spf
9717 dkim
9718 .endd
9719
9720 Example use (as an ACL modifier):
9721 .code
9722       add_header = :at_start:${authresults {$primary_hostname}}
9723 .endd
9724 This is safe even if no authentication results are available
9725 .new
9726 and would generally be placed in the DATA ACL.
9727 .wen
9728
9729
9730 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9731        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9732 .cindex "expansion" "extracting certificate fields"
9733 .cindex "&%certextract%&" "certificate fields"
9734 .cindex "certificate" "extracting fields"
9735 The <&'certificate'&> must be a variable of type certificate.
9736 The field name is expanded and used to retrieve the relevant field from
9737 the certificate.  Supported fields are:
9738 .display
9739 &`version        `&
9740 &`serial_number  `&
9741 &`subject        `& RFC4514 DN
9742 &`issuer         `& RFC4514 DN
9743 &`notbefore      `& time
9744 &`notafter       `& time
9745 &`sig_algorithm  `&
9746 &`signature      `&
9747 &`subj_altname   `& tagged list
9748 &`ocsp_uri       `& list
9749 &`crl_uri        `& list
9750 .endd
9751 If the field is found,
9752 <&'string2'&> is expanded, and replaces the whole item;
9753 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9754 variable &$value$& contains the value that has been extracted. Afterwards, it
9755 is restored to any previous value it might have had.
9756
9757 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9758 key is not found. If {<&'string2'&>} is also omitted, the value that was
9759 extracted is used.
9760
9761 Some field names take optional modifiers, appended and separated by commas.
9762
9763 The field selectors marked as "RFC4514" above
9764 output a Distinguished Name string which is
9765 not quite
9766 parseable by Exim as a comma-separated tagged list
9767 (the exceptions being elements containing commas).
9768 RDN elements of a single type may be selected by
9769 a modifier of the type label; if so the expansion
9770 result is a list (newline-separated by default).
9771 The separator may be changed by another modifier of
9772 a right angle-bracket followed immediately by the new separator.
9773 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9774
9775 The field selectors marked as "time" above
9776 take an optional modifier of "int"
9777 for which the result is the number of seconds since epoch.
9778 Otherwise the result is a human-readable string
9779 in the timezone selected by the main "timezone" option.
9780
9781 The field selectors marked as "list" above return a list,
9782 newline-separated by default,
9783 (embedded separator characters in elements are doubled).
9784 The separator may be changed by a modifier of
9785 a right angle-bracket followed immediately by the new separator.
9786
9787 The field selectors marked as "tagged" above
9788 prefix each list element with a type string and an equals sign.
9789 Elements of only one type may be selected by a modifier
9790 which is one of "dns", "uri" or "mail";
9791 if so the element tags are omitted.
9792
9793 If not otherwise noted field values are presented in human-readable form.
9794
9795 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9796        {*&<&'arg'&>&*}...}*&"
9797 .cindex &%dlfunc%&
9798 This expansion dynamically loads and then calls a locally-written C function.
9799 This functionality is available only if Exim is compiled with
9800 .code
9801 EXPAND_DLFUNC=yes
9802 .endd
9803 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9804 object so that it doesn't reload the same object file in the same Exim process
9805 (but of course Exim does start new processes frequently).
9806
9807 There may be from zero to eight arguments to the function.
9808
9809 When compiling
9810 a local function that is to be called in this way,
9811 first &_DLFUNC_IMPL_& should be defined,
9812 and second &_local_scan.h_& should be included.
9813 The Exim variables and functions that are defined by that API
9814 are also available for dynamically loaded functions. The function itself
9815 must have the following type:
9816 .code
9817 int dlfunction(uschar **yield, int argc, uschar *argv[])
9818 .endd
9819 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9820 function should return one of the following values:
9821
9822 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9823 into the expanded string that is being built.
9824
9825 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9826 from &'yield'&, if it is set.
9827
9828 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9829 taken from &'yield'& if it is set.
9830
9831 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9832
9833 When compiling a function that is to be used in this way with gcc,
9834 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9835 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9836
9837
9838 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9839 .cindex "expansion" "extracting value from environment"
9840 .cindex "environment" "values from"
9841 The key is first expanded separately, and leading and trailing white space
9842 removed.
9843 This is then searched for as a name in the environment.
9844 If a variable is found then its value is placed in &$value$&
9845 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9846
9847 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9848 appear, for example:
9849 .code
9850 ${env{USER}{$value} fail }
9851 .endd
9852 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9853 {<&'string1'&>} must be present for &"fail"& to be recognized.
9854
9855 If {<&'string2'&>} is omitted an empty string is substituted on
9856 search failure.
9857 If {<&'string1'&>} is omitted the search result is substituted on
9858 search success.
9859
9860 The environment is adjusted by the &%keep_environment%& and
9861 &%add_environment%& main section options.
9862
9863
9864 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9865        {*&<&'string3'&>&*}}*&"
9866 .cindex "expansion" "extracting substrings by key"
9867 .cindex "&%extract%&" "substrings by key"
9868 The key and <&'string1'&> are first expanded separately. Leading and trailing
9869 white space is removed from the key (but not from any of the strings). The key
9870 must not be empty and must not consist entirely of digits.
9871 The expanded <&'string1'&> must be of the form:
9872 .display
9873 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9874 .endd
9875 .vindex "&$value$&"
9876 where the equals signs and spaces (but not both) are optional. If any of the
9877 values contain white space, they must be enclosed in double quotes, and any
9878 values that are enclosed in double quotes are subject to escape processing as
9879 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9880 for the value that corresponds to the key. The search is case-insensitive. If
9881 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9882 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9883 variable &$value$& contains the value that has been extracted. Afterwards, it
9884 is restored to any previous value it might have had.
9885
9886 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9887 key is not found. If {<&'string2'&>} is also omitted, the value that was
9888 extracted is used. Thus, for example, these two expansions are identical, and
9889 yield &"2001"&:
9890 .code
9891 ${extract{gid}{uid=1984 gid=2001}}
9892 ${extract{gid}{uid=1984 gid=2001}{$value}}
9893 .endd
9894 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9895 appear, for example:
9896 .code
9897 ${extract{Z}{A=... B=...}{$value} fail }
9898 .endd
9899 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9900 {<&'string2'&>} must be present for &"fail"& to be recognized.
9901
9902 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9903        {*&<&'string3'&>&*}}*&" &&&
9904        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9905        {*&<&'string3'&>&*}}*&"
9906 .cindex "expansion" "extracting from JSON object"
9907 .cindex JSON expansions
9908 The key and <&'string1'&> are first expanded separately. Leading and trailing
9909 white space is removed from the key (but not from any of the strings). The key
9910 must not be empty and must not consist entirely of digits.
9911 The expanded <&'string1'&> must be of the form:
9912 .display
9913 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9914 .endd
9915 .vindex "&$value$&"
9916 The braces, commas and colons, and the quoting of the member name are required;
9917 the spaces are optional.
9918 Matching of the key against the member names is done case-sensitively.
9919 For the &"json"& variant,
9920 if a returned value is a JSON string, it retains its leading and
9921 trailing quotes.
9922 For the &"jsons"& variant, which is intended for use with JSON strings, the
9923 leading and trailing quotes are removed from the returned value.
9924 . XXX should be a UTF-8 compare
9925
9926 The results of matching are handled as above.
9927
9928
9929 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9930         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9931 .cindex "expansion" "extracting substrings by number"
9932 .cindex "&%extract%&" "substrings by number"
9933 The <&'number'&> argument must consist entirely of decimal digits,
9934 apart from leading and trailing white space, which is ignored.
9935 This is what distinguishes this form of &%extract%& from the previous kind. It
9936 behaves in the same way, except that, instead of extracting a named field, it
9937 extracts from <&'string1'&> the field whose number is given as the first
9938 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9939 <&'string3'&> as before.
9940
9941 The fields in the string are separated by any one of the characters in the
9942 separator string. These may include space or tab characters.
9943 The first field is numbered one. If the number is negative, the fields are
9944 counted from the end of the string, with the rightmost one numbered -1. If the
9945 number given is zero, the entire string is returned. If the modulus of the
9946 number is greater than the number of fields in the string, the result is the
9947 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9948 provided. For example:
9949 .code
9950 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9951 .endd
9952 yields &"42"&, and
9953 .code
9954 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9955 .endd
9956 yields &"99"&. Two successive separators mean that the field between them is
9957 empty (for example, the fifth field above).
9958
9959
9960 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9961         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9962        "&*${extract jsons{*&<&'number'&>&*}}&&&
9963         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9964 .cindex "expansion" "extracting from JSON array"
9965 .cindex JSON expansions
9966 The <&'number'&> argument must consist entirely of decimal digits,
9967 apart from leading and trailing white space, which is ignored.
9968
9969 Field selection and result handling is as above;
9970 there is no choice of field separator.
9971 For the &"json"& variant,
9972 if a returned value is a JSON string, it retains its leading and
9973 trailing quotes.
9974 For the &"jsons"& variant, which is intended for use with JSON strings, the
9975 leading and trailing quotes are removed from the returned value.
9976
9977
9978 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9979 .cindex "list" "selecting by condition"
9980 .cindex "expansion" "selecting from list by condition"
9981 .vindex "&$item$&"
9982 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9983 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9984 For each item
9985 in this list, its value is placed in &$item$&, and then the condition is
9986 evaluated.
9987 .new
9988 Any modification of &$value$& by this evaluation is discarded.
9989 .wen
9990 If the condition is true, &$item$& is added to the output as an
9991 item in a new list; if the condition is false, the item is discarded. The
9992 separator used for the output list is the same as the one used for the
9993 input, but a separator setting is not included in the output. For example:
9994 .code
9995 ${filter{a:b:c}{!eq{$item}{b}}}
9996 .endd
9997 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9998 to what it was before.
9999 See also the &%map%& and &%reduce%& expansion items.
10000
10001
10002 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10003 .cindex "hash function" "textual"
10004 .cindex "expansion" "textual hash"
10005 This is a textual hashing function, and was the first to be implemented in
10006 early versions of Exim. In current releases, there are other hashing functions
10007 (numeric, MD5, and SHA-1), which are described below.
10008
10009 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10010 <&'n'&>. If you are using fixed values for these numbers, that is, if
10011 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10012 use the simpler operator notation that avoids some of the braces:
10013 .code
10014 ${hash_<n>_<m>:<string>}
10015 .endd
10016 The second number is optional (in both notations). If <&'n'&> is greater than
10017 or equal to the length of the string, the expansion item returns the string.
10018 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10019 function to the string. The new string consists of characters taken from the
10020 first <&'m'&> characters of the string
10021 .code
10022 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10023 .endd
10024 If <&'m'&> is not present the value 26 is used, so that only lower case
10025 letters appear. For example:
10026 .display
10027 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10028 &`$hash{5}{monty}}           `&   yields  &`monty`&
10029 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10030 .endd
10031
10032 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10033         &*$h_*&<&'header&~name'&>&*:*&" &&&
10034        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10035         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10036        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10037         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10038        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10039         &*$rh_*&<&'header&~name'&>&*:*&"
10040 .cindex "expansion" "header insertion"
10041 .vindex "&$header_$&"
10042 .vindex "&$bheader_$&"
10043 .vindex "&$lheader_$&"
10044 .vindex "&$rheader_$&"
10045 .cindex "header lines" "in expansion strings"
10046 .cindex "header lines" "character sets"
10047 .cindex "header lines" "decoding"
10048 Substitute the contents of the named message header line, for example
10049 .code
10050 $header_reply-to:
10051 .endd
10052 The newline that terminates a header line is not included in the expansion, but
10053 internal newlines (caused by splitting the header line over several physical
10054 lines) may be present.
10055
10056 The difference between the four pairs of expansions is in the way
10057 the data in the header line is interpreted.
10058
10059 .ilist
10060 .cindex "white space" "in header lines"
10061 &%rheader%& gives the original &"raw"& content of the header line, with no
10062 processing at all, and without the removal of leading and trailing white space.
10063
10064 .next
10065 .cindex "list" "of header lines"
10066 &%lheader%& gives a colon-separated list, one element per header when there
10067 are multiple headers with a given name.
10068 Any embedded colon characters within an element are doubled, so normal Exim
10069 list-processing facilities can be used.
10070 The terminating newline of each element is removed; in other respects
10071 the content is &"raw"&.
10072
10073 .next
10074 .cindex "base64 encoding" "in header lines"
10075 &%bheader%& removes leading and trailing white space, and then decodes base64
10076 or quoted-printable MIME &"words"& within the header text, but does no
10077 character set translation. If decoding of what looks superficially like a MIME
10078 &"word"& fails, the raw string is returned. If decoding
10079 .cindex "binary zero" "in header line"
10080 produces a binary zero character, it is replaced by a question mark &-- this is
10081 what Exim does for binary zeros that are actually received in header lines.
10082
10083 .next
10084 &%header%& tries to translate the string as decoded by &%bheader%& to a
10085 standard character set. This is an attempt to produce the same string as would
10086 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10087 returned. Translation is attempted only on operating systems that support the
10088 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10089 a system Makefile or in &_Local/Makefile_&.
10090 .endlist ilist
10091
10092 In a filter file, the target character set for &%header%& can be specified by a
10093 command of the following form:
10094 .code
10095 headers charset "UTF-8"
10096 .endd
10097 This command affects all references to &$h_$& (or &$header_$&) expansions in
10098 subsequently obeyed filter commands. In the absence of this command, the target
10099 character set in a filter is taken from the setting of the &%headers_charset%&
10100 option in the runtime configuration. The value of this option defaults to the
10101 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10102 ISO-8859-1.
10103
10104 Header names follow the syntax of RFC 2822, which states that they may contain
10105 any printing characters except space and colon. Consequently, curly brackets
10106 &'do not'& terminate header names, and should not be used to enclose them as
10107 if they were variables. Attempting to do so causes a syntax error.
10108
10109 Only header lines that are common to all copies of a message are visible to
10110 this mechanism. These are the original header lines that are received with the
10111 message, and any that are added by an ACL statement or by a system
10112 filter. Header lines that are added to a particular copy of a message by a
10113 router or transport are not accessible.
10114
10115 For incoming SMTP messages, no header lines are visible in
10116 ACLs that are obeyed before the data phase completes,
10117 because the header structure is not set up until the message is received.
10118 They are visible in DKIM, PRDR and DATA ACLs.
10119 Header lines that are added in a RCPT ACL (for example)
10120 are saved until the message's incoming header lines are available, at which
10121 point they are added.
10122 When any of the above ACLs are
10123 running, however, header lines added by earlier ACLs are visible.
10124
10125 Upper case and lower case letters are synonymous in header names. If the
10126 following character is white space, the terminating colon may be omitted, but
10127 this is not recommended, because you may then forget it when it is needed. When
10128 white space terminates the header name, this white space is included in the
10129 expanded string.  If the message does not contain the given header, the
10130 expansion item is replaced by an empty string. (See the &%def%& condition in
10131 section &<<SECTexpcond>>& for a means of testing for the existence of a
10132 header.)
10133
10134 If there is more than one header with the same name, they are all concatenated
10135 to form the substitution string, up to a maximum length of 64K. Unless
10136 &%rheader%& is being used, leading and trailing white space is removed from
10137 each header before concatenation, and a completely empty header is ignored. A
10138 newline character is then inserted between non-empty headers, but there is no
10139 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10140 those headers that contain lists of addresses, a comma is also inserted at the
10141 junctions between headers. This does not happen for the &%rheader%& expansion.
10142
10143 .cindex "tainted data" "message headers"
10144 When the headers are from an incoming message,
10145 the result of expanding any of these variables is tainted.
10146
10147
10148 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10149 .cindex "expansion" "hmac hashing"
10150 .cindex &%hmac%&
10151 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10152 shared secret and some text into a message authentication code, as specified in
10153 RFC 2104. This differs from &`${md5:secret_text...}`& or
10154 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10155 cryptographic hash, allowing for authentication that is not possible with MD5
10156 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10157 present. For example:
10158 .code
10159 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10160 .endd
10161 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10162 produces:
10163 .code
10164 dd97e3ba5d1a61b5006108f8c8252953
10165 .endd
10166 As an example of how this might be used, you might put in the main part of
10167 an Exim configuration:
10168 .code
10169 SPAMSCAN_SECRET=cohgheeLei2thahw
10170 .endd
10171 In a router or a transport you could then have:
10172 .code
10173 headers_add = \
10174   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10175   ${hmac{md5}{SPAMSCAN_SECRET}\
10176   {${primary_hostname},${message_exim_id},$h_message-id:}}
10177 .endd
10178 Then given a message, you can check where it was scanned by looking at the
10179 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10180 this header line is authentic by recomputing the authentication code from the
10181 host name, message ID and the &'Message-id:'& header line. This can be done
10182 using Exim's &%-be%& option, or by other means, for example, by using the
10183 &'hmac_md5_hex()'& function in Perl.
10184
10185
10186 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10187 .cindex "expansion" "conditional"
10188 .cindex "&%if%&, expansion item"
10189 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10190 item; otherwise <&'string2'&> is used. The available conditions are described
10191 in section &<<SECTexpcond>>& below. For example:
10192 .code
10193 ${if eq {$local_part}{postmaster} {yes}{no} }
10194 .endd
10195 The second string need not be present; if it is not and the condition is not
10196 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10197 be present instead of the second string (without any curly brackets). In this
10198 case, the expansion is forced to fail if the condition is not true (see section
10199 &<<SECTforexpfai>>&).
10200
10201 If both strings are omitted, the result is the string &`true`& if the condition
10202 is true, and the empty string if the condition is false. This makes it less
10203 cumbersome to write custom ACL and router conditions. For example, instead of
10204 .code
10205 condition = ${if >{$acl_m4}{3}{true}{false}}
10206 .endd
10207 you can use
10208 .code
10209 condition = ${if >{$acl_m4}{3}}
10210 .endd
10211
10212
10213
10214 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10215 .cindex expansion "imap folder"
10216 .cindex "&%imapfolder%& expansion item"
10217 This item converts a (possibly multilevel, or with non-ASCII characters)
10218 folder specification to a Maildir name for filesystem use.
10219 For information on internationalisation support see &<<SECTi18nMDA>>&.
10220
10221
10222
10223 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10224 .cindex "expansion" "string truncation"
10225 .cindex "&%length%& expansion item"
10226 The &%length%& item is used to extract the initial portion of a string. Both
10227 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10228 you are using a fixed value for the number, that is, if <&'string1'&> does not
10229 change when expanded, you can use the simpler operator notation that avoids
10230 some of the braces:
10231 .code
10232 ${length_<n>:<string>}
10233 .endd
10234 The result of this item is either the first <&'n'&> bytes or the whole
10235 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10236 &%strlen%&, which gives the length of a string.
10237 All measurement is done in bytes and is not UTF-8 aware.
10238
10239
10240 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10241         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10242 .cindex "expansion" "extracting list elements by number"
10243 .cindex "&%listextract%&" "extract list elements by number"
10244 .cindex "list" "extracting elements by number"
10245 The <&'number'&> argument must consist entirely of decimal digits,
10246 apart from an optional leading minus,
10247 and leading and trailing white space (which is ignored).
10248
10249 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10250 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10251
10252 The first field of the list is numbered one.
10253 If the number is negative, the fields are
10254 counted from the end of the list, with the rightmost one numbered -1.
10255 The numbered element of the list is extracted and placed in &$value$&,
10256 then <&'string2'&> is expanded as the result.
10257
10258 If the modulus of the
10259 number is zero or greater than the number of fields in the string,
10260 the result is the expansion of <&'string3'&>.
10261
10262 For example:
10263 .code
10264 ${listextract{2}{x:42:99}}
10265 .endd
10266 yields &"42"&, and
10267 .code
10268 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10269 .endd
10270 yields &"result: 42"&.
10271
10272 If {<&'string3'&>} is omitted, an empty string is used for string3.
10273 If {<&'string2'&>} is also omitted, the value that was
10274 extracted is used.
10275 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10276
10277
10278 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10279 .cindex quoting "for list"
10280 .cindex list quoting
10281 This item doubles any occurrence of the separator character
10282 in the given string.
10283 An empty string is replaced with a single space.
10284 This converts the string into a safe form for use as a list element,
10285 in a list using the given separator.
10286
10287
10288 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10289         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10290        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10291         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10292 .cindex "expansion" "lookup in"
10293 .cindex "file" "lookups"
10294 .cindex "lookup" "in expanded string"
10295 The two forms of lookup item specify data lookups in files and databases, as
10296 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10297 lookups, and the second is used for query-style lookups. The <&'key'&>,
10298 <&'file'&>, and <&'query'&> strings are expanded before use.
10299
10300 If there is any white space in a lookup item which is part of a filter command,
10301 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10302 other place where white space is significant, the lookup item must be enclosed
10303 in double quotes. The use of data lookups in users' filter files may be locked
10304 out by the system administrator.
10305
10306 .vindex "&$value$&"
10307 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10308 During its expansion, the variable &$value$& contains the data returned by the
10309 lookup. Afterwards it reverts to the value it had previously (at the outer
10310 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10311 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10312 string on failure. If <&'string2'&> is provided, it can itself be a nested
10313 lookup, thus providing a mechanism for looking up a default value when the
10314 original lookup fails.
10315
10316 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10317 data for the outer lookup while the parameters of the second lookup are
10318 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10319 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10320 appear, and in this case, if the lookup fails, the entire expansion is forced
10321 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10322 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10323 successful lookup, and nothing in the case of failure.
10324
10325 For single-key lookups, the string &"partial"& is permitted to precede the
10326 search type in order to do partial matching, and * or *@ may follow a search
10327 type to request default lookups if the key does not match (see sections
10328 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10329
10330 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10331 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10332 and non-wild parts of the key during the expansion of the replacement text.
10333 They return to their previous values at the end of the lookup item.
10334
10335 This example looks up the postmaster alias in the conventional alias file:
10336 .code
10337 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10338 .endd
10339 This example uses NIS+ to look up the full name of the user corresponding to
10340 the local part of an address, forcing the expansion to fail if it is not found:
10341 .code
10342 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10343   {$value}fail}
10344 .endd
10345
10346
10347 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10348 .cindex "expansion" "list creation"
10349 .vindex "&$item$&"
10350 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10351 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10352 For each item
10353 in this list, its value is place in &$item$&, and then <&'string2'&> is
10354 expanded and added to the output as an item in a new list. The separator used
10355 for the output list is the same as the one used for the input, but a separator
10356 setting is not included in the output. For example:
10357 .code
10358 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10359 .endd
10360 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10361 value of &$item$& is restored to what it was before. See also the &%filter%&
10362 and &%reduce%& expansion items.
10363
10364 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10365 .cindex "expansion" "numeric hash"
10366 .cindex "hash function" "numeric"
10367 The three strings are expanded; the first two must yield numbers. Call them
10368 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10369 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10370 can use the simpler operator notation that avoids some of the braces:
10371 .code
10372 ${nhash_<n>_<m>:<string>}
10373 .endd
10374 The second number is optional (in both notations). If there is only one number,
10375 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10376 processed by a div/mod hash function that returns two numbers, separated by a
10377 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10378 example,
10379 .code
10380 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10381 .endd
10382 returns the string &"6/33"&.
10383
10384
10385
10386 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10387 .cindex "Perl" "use in expanded string"
10388 .cindex "expansion" "calling Perl from"
10389 This item is available only if Exim has been built to include an embedded Perl
10390 interpreter. The subroutine name and the arguments are first separately
10391 expanded, and then the Perl subroutine is called with those arguments. No
10392 additional arguments need be given; the maximum number permitted, including the
10393 name of the subroutine, is nine.
10394
10395 The return value of the subroutine is inserted into the expanded string, unless
10396 the return value is &%undef%&. In that case, the entire expansion is
10397 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10398 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10399 in a scalar context, thus the return value is a scalar.  For example, if you
10400 return a Perl vector, the return value is the size of the vector,
10401 not its contents.
10402
10403 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10404 with the error message that was passed to &%die%&. More details of the embedded
10405 Perl facility are given in chapter &<<CHAPperl>>&.
10406
10407 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10408 out the use of this expansion item in filter files.
10409
10410
10411 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10412 .cindex "&%prvs%& expansion item"
10413 The first argument is a complete email address and the second is secret
10414 keystring. The third argument, specifying a key number, is optional. If absent,
10415 it defaults to 0. The result of the expansion is a prvs-signed email address,
10416 to be typically used with the &%return_path%& option on an &(smtp)& transport
10417 as part of a bounce address tag validation (BATV) scheme. For more discussion
10418 and an example, see section &<<SECTverifyPRVS>>&.
10419
10420 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10421         {*&<&'string'&>&*}}*&"
10422 .cindex "&%prvscheck%& expansion item"
10423 This expansion item is the complement of the &%prvs%& item. It is used for
10424 checking prvs-signed addresses. If the expansion of the first argument does not
10425 yield a syntactically valid prvs-signed address, the whole item expands to the
10426 empty string. When the first argument does expand to a syntactically valid
10427 prvs-signed address, the second argument is expanded, with the prvs-decoded
10428 version of the address and the key number extracted from the address in the
10429 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10430
10431 These two variables can be used in the expansion of the second argument to
10432 retrieve the secret. The validity of the prvs-signed address is then checked
10433 against the secret. The result is stored in the variable &$prvscheck_result$&,
10434 which is empty for failure or &"1"& for success.
10435
10436 The third argument is optional; if it is missing, it defaults to an empty
10437 string. This argument is now expanded. If the result is an empty string, the
10438 result of the expansion is the decoded version of the address. This is the case
10439 whether or not the signature was valid. Otherwise, the result of the expansion
10440 is the expansion of the third argument.
10441
10442 All three variables can be used in the expansion of the third argument.
10443 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10444 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10445
10446 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10447 .cindex "expansion" "inserting an entire file"
10448 .cindex "file" "inserting into expansion"
10449 .cindex "&%readfile%& expansion item"
10450 The filename and end-of-line (eol) string are first expanded separately. The file is
10451 then read, and its contents replace the entire item. All newline characters in
10452 the file are replaced by the end-of-line string if it is present. Otherwise,
10453 newlines are left in the string.
10454 String expansion is not applied to the contents of the file. If you want this,
10455 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10456 the string expansion fails.
10457
10458 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10459 locks out the use of this expansion item in filter files.
10460
10461
10462
10463 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10464         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10465 .cindex "expansion" "inserting from a socket"
10466 .cindex "socket, use of in expansion"
10467 .cindex "&%readsocket%& expansion item"
10468 This item inserts data from a Unix domain or TCP socket into the expanded
10469 string. The minimal way of using it uses just two arguments, as in these
10470 examples:
10471 .code
10472 ${readsocket{/socket/name}{request string}}
10473 ${readsocket{inet:some.host:1234}{request string}}
10474 .endd
10475 For a Unix domain socket, the first substring must be the path to the socket.
10476 For an Internet socket, the first substring must contain &`inet:`& followed by
10477 a host name or IP address, followed by a colon and a port, which can be a
10478 number or the name of a TCP port in &_/etc/services_&. An IP address may
10479 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10480 example:
10481 .code
10482 ${readsocket{inet:[::1]:1234}{request string}}
10483 .endd
10484 Only a single host name may be given, but if looking it up yields more than
10485 one IP address, they are each tried in turn until a connection is made. For
10486 both kinds of socket, Exim makes a connection, writes the request string
10487 (unless it is an empty string; no terminating NUL is ever sent)
10488 and reads from the socket until an end-of-file
10489 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10490 extend what can be done. Firstly, you can vary the timeout. For example:
10491 .code
10492 ${readsocket{/socket/name}{request string}{3s}}
10493 .endd
10494
10495 The third argument is a list of options, of which the first element is the timeout
10496 and must be present if any options are given.
10497 Further elements are options of form &'name=value'&.
10498 Example:
10499 .code
10500 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10501 .endd
10502
10503 The following option names are recognised:
10504 .ilist
10505 &*cache*&
10506 Defines if the result data can be cached for use by a later identical
10507 request in the same process.
10508 Values are &"yes"& or &"no"& (the default).
10509 If not, all cached results for this connection specification
10510 will be invalidated.
10511
10512 .next
10513 &*shutdown*&
10514 Defines whether or not a write-shutdown is done on the connection after
10515 sending the request. Values are &"yes"& (the default) or &"no"&
10516 (preferred, eg. by some webservers).
10517
10518 .next
10519 &*sni*&
10520 Controls the use of Server Name Identification on the connection.
10521 Any nonempty value will be the SNI sent; TLS will be forced.
10522
10523 .next
10524 &*tls*&
10525 Controls the use of TLS on the connection.
10526 Values are &"yes"& or &"no"& (the default).
10527 If it is enabled, a shutdown as described above is never done.
10528 .endlist
10529
10530
10531 A fourth argument allows you to change any newlines that are in the data
10532 that is read, in the same way as for &%readfile%& (see above). This example
10533 turns them into spaces:
10534 .code
10535 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10536 .endd
10537 As with all expansions, the substrings are expanded before the processing
10538 happens. Errors in these sub-expansions cause the expansion to fail. In
10539 addition, the following errors can occur:
10540
10541 .ilist
10542 Failure to create a socket file descriptor;
10543 .next
10544 Failure to connect the socket;
10545 .next
10546 Failure to write the request string;
10547 .next
10548 Timeout on reading from the socket.
10549 .endlist
10550
10551 By default, any of these errors causes the expansion to fail. However, if
10552 you supply a fifth substring, it is expanded and used when any of the above
10553 errors occurs. For example:
10554 .code
10555 ${readsocket{/socket/name}{request string}{3s}{\n}\
10556   {socket failure}}
10557 .endd
10558 You can test for the existence of a Unix domain socket by wrapping this
10559 expansion in &`${if exists`&, but there is a race condition between that test
10560 and the actual opening of the socket, so it is safer to use the fifth argument
10561 if you want to be absolutely sure of avoiding an expansion error for a
10562 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10563
10564 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10565 locks out the use of this expansion item in filter files.
10566
10567
10568 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10569 .cindex "expansion" "reducing a list to a scalar"
10570 .cindex "list" "reducing to a scalar"
10571 .vindex "&$value$&"
10572 .vindex "&$item$&"
10573 This operation reduces a list to a single, scalar string. After expansion,
10574 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10575 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10576 Then <&'string2'&> is expanded and
10577 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10578 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10579 them. The result of that expansion is assigned to &$value$& before the next
10580 iteration. When the end of the list is reached, the final value of &$value$& is
10581 added to the expansion output. The &%reduce%& expansion item can be used in a
10582 number of ways. For example, to add up a list of numbers:
10583 .code
10584 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10585 .endd
10586 The result of that expansion would be &`6`&. The maximum of a list of numbers
10587 can be found:
10588 .code
10589 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10590 .endd
10591 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10592 restored to what they were before. See also the &%filter%& and &%map%&
10593 expansion items.
10594
10595 . A bit of a special-case logic error in writing an expansion;
10596 . probably not worth including in the mainline of documentation.
10597 . If only we had footnotes (the html output variant is the problem).
10598 .
10599 . .new
10600 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10601 . and that condition modifies &$value$&,
10602 . then the string expansions dependent on the condition cannot use
10603 . the &$value$& of the reduce iteration.
10604 . .wen
10605
10606 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10607 This item inserts &"raw"& header lines. It is described with the &%header%&
10608 expansion item in section &<<SECTexpansionitems>>& above.
10609
10610 .vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10611         {*&<&'string2'&>&*}}*&"
10612 .cindex "expansion" "running a command"
10613 .cindex "&%run%& expansion item"
10614 This item runs an external command, as a subprocess.
10615 One option is supported after the word &'run'&, comma-separated
10616 and without whitespace.
10617
10618 If the option &'preexpand'& is not used,
10619 the command string is split into individual arguments by spaces
10620 and then each argument is expanded.
10621 Then the command is run
10622 in a separate process, but under the same uid and gid.  As in other command
10623 executions from Exim, a shell is not used by default. If the command requires
10624 a shell, you must explicitly code it.
10625 The command name may not be tainted, but the remaining arguments can be.
10626
10627 &*Note*&: if tainted arguments are used, they are supplied by a
10628 potential attacker;
10629 a careful assessment for security vulnerabilities should be done.
10630
10631 If the option &'preexpand'& is used,
10632 the command and its arguments are first expanded as one string. The result is
10633 split apart into individual arguments by spaces, and then the command is run
10634 as above.
10635 Since the arguments are split by spaces, when there is a variable expansion
10636 which has an empty result, it will cause the situation that the argument will
10637 simply be omitted when the program is actually executed by Exim. If the
10638 script/program requires a specific number of arguments and the expanded
10639 variable could possibly result in this empty expansion, the variable must be
10640 quoted. This is more difficult if the expanded variable itself could result
10641 in a string containing quotes, because it would interfere with the quotes
10642 around the command arguments. A possible guard against this is to wrap the
10643 variable in the &%sg%& operator to change any quote marks to some other
10644 character.
10645 Neither the command nor any argument may be tainted.
10646
10647 The standard input for the command exists, but is empty. The standard output
10648 and standard error are set to the same file descriptor.
10649 .cindex "return code" "from &%run%& expansion"
10650 .vindex "&$value$&"
10651 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10652 and replaces the entire item; during this expansion, the standard output/error
10653 from the command is in the variable &$value$&. If the command fails,
10654 <&'string2'&>, if present, is expanded and used. Once again, during the
10655 expansion, the standard output/error from the command is in the variable
10656 &$value$&.
10657
10658 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10659 can be the word &"fail"& (not in braces) to force expansion failure if the
10660 command does not succeed. If both strings are omitted, the result is contents
10661 of the standard output/error on success, and nothing on failure.
10662
10663 .vindex "&$run_in_acl$&"
10664 The standard output/error of the command is put in the variable &$value$&.
10665 In this ACL example, the output of a command is logged for the admin to
10666 troubleshoot:
10667 .code
10668 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10669       log_message  = Output of id: $value
10670 .endd
10671 If the command requires shell idioms, such as the > redirect operator, the
10672 shell must be invoked directly, such as with:
10673 .code
10674 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10675 .endd
10676
10677 .vindex "&$runrc$&"
10678 The return code from the command is put in the variable &$runrc$&, and this
10679 remains set afterwards, so in a filter file you can do things like this:
10680 .code
10681 if "${run{x y z}{}}$runrc" is 1 then ...
10682   elif $runrc is 2 then ...
10683   ...
10684 endif
10685 .endd
10686 If execution of the command fails (for example, the command does not exist),
10687 the return code is 127 &-- the same code that shells use for non-existent
10688 commands.
10689
10690 &*Warning*&: In a router or transport, you cannot assume the order in which
10691 option values are expanded, except for those preconditions whose order of
10692 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10693 by the expansion of one option, and use it in another.
10694
10695 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10696 out the use of this expansion item in filter files.
10697
10698
10699 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10700 .cindex "expansion" "string substitution"
10701 .cindex "&%sg%& expansion item"
10702 This item works like Perl's substitution operator (s) with the global (/g)
10703 option; hence its name. However, unlike the Perl equivalent, Exim does not
10704 modify the subject string; instead it returns the modified string for insertion
10705 into the overall expansion. The item takes three arguments: the subject string,
10706 a regular expression, and a substitution string. For example:
10707 .code
10708 ${sg{abcdefabcdef}{abc}{xyz}}
10709 .endd
10710 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10711 if any $, } or \ characters are required in the regular expression or in the
10712 substitution string, they have to be escaped. For example:
10713 .code
10714 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10715 .endd
10716 yields &"defabc"&, and
10717 .code
10718 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10719 .endd
10720 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10721 the regular expression from string expansion.
10722
10723 The regular expression is compiled in 8-bit mode, working against bytes
10724 rather than any Unicode-aware character handling.
10725
10726
10727 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10728 .cindex sorting "a list"
10729 .cindex list sorting
10730 .cindex expansion "list sorting"
10731 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10732 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10733 The <&'comparator'&> argument is interpreted as the operator
10734 of a two-argument expansion condition.
10735 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10736 The comparison should return true when applied to two values
10737 if the first value should sort before the second value.
10738 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10739 the element being placed in &$item$&,
10740 to give values for comparison.
10741
10742 The item result is a sorted list,
10743 with the original list separator,
10744 of the list elements (in full) of the original.
10745
10746 Examples:
10747 .code
10748 ${sort{3:2:1:4}{<}{$item}}
10749 .endd
10750 sorts a list of numbers, and
10751 .code
10752 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10753 .endd
10754 will sort an MX lookup into priority order.
10755
10756
10757
10758 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10759 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10760
10761
10762
10763 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10764 .cindex "&%substr%& expansion item"
10765 .cindex "substring extraction"
10766 .cindex "expansion" "substring extraction"
10767 The three strings are expanded; the first two must yield numbers. Call them
10768 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10769 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10770 can use the simpler operator notation that avoids some of the braces:
10771 .code
10772 ${substr_<n>_<m>:<subject>}
10773 .endd
10774 The second number is optional (in both notations).
10775 If it is absent in the simpler format, the preceding underscore must also be
10776 omitted.
10777
10778 The &%substr%& item can be used to extract more general substrings than
10779 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10780 length required. For example
10781 .code
10782 ${substr{3}{2}{$local_part}}
10783 .endd
10784 If the starting offset is greater than the string length the result is the
10785 null string; if the length plus starting offset is greater than the string
10786 length, the result is the right-hand part of the string, starting from the
10787 given offset. The first byte (character) in the string has offset zero.
10788
10789 The &%substr%& expansion item can take negative offset values to count
10790 from the right-hand end of its operand. The last byte (character) is offset -1,
10791 the second-last is offset -2, and so on. Thus, for example,
10792 .code
10793 ${substr{-5}{2}{1234567}}
10794 .endd
10795 yields &"34"&. If the absolute value of a negative offset is greater than the
10796 length of the string, the substring starts at the beginning of the string, and
10797 the length is reduced by the amount of overshoot. Thus, for example,
10798 .code
10799 ${substr{-5}{2}{12}}
10800 .endd
10801 yields an empty string, but
10802 .code
10803 ${substr{-3}{2}{12}}
10804 .endd
10805 yields &"1"&.
10806
10807 When the second number is omitted from &%substr%&, the remainder of the string
10808 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10809 string preceding the offset point are taken. For example, an offset of -1 and
10810 no length, as in these semantically identical examples:
10811 .code
10812 ${substr_-1:abcde}
10813 ${substr{-1}{abcde}}
10814 .endd
10815 yields all but the last character of the string, that is, &"abcd"&.
10816
10817 All measurement is done in bytes and is not UTF-8 aware.
10818
10819
10820
10821 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10822         {*&<&'replacements'&>&*}}*&"
10823 .cindex "expansion" "character translation"
10824 .cindex "&%tr%& expansion item"
10825 This item does single-character (in bytes) translation on its subject string. The second
10826 argument is a list of characters to be translated in the subject string. Each
10827 matching character is replaced by the corresponding character from the
10828 replacement list. For example
10829 .code
10830 ${tr{abcdea}{ac}{13}}
10831 .endd
10832 yields &`1b3de1`&. If there are duplicates in the second character string, the
10833 last occurrence is used. If the third string is shorter than the second, its
10834 last character is replicated. However, if it is empty, no translation takes
10835 place.
10836
10837 All character handling is done in bytes and is not UTF-8 aware.
10838
10839 .endlist
10840
10841
10842
10843 .section "Expansion operators" "SECTexpop"
10844 .cindex "expansion" "operators"
10845 For expansion items that perform transformations on a single argument string,
10846 the &"operator"& notation is used because it is simpler and uses fewer braces.
10847 The substring is first expanded before the operation is applied to it. The
10848 following operations can be performed:
10849
10850 .vlist
10851 .vitem &*${address:*&<&'string'&>&*}*&
10852 .cindex "expansion" "RFC 2822 address handling"
10853 .cindex "&%address%& expansion item"
10854 The string is interpreted as an RFC 2822 address, as it might appear in a
10855 header line, and the effective address is extracted from it. If the string does
10856 not parse successfully, the result is empty.
10857
10858 The parsing correctly handles SMTPUTF8 Unicode in the string.
10859
10860
10861 .vitem &*${addresses:*&<&'string'&>&*}*&
10862 .cindex "expansion" "RFC 2822 address handling"
10863 .cindex "&%addresses%& expansion item"
10864 The string (after expansion) is interpreted as a list of addresses in RFC
10865 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10866 operative address (&'local-part@domain'&) is extracted from each item, and the
10867 result of the expansion is a colon-separated list, with appropriate
10868 doubling of colons should any happen to be present in the email addresses.
10869 Syntactically invalid RFC2822 address items are omitted from the output.
10870
10871 It is possible to specify a character other than colon for the output
10872 separator by starting the string with > followed by the new separator
10873 character. For example:
10874 .code
10875 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10876 .endd
10877 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10878 first, so if the expanded string starts with >, it may change the output
10879 separator unintentionally. This can be avoided by setting the output
10880 separator explicitly:
10881 .code
10882 ${addresses:>:$h_from:}
10883 .endd
10884
10885 Compare the &%address%& (singular)
10886 expansion item, which extracts the working address from a single RFC2822
10887 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10888 processing lists.
10889
10890 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10891 a strict interpretation of header line formatting.  Exim parses the bare,
10892 unquoted portion of an email address and if it finds a comma, treats it as an
10893 email address separator. For the example header line:
10894 .code
10895 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10896 .endd
10897 The first example below demonstrates that Q-encoded email addresses are parsed
10898 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10899 It does not see the comma because it's still encoded as "=2C".  The second
10900 example below is passed the contents of &`$header_from:`&, meaning it gets
10901 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10902 The third example shows that the presence of a comma is skipped when it is
10903 quoted.  The fourth example shows SMTPUTF8 handling.
10904 .code
10905 # exim -be '${addresses:From: \
10906 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10907 user@example.com
10908 # exim -be '${addresses:From: Last, First <user@example.com>}'
10909 Last:user@example.com
10910 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10911 user@example.com
10912 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10913 フィリップ@example.jp
10914 .endd
10915
10916 .vitem &*${base32:*&<&'digits'&>&*}*&
10917 .cindex "&%base32%& expansion item"
10918 .cindex "expansion" "conversion to base 32"
10919 The string must consist entirely of decimal digits. The number is converted to
10920 base 32 and output as a (empty, for zero) string of characters.
10921 Only lowercase letters are used.
10922
10923 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10924 .cindex "&%base32d%& expansion item"
10925 .cindex "expansion" "conversion to base 32"
10926 The string must consist entirely of base-32 digits.
10927 The number is converted to decimal and output as a string.
10928
10929 .vitem &*${base62:*&<&'digits'&>&*}*&
10930 .cindex "&%base62%& expansion item"
10931 .cindex "expansion" "conversion to base 62"
10932 The string must consist entirely of decimal digits. The number is converted to
10933 base 62 and output as a string of six characters, including leading zeros. In
10934 the few operating environments where Exim uses base 36 instead of base 62 for
10935 its message identifiers (because those systems do not have case-sensitive
10936 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10937 to be absolutely clear: this is &'not'& base64 encoding.
10938
10939 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10940 .cindex "&%base62d%& expansion item"
10941 .cindex "expansion" "conversion to base 62"
10942 The string must consist entirely of base-62 digits, or, in operating
10943 environments where Exim uses base 36 instead of base 62 for its message
10944 identifiers, base-36 digits. The number is converted to decimal and output as a
10945 string.
10946
10947 .vitem &*${base64:*&<&'string'&>&*}*&
10948 .cindex "expansion" "base64 encoding"
10949 .cindex "base64 encoding" "in string expansion"
10950 .cindex "&%base64%& expansion item"
10951 .cindex certificate "base64 of DER"
10952 This operator converts a string into one that is base64 encoded.
10953
10954 If the string is a single variable of type certificate,
10955 returns the base64 encoding of the DER form of the certificate.
10956
10957
10958 .vitem &*${base64d:*&<&'string'&>&*}*&
10959 .cindex "expansion" "base64 decoding"
10960 .cindex "base64 decoding" "in string expansion"
10961 .cindex "&%base64d%& expansion item"
10962 This operator converts a base64-encoded string into the un-coded form.
10963
10964
10965 .vitem &*${domain:*&<&'string'&>&*}*&
10966 .cindex "domain" "extraction"
10967 .cindex "expansion" "domain extraction"
10968 The string is interpreted as an RFC 2822 address and the domain is extracted
10969 from it. If the string does not parse successfully, the result is empty.
10970
10971
10972 .vitem &*${escape:*&<&'string'&>&*}*&
10973 .cindex "expansion" "escaping non-printing characters"
10974 .cindex "&%escape%& expansion item"
10975 If the string contains any non-printing characters, they are converted to
10976 escape sequences starting with a backslash. Whether characters with the most
10977 significant bit set (so-called &"8-bit characters"&) count as printing or not
10978 is controlled by the &%print_topbitchars%& option.
10979
10980 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10981 .cindex "expansion" "escaping 8-bit characters"
10982 .cindex "&%escape8bit%& expansion item"
10983 If the string contains any characters with the most significant bit set,
10984 they are converted to escape sequences starting with a backslash.
10985 Backslashes and DEL characters are also converted.
10986
10987
10988 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10989 .cindex "expansion" "expression evaluation"
10990 .cindex "expansion" "arithmetic expression"
10991 .cindex "&%eval%& expansion item"
10992 These items supports simple arithmetic and bitwise logical operations in
10993 expansion strings. The string (after expansion) must be a conventional
10994 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10995 logical operators, and parentheses. All operations are carried out using
10996 integer arithmetic. The operator priorities are as follows (the same as in the
10997 C programming language):
10998 .table2 70pt 300pt
10999 .irow &'highest:'& "not (~), negate (-)"
11000 .irow ""   "multiply (*), divide (/), remainder (%)"
11001 .irow ""   "plus (+), minus (-)"
11002 .irow ""   "shift-left (<<), shift-right (>>)"
11003 .irow ""   "and (&&)"
11004 .irow ""   "xor (^)"
11005 .irow &'lowest:'&  "or (|)"
11006 .endtable
11007 Binary operators with the same priority are evaluated from left to right. White
11008 space is permitted before or after operators.
11009
11010 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11011 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11012 decimal, even if they start with a leading zero; hexadecimal numbers are not
11013 permitted. This can be useful when processing numbers extracted from dates or
11014 times, which often do have leading zeros.
11015
11016 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11017 or 1024*1024*1024,
11018 respectively. Negative numbers are supported. The result of the computation is
11019 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11020
11021 .display
11022 &`${eval:1+1}            `&  yields 2
11023 &`${eval:1+2*3}          `&  yields 7
11024 &`${eval:(1+2)*3}        `&  yields 9
11025 &`${eval:2+42%5}         `&  yields 4
11026 &`${eval:0xc&amp;5}          `&  yields 4
11027 &`${eval:0xc|5}          `&  yields 13
11028 &`${eval:0xc^5}          `&  yields 9
11029 &`${eval:0xc>>1}         `&  yields 6
11030 &`${eval:0xc<<1}         `&  yields 24
11031 &`${eval:~255&amp;0x1234}    `&  yields 4608
11032 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11033 .endd
11034
11035 As a more realistic example, in an ACL you might have
11036 .code
11037 deny   condition =                    \
11038          ${if and {                   \
11039            {>{$rcpt_count}{10}}       \
11040            {                          \
11041            <                          \
11042              {$recipients_count}      \
11043              {${eval:$rcpt_count/2}}  \
11044            }                          \
11045          }{yes}{no}}
11046        message = Too many bad recipients
11047 .endd
11048 The condition is true if there have been more than 10 RCPT commands and
11049 fewer than half of them have resulted in a valid recipient.
11050
11051
11052 .vitem &*${expand:*&<&'string'&>&*}*&
11053 .cindex "expansion" "re-expansion of substring"
11054 The &%expand%& operator causes a string to be expanded for a second time. For
11055 example,
11056 .code
11057 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11058 .endd
11059 first looks up a string in a file while expanding the operand for &%expand%&,
11060 and then re-expands what it has found.
11061
11062
11063 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11064 .cindex "Unicode"
11065 .cindex "UTF-8" "conversion from"
11066 .cindex "expansion" "UTF-8 conversion"
11067 .cindex "&%from_utf8%& expansion item"
11068 The world is slowly moving towards Unicode, although there are no standards for
11069 email yet. However, other applications (including some databases) are starting
11070 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11071 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11072 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11073 the result is an undefined sequence of bytes.
11074
11075 Unicode code points with values less than 256 are compatible with ASCII and
11076 ISO-8859-1 (also known as Latin-1).
11077 For example, character 169 is the copyright symbol in both cases, though the
11078 way it is encoded is different. In UTF-8, more than one byte is needed for
11079 characters with code values greater than 127, whereas ISO-8859-1 is a
11080 single-byte encoding (but thereby limited to 256 characters). This makes
11081 translation from UTF-8 to ISO-8859-1 straightforward.
11082
11083
11084 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11085 .cindex "hash function" "textual"
11086 .cindex "expansion" "textual hash"
11087 The &%hash%& operator is a simpler interface to the hashing function that can
11088 be used when the two parameters are fixed numbers (as opposed to strings that
11089 change when expanded). The effect is the same as
11090 .code
11091 ${hash{<n>}{<m>}{<string>}}
11092 .endd
11093 See the description of the general &%hash%& item above for details. The
11094 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11095
11096
11097
11098 .new
11099 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11100 .cindex header "wrapping operator"
11101 .cindex expansion "header wrapping"
11102 This operator line-wraps its argument in a way useful for headers.
11103 The &'cols'& value gives the column number to wrap after,
11104 the &'limit'& gives a limit number of result characters to truncate at.
11105 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11106 the defaults are 80 and 998.
11107 Wrapping will be inserted at a space if possible before the
11108 column number is reached.
11109 Whitespace at a chosen wrap point is removed.
11110 A line-wrap consists of a newline followed by a tab,
11111 and the tab is counted as 8 columns.
11112 .wen
11113
11114
11115
11116 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11117 .cindex "base64 encoding" "conversion from hex"
11118 .cindex "expansion" "hex to base64"
11119 .cindex "&%hex2b64%& expansion item"
11120 This operator converts a hex string into one that is base64 encoded. This can
11121 be useful for processing the output of the various hashing functions.
11122
11123
11124
11125 .vitem &*${hexquote:*&<&'string'&>&*}*&
11126 .cindex "quoting" "hex-encoded unprintable characters"
11127 .cindex "&%hexquote%& expansion item"
11128 This operator converts non-printable characters in a string into a hex
11129 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11130 as is, and other byte values are converted to &`\xNN`&, for example, a
11131 byte value 127 is converted to &`\x7f`&.
11132
11133
11134 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11135 .cindex "&%ipv6denorm%& expansion item"
11136 .cindex "IP address" normalisation
11137 This expands an IPv6 address to a full eight-element colon-separated set
11138 of hex digits including leading zeroes.
11139 A trailing ipv4-style dotted-decimal set is converted to hex.
11140 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11141
11142 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11143 .cindex "&%ipv6norm%& expansion item"
11144 .cindex "IP address" normalisation
11145 .cindex "IP address" "canonical form"
11146 This converts an IPv6 address to canonical form.
11147 Leading zeroes of groups are omitted, and the longest
11148 set of zero-valued groups is replaced with a double colon.
11149 A trailing ipv4-style dotted-decimal set is converted to hex.
11150 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11151
11152
11153 .vitem &*${lc:*&<&'string'&>&*}*&
11154 .cindex "case forcing in strings"
11155 .cindex "string" "case forcing"
11156 .cindex "lower casing"
11157 .cindex "expansion" "case forcing"
11158 .cindex "&%lc%& expansion item"
11159 This forces the letters in the string into lower-case, for example:
11160 .code
11161 ${lc:$local_part}
11162 .endd
11163 Case is defined per the system C locale.
11164
11165 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11166 .cindex "expansion" "string truncation"
11167 .cindex "&%length%& expansion item"
11168 The &%length%& operator is a simpler interface to the &%length%& function that
11169 can be used when the parameter is a fixed number (as opposed to a string that
11170 changes when expanded). The effect is the same as
11171 .code
11172 ${length{<number>}{<string>}}
11173 .endd
11174 See the description of the general &%length%& item above for details. Note that
11175 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11176 when &%length%& is used as an operator.
11177 All measurement is done in bytes and is not UTF-8 aware.
11178
11179
11180 .vitem &*${listcount:*&<&'string'&>&*}*&
11181 .cindex "expansion" "list item count"
11182 .cindex "list" "item count"
11183 .cindex "list" "count of items"
11184 .cindex "&%listcount%& expansion item"
11185 The string is interpreted as a list and the number of items is returned.
11186
11187
11188 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11189 .cindex "expansion" "named list"
11190 .cindex "&%listnamed%& expansion item"
11191 The name is interpreted as a named list and the content of the list is returned,
11192 expanding any referenced lists, re-quoting as needed for colon-separation.
11193 If the optional type is given it must be one of "a", "d", "h" or "l"
11194 and selects address-, domain-, host- or localpart- lists to search among respectively.
11195 Otherwise all types are searched in an undefined order and the first
11196 matching list is returned.
11197 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11198 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11199
11200
11201 .vitem &*${local_part:*&<&'string'&>&*}*&
11202 .cindex "expansion" "local part extraction"
11203 .cindex "&%local_part%& expansion item"
11204 The string is interpreted as an RFC 2822 address and the local part is
11205 extracted from it. If the string does not parse successfully, the result is
11206 empty.
11207 The parsing correctly handles SMTPUTF8 Unicode in the string.
11208
11209
11210 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11211        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11212 .cindex "masked IP address"
11213 .cindex "IP address" "masking"
11214 .cindex "CIDR notation"
11215 .cindex "expansion" "IP address masking"
11216 .cindex "&%mask%& expansion item"
11217 If the form of the string to be operated on is not an IP address followed by a
11218 slash and an integer (that is, a network address in CIDR notation), the
11219 expansion fails. Otherwise, this operator converts the IP address to binary,
11220 masks off the least significant bits according to the bit count, and converts
11221 the result back to text, with mask appended. For example,
11222 .code
11223 ${mask:10.111.131.206/28}
11224 .endd
11225 returns the string &"10.111.131.192/28"&.
11226
11227 Since this operation is expected to
11228 be mostly used for looking up masked addresses in files, the
11229 normal
11230 result for an IPv6
11231 address uses dots to separate components instead of colons, because colon
11232 terminates a key string in lsearch files. So, for example,
11233 .code
11234 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11235 .endd
11236 returns the string
11237 .code
11238 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11239 .endd
11240 If the optional form &*mask_n*& is used, IPv6 address result are instead
11241 returned in normailsed form, using colons and with zero-compression.
11242 Letters in IPv6 addresses are always output in lower case.
11243
11244
11245 .vitem &*${md5:*&<&'string'&>&*}*&
11246 .cindex "MD5 hash"
11247 .cindex "expansion" "MD5 hash"
11248 .cindex certificate fingerprint
11249 .cindex "&%md5%& expansion item"
11250 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11251 as a 32-digit hexadecimal number, in which any letters are in lower case.
11252
11253 If the string is a single variable of type certificate,
11254 returns the MD5 hash fingerprint of the certificate.
11255
11256
11257 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11258 .cindex "expansion" "numeric hash"
11259 .cindex "hash function" "numeric"
11260 The &%nhash%& operator is a simpler interface to the numeric hashing function
11261 that can be used when the two parameters are fixed numbers (as opposed to
11262 strings that change when expanded). The effect is the same as
11263 .code
11264 ${nhash{<n>}{<m>}{<string>}}
11265 .endd
11266 See the description of the general &%nhash%& item above for details.
11267
11268
11269 .vitem &*${quote:*&<&'string'&>&*}*&
11270 .cindex "quoting" "in string expansions"
11271 .cindex "expansion" "quoting"
11272 .cindex "&%quote%& expansion item"
11273 The &%quote%& operator puts its argument into double quotes if it
11274 is an empty string or
11275 contains anything other than letters, digits, underscores, dots, and hyphens.
11276 Any occurrences of double quotes and backslashes are escaped with a backslash.
11277 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11278 respectively For example,
11279 .code
11280 ${quote:ab"*"cd}
11281 .endd
11282 becomes
11283 .code
11284 "ab\"*\"cd"
11285 .endd
11286 The place where this is useful is when the argument is a substitution from a
11287 variable or a message header.
11288
11289 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11290 .cindex "&%quote_local_part%& expansion item"
11291 This operator is like &%quote%&, except that it quotes the string only if
11292 required to do so by the rules of RFC 2822 for quoting local parts. For
11293 example, a plus sign would not cause quoting (but it would for &%quote%&).
11294 If you are creating a new email address from the contents of &$local_part$&
11295 (or any other unknown data), you should always use this operator.
11296
11297 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11298 will likely use the quoting form.
11299 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11300
11301
11302 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11303 .cindex "quoting" "lookup-specific"
11304 This operator applies lookup-specific quoting rules to the string. Each
11305 query-style lookup type has its own quoting rules which are described with
11306 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11307 .code
11308 ${quote_ldap:two * two}
11309 .endd
11310 returns
11311 .code
11312 two%20%5C2A%20two
11313 .endd
11314 For single-key lookup types, no quoting is ever necessary and this operator
11315 yields an unchanged string.
11316
11317
11318 .vitem &*${randint:*&<&'n'&>&*}*&
11319 .cindex "random number"
11320 This operator returns a somewhat random number which is less than the
11321 supplied number and is at least 0.  The quality of this randomness depends
11322 on how Exim was built; the values are not suitable for keying material.
11323 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11324 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11325 for versions of GnuTLS with that function.
11326 Otherwise, the implementation may be arc4random(), random() seeded by
11327 srandomdev() or srandom(), or a custom implementation even weaker than
11328 random().
11329
11330
11331 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11332 .cindex "expansion" "IP address"
11333 This operator reverses an IP address; for IPv4 addresses, the result is in
11334 dotted-quad decimal form, while for IPv6 addresses the result is in
11335 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11336 for DNS.  For example,
11337 .code
11338 ${reverse_ip:192.0.2.4}
11339 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11340 .endd
11341 returns
11342 .code
11343 4.2.0.192
11344 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
11345 .endd
11346
11347
11348 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11349 .cindex "expansion" "RFC 2047"
11350 .cindex "RFC 2047" "expansion operator"
11351 .cindex "&%rfc2047%& expansion item"
11352 This operator encodes text according to the rules of RFC 2047. This is an
11353 encoding that is used in header lines to encode non-ASCII characters. It is
11354 assumed that the input string is in the encoding specified by the
11355 &%headers_charset%& option, which gets its default at build time. If the string
11356 contains only characters in the range 33&--126, and no instances of the
11357 characters
11358 .code
11359 ? = ( ) < > @ , ; : \ " . [ ] _
11360 .endd
11361 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11362 string, using as many &"encoded words"& as necessary to encode all the
11363 characters.
11364
11365
11366 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11367 .cindex "expansion" "RFC 2047"
11368 .cindex "RFC 2047" "decoding"
11369 .cindex "&%rfc2047d%& expansion item"
11370 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11371 bytes are replaced by question marks. Characters are converted into the
11372 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11373 not recognized unless &%check_rfc2047_length%& is set false.
11374
11375 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11376 access a header line, RFC 2047 decoding is done automatically. You do not need
11377 to use this operator as well.
11378
11379
11380
11381 .vitem &*${rxquote:*&<&'string'&>&*}*&
11382 .cindex "quoting" "in regular expressions"
11383 .cindex "regular expressions" "quoting"
11384 .cindex "&%rxquote%& expansion item"
11385 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11386 characters in its argument. This is useful when substituting the values of
11387 variables or headers inside regular expressions.
11388
11389
11390 .vitem &*${sha1:*&<&'string'&>&*}*&
11391 .cindex "SHA-1 hash"
11392 .cindex "expansion" "SHA-1 hashing"
11393 .cindex certificate fingerprint
11394 .cindex "&%sha1%& expansion item"
11395 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11396 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11397
11398 If the string is a single variable of type certificate,
11399 returns the SHA-1 hash fingerprint of the certificate.
11400
11401
11402 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11403        &*${sha2:*&<&'string'&>&*}*& &&&
11404        &*${sha2_<n>:*&<&'string'&>&*}*&
11405 .cindex "SHA-256 hash"
11406 .cindex "SHA-2 hash"
11407 .cindex certificate fingerprint
11408 .cindex "expansion" "SHA-256 hashing"
11409 .cindex "&%sha256%& expansion item"
11410 .cindex "&%sha2%& expansion item"
11411 The &%sha256%& operator computes the SHA-256 hash value of the string
11412 and returns
11413 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11414
11415 If the string is a single variable of type certificate,
11416 returns the SHA-256 hash fingerprint of the certificate.
11417
11418 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11419 (except for certificates, which are not supported).
11420 Finally, if an underbar
11421 and a number is appended it specifies the output length, selecting a
11422 member of the SHA-2 family of hash functions.
11423 Values of 256, 384 and 512 are accepted, with 256 being the default.
11424
11425
11426 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11427        &*${sha3_<n>:*&<&'string'&>&*}*&
11428 .cindex "SHA3 hash"
11429 .cindex "expansion" "SHA3 hashing"
11430 .cindex "&%sha3%& expansion item"
11431 The &%sha3%& operator computes the SHA3-256 hash value of the string
11432 and returns
11433 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11434
11435 If a number is appended, separated by an underbar, it specifies
11436 the output length.  Values of 224, 256, 384 and 512 are accepted;
11437 with 256 being the default.
11438
11439 The &%sha3%& expansion item is only supported if Exim has been
11440 compiled with GnuTLS 3.5.0 or later,
11441 or OpenSSL 1.1.1 or later.
11442 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11443
11444
11445 .vitem &*${stat:*&<&'string'&>&*}*&
11446 .cindex "expansion" "statting a file"
11447 .cindex "file" "extracting characteristics"
11448 .cindex "&%stat%& expansion item"
11449 The string, after expansion, must be a file path. A call to the &[stat()]&
11450 function is made for this path. If &[stat()]& fails, an error occurs and the
11451 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11452 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11453 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11454 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11455 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11456 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11457 can extract individual fields using the &%extract%& expansion item.
11458
11459 The use of the &%stat%& expansion in users' filter files can be locked out by
11460 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11461 systems for files larger than 2GB.
11462
11463 .vitem &*${str2b64:*&<&'string'&>&*}*&
11464 .cindex "&%str2b64%& expansion item"
11465 Now deprecated, a synonym for the &%base64%& expansion operator.
11466
11467
11468
11469 .vitem &*${strlen:*&<&'string'&>&*}*&
11470 .cindex "expansion" "string length"
11471 .cindex "string" "length in expansion"
11472 .cindex "&%strlen%& expansion item"
11473 The item is replaced by the length of the expanded string, expressed as a
11474 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11475 All measurement is done in bytes and is not UTF-8 aware.
11476
11477
11478 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11479 .cindex "&%substr%& expansion item"
11480 .cindex "substring extraction"
11481 .cindex "expansion" "substring expansion"
11482 The &%substr%& operator is a simpler interface to the &%substr%& function that
11483 can be used when the two parameters are fixed numbers (as opposed to strings
11484 that change when expanded). The effect is the same as
11485 .code
11486 ${substr{<start>}{<length>}{<string>}}
11487 .endd
11488 See the description of the general &%substr%& item above for details. The
11489 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11490 All measurement is done in bytes and is not UTF-8 aware.
11491
11492 .vitem &*${time_eval:*&<&'string'&>&*}*&
11493 .cindex "&%time_eval%& expansion item"
11494 .cindex "time interval" "decoding"
11495 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11496 seconds.
11497
11498 .vitem &*${time_interval:*&<&'string'&>&*}*&
11499 .cindex "&%time_interval%& expansion item"
11500 .cindex "time interval" "formatting"
11501 The argument (after sub-expansion) must be a sequence of decimal digits that
11502 represents an interval of time as a number of seconds. It is converted into a
11503 number of larger units and output in Exim's normal time format, for example,
11504 &`1w3d4h2m6s`&.
11505
11506 .vitem &*${uc:*&<&'string'&>&*}*&
11507 .cindex "case forcing in strings"
11508 .cindex "string" "case forcing"
11509 .cindex "upper casing"
11510 .cindex "expansion" "case forcing"
11511 .cindex "&%uc%& expansion item"
11512 This forces the letters in the string into upper-case.
11513 Case is defined per the system C locale.
11514
11515 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11516 .cindex "correction of invalid utf-8 sequences in strings"
11517 .cindex "utf-8" "utf-8 sequences"
11518 .cindex "incorrect utf-8"
11519 .cindex "expansion" "utf-8 forcing"
11520 .cindex "&%utf8clean%& expansion item"
11521 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11522 In versions of Exim before 4.92, this did not correctly do so for a truncated
11523 final codepoint's encoding, and the character would be silently dropped.
11524 If you must handle detection of this scenario across both sets of Exim behavior,
11525 the complexity will depend upon the task.
11526 For instance, to detect if the first character is multibyte and a 1-byte
11527 extraction can be successfully used as a path component (as is common for
11528 dividing up delivery folders), you might use:
11529 .code
11530 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11531 .endd
11532 (which will false-positive if the first character of the local part is a
11533 literal question mark).
11534
11535 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11536        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11537        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11538        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11539 .cindex expansion UTF-8
11540 .cindex UTF-8 expansion
11541 .cindex EAI
11542 .cindex internationalisation
11543 .cindex "&%utf8_domain_to_alabel%& expansion item"
11544 .cindex "&%utf8_domain_from_alabel%& expansion item"
11545 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11546 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11547 These convert EAI mail name components between UTF-8 and a-label forms.
11548 For information on internationalisation support see &<<SECTi18nMTA>>&.
11549 .endlist
11550
11551
11552
11553
11554
11555
11556 .section "Expansion conditions" "SECTexpcond"
11557 .scindex IIDexpcond "expansion" "conditions"
11558 The following conditions are available for testing by the &%${if%& construct
11559 while expanding strings:
11560
11561 .vlist
11562 .vitem &*!*&<&'condition'&>
11563 .cindex "expansion" "negating a condition"
11564 .cindex "negation" "in expansion condition"
11565 Preceding any condition with an exclamation mark negates the result of the
11566 condition.
11567
11568 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11569 .cindex "numeric comparison"
11570 .cindex "expansion" "numeric comparison"
11571 There are a number of symbolic operators for doing numeric comparisons. They
11572 are:
11573 .itable none 0 0 2 10* left 90* left
11574 .irow "=   " "equal"
11575 .irow "==  " "equal"
11576 .irow ">   " "greater"
11577 .irow ">=  " "greater or equal"
11578 .irow "<   " "less"
11579 .irow "<=  " "less or equal"
11580 .endtable
11581 For example:
11582 .code
11583 ${if >{$message_size}{10M} ...
11584 .endd
11585 Note that the general negation operator provides for inequality testing. The
11586 two strings must take the form of optionally signed decimal integers,
11587 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11588 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11589 As a special case, the numerical value of an empty string is taken as
11590 zero.
11591
11592 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11593 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11594 10M, not if 10M is larger than &$message_size$&.
11595
11596
11597 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11598         {*&<&'arg2'&>&*}...}*&
11599 .cindex "expansion" "calling an acl"
11600 .cindex "&%acl%&" "expansion condition"
11601 The name and zero to nine argument strings are first expanded separately.  The expanded
11602 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11603 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11604 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11605 and may use the variables; if another acl expansion is used the values
11606 are restored after it returns.  If the ACL sets
11607 a value using a "message =" modifier the variable $value becomes
11608 the result of the expansion, otherwise it is empty.
11609 If the ACL returns accept the condition is true; if deny, false.
11610 If the ACL returns defer the result is a forced-fail.
11611
11612 .vitem &*bool&~{*&<&'string'&>&*}*&
11613 .cindex "expansion" "boolean parsing"
11614 .cindex "&%bool%& expansion condition"
11615 This condition turns a string holding a true or false representation into
11616 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11617 (case-insensitively); also integer numbers map to true if non-zero,
11618 false if zero.
11619 An empty string is treated as false.
11620 Leading and trailing whitespace is ignored;
11621 thus a string consisting only of whitespace is false.
11622 All other string values will result in expansion failure.
11623
11624 When combined with ACL variables, this expansion condition will let you
11625 make decisions in one place and act on those decisions in another place.
11626 For example:
11627 .code
11628 ${if bool{$acl_m_privileged_sender} ...
11629 .endd
11630
11631
11632 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11633 .cindex "expansion" "boolean parsing"
11634 .cindex "&%bool_lax%& expansion condition"
11635 Like &%bool%&, this condition turns a string into a boolean state.  But
11636 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11637 loose definition that the Router &%condition%& option uses.  The empty string
11638 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11639 true.  Leading and trailing whitespace is ignored.
11640
11641 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11642
11643 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11644 .cindex "expansion" "encrypted comparison"
11645 .cindex "encrypted strings, comparing"
11646 .cindex "&%crypteq%& expansion condition"
11647 This condition is included in the Exim binary if it is built to support any
11648 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11649 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11650 included in the binary.
11651
11652 The &%crypteq%& condition has two arguments. The first is encrypted and
11653 compared against the second, which is already encrypted. The second string may
11654 be in the LDAP form for storing encrypted strings, which starts with the
11655 encryption type in curly brackets, followed by the data. If the second string
11656 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11657 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11658 Typically this will be a field from a password file. An example of an encrypted
11659 string in LDAP form is:
11660 .code
11661 {md5}CY9rzUYh03PK3k6DJie09g==
11662 .endd
11663 If such a string appears directly in an expansion, the curly brackets have to
11664 be quoted, because they are part of the expansion syntax. For example:
11665 .code
11666 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11667 .endd
11668 The following encryption types (whose names are matched case-independently) are
11669 supported:
11670
11671 .ilist
11672 .cindex "MD5 hash"
11673 .cindex "base64 encoding" "in encrypted password"
11674 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11675 printable characters to compare with the remainder of the second string. If the
11676 length of the comparison string is 24, Exim assumes that it is base64 encoded
11677 (as in the above example). If the length is 32, Exim assumes that it is a
11678 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11679 comparison fails.
11680
11681 .next
11682 .cindex "SHA-1 hash"
11683 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11684 printable characters to compare with the remainder of the second string. If the
11685 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11686 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11687 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11688
11689 .next
11690 .cindex "&[crypt()]&"
11691 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11692 only the first eight characters of the password. However, in modern operating
11693 systems this is no longer true, and in many cases the entire password is used,
11694 whatever its length.
11695
11696 .next
11697 .cindex "&[crypt16()]&"
11698 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11699 use up to 16 characters of the password in some operating systems. Again, in
11700 modern operating systems, more characters may be used.
11701 .endlist
11702 Exim has its own version of &[crypt16()]&, which is just a double call to
11703 &[crypt()]&. For operating systems that have their own version, setting
11704 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11705 operating system version instead of its own. This option is set by default in
11706 the OS-dependent &_Makefile_& for those operating systems that are known to
11707 support &[crypt16()]&.
11708
11709 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11710 it was not using the same algorithm as some operating systems' versions. It
11711 turns out that as well as &[crypt16()]& there is a function called
11712 &[bigcrypt()]& in some operating systems. This may or may not use the same
11713 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11714
11715 However, since there is now a move away from the traditional &[crypt()]&
11716 functions towards using SHA1 and other algorithms, tidying up this area of
11717 Exim is seen as very low priority.
11718
11719 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11720 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11721 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11722 default is &`{crypt}`&. Whatever the default, you can always use either
11723 function by specifying it explicitly in curly brackets.
11724
11725 .vitem &*def:*&<&'variable&~name'&>
11726 .cindex "expansion" "checking for empty variable"
11727 .cindex "&%def%& expansion condition"
11728 The &%def%& condition must be followed by the name of one of the expansion
11729 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11730 variable does not contain the empty string. For example:
11731 .code
11732 ${if def:sender_ident {from $sender_ident}}
11733 .endd
11734 Note that the variable name is given without a leading &%$%& character. If the
11735 variable does not exist, the expansion fails.
11736
11737 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11738         &~&*def:h_*&<&'header&~name'&>&*:*&"
11739 .cindex "expansion" "checking header line existence"
11740 This condition is true if a message is being processed and the named header
11741 exists in the message. For example,
11742 .code
11743 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11744 .endd
11745 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11746 the header name must be terminated by a colon if white space does not follow.
11747
11748 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11749        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11750 .cindex "string" "comparison"
11751 .cindex "expansion" "string comparison"
11752 .cindex "&%eq%& expansion condition"
11753 .cindex "&%eqi%& expansion condition"
11754 The two substrings are first expanded. The condition is true if the two
11755 resulting strings are identical. For &%eq%& the comparison includes the case of
11756 letters, whereas for &%eqi%& the comparison is case-independent, where
11757 case is defined per the system C locale.
11758
11759 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11760 .cindex "expansion" "file existence test"
11761 .cindex "file" "existence test"
11762 .cindex "&%exists%&, expansion condition"
11763 The substring is first expanded and then interpreted as an absolute path. The
11764 condition is true if the named file (or directory) exists. The existence test
11765 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11766 users' filter files may be locked out by the system administrator.
11767
11768 &*Note:*& Testing a path using this condition is not a sufficient way of
11769 de-tainting it.
11770 Consider using a dsearch lookup.
11771
11772 .vitem &*first_delivery*&
11773 .cindex "delivery" "first"
11774 .cindex "first delivery"
11775 .cindex "expansion" "first delivery test"
11776 .cindex "&%first_delivery%& expansion condition"
11777 .cindex retry condition
11778 This condition, which has no data, is true during a message's first delivery
11779 attempt. It is false during any subsequent delivery attempts.
11780
11781
11782 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11783        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11784 .cindex "list" "iterative conditions"
11785 .cindex "expansion" "&*forall*& condition"
11786 .cindex "expansion" "&*forany*& condition"
11787 .vindex "&$item$&"
11788 These conditions iterate over a list. The first argument is expanded to form
11789 the list. By default, the list separator is a colon, but it can be changed by
11790 the normal method (&<<SECTlistsepchange>>&).
11791 The second argument is interpreted as a condition that is to
11792 be applied to each item in the list in turn. During the interpretation of the
11793 condition, the current list item is placed in a variable called &$item$&.
11794 .ilist
11795 For &*forany*&, interpretation stops if the condition is true for any item, and
11796 the result of the whole condition is true. If the condition is false for all
11797 items in the list, the overall condition is false.
11798 .next
11799 For &*forall*&, interpretation stops if the condition is false for any item,
11800 and the result of the whole condition is false. If the condition is true for
11801 all items in the list, the overall condition is true.
11802 .endlist
11803 Note that negation of &*forany*& means that the condition must be false for all
11804 items for the overall condition to succeed, and negation of &*forall*& means
11805 that the condition must be false for at least one item. In this example, the
11806 list separator is changed to a comma:
11807 .code
11808 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11809 .endd
11810 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11811 being processed, to enable these expansion items to be nested.
11812
11813 To scan a named list, expand it with the &*listnamed*& operator.
11814
11815 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11816        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11817        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11818        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11819 .cindex JSON "iterative conditions"
11820 .cindex JSON expansions
11821 .cindex expansion "&*forall_json*& condition"
11822 .cindex expansion "&*forany_json*& condition"
11823 .cindex expansion "&*forall_jsons*& condition"
11824 .cindex expansion "&*forany_jsons*& condition"
11825 As for the above, except that the first argument must, after expansion,
11826 be a JSON array.
11827 The array separator is not changeable.
11828 For the &"jsons"& variants the elements are expected to be JSON strings
11829 and have their quotes removed before the evaluation of the condition.
11830
11831
11832
11833 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11834        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11835 .cindex "string" "comparison"
11836 .cindex "expansion" "string comparison"
11837 .cindex "&%ge%& expansion condition"
11838 .cindex "&%gei%& expansion condition"
11839 The two substrings are first expanded. The condition is true if the first
11840 string is lexically greater than or equal to the second string. For &%ge%& the
11841 comparison includes the case of letters, whereas for &%gei%& the comparison is
11842 case-independent.
11843 Case and collation order are defined per the system C locale.
11844
11845 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11846        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11847 .cindex "string" "comparison"
11848 .cindex "expansion" "string comparison"
11849 .cindex "&%gt%& expansion condition"
11850 .cindex "&%gti%& expansion condition"
11851 The two substrings are first expanded. The condition is true if the first
11852 string is lexically greater than the second string. For &%gt%& the comparison
11853 includes the case of letters, whereas for &%gti%& the comparison is
11854 case-independent.
11855 Case and collation order are defined per the system C locale.
11856
11857
11858 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11859 SRS decode.  See SECT &<<SECTSRS>>& for details.
11860
11861
11862 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11863        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11864 .cindex "string" "comparison"
11865 .cindex "list" "iterative conditions"
11866 Both strings are expanded; the second string is treated as a list of simple
11867 strings; if the first string is a member of the second, then the condition
11868 is true.
11869 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11870
11871 These are simpler to use versions of the more powerful &*forany*& condition.
11872 Examples, and the &*forany*& equivalents:
11873 .code
11874 ${if inlist{needle}{foo:needle:bar}}
11875   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11876 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11877   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11878 .endd
11879
11880 The variable &$value$& will be set for a successful match and can be
11881 used in the success clause of an &%if%& expansion item using the condition.
11882 .cindex "tainted data" "de-tainting"
11883 .cindex "de-tainting" "using an inlist expansion condition"
11884 It will have the same taint status as the list; expansions such as
11885 .code
11886 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11887 .endd
11888 can be used for de-tainting.
11889 Any previous &$value$& is restored after the if.
11890
11891
11892 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11893        &*isip4&~{*&<&'string'&>&*}*& &&&
11894        &*isip6&~{*&<&'string'&>&*}*&
11895 .cindex "IP address" "testing string format"
11896 .cindex "string" "testing for IP address"
11897 .cindex "&%isip%& expansion condition"
11898 .cindex "&%isip4%& expansion condition"
11899 .cindex "&%isip6%& expansion condition"
11900 The substring is first expanded, and then tested to see if it has the form of
11901 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11902 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11903
11904 For an IPv4 address, the test is for four dot-separated components, each of
11905 which consists of from one to three digits. For an IPv6 address, up to eight
11906 colon-separated components are permitted, each containing from one to four
11907 hexadecimal digits. There may be fewer than eight components if an empty
11908 component (adjacent colons) is present. Only one empty component is permitted.
11909
11910 &*Note*&: The checks used to be just on the form of the address; actual numerical
11911 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11912 check.
11913 This is no longer the case.
11914
11915 The main use of these tests is to distinguish between IP addresses and
11916 host names, or between IPv4 and IPv6 addresses. For example, you could use
11917 .code
11918 ${if isip4{$sender_host_address}...
11919 .endd
11920 to test which IP version an incoming SMTP connection is using.
11921
11922 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11923 .cindex "LDAP" "use for authentication"
11924 .cindex "expansion" "LDAP authentication test"
11925 .cindex "&%ldapauth%& expansion condition"
11926 This condition supports user authentication using LDAP. See section
11927 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11928 queries. For this use, the query must contain a user name and password. The
11929 query itself is not used, and can be empty. The condition is true if the
11930 password is not empty, and the user name and password are accepted by the LDAP
11931 server. An empty password is rejected without calling LDAP because LDAP binds
11932 with an empty password are considered anonymous regardless of the username, and
11933 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11934 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11935 this can be used.
11936
11937
11938 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11939        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11940 .cindex "string" "comparison"
11941 .cindex "expansion" "string comparison"
11942 .cindex "&%le%& expansion condition"
11943 .cindex "&%lei%& expansion condition"
11944 The two substrings are first expanded. The condition is true if the first
11945 string is lexically less than or equal to the second string. For &%le%& the
11946 comparison includes the case of letters, whereas for &%lei%& the comparison is
11947 case-independent.
11948 Case and collation order are defined per the system C locale.
11949
11950 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11951        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11952 .cindex "string" "comparison"
11953 .cindex "expansion" "string comparison"
11954 .cindex "&%lt%& expansion condition"
11955 .cindex "&%lti%& expansion condition"
11956 The two substrings are first expanded. The condition is true if the first
11957 string is lexically less than the second string. For &%lt%& the comparison
11958 includes the case of letters, whereas for &%lti%& the comparison is
11959 case-independent.
11960 Case and collation order are defined per the system C locale.
11961
11962
11963 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11964 .cindex "expansion" "regular expression comparison"
11965 .cindex "regular expressions" "match in expanded string"
11966 .cindex "&%match%& expansion condition"
11967 The two substrings are first expanded. The second is then treated as a regular
11968 expression and applied to the first. Because of the pre-expansion, if the
11969 regular expression contains dollar, or backslash characters, they must be
11970 escaped. Care must also be taken if the regular expression contains braces
11971 (curly brackets). A closing brace must be escaped so that it is not taken as a
11972 premature termination of <&'string2'&>. The easiest approach is to use the
11973 &`\N`& feature to disable expansion of the regular expression.
11974 For example,
11975 .code
11976 ${if match {$local_part}{\N^\d{3}\N} ...
11977 .endd
11978 If the whole expansion string is in double quotes, further escaping of
11979 backslashes is also required.
11980
11981 The condition is true if the regular expression match succeeds.
11982 The regular expression is not required to begin with a circumflex
11983 metacharacter, but if there is no circumflex, the expression is not anchored,
11984 and it may match anywhere in the subject, not just at the start. If you want
11985 the pattern to match at the end of the subject, you must include the &`$`&
11986 metacharacter at an appropriate point.
11987 All character handling is done in bytes and is not UTF-8 aware,
11988 but we might change this in a future Exim release.
11989
11990 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11991 At the start of an &%if%& expansion the values of the numeric variable
11992 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11993 succeeds causes them to be reset to the substrings of that condition and they
11994 will have these values during the expansion of the success string. At the end
11995 of the &%if%& expansion, the previous values are restored. After testing a
11996 combination of conditions using &%or%&, the subsequent values of the numeric
11997 variables are those of the condition that succeeded.
11998
11999 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12000 .cindex "&%match_address%& expansion condition"
12001 See &*match_local_part*&.
12002
12003 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12004 .cindex "&%match_domain%& expansion condition"
12005 See &*match_local_part*&.
12006
12007 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12008 .cindex "&%match_ip%& expansion condition"
12009 This condition matches an IP address to a list of IP address patterns. It must
12010 be followed by two argument strings. The first (after expansion) must be an IP
12011 address or an empty string. The second (not expanded) is a restricted host
12012 list that can match only an IP address, not a host name. For example:
12013 .code
12014 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12015 .endd
12016 The specific types of host list item that are permitted in the list are:
12017
12018 .ilist
12019 An IP address, optionally with a CIDR mask.
12020 .next
12021 A single asterisk, which matches any IP address.
12022 .next
12023 An empty item, which matches only if the IP address is empty. This could be
12024 useful for testing for a locally submitted message or one from specific hosts
12025 in a single test such as
12026 . ==== As this is a nested list, any displays it contains must be indented
12027 . ==== as otherwise they are too far to the left. This comment applies to
12028 . ==== the use of xmlto plus fop. There's no problem when formatting with
12029 . ==== sdop, with or without the extra indent.
12030 .code
12031   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12032 .endd
12033 where the first item in the list is the empty string.
12034 .next
12035 The item @[] matches any of the local host's interface addresses.
12036 .next
12037 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12038 even if &`net-`& is not specified. There is never any attempt to turn the IP
12039 address into a host name. The most common type of linear search for
12040 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12041 masks. For example:
12042 .code
12043   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12044 .endd
12045 It is of course possible to use other kinds of lookup, and in such a case, you
12046 do need to specify the &`net-`& prefix if you want to specify a specific
12047 address mask, for example:
12048 .code
12049   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12050 .endd
12051 However, unless you are combining a &%match_ip%& condition with others, it is
12052 just as easy to use the fact that a lookup is itself a condition, and write:
12053 .code
12054   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12055 .endd
12056 .endlist ilist
12057
12058 Note that <&'string2'&> is not itself subject to string expansion, unless
12059 Exim was built with the EXPAND_LISTMATCH_RHS option.
12060
12061 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12062
12063 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12064 .cindex "domain list" "in expansion condition"
12065 .cindex "address list" "in expansion condition"
12066 .cindex "local part" "list, in expansion condition"
12067 .cindex "&%match_local_part%& expansion condition"
12068 This condition, together with &%match_address%& and &%match_domain%&, make it
12069 possible to test domain, address, and local part lists within expansions. Each
12070 condition requires two arguments: an item and a list to match. A trivial
12071 example is:
12072 .code
12073 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12074 .endd
12075 In each case, the second argument may contain any of the allowable items for a
12076 list of the appropriate type. Also, because the second argument
12077 is a standard form of list, it is possible to refer to a named list.
12078 Thus, you can use conditions like this:
12079 .code
12080 ${if match_domain{$domain}{+local_domains}{...
12081 .endd
12082 .cindex "&`+caseful`&"
12083 For address lists, the matching starts off caselessly, but the &`+caseful`&
12084 item can be used, as in all address lists, to cause subsequent items to
12085 have their local parts matched casefully. Domains are always matched
12086 caselessly.
12087
12088 The variable &$value$& will be set for a successful match and can be
12089 used in the success clause of an &%if%& expansion item using the condition.
12090 .cindex "tainted data" "de-tainting"
12091 .cindex "de-tainting" "using a match_local_part expansion condition"
12092 It will have the same taint status as the list; expansions such as
12093 .code
12094 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12095 .endd
12096 can be used for de-tainting.
12097 Any previous &$value$& is restored after the if.
12098
12099 Note that <&'string2'&> is not itself subject to string expansion, unless
12100 Exim was built with the EXPAND_LISTMATCH_RHS option.
12101
12102 &*Note*&: Host lists are &'not'& supported in this way. This is because
12103 hosts have two identities: a name and an IP address, and it is not clear
12104 how to specify cleanly how such a test would work. However, IP addresses can be
12105 matched using &%match_ip%&.
12106
12107 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12108 .cindex "PAM authentication"
12109 .cindex "AUTH" "with PAM"
12110 .cindex "Solaris" "PAM support"
12111 .cindex "expansion" "PAM authentication test"
12112 .cindex "&%pam%& expansion condition"
12113 &'Pluggable Authentication Modules'&
12114 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12115 available in Solaris
12116 and in some GNU/Linux distributions.
12117 The Exim support, which is intended for use in conjunction with
12118 the SMTP AUTH command, is available only if Exim is compiled with
12119 .code
12120 SUPPORT_PAM=yes
12121 .endd
12122 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12123 in some releases of GNU/Linux &%-ldl%& is also needed.
12124
12125 The argument string is first expanded, and the result must be a
12126 colon-separated list of strings. Leading and trailing white space is ignored.
12127 The PAM module is initialized with the service name &"exim"& and the user name
12128 taken from the first item in the colon-separated data string (<&'string1'&>).
12129 The remaining items in the data string are passed over in response to requests
12130 from the authentication function. In the simple case there will only be one
12131 request, for a password, so the data consists of just two strings.
12132
12133 There can be problems if any of the strings are permitted to contain colon
12134 characters. In the usual way, these have to be doubled to avoid being taken as
12135 separators.
12136 The &%listquote%& expansion item can be used for this.
12137 For example, the configuration
12138 of a LOGIN authenticator might contain this setting:
12139 .code
12140 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12141 .endd
12142 In some operating systems, PAM authentication can be done only from a process
12143 running as root. Since Exim is running as the Exim user when receiving
12144 messages, this means that PAM cannot be used directly in those systems.
12145 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12146
12147
12148 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12149 .cindex "&'pwcheck'& daemon"
12150 .cindex "Cyrus"
12151 .cindex "expansion" "&'pwcheck'& authentication test"
12152 .cindex "&%pwcheck%& expansion condition"
12153 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12154 This is one way of making it possible for passwords to be checked by a process
12155 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12156 deprecated. Its replacement is &'saslauthd'& (see below).
12157
12158 The pwcheck support is not included in Exim by default. You need to specify
12159 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12160 building Exim. For example:
12161 .code
12162 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12163 .endd
12164 You do not need to install the full Cyrus software suite in order to use
12165 the pwcheck daemon. You can compile and install just the daemon alone
12166 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12167 access to the &_/var/pwcheck_& directory.
12168
12169 The &%pwcheck%& condition takes one argument, which must be the user name and
12170 password, separated by a colon. For example, in a LOGIN authenticator
12171 configuration, you might have this:
12172 .code
12173 server_condition = ${if pwcheck{$auth1:$auth2}}
12174 .endd
12175 Again, for a PLAIN authenticator configuration, this would be:
12176 .code
12177 server_condition = ${if pwcheck{$auth2:$auth3}}
12178 .endd
12179 .vitem &*queue_running*&
12180 .cindex "queue runner" "detecting when delivering from"
12181 .cindex "expansion" "queue runner test"
12182 .cindex "&%queue_running%& expansion condition"
12183 This condition, which has no data, is true during delivery attempts that are
12184 initiated by queue runner processes, and false otherwise.
12185
12186
12187 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12188 .cindex "Radius"
12189 .cindex "expansion" "Radius authentication"
12190 .cindex "&%radius%& expansion condition"
12191 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12192 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12193 the Radius client configuration file in order to build Exim with Radius
12194 support.
12195
12196 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12197 library, using the original API. If you are using release 0.4.0 or later of
12198 this library, you need to set
12199 .code
12200 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12201 .endd
12202 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12203 &%libradius%& library that comes with FreeBSD. To do this, set
12204 .code
12205 RADIUS_LIB_TYPE=RADLIB
12206 .endd
12207 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12208 You may also have to supply a suitable setting in EXTRALIBS so that the
12209 Radius library can be found when Exim is linked.
12210
12211 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12212 Radius client library, which calls the Radius server. The condition is true if
12213 the authentication is successful. For example:
12214 .code
12215 server_condition = ${if radius{<arguments>}}
12216 .endd
12217
12218
12219 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12220         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12221 .cindex "&'saslauthd'& daemon"
12222 .cindex "Cyrus"
12223 .cindex "expansion" "&'saslauthd'& authentication test"
12224 .cindex "&%saslauthd%& expansion condition"
12225 This condition supports user authentication using the Cyrus &'saslauthd'&
12226 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12227 Using this daemon is one way of making it possible for passwords to be checked
12228 by a process that is not running as root.
12229
12230 The saslauthd support is not included in Exim by default. You need to specify
12231 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12232 building Exim. For example:
12233 .code
12234 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12235 .endd
12236 You do not need to install the full Cyrus software suite in order to use
12237 the saslauthd daemon. You can compile and install just the daemon alone
12238 from the Cyrus SASL library.
12239
12240 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12241 two are mandatory. For example:
12242 .code
12243 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12244 .endd
12245 The service and the realm are optional (which is why the arguments are enclosed
12246 in their own set of braces). For details of the meaning of the service and
12247 realm, and how to run the daemon, consult the Cyrus documentation.
12248 .endlist vlist
12249
12250
12251
12252 .section "Combining expansion conditions" "SECID84"
12253 .cindex "expansion" "combining conditions"
12254 Several conditions can be tested at once by combining them using the &%and%&
12255 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12256 conditions on their own, and precede their lists of sub-conditions. Each
12257 sub-condition must be enclosed in braces within the overall braces that contain
12258 the list. No repetition of &%if%& is used.
12259
12260
12261 .vlist
12262 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12263 .cindex "&""or""& expansion condition"
12264 .cindex "expansion" "&""or""& of conditions"
12265 The sub-conditions are evaluated from left to right. The condition is true if
12266 any one of the sub-conditions is true.
12267 For example,
12268 .code
12269 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12270 .endd
12271 When a true sub-condition is found, the following ones are parsed but not
12272 evaluated. If there are several &"match"& sub-conditions the values of the
12273 numeric variables afterwards are taken from the first one that succeeds.
12274
12275 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12276 .cindex "&""and""& expansion condition"
12277 .cindex "expansion" "&""and""& of conditions"
12278 The sub-conditions are evaluated from left to right. The condition is true if
12279 all of the sub-conditions are true. If there are several &"match"&
12280 sub-conditions, the values of the numeric variables afterwards are taken from
12281 the last one. When a false sub-condition is found, the following ones are
12282 parsed but not evaluated.
12283 .endlist
12284 .ecindex IIDexpcond
12285
12286
12287
12288
12289 .section "Expansion variables" "SECTexpvar"
12290 .cindex "expansion" "variables, list of"
12291 This section contains an alphabetical list of all the expansion variables. Some
12292 of them are available only when Exim is compiled with specific options such as
12293 support for TLS or the content scanning extension.
12294 .cindex "tainted data"
12295 Variables marked as &'tainted'& are likely to carry data supplied by
12296 a potential attacker.
12297 Variables without such marking may also, depending on how their
12298 values are created.
12299 Such variables should not be further expanded,
12300 used as filenames
12301 or used as command-line arguments for external commands.
12302
12303 .vlist
12304 .vitem "&$0$&, &$1$&, etc"
12305 .cindex "numerical variables (&$1$& &$2$& etc)"
12306 When a &%match%& expansion condition succeeds, these variables contain the
12307 captured substrings identified by the regular expression during subsequent
12308 processing of the success string of the containing &%if%& expansion item.
12309 In the expansion condition case
12310 they do not retain their values afterwards; in fact, their previous
12311 values are restored at the end of processing an &%if%& item. The numerical
12312 variables may also be set externally by some other matching process which
12313 precedes the expansion of the string. For example, the commands available in
12314 Exim filter files include an &%if%& command with its own regular expression
12315 matching condition.
12316 If the subject string was tainted then any captured substring will also be.
12317
12318 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12319 Within an acl condition, expansion condition or expansion item
12320 any arguments are copied to these variables,
12321 any unused variables being made empty.
12322
12323 .vitem "&$acl_c...$&"
12324 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12325 can be given any name that starts with &$acl_c$& and is at least six characters
12326 long, but the sixth character must be either a digit or an underscore. For
12327 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12328 variables persist throughout the lifetime of an SMTP connection. They can be
12329 used to pass information between ACLs and between different invocations of the
12330 same ACL. When a message is received, the values of these variables are saved
12331 with the message, and can be accessed by filters, routers, and transports
12332 during subsequent delivery.
12333
12334 .vitem "&$acl_m...$&"
12335 These variables are like the &$acl_c...$& variables, except that their values
12336 are reset after a message has been received. Thus, if several messages are
12337 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12338 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12339 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12340 message is received, the values of these variables are saved with the message,
12341 and can be accessed by filters, routers, and transports during subsequent
12342 delivery.
12343
12344 .vitem &$acl_narg$&
12345 Within an acl condition, expansion condition or expansion item
12346 this variable has the number of arguments.
12347
12348 .vitem &$acl_verify_message$&
12349 .vindex "&$acl_verify_message$&"
12350 After an address verification has failed, this variable contains the failure
12351 message. It retains its value for use in subsequent modifiers of the verb.
12352 The message can be preserved by coding like this:
12353 .code
12354 warn !verify = sender
12355      set acl_m0 = $acl_verify_message
12356 .endd
12357 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12358 &%log_message%& modifiers, to include information about the verification
12359 failure.
12360 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12361
12362 .vitem &$address_data$&
12363 .vindex "&$address_data$&"
12364 This variable is set by means of the &%address_data%& option in routers. The
12365 value then remains with the address while it is processed by subsequent routers
12366 and eventually a transport. If the transport is handling multiple addresses,
12367 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12368 for more details. &*Note*&: The contents of &$address_data$& are visible in
12369 user filter files.
12370
12371 If &$address_data$& is set when the routers are called from an ACL to verify
12372 a recipient address, the final value is still in the variable for subsequent
12373 conditions and modifiers of the ACL statement. If routing the address caused it
12374 to be redirected to just one address, the child address is also routed as part
12375 of the verification, and in this case the final value of &$address_data$& is
12376 from the child's routing.
12377
12378 If &$address_data$& is set when the routers are called from an ACL to verify a
12379 sender address, the final value is also preserved, but this time in
12380 &$sender_address_data$&, to distinguish it from data from a recipient
12381 address.
12382
12383 In both cases (recipient and sender verification), the value does not persist
12384 after the end of the current ACL statement. If you want to preserve
12385 these values for longer, you can save them in ACL variables.
12386
12387 .vitem &$address_file$&
12388 .vindex "&$address_file$&"
12389 When, as a result of aliasing, forwarding, or filtering, a message is directed
12390 to a specific file, this variable holds the name of the file when the transport
12391 is running. At other times, the variable is empty. For example, using the
12392 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12393 .code
12394 /home/r2d2/savemail
12395 .endd
12396 then when the &(address_file)& transport is running, &$address_file$&
12397 contains the text string &`/home/r2d2/savemail`&.
12398 .cindex "Sieve filter" "value of &$address_file$&"
12399 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12400 then up to the transport configuration to generate an appropriate absolute path
12401 to the relevant file.
12402
12403 .vitem &$address_pipe$&
12404 .vindex "&$address_pipe$&"
12405 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12406 this variable holds the pipe command when the transport is running.
12407
12408 .vitem "&$auth1$& &-- &$auth4$&"
12409 .vindex "&$auth1$&, &$auth2$&, etc"
12410 These variables are used in SMTP authenticators (see chapters
12411 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12412
12413 .vitem &$authenticated_id$&
12414 .cindex "authentication" "id"
12415 .vindex "&$authenticated_id$&"
12416 When a server successfully authenticates a client it may be configured to
12417 preserve some of the authentication information in the variable
12418 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12419 user/password authenticator configuration might preserve the user name for use
12420 in the routers. Note that this is not the same information that is saved in
12421 &$sender_host_authenticated$&.
12422
12423 When a message is submitted locally (that is, not over a TCP connection)
12424 the value of &$authenticated_id$& is normally the login name of the calling
12425 process. However, a trusted user can override this by means of the &%-oMai%&
12426 command line option.
12427 This second case also sets up information used by the
12428 &$authresults$& expansion item.
12429
12430 .vitem &$authenticated_fail_id$&
12431 .cindex "authentication" "fail" "id"
12432 .vindex "&$authenticated_fail_id$&"
12433 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12434 will contain the failed authentication id. If more than one authentication
12435 id is attempted, it will contain only the last one. The variable is
12436 available for processing in the ACL's, generally the quit or notquit ACL.
12437 A message to a local recipient could still be accepted without requiring
12438 authentication, which means this variable could also be visible in all of
12439 the ACL's as well.
12440
12441
12442 .tvar &$authenticated_sender$&
12443 .cindex "sender" "authenticated"
12444 .cindex "authentication" "sender"
12445 .cindex "AUTH" "on MAIL command"
12446 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12447 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12448 described in section &<<SECTauthparamail>>&. Unless the data is the string
12449 &"<>"&, it is set as the authenticated sender of the message, and the value is
12450 available during delivery in the &$authenticated_sender$& variable. If the
12451 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12452
12453 .vindex "&$qualify_domain$&"
12454 When a message is submitted locally (that is, not over a TCP connection), the
12455 value of &$authenticated_sender$& is an address constructed from the login
12456 name of the calling process and &$qualify_domain$&, except that a trusted user
12457 can override this by means of the &%-oMas%& command line option.
12458
12459
12460 .vitem &$authentication_failed$&
12461 .cindex "authentication" "failure"
12462 .vindex "&$authentication_failed$&"
12463 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12464 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12465 possible to distinguish between &"did not try to authenticate"&
12466 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12467 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12468 is empty and &$authentication_failed$& is set to &"1"&).
12469 Failure includes cancellation of a authentication attempt,
12470 and any negative response to an AUTH command,
12471 (including, for example, an attempt to use an undefined mechanism).
12472
12473 .vitem &$av_failed$&
12474 .cindex "content scanning" "AV scanner failure"
12475 This variable is available when Exim is compiled with the content-scanning
12476 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12477 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12478 the ACL malware condition.
12479
12480 .vitem &$body_linecount$&
12481 .cindex "message body" "line count"
12482 .cindex "body of message" "line count"
12483 .vindex "&$body_linecount$&"
12484 When a message is being received or delivered, this variable contains the
12485 number of lines in the message's body. See also &$message_linecount$&.
12486
12487 .vitem &$body_zerocount$&
12488 .cindex "message body" "binary zero count"
12489 .cindex "body of message" "binary zero count"
12490 .cindex "binary zero" "in message body"
12491 .vindex "&$body_zerocount$&"
12492 When a message is being received or delivered, this variable contains the
12493 number of binary zero bytes (ASCII NULs) in the message's body.
12494
12495 .vitem &$bounce_recipient$&
12496 .vindex "&$bounce_recipient$&"
12497 This is set to the recipient address of a bounce message while Exim is creating
12498 it. It is useful if a customized bounce message text file is in use (see
12499 chapter &<<CHAPemsgcust>>&).
12500
12501 .vitem &$bounce_return_size_limit$&
12502 .vindex "&$bounce_return_size_limit$&"
12503 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12504 up to a multiple of 1000. It is useful when a customized error message text
12505 file is in use (see chapter &<<CHAPemsgcust>>&).
12506
12507 .vitem &$caller_gid$&
12508 .cindex "gid (group id)" "caller"
12509 .vindex "&$caller_gid$&"
12510 The real group id under which the process that called Exim was running. This is
12511 not the same as the group id of the originator of a message (see
12512 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12513 incarnation normally contains the Exim gid.
12514
12515 .vitem &$caller_uid$&
12516 .cindex "uid (user id)" "caller"
12517 .vindex "&$caller_uid$&"
12518 The real user id under which the process that called Exim was running. This is
12519 not the same as the user id of the originator of a message (see
12520 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12521 incarnation normally contains the Exim uid.
12522
12523 .vitem &$callout_address$&
12524 .vindex "&$callout_address$&"
12525 After a callout for verification, spamd or malware daemon service, the
12526 address that was connected to.
12527
12528 .vitem &$compile_number$&
12529 .vindex "&$compile_number$&"
12530 The building process for Exim keeps a count of the number
12531 of times it has been compiled. This serves to distinguish different
12532 compilations of the same version of Exim.
12533
12534 .vitem &$config_dir$&
12535 .vindex "&$config_dir$&"
12536 The directory name of the main configuration file. That is, the content of
12537 &$config_file$& with the last component stripped. The value does not
12538 contain the trailing slash. If &$config_file$& does not contain a slash,
12539 &$config_dir$& is ".".
12540
12541 .vitem &$config_file$&
12542 .vindex "&$config_file$&"
12543 The name of the main configuration file Exim is using.
12544
12545 .vitem &$dkim_verify_status$&
12546 Results of DKIM verification.
12547 For details see section &<<SECDKIMVFY>>&.
12548
12549 .vitem &$dkim_cur_signer$& &&&
12550        &$dkim_verify_reason$& &&&
12551        &$dkim_domain$& &&&
12552        &$dkim_identity$& &&&
12553        &$dkim_selector$& &&&
12554        &$dkim_algo$& &&&
12555        &$dkim_canon_body$& &&&
12556        &$dkim_canon_headers$& &&&
12557        &$dkim_copiedheaders$& &&&
12558        &$dkim_bodylength$& &&&
12559        &$dkim_created$& &&&
12560        &$dkim_expires$& &&&
12561        &$dkim_headernames$& &&&
12562        &$dkim_key_testing$& &&&
12563        &$dkim_key_nosubdomains$& &&&
12564        &$dkim_key_srvtype$& &&&
12565        &$dkim_key_granularity$& &&&
12566        &$dkim_key_notes$& &&&
12567        &$dkim_key_length$&
12568 These variables are only available within the DKIM ACL.
12569 For details see section &<<SECDKIMVFY>>&.
12570
12571 .vitem &$dkim_signers$&
12572 .vindex &$dkim_signers$&
12573 When a message has been received this variable contains
12574 a colon-separated list of signer domains and identities for the message.
12575 For details see section &<<SECDKIMVFY>>&.
12576
12577 .vitem &$dmarc_domain_policy$& &&&
12578        &$dmarc_status$& &&&
12579        &$dmarc_status_text$& &&&
12580        &$dmarc_used_domains$&
12581 Results of DMARC verification.
12582 For details see section &<<SECDMARC>>&.
12583
12584 .vitem &$dnslist_domain$& &&&
12585        &$dnslist_matched$& &&&
12586        &$dnslist_text$& &&&
12587        &$dnslist_value$&
12588 .vindex "&$dnslist_domain$&"
12589 .vindex "&$dnslist_matched$&"
12590 .vindex "&$dnslist_text$&"
12591 .vindex "&$dnslist_value$&"
12592 .cindex "black list (DNS)"
12593 When a DNS (black) list lookup succeeds, these variables are set to contain
12594 the following data from the lookup: the list's domain name, the key that was
12595 looked up, the contents of any associated TXT record, and the value from the
12596 main A record. See section &<<SECID204>>& for more details.
12597
12598 .tvar &$domain$&
12599 When an address is being routed, or delivered on its own, this variable
12600 contains the domain. Uppercase letters in the domain are converted into lower
12601 case for &$domain$&.
12602
12603 Global address rewriting happens when a message is received, so the value of
12604 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12605 is set during user filtering, but not during system filtering, because a
12606 message may have many recipients and the system filter is called just once.
12607
12608 When more than one address is being delivered at once (for example, several
12609 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12610 have the same domain. Transports can be restricted to handling only one domain
12611 at a time if the value of &$domain$& is required at transport time &-- this is
12612 the default for local transports. For further details of the environment in
12613 which local transports are run, see chapter &<<CHAPenvironment>>&.
12614
12615 .oindex "&%delay_warning_condition%&"
12616 At the end of a delivery, if all deferred addresses have the same domain, it is
12617 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12618
12619 The &$domain$& variable is also used in some other circumstances:
12620
12621 .ilist
12622 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12623 the recipient address. The domain of the &'sender'& address is in
12624 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12625 normally set during the running of the MAIL ACL. However, if the sender address
12626 is verified with a callout during the MAIL ACL, the sender domain is placed in
12627 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12628 the &(smtp)& transport.
12629
12630 .next
12631 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12632 &$domain$& contains the domain portion of the address that is being rewritten;
12633 it can be used in the expansion of the replacement address, for example, to
12634 rewrite domains by file lookup.
12635
12636 .next
12637 With one important exception, whenever a domain list is being scanned,
12638 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12639 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12640 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12641 that, in a RCPT ACL, the sender domain list can be dependent on the
12642 recipient domain (which is what is in &$domain$& at this time).
12643
12644 .next
12645 .cindex "ETRN" "value of &$domain$&"
12646 .oindex "&%smtp_etrn_command%&"
12647 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12648 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12649 .endlist
12650
12651 .cindex "tainted data"
12652 If the origin of the data is an incoming message,
12653 the result of expanding this variable is tainted and may not
12654 be further expanded or used as a filename.
12655 When an untainted version is needed, one should be obtained from
12656 looking up the value in a local (therefore trusted) database.
12657 Often &$domain_data$& is usable in this role.
12658
12659
12660 .vitem &$domain_data$&
12661 .vindex "&$domain_data$&"
12662 When the &%domains%& condition on a router
12663 or an ACL
12664 matches a domain
12665 against a list, the match value is copied to &$domain_data$&.
12666 This is an enhancement over previous versions of Exim, when it only
12667 applied to the data read by a lookup.
12668 For details on match values see section &<<SECTlistresults>>& et. al.
12669
12670 If the router routes the
12671 address to a transport, the value is available in that transport. If the
12672 transport is handling multiple addresses, the value from the first address is
12673 used.
12674
12675 &$domain_data$& set in an ACL is available during
12676 the rest of the ACL statement.
12677
12678 .vitem &$exim_gid$&
12679 .vindex "&$exim_gid$&"
12680 This variable contains the numerical value of the Exim group id.
12681
12682 .vitem &$exim_path$&
12683 .vindex "&$exim_path$&"
12684 This variable contains the path to the Exim binary.
12685
12686 .vitem &$exim_uid$&
12687 .vindex "&$exim_uid$&"
12688 This variable contains the numerical value of the Exim user id.
12689
12690 .vitem &$exim_version$&
12691 .vindex "&$exim_version$&"
12692 This variable contains the version string of the Exim build.
12693 The first character is a major version number, currently 4.
12694 Then after a dot, the next group of digits is a minor version number.
12695 There may be other characters following the minor version.
12696 This value may be overridden by the &%exim_version%& main config option.
12697
12698 .vitem &$header_$&<&'name'&>
12699 .tmark
12700 This is not strictly an expansion variable. It is expansion syntax for
12701 inserting the message header line with the given name. Note that the name must
12702 be terminated by colon or white space, because it may contain a wide variety of
12703 characters. Note also that braces must &'not'& be used.
12704 See the full description in section &<<SECTexpansionitems>>& above.
12705
12706 .vitem &$headers_added$&
12707 .vindex "&$headers_added$&"
12708 Within an ACL this variable contains the headers added so far by
12709 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12710 The headers are a newline-separated list.
12711
12712 .vitem &$home$&
12713 .vindex "&$home$&"
12714 When the &%check_local_user%& option is set for a router, the user's home
12715 directory is placed in &$home$& when the check succeeds. In particular, this
12716 means it is set during the running of users' filter files. A router may also
12717 explicitly set a home directory for use by a transport; this can be overridden
12718 by a setting on the transport itself.
12719
12720 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12721 of the environment variable HOME, which is subject to the
12722 &%keep_environment%& and &%add_environment%& main config options.
12723
12724 .vitem &$host$&
12725 .vindex "&$host$&"
12726 If a router assigns an address to a transport (any transport), and passes a
12727 list of hosts with the address, the value of &$host$& when the transport starts
12728 to run is the name of the first host on the list. Note that this applies both
12729 to local and remote transports.
12730
12731 .cindex "transport" "filter"
12732 .cindex "filter" "transport filter"
12733 For the &(smtp)& transport, if there is more than one host, the value of
12734 &$host$& changes as the transport works its way through the list. In
12735 particular, when the &(smtp)& transport is expanding its options for encryption
12736 using TLS, or for specifying a transport filter (see chapter
12737 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12738 is connected.
12739
12740 When used in the client part of an authenticator configuration (see chapter
12741 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12742 client is connected.
12743
12744
12745 .vitem &$host_address$&
12746 .vindex "&$host_address$&"
12747 This variable is set to the remote host's IP address whenever &$host$& is set
12748 for a remote connection. It is also set to the IP address that is being checked
12749 when the &%ignore_target_hosts%& option is being processed.
12750
12751 .vitem &$host_data$&
12752 .vindex "&$host_data$&"
12753 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12754 result of the lookup is made available in the &$host_data$& variable. This
12755 allows you, for example, to do things like this:
12756 .code
12757 deny  hosts = net-lsearch;/some/file
12758       message = $host_data
12759 .endd
12760
12761 .vitem &$host_lookup_deferred$&
12762 .cindex "host name" "lookup, failure of"
12763 .vindex "&$host_lookup_deferred$&"
12764 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12765 message comes from a remote host and there is an attempt to look up the host's
12766 name from its IP address, and the attempt is not successful, one of these
12767 variables is set to &"1"&.
12768
12769 .ilist
12770 If the lookup receives a definite negative response (for example, a DNS lookup
12771 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12772
12773 .next
12774 If there is any kind of problem during the lookup, such that Exim cannot
12775 tell whether or not the host name is defined (for example, a timeout for a DNS
12776 lookup), &$host_lookup_deferred$& is set to &"1"&.
12777 .endlist ilist
12778
12779 Looking up a host's name from its IP address consists of more than just a
12780 single reverse lookup. Exim checks that a forward lookup of at least one of the
12781 names it receives from a reverse lookup yields the original IP address. If this
12782 is not the case, Exim does not accept the looked up name(s), and
12783 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12784 IP address (for example, the existence of a PTR record in the DNS) is not
12785 sufficient on its own for the success of a host name lookup. If the reverse
12786 lookup succeeds, but there is a lookup problem such as a timeout when checking
12787 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12788 &"1"&. See also &$sender_host_name$&.
12789
12790 .cindex authentication "expansion item"
12791 Performing these checks sets up information used by the
12792 &%authresults%& expansion item.
12793
12794
12795 .vitem &$host_lookup_failed$&
12796 .vindex "&$host_lookup_failed$&"
12797 See &$host_lookup_deferred$&.
12798
12799 .vitem &$host_port$&
12800 .vindex "&$host_port$&"
12801 This variable is set to the remote host's TCP port whenever &$host$& is set
12802 for an outbound connection.
12803
12804 .vitem &$initial_cwd$&
12805 .vindex "&$initial_cwd$&
12806 This variable contains the full path name of the initial working
12807 directory of the current Exim process. This may differ from the current
12808 working directory, as Exim changes this to "/" during early startup, and
12809 to &$spool_directory$& later.
12810
12811 .vitem &$inode$&
12812 .vindex "&$inode$&"
12813 The only time this variable is set is while expanding the &%directory_file%&
12814 option in the &(appendfile)& transport. The variable contains the inode number
12815 of the temporary file which is about to be renamed. It can be used to construct
12816 a unique name for the file.
12817
12818 .vitem &$interface_address$& &&&
12819        &$interface_port$&
12820 .vindex "&$interface_address$&"
12821 .vindex "&$interface_port$&"
12822 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12823
12824 .vitem &$item$&
12825 .vindex "&$item$&"
12826 This variable is used during the expansion of &*forall*& and &*forany*&
12827 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12828 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12829 empty.
12830
12831 .vitem &$ldap_dn$&
12832 .vindex "&$ldap_dn$&"
12833 This variable, which is available only when Exim is compiled with LDAP support,
12834 contains the DN from the last entry in the most recently successful LDAP
12835 lookup.
12836
12837 .vitem &$load_average$&
12838 .vindex "&$load_average$&"
12839 This variable contains the system load average, multiplied by 1000 so that it
12840 is an integer. For example, if the load average is 0.21, the value of the
12841 variable is 210. The value is recomputed every time the variable is referenced.
12842
12843 .tvar &$local_part$&
12844 When an address is being routed, or delivered on its own, this
12845 variable contains the local part. When a number of addresses are being
12846 delivered together (for example, multiple RCPT commands in an SMTP
12847 session), &$local_part$& is not set.
12848
12849 Global address rewriting happens when a message is received, so the value of
12850 &$local_part$& during routing and delivery is the value after rewriting.
12851 &$local_part$& is set during user filtering, but not during system filtering,
12852 because a message may have many recipients and the system filter is called just
12853 once.
12854
12855 .cindex "tainted data"
12856 If the origin of the data is an incoming message,
12857 the result of expanding this variable is tainted and
12858 may not be further expanded or used as a filename.
12859
12860 &*Warning*&: the content of this variable is usually provided by a potential
12861 attacker.
12862 Consider carefully the implications of using it unvalidated as a name
12863 for file access.
12864 This presents issues for users' &_.forward_& and filter files.
12865 For traditional full user accounts, use &%check_local_users%& and the
12866 &$local_part_data$& variable rather than this one.
12867 For virtual users, store a suitable pathname component in the database
12868 which is used for account name validation, and use that retrieved value
12869 rather than this variable.
12870 Often &$local_part_data$& is usable in this role.
12871 If needed, use a router &%address_data%& or &%set%& option for
12872 the retrieved data.
12873
12874 When a message is being delivered to a file, pipe, or autoreply transport as a
12875 result of aliasing or forwarding, &$local_part$& is set to the local part of
12876 the parent address, not to the filename or command (see &$address_file$& and
12877 &$address_pipe$&).
12878
12879 When an ACL is running for a RCPT command, &$local_part$& contains the
12880 local part of the recipient address.
12881
12882 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12883 &$local_part$& contains the local part of the address that is being rewritten;
12884 it can be used in the expansion of the replacement address, for example.
12885
12886 In all cases, all quoting is removed from the local part. For example, for both
12887 the addresses
12888 .code
12889 "abc:xyz"@test.example
12890 abc\:xyz@test.example
12891 .endd
12892 the value of &$local_part$& is
12893 .code
12894 abc:xyz
12895 .endd
12896 If you use &$local_part$& to create another address, you should always wrap it
12897 inside a quoting operator. For example, in a &(redirect)& router you could
12898 have:
12899 .code
12900 data = ${quote_local_part:$local_part}@new.domain.example
12901 .endd
12902 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12903 to process local parts in a case-dependent manner in a router, you can set the
12904 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12905
12906 .vitem &$local_part_data$&
12907 .vindex "&$local_part_data$&"
12908 When the &%local_parts%& condition on a router or ACL
12909 matches a local part list
12910 the match value is copied to &$local_part_data$&.
12911 This is an enhancement over previous versions of Exim, when it only
12912 applied to the data read by a lookup.
12913 For details on match values see section &<<SECTlistresults>>& et. al.
12914
12915 The &%check_local_user%& router option also sets this variable.
12916
12917 .vindex &$local_part_prefix$& &&&
12918         &$local_part_prefix_v$& &&&
12919         &$local_part_suffix$& &&&
12920         &$local_part_suffix_v$&
12921 .cindex affix variables
12922 If a local part prefix or suffix has been recognized, it is not included in the
12923 value of &$local_part$& during routing and subsequent delivery. The values of
12924 any prefix or suffix are in &$local_part_prefix$& and
12925 &$local_part_suffix$&, respectively.
12926 .cindex "tainted data"
12927 If the specification did not include a wildcard then
12928 the affix variable value is not tainted.
12929
12930 If the affix specification included a wildcard then the portion of
12931 the affix matched by the wildcard is in
12932 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12933 and both the whole and varying values are tainted.
12934
12935 .vitem &$local_scan_data$&
12936 .vindex "&$local_scan_data$&"
12937 This variable contains the text returned by the &[local_scan()]& function when
12938 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12939
12940 .vitem &$local_user_gid$&
12941 .vindex "&$local_user_gid$&"
12942 See &$local_user_uid$&.
12943
12944 .vitem &$local_user_uid$&
12945 .vindex "&$local_user_uid$&"
12946 This variable and &$local_user_gid$& are set to the uid and gid after the
12947 &%check_local_user%& router precondition succeeds. This means that their values
12948 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12949 and &%condition%&), for the &%address_data%& expansion, and for any
12950 router-specific expansions. At all other times, the values in these variables
12951 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12952
12953 .vitem &$localhost_number$&
12954 .vindex "&$localhost_number$&"
12955 This contains the expanded value of the
12956 &%localhost_number%& option. The expansion happens after the main options have
12957 been read.
12958
12959 .vitem &$log_inodes$&
12960 .vindex "&$log_inodes$&"
12961 The number of free inodes in the disk partition where Exim's
12962 log files are being written. The value is recalculated whenever the variable is
12963 referenced. If the relevant file system does not have the concept of inodes,
12964 the value of is -1. See also the &%check_log_inodes%& option.
12965
12966 .vitem &$log_space$&
12967 .vindex "&$log_space$&"
12968 The amount of free space (as a number of kilobytes) in the disk
12969 partition where Exim's log files are being written. The value is recalculated
12970 whenever the variable is referenced. If the operating system does not have the
12971 ability to find the amount of free space (only true for experimental systems),
12972 the space value is -1. See also the &%check_log_space%& option.
12973
12974
12975 .vitem &$lookup_dnssec_authenticated$&
12976 .vindex "&$lookup_dnssec_authenticated$&"
12977 This variable is set after a DNS lookup done by
12978 a dnsdb lookup expansion, dnslookup router or smtp transport.
12979 .cindex "DNS" "DNSSEC"
12980 It will be empty if &(DNSSEC)& was not requested,
12981 &"no"& if the result was not labelled as authenticated data
12982 and &"yes"& if it was.
12983 Results that are labelled as authoritative answer that match
12984 the &%dns_trust_aa%& configuration variable count also
12985 as authenticated data.
12986
12987 .vitem &$mailstore_basename$&
12988 .vindex "&$mailstore_basename$&"
12989 This variable is set only when doing deliveries in &"mailstore"& format in the
12990 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12991 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12992 contains the basename of the files that are being written, that is, the name
12993 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12994 variable is empty.
12995
12996 .vitem &$malware_name$&
12997 .vindex "&$malware_name$&"
12998 This variable is available when Exim is compiled with the
12999 content-scanning extension. It is set to the name of the virus that was found
13000 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13001
13002 .vitem &$max_received_linelength$&
13003 .vindex "&$max_received_linelength$&"
13004 .cindex "maximum" "line length"
13005 .cindex "line length" "maximum"
13006 This variable contains the number of bytes in the longest line that was
13007 received as part of the message, not counting the line termination
13008 character(s).
13009 It is not valid if the &%spool_wireformat%& option is used.
13010
13011 .vitem &$message_age$&
13012 .cindex "message" "age of"
13013 .vindex "&$message_age$&"
13014 This variable is set at the start of a delivery attempt to contain the number
13015 of seconds since the message was received. It does not change during a single
13016 delivery attempt.
13017
13018 .tvar &$message_body$&
13019 .cindex "body of message" "expansion variable"
13020 .cindex "message body" "in expansion"
13021 .cindex "binary zero" "in message body"
13022 .oindex "&%message_body_visible%&"
13023 This variable contains the initial portion of a message's body while it is
13024 being delivered, and is intended mainly for use in filter files. The maximum
13025 number of characters of the body that are put into the variable is set by the
13026 &%message_body_visible%& configuration option; the default is 500.
13027
13028 .oindex "&%message_body_newlines%&"
13029 By default, newlines are converted into spaces in &$message_body$&, to make it
13030 easier to search for phrases that might be split over a line break. However,
13031 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13032 zeros are always converted into spaces.
13033
13034 .tvar &$message_body_end$&
13035 .cindex "body of message" "expansion variable"
13036 .cindex "message body" "in expansion"
13037 This variable contains the final portion of a message's
13038 body while it is being delivered. The format and maximum size are as for
13039 &$message_body$&.
13040
13041 .vitem &$message_body_size$&
13042 .cindex "body of message" "size"
13043 .cindex "message body" "size"
13044 .vindex "&$message_body_size$&"
13045 When a message is being delivered, this variable contains the size of the body
13046 in bytes. The count starts from the character after the blank line that
13047 separates the body from the header. Newlines are included in the count. See
13048 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13049
13050 If the spool file is wireformat
13051 (see the &%spool_wireformat%& main option)
13052 the CRLF line-terminators are included in the count.
13053
13054 .vitem &$message_exim_id$&
13055 .vindex "&$message_exim_id$&"
13056 When a message is being received or delivered, this variable contains the
13057 unique message id that is generated and used by Exim to identify the message.
13058 An id is not created for a message until after its header has been successfully
13059 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13060 line; it is the local id that Exim assigns to the message, for example:
13061 &`1BXTIK-0001yO-VA`&.
13062
13063 .tvar &$message_headers$&
13064 This variable contains a concatenation of all the header lines when a message
13065 is being processed, except for lines added by routers or transports. The header
13066 lines are separated by newline characters. Their contents are decoded in the
13067 same way as a header line that is inserted by &%bheader%&.
13068
13069 .tvar &$message_headers_raw$&
13070 This variable is like &$message_headers$& except that no processing of the
13071 contents of header lines is done.
13072
13073 .vitem &$message_id$&
13074 This is an old name for &$message_exim_id$&. It is now deprecated.
13075
13076 .vitem &$message_linecount$&
13077 .vindex "&$message_linecount$&"
13078 This variable contains the total number of lines in the header and body of the
13079 message. Compare &$body_linecount$&, which is the count for the body only.
13080 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13081 number of lines received. Before delivery happens (that is, before filters,
13082 routers, and transports run) the count is increased to include the
13083 &'Received:'& header line that Exim standardly adds, and also any other header
13084 lines that are added by ACLs. The blank line that separates the message header
13085 from the body is not counted.
13086
13087 As with the special case of &$message_size$&, during the expansion of the
13088 appendfile transport's maildir_tag option in maildir format, the value of
13089 &$message_linecount$& is the precise size of the number of newlines in the
13090 file that has been written (minus one for the blank line between the
13091 header and the body).
13092
13093 Here is an example of the use of this variable in a DATA ACL:
13094 .code
13095 deny condition = \
13096       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13097      message   = Too many lines in message header
13098 .endd
13099 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13100 message has not yet been received.
13101
13102 This variable is not valid if the &%spool_wireformat%& option is used.
13103
13104 .vitem &$message_size$&
13105 .cindex "size" "of message"
13106 .cindex "message" "size"
13107 .vindex "&$message_size$&"
13108 When a message is being processed, this variable contains its size in bytes. In
13109 most cases, the size includes those headers that were received with the
13110 message, but not those (such as &'Envelope-to:'&) that are added to individual
13111 deliveries as they are written. However, there is one special case: during the
13112 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13113 doing a delivery in maildir format, the value of &$message_size$& is the
13114 precise size of the file that has been written. See also
13115 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13116
13117 .cindex "RCPT" "value of &$message_size$&"
13118 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13119 contains the size supplied on the MAIL command, or -1 if no size was given. The
13120 value may not, of course, be truthful.
13121
13122 .vitem &$mime_anomaly_level$& &&&
13123        &$mime_anomaly_text$& &&&
13124        &$mime_boundary$& &&&
13125        &$mime_charset$& &&&
13126        &$mime_content_description$& &&&
13127        &$mime_content_disposition$& &&&
13128        &$mime_content_id$& &&&
13129        &$mime_content_size$& &&&
13130        &$mime_content_transfer_encoding$& &&&
13131        &$mime_content_type$& &&&
13132        &$mime_decoded_filename$& &&&
13133        &$mime_filename$& &&&
13134        &$mime_is_coverletter$& &&&
13135        &$mime_is_multipart$& &&&
13136        &$mime_is_rfc822$& &&&
13137        &$mime_part_count$&
13138 A number of variables whose names start with &$mime$& are
13139 available when Exim is compiled with the content-scanning extension. For
13140 details, see section &<<SECTscanmimepart>>&.
13141
13142 .vitem "&$n0$& &-- &$n9$&"
13143 These variables are counters that can be incremented by means
13144 of the &%add%& command in filter files.
13145
13146 .tvar &$original_domain$&
13147 .vindex "&$domain$&"
13148 When a top-level address is being processed for delivery, this contains the
13149 same value as &$domain$&. However, if a &"child"& address (for example,
13150 generated by an alias, forward, or filter file) is being processed, this
13151 variable contains the domain of the original address (lower cased). This
13152 differs from &$parent_domain$& only when there is more than one level of
13153 aliasing or forwarding. When more than one address is being delivered in a
13154 single transport run, &$original_domain$& is not set.
13155
13156 If a new address is created by means of a &%deliver%& command in a system
13157 filter, it is set up with an artificial &"parent"& address. This has the local
13158 part &'system-filter'& and the default qualify domain.
13159
13160 .tvar &$original_local_part$&
13161 .vindex "&$local_part$&"
13162 When a top-level address is being processed for delivery, this contains the
13163 same value as &$local_part$&, unless a prefix or suffix was removed from the
13164 local part, because &$original_local_part$& always contains the full local
13165 part. When a &"child"& address (for example, generated by an alias, forward, or
13166 filter file) is being processed, this variable contains the full local part of
13167 the original address.
13168
13169 If the router that did the redirection processed the local part
13170 case-insensitively, the value in &$original_local_part$& is in lower case.
13171 This variable differs from &$parent_local_part$& only when there is more than
13172 one level of aliasing or forwarding. When more than one address is being
13173 delivered in a single transport run, &$original_local_part$& is not set.
13174
13175 If a new address is created by means of a &%deliver%& command in a system
13176 filter, it is set up with an artificial &"parent"& address. This has the local
13177 part &'system-filter'& and the default qualify domain.
13178
13179 .vitem &$originator_gid$&
13180 .cindex "gid (group id)" "of originating user"
13181 .cindex "sender" "gid"
13182 .vindex "&$caller_gid$&"
13183 .vindex "&$originator_gid$&"
13184 This variable contains the value of &$caller_gid$& that was set when the
13185 message was received. For messages received via the command line, this is the
13186 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13187 normally the gid of the Exim user.
13188
13189 .vitem &$originator_uid$&
13190 .cindex "uid (user id)" "of originating user"
13191 .cindex "sender" "uid"
13192 .vindex "&$caller_uid$&"
13193 .vindex "&$originator_uid$&"
13194 The value of &$caller_uid$& that was set when the message was received. For
13195 messages received via the command line, this is the uid of the sending user.
13196 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13197 user.
13198
13199 .tvar &$parent_domain$&
13200 This variable is similar to &$original_domain$& (see
13201 above), except that it refers to the immediately preceding parent address.
13202
13203 .tvar &$parent_local_part$&
13204 This variable is similar to &$original_local_part$&
13205 (see above), except that it refers to the immediately preceding parent address.
13206
13207 .vitem &$pid$&
13208 .cindex "pid (process id)" "of current process"
13209 .vindex "&$pid$&"
13210 This variable contains the current process id.
13211
13212 .vitem &$pipe_addresses$&
13213 .cindex "filter" "transport filter"
13214 .cindex "transport" "filter"
13215 .vindex "&$pipe_addresses$&"
13216 This is not an expansion variable, but is mentioned here because the string
13217 &`$pipe_addresses`& is handled specially in the command specification for the
13218 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13219 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13220 It cannot be used in general expansion strings, and provokes an &"unknown
13221 variable"& error if encountered.
13222 &*Note*&: This value permits data supplied by a potential attacker to
13223 be used in the command for a &(pipe)& transport.
13224 Such configurations should be carefully assessed for security vulnerbilities.
13225
13226 .vitem &$primary_hostname$&
13227 .vindex "&$primary_hostname$&"
13228 This variable contains the value set by &%primary_hostname%& in the
13229 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13230 a single-component name, Exim calls &[gethostbyname()]& (or
13231 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13232 qualified host name. See also &$smtp_active_hostname$&.
13233
13234
13235 .vitem &$proxy_external_address$& &&&
13236        &$proxy_external_port$& &&&
13237        &$proxy_local_address$& &&&
13238        &$proxy_local_port$& &&&
13239        &$proxy_session$&
13240 These variables are only available when built with Proxy Protocol
13241 or SOCKS5 support.
13242 For details see chapter &<<SECTproxyInbound>>&.
13243
13244 .vitem &$prdr_requested$&
13245 .cindex "PRDR" "variable for"
13246 This variable is set to &"yes"& if PRDR was requested by the client for the
13247 current message, otherwise &"no"&.
13248
13249 .vitem &$prvscheck_address$& &&&
13250        &$prvscheck_keynum$& &&&
13251        &$prvscheck_result$&
13252 These variables are used in conjunction with the &%prvscheck%& expansion item,
13253 which is described in sections &<<SECTexpansionitems>>& and
13254 &<<SECTverifyPRVS>>&.
13255
13256 .vitem &$qualify_domain$&
13257 .vindex "&$qualify_domain$&"
13258 The value set for the &%qualify_domain%& option in the configuration file.
13259
13260 .vitem &$qualify_recipient$&
13261 .vindex "&$qualify_recipient$&"
13262 The value set for the &%qualify_recipient%& option in the configuration file,
13263 or if not set, the value of &$qualify_domain$&.
13264
13265 .vitem &$queue_name$&
13266 .vindex &$queue_name$&
13267 .cindex "named queues" variable
13268 .cindex queues named
13269 The name of the spool queue in use; empty for the default queue.
13270
13271 .vitem &$queue_size$&
13272 .vindex "&$queue_size$&"
13273 .cindex "queue" "size of"
13274 .cindex "spool" "number of messages"
13275 This variable contains the number of messages queued.
13276 It is evaluated on demand, but no more often than once every minute.
13277 If there is no daemon notifier socket open, the value will be
13278 an empty string.
13279
13280 .vitem &$r_...$&
13281 .vindex &$r_...$&
13282 .cindex router variables
13283 Values can be placed in these variables by the &%set%& option of a router.
13284 They can be given any name that starts with &$r_$&.
13285 The values persist for the address being handled through subsequent routers
13286 and the eventual transport.
13287
13288 .vitem &$rcpt_count$&
13289 .vindex "&$rcpt_count$&"
13290 When a message is being received by SMTP, this variable contains the number of
13291 RCPT commands received for the current message. If this variable is used in a
13292 RCPT ACL, its value includes the current command.
13293
13294 .vitem &$rcpt_defer_count$&
13295 .vindex "&$rcpt_defer_count$&"
13296 .cindex "4&'xx'& responses" "count of"
13297 When a message is being received by SMTP, this variable contains the number of
13298 RCPT commands in the current message that have previously been rejected with a
13299 temporary (4&'xx'&) response.
13300
13301 .vitem &$rcpt_fail_count$&
13302 .vindex "&$rcpt_fail_count$&"
13303 When a message is being received by SMTP, this variable contains the number of
13304 RCPT commands in the current message that have previously been rejected with a
13305 permanent (5&'xx'&) response.
13306
13307 .vitem &$received_count$&
13308 .vindex "&$received_count$&"
13309 This variable contains the number of &'Received:'& header lines in the message,
13310 including the one added by Exim (so its value is always greater than zero). It
13311 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13312 delivering.
13313
13314 .tvar &$received_for$&
13315 If there is only a single recipient address in an incoming message, this
13316 variable contains that address when the &'Received:'& header line is being
13317 built. The value is copied after recipient rewriting has happened, but before
13318 the &[local_scan()]& function is run.
13319
13320 .vitem &$received_ip_address$& &&&
13321        &$received_port$&
13322 .vindex "&$received_ip_address$&"
13323 .vindex "&$received_port$&"
13324 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13325 variables are set to the address and port on the local IP interface.
13326 (The remote IP address and port are in
13327 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13328 the port value is -1 unless it has been set using the &%-oMi%& command line
13329 option.
13330
13331 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13332 could be used, for example, to make the filename for a TLS certificate depend
13333 on which interface and/or port is being used for the incoming connection. The
13334 values of &$received_ip_address$& and &$received_port$& are saved with any
13335 messages that are received, thus making these variables available at delivery
13336 time.
13337 For outbound connections see &$sending_ip_address$&.
13338
13339 .vitem &$received_protocol$&
13340 .vindex "&$received_protocol$&"
13341 When a message is being processed, this variable contains the name of the
13342 protocol by which it was received. Most of the names used by Exim are defined
13343 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13344 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13345 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13346 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13347 connection and the client was successfully authenticated.
13348
13349 Exim uses the protocol name &"smtps"& for the case when encryption is
13350 automatically set up on connection without the use of STARTTLS (see
13351 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13352 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13353 where the client initially uses EHLO, sets up an encrypted connection using
13354 STARTTLS, and then uses HELO afterwards.
13355
13356 The &%-oMr%& option provides a way of specifying a custom protocol name for
13357 messages that are injected locally by trusted callers. This is commonly used to
13358 identify messages that are being re-injected after some kind of scanning.
13359
13360 .vitem &$received_time$&
13361 .vindex "&$received_time$&"
13362 This variable contains the date and time when the current message was received,
13363 as a number of seconds since the start of the Unix epoch.
13364
13365 .vitem &$recipient_data$&
13366 .vindex "&$recipient_data$&"
13367 This variable is set after an indexing lookup success in an ACL &%recipients%&
13368 condition. It contains the data from the lookup, and the value remains set
13369 until the next &%recipients%& test. Thus, you can do things like this:
13370 .display
13371 &`require recipients  = cdb*@;/some/file`&
13372 &`deny    `&&'some further test involving'& &`$recipient_data`&
13373 .endd
13374 &*Warning*&: This variable is set only when a lookup is used as an indexing
13375 method in the address list, using the semicolon syntax as in the example above.
13376 The variable is not set for a lookup that is used as part of the string
13377 expansion that all such lists undergo before being interpreted.
13378
13379 .vitem &$recipient_verify_failure$&
13380 .vindex "&$recipient_verify_failure$&"
13381 In an ACL, when a recipient verification fails, this variable contains
13382 information about the failure. It is set to one of the following words:
13383
13384 .ilist
13385 &"qualify"&: The address was unqualified (no domain), and the message
13386 was neither local nor came from an exempted host.
13387
13388 .next
13389 &"route"&: Routing failed.
13390
13391 .next
13392 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13393 or before the MAIL command (that is, on initial connection, HELO, or
13394 MAIL).
13395
13396 .next
13397 &"recipient"&: The RCPT command in a callout was rejected.
13398 .next
13399
13400 &"postmaster"&: The postmaster check in a callout was rejected.
13401 .endlist
13402
13403 The main use of this variable is expected to be to distinguish between
13404 rejections of MAIL and rejections of RCPT.
13405
13406 .tvar &$recipients$&
13407 This variable contains a list of envelope recipients for a message. A comma and
13408 a space separate the addresses in the replacement text. However, the variable
13409 is not generally available, to prevent exposure of Bcc recipients in
13410 unprivileged users' filter files. You can use &$recipients$& only in these
13411 cases:
13412
13413 .olist
13414 In a system filter file.
13415 .next
13416 In the ACLs associated with the DATA command and with non-SMTP messages, that
13417 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13418 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13419 &%acl_not_smtp_mime%&.
13420 .next
13421 From within a &[local_scan()]& function.
13422 .endlist
13423
13424
13425 .vitem &$recipients_count$&
13426 .vindex "&$recipients_count$&"
13427 When a message is being processed, this variable contains the number of
13428 envelope recipients that came with the message. Duplicates are not excluded
13429 from the count. While a message is being received over SMTP, the number
13430 increases for each accepted recipient. It can be referenced in an ACL.
13431
13432
13433 .vitem &$regex_match_string$&
13434 .vindex "&$regex_match_string$&"
13435 This variable is set to contain the matching regular expression after a
13436 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13437
13438 .vitem "&$regex1$&, &$regex2$&, etc"
13439 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13440 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13441 these variables contain the
13442 captured substrings identified by the regular expression.
13443 If the subject string was tainted then so will any captured substring.
13444
13445
13446 .tvar &$reply_address$&
13447 When a message is being processed, this variable contains the contents of the
13448 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13449 contents of the &'From:'& header line. Apart from the removal of leading
13450 white space, the value is not processed in any way. In particular, no RFC 2047
13451 decoding or character code translation takes place.
13452
13453 .vitem &$return_path$&
13454 .vindex "&$return_path$&"
13455 When a message is being delivered, this variable contains the return path &--
13456 the sender field that will be sent as part of the envelope. It is not enclosed
13457 in <> characters. At the start of routing an address, &$return_path$& has the
13458 same value as &$sender_address$&, but if, for example, an incoming message to a
13459 mailing list has been expanded by a router which specifies a different address
13460 for bounce messages, &$return_path$& subsequently contains the new bounce
13461 address, whereas &$sender_address$& always contains the original sender address
13462 that was received with the message. In other words, &$sender_address$& contains
13463 the incoming envelope sender, and &$return_path$& contains the outgoing
13464 envelope sender.
13465
13466 .vitem &$return_size_limit$&
13467 .vindex "&$return_size_limit$&"
13468 This is an obsolete name for &$bounce_return_size_limit$&.
13469
13470 .vitem &$router_name$&
13471 .cindex "router" "name"
13472 .cindex "name" "of router"
13473 .vindex "&$router_name$&"
13474 During the running of a router, or a transport called,
13475 this variable contains the router name.
13476
13477 .vitem &$runrc$&
13478 .cindex "return code" "from &%run%& expansion"
13479 .vindex "&$runrc$&"
13480 This variable contains the return code from a command that is run by the
13481 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13482 assume the order in which option values are expanded, except for those
13483 preconditions whose order of testing is documented. Therefore, you cannot
13484 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13485 another.
13486
13487 .vitem &$self_hostname$&
13488 .oindex "&%self%&" "value of host name"
13489 .vindex "&$self_hostname$&"
13490 When an address is routed to a supposedly remote host that turns out to be the
13491 local host, what happens is controlled by the &%self%& generic router option.
13492 One of its values causes the address to be passed to another router. When this
13493 happens, &$self_hostname$& is set to the name of the local host that the
13494 original router encountered. In other circumstances its contents are null.
13495
13496 .tvar &$sender_address$&
13497 When a message is being processed, this variable contains the sender's address
13498 that was received in the message's envelope. The case of letters in the address
13499 is retained, in both the local part and the domain. For bounce messages, the
13500 value of this variable is the empty string. See also &$return_path$&.
13501
13502 .vitem &$sender_address_data$&
13503 .vindex "&$address_data$&"
13504 .vindex "&$sender_address_data$&"
13505 If &$address_data$& is set when the routers are called from an ACL to verify a
13506 sender address, the final value is preserved in &$sender_address_data$&, to
13507 distinguish it from data from a recipient address. The value does not persist
13508 after the end of the current ACL statement. If you want to preserve it for
13509 longer, you can save it in an ACL variable.
13510
13511 .tvar &$sender_address_domain$&
13512 The domain portion of &$sender_address$&.
13513
13514 .tvar &$sender_address_local_part$&
13515 The local part portion of &$sender_address$&.
13516
13517 .vitem &$sender_data$&
13518 .vindex "&$sender_data$&"
13519 This variable is set after a lookup success in an ACL &%senders%& condition or
13520 in a router &%senders%& option. It contains the data from the lookup, and the
13521 value remains set until the next &%senders%& test. Thus, you can do things like
13522 this:
13523 .display
13524 &`require senders      = cdb*@;/some/file`&
13525 &`deny    `&&'some further test involving'& &`$sender_data`&
13526 .endd
13527 &*Warning*&: This variable is set only when a lookup is used as an indexing
13528 method in the address list, using the semicolon syntax as in the example above.
13529 The variable is not set for a lookup that is used as part of the string
13530 expansion that all such lists undergo before being interpreted.
13531
13532 .vitem &$sender_fullhost$&
13533 .vindex "&$sender_fullhost$&"
13534 When a message is received from a remote host, this variable contains the host
13535 name and IP address in a single string. It ends with the IP address in square
13536 brackets, followed by a colon and a port number if the logging of ports is
13537 enabled. The format of the rest of the string depends on whether the host
13538 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13539 looking up its IP address. (Looking up the IP address can be forced by the
13540 &%host_lookup%& option, independent of verification.) A plain host name at the
13541 start of the string is a verified host name; if this is not present,
13542 verification either failed or was not requested. A host name in parentheses is
13543 the argument of a HELO or EHLO command. This is omitted if it is identical to
13544 the verified host name or to the host's IP address in square brackets.
13545
13546 .vitem &$sender_helo_dnssec$&
13547 .vindex "&$sender_helo_dnssec$&"
13548 This boolean variable is true if a successful HELO verification was
13549 .cindex "DNS" "DNSSEC"
13550 done using DNS information the resolver library stated was authenticated data.
13551
13552 .tvar &$sender_helo_name$&
13553 When a message is received from a remote host that has issued a HELO or EHLO
13554 command, the argument of that command is placed in this variable. It is also
13555 set if HELO or EHLO is used when a message is received using SMTP locally via
13556 the &%-bs%& or &%-bS%& options.
13557
13558 .vitem &$sender_host_address$&
13559 .vindex "&$sender_host_address$&"
13560 When a message is received from a remote host using SMTP,
13561 this variable contains that
13562 host's IP address. For locally non-SMTP submitted messages, it is empty.
13563
13564 .vitem &$sender_host_authenticated$&
13565 .vindex "&$sender_host_authenticated$&"
13566 This variable contains the name (not the public name) of the authenticator
13567 driver that successfully authenticated the client from which the message was
13568 received. It is empty if there was no successful authentication. See also
13569 &$authenticated_id$&.
13570
13571 .vitem &$sender_host_dnssec$&
13572 .vindex "&$sender_host_dnssec$&"
13573 If an attempt to populate &$sender_host_name$& has been made
13574 (by reference, &%hosts_lookup%& or
13575 otherwise) then this boolean will have been set true if, and only if, the
13576 resolver library states that both
13577 the reverse and forward DNS were authenticated data.  At all
13578 other times, this variable is false.
13579
13580 .cindex "DNS" "DNSSEC"
13581 It is likely that you will need to coerce DNSSEC support on in the resolver
13582 library, by setting:
13583 .code
13584 dns_dnssec_ok = 1
13585 .endd
13586
13587 In addition, on Linux with glibc 2.31 or newer the resolver library will
13588 default to stripping out a successful validation status.
13589 This will break a previously working Exim installation.
13590 Provided that you do trust the resolver (ie, is on localhost) you can tell
13591 glibc to pass through any successful validation with a new option in
13592 &_/etc/resolv.conf_&:
13593 .code
13594 options trust-ad
13595 .endd
13596
13597 Exim does not perform DNSSEC validation itself, instead leaving that to a
13598 validating resolver (e.g. unbound, or bind with suitable configuration).
13599
13600 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13601 mechanism in the list, then this variable will be false.
13602
13603 This requires that your system resolver library support EDNS0 (and that
13604 DNSSEC flags exist in the system headers).  If the resolver silently drops
13605 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13606 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13607
13608
13609 .tvar &$sender_host_name$&
13610 When a message is received from a remote host, this variable contains the
13611 host's name as obtained by looking up its IP address. For messages received by
13612 other means, this variable is empty.
13613
13614 .vindex "&$host_lookup_failed$&"
13615 If the host name has not previously been looked up, a reference to
13616 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13617 A looked up name is accepted only if it leads back to the original IP address
13618 via a forward lookup. If either the reverse or the forward lookup fails to find
13619 any data, or if the forward lookup does not yield the original IP address,
13620 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13621
13622 .vindex "&$host_lookup_deferred$&"
13623 However, if either of the lookups cannot be completed (for example, there is a
13624 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13625 &$host_lookup_failed$& remains set to &"0"&.
13626
13627 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13628 host name again if there is a subsequent reference to &$sender_host_name$&
13629 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13630 is set to &"1"&.
13631
13632 Exim does not automatically look up every calling host's name. If you want
13633 maximum efficiency, you should arrange your configuration so that it avoids
13634 these lookups altogether. The lookup happens only if one or more of the
13635 following are true:
13636
13637 .ilist
13638 A string containing &$sender_host_name$& is expanded.
13639 .next
13640 The calling host matches the list in &%host_lookup%&. In the default
13641 configuration, this option is set to *, so it must be changed if lookups are
13642 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13643 .next
13644 Exim needs the host name in order to test an item in a host list. The items
13645 that require this are described in sections &<<SECThoslispatnam>>& and
13646 &<<SECThoslispatnamsk>>&.
13647 .next
13648 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13649 In this case, the host name is required to compare with the name quoted in any
13650 EHLO or HELO commands that the client issues.
13651 .next
13652 The remote host issues a EHLO or HELO command that quotes one of the
13653 domains in &%helo_lookup_domains%&. The default value of this option is
13654 . ==== As this is a nested list, any displays it contains must be indented
13655 . ==== as otherwise they are too far to the left.
13656 .code
13657   helo_lookup_domains = @ : @[]
13658 .endd
13659 which causes a lookup if a remote host (incorrectly) gives the server's name or
13660 IP address in an EHLO or HELO command.
13661 .endlist
13662
13663
13664 .vitem &$sender_host_port$&
13665 .vindex "&$sender_host_port$&"
13666 When a message is received from a remote host, this variable contains the port
13667 number that was used on the remote host.
13668
13669 .vitem &$sender_ident$&
13670 .vindex "&$sender_ident$&"
13671 When a message is received from a remote host, this variable contains the
13672 identification received in response to an RFC 1413 request. When a message has
13673 been received locally, this variable contains the login name of the user that
13674 called Exim.
13675
13676 .vitem &$sender_rate_$&&'xxx'&
13677 A number of variables whose names begin &$sender_rate_$& are set as part of the
13678 &%ratelimit%& ACL condition. Details are given in section
13679 &<<SECTratelimiting>>&.
13680
13681 .vitem &$sender_rcvhost$&
13682 .cindex "DNS" "reverse lookup"
13683 .cindex "reverse DNS lookup"
13684 .vindex "&$sender_rcvhost$&"
13685 This is provided specifically for use in &'Received:'& headers. It starts with
13686 either the verified host name (as obtained from a reverse DNS lookup) or, if
13687 there is no verified host name, the IP address in square brackets. After that
13688 there may be text in parentheses. When the first item is a verified host name,
13689 the first thing in the parentheses is the IP address in square brackets,
13690 followed by a colon and a port number if port logging is enabled. When the
13691 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13692 the parentheses.
13693
13694 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13695 was used and its argument was not identical to the real host name or IP
13696 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13697 all three items are present in the parentheses, a newline and tab are inserted
13698 into the string, to improve the formatting of the &'Received:'& header.
13699
13700 .vitem &$sender_verify_failure$&
13701 .vindex "&$sender_verify_failure$&"
13702 In an ACL, when a sender verification fails, this variable contains information
13703 about the failure. The details are the same as for
13704 &$recipient_verify_failure$&.
13705
13706 .vitem &$sending_ip_address$&
13707 .vindex "&$sending_ip_address$&"
13708 This variable is set whenever an outgoing SMTP connection to another host has
13709 been set up. It contains the IP address of the local interface that is being
13710 used. This is useful if a host that has more than one IP address wants to take
13711 on different personalities depending on which one is being used. For incoming
13712 connections, see &$received_ip_address$&.
13713
13714 .vitem &$sending_port$&
13715 .vindex "&$sending_port$&"
13716 This variable is set whenever an outgoing SMTP connection to another host has
13717 been set up. It contains the local port that is being used. For incoming
13718 connections, see &$received_port$&.
13719
13720 .vitem &$smtp_active_hostname$&
13721 .vindex "&$smtp_active_hostname$&"
13722 During an incoming SMTP session, this variable contains the value of the active
13723 host name, as specified by the &%smtp_active_hostname%& option. The value of
13724 &$smtp_active_hostname$& is saved with any message that is received, so its
13725 value can be consulted during routing and delivery.
13726
13727 .tvar &$smtp_command$&
13728 During the processing of an incoming SMTP command, this variable contains the
13729 entire command. This makes it possible to distinguish between HELO and EHLO in
13730 the HELO ACL, and also to distinguish between commands such as these:
13731 .code
13732 MAIL FROM:<>
13733 MAIL FROM: <>
13734 .endd
13735 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13736 command, the address in &$smtp_command$& is the original address before any
13737 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13738 the address after SMTP-time rewriting.
13739
13740 .tvar &$smtp_command_argument$&
13741 .cindex "SMTP" "command, argument for"
13742 While an ACL is running to check an SMTP command, this variable contains the
13743 argument, that is, the text that follows the command name, with leading white
13744 space removed. Following the introduction of &$smtp_command$&, this variable is
13745 somewhat redundant, but is retained for backwards compatibility.
13746
13747 .vitem &$smtp_command_history$&
13748 .cindex SMTP "command history"
13749 .vindex "&$smtp_command_history$&"
13750 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13751 received, in time-order left to right.  Only a limited number of commands
13752 are remembered.
13753
13754 .vitem &$smtp_count_at_connection_start$&
13755 .vindex "&$smtp_count_at_connection_start$&"
13756 This variable is set greater than zero only in processes spawned by the Exim
13757 daemon for handling incoming SMTP connections. The name is deliberately long,
13758 in order to emphasize what the contents are. When the daemon accepts a new
13759 connection, it increments this variable. A copy of the variable is passed to
13760 the child process that handles the connection, but its value is fixed, and
13761 never changes. It is only an approximation of how many incoming connections
13762 there actually are, because many other connections may come and go while a
13763 single connection is being processed. When a child process terminates, the
13764 daemon decrements its copy of the variable.
13765
13766 .vitem &$smtp_notquit_reason$&
13767 .vindex "&$smtp_notquit_reason$&"
13768 When the not-QUIT ACL is running, this variable is set to a string
13769 that indicates the reason for the termination of the SMTP connection.
13770
13771 .vitem "&$sn0$& &-- &$sn9$&"
13772 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13773 that were current at the end of the system filter file. This allows a system
13774 filter file to set values that can be tested in users' filter files. For
13775 example, a system filter could set a value indicating how likely it is that a
13776 message is junk mail.
13777
13778 .vitem &$spam_score$& &&&
13779        &$spam_score_int$& &&&
13780        &$spam_bar$& &&&
13781        &$spam_report$& &&&
13782        &$spam_action$&
13783 A number of variables whose names start with &$spam$& are available when Exim
13784 is compiled with the content-scanning extension. For details, see section
13785 &<<SECTscanspamass>>&.
13786
13787 .vitem &$spf_header_comment$& &&&
13788        &$spf_received$& &&&
13789        &$spf_result$& &&&
13790        &$spf_result_guessed$& &&&
13791        &$spf_smtp_comment$&
13792 These variables are only available if Exim is built with SPF support.
13793 For details see section &<<SECSPF>>&.
13794
13795 .vitem &$spool_directory$&
13796 .vindex "&$spool_directory$&"
13797 The name of Exim's spool directory.
13798
13799 .vitem &$spool_inodes$&
13800 .vindex "&$spool_inodes$&"
13801 The number of free inodes in the disk partition where Exim's spool files are
13802 being written. The value is recalculated whenever the variable is referenced.
13803 If the relevant file system does not have the concept of inodes, the value of
13804 is -1. See also the &%check_spool_inodes%& option.
13805
13806 .vitem &$spool_space$&
13807 .vindex "&$spool_space$&"
13808 The amount of free space (as a number of kilobytes) in the disk partition where
13809 Exim's spool files are being written. The value is recalculated whenever the
13810 variable is referenced. If the operating system does not have the ability to
13811 find the amount of free space (only true for experimental systems), the space
13812 value is -1. For example, to check in an ACL that there is at least 50
13813 megabytes free on the spool, you could write:
13814 .code
13815 condition = ${if > {$spool_space}{50000}}
13816 .endd
13817 See also the &%check_spool_space%& option.
13818
13819
13820 .vitem &$thisaddress$&
13821 .vindex "&$thisaddress$&"
13822 This variable is set only during the processing of the &%foranyaddress%&
13823 command in a filter file. Its use is explained in the description of that
13824 command, which can be found in the separate document entitled &'Exim's
13825 interfaces to mail filtering'&.
13826
13827 .vitem &$tls_in_bits$&
13828 .vindex "&$tls_in_bits$&"
13829 Contains an approximation of the TLS cipher's bit-strength
13830 on the inbound connection; the meaning of
13831 this depends upon the TLS implementation used.
13832 If TLS has not been negotiated, the value will be 0.
13833 The value of this is automatically fed into the Cyrus SASL authenticator
13834 when acting as a server, to specify the "external SSF" (a SASL term).
13835
13836 The deprecated &$tls_bits$& variable refers to the inbound side
13837 except when used in the context of an outbound SMTP delivery, when it refers to
13838 the outbound.
13839
13840 .vitem &$tls_out_bits$&
13841 .vindex "&$tls_out_bits$&"
13842 Contains an approximation of the TLS cipher's bit-strength
13843 on an outbound SMTP connection; the meaning of
13844 this depends upon the TLS implementation used.
13845 If TLS has not been negotiated, the value will be 0.
13846
13847 .vitem &$tls_in_ourcert$&
13848 .vindex "&$tls_in_ourcert$&"
13849 .cindex certificate variables
13850 This variable refers to the certificate presented to the peer of an
13851 inbound connection when the message was received.
13852 It is only useful as the argument of a
13853 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13854 or a &%def%& condition.
13855
13856 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13857 when a list of more than one
13858 file is used for &%tls_certificate%&, this variable is not reliable.
13859 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13860
13861 .vitem &$tls_in_peercert$&
13862 .vindex "&$tls_in_peercert$&"
13863 This variable refers to the certificate presented by the peer of an
13864 inbound connection when the message was received.
13865 It is only useful as the argument of a
13866 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13867 or a &%def%& condition.
13868 If certificate verification fails it may refer to a failing chain element
13869 which is not the leaf.
13870
13871 .vitem &$tls_out_ourcert$&
13872 .vindex "&$tls_out_ourcert$&"
13873 This variable refers to the certificate presented to the peer of an
13874 outbound connection.  It is only useful as the argument of a
13875 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13876 or a &%def%& condition.
13877
13878 .vitem &$tls_out_peercert$&
13879 .vindex "&$tls_out_peercert$&"
13880 This variable refers to the certificate presented by the peer of an
13881 outbound connection.  It is only useful as the argument of a
13882 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13883 or a &%def%& condition.
13884 If certificate verification fails it may refer to a failing chain element
13885 which is not the leaf.
13886
13887 .vitem &$tls_in_certificate_verified$&
13888 .vindex "&$tls_in_certificate_verified$&"
13889 This variable is set to &"1"& if a TLS certificate was verified when the
13890 message was received, and &"0"& otherwise.
13891
13892 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13893 except when used in the context of an outbound SMTP delivery, when it refers to
13894 the outbound.
13895
13896 .vitem &$tls_out_certificate_verified$&
13897 .vindex "&$tls_out_certificate_verified$&"
13898 This variable is set to &"1"& if a TLS certificate was verified when an
13899 outbound SMTP connection was made,
13900 and &"0"& otherwise.
13901
13902 .vitem &$tls_in_cipher$&
13903 .vindex "&$tls_in_cipher$&"
13904 .vindex "&$tls_cipher$&"
13905 When a message is received from a remote host over an encrypted SMTP
13906 connection, this variable is set to the cipher suite that was negotiated, for
13907 example DES-CBC3-SHA. In other circumstances, in particular, for message
13908 received over unencrypted connections, the variable is empty. Testing
13909 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13910 non-encrypted connections during ACL processing.
13911
13912 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13913 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13914 becomes the same as &$tls_out_cipher$&.
13915
13916 .vitem &$tls_in_cipher_std$&
13917 .vindex "&$tls_in_cipher_std$&"
13918 As above, but returning the RFC standard name for the cipher suite.
13919
13920 .vitem &$tls_out_cipher$&
13921 .vindex "&$tls_out_cipher$&"
13922 This variable is
13923 cleared before any outgoing SMTP connection is made,
13924 and then set to the outgoing cipher suite if one is negotiated. See chapter
13925 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13926 details of the &(smtp)& transport.
13927
13928 .vitem &$tls_out_cipher_std$&
13929 .vindex "&$tls_out_cipher_std$&"
13930 As above, but returning the RFC standard name for the cipher suite.
13931
13932 .vitem &$tls_out_dane$&
13933 .vindex &$tls_out_dane$&
13934 DANE active status.  See section &<<SECDANE>>&.
13935
13936 .vitem &$tls_in_ocsp$&
13937 .vindex "&$tls_in_ocsp$&"
13938 When a message is received from a remote client connection
13939 the result of any OCSP request from the client is encoded in this variable:
13940 .code
13941 0 OCSP proof was not requested (default value)
13942 1 No response to request
13943 2 Response not verified
13944 3 Verification failed
13945 4 Verification succeeded
13946 .endd
13947
13948 .vitem &$tls_out_ocsp$&
13949 .vindex "&$tls_out_ocsp$&"
13950 When a message is sent to a remote host connection
13951 the result of any OCSP request made is encoded in this variable.
13952 See &$tls_in_ocsp$& for values.
13953
13954 .vitem &$tls_in_peerdn$&
13955 .vindex "&$tls_in_peerdn$&"
13956 .vindex "&$tls_peerdn$&"
13957 .cindex certificate "extracting fields"
13958 When a message is received from a remote host over an encrypted SMTP
13959 connection, and Exim is configured to request a certificate from the client,
13960 the value of the Distinguished Name of the certificate is made available in the
13961 &$tls_in_peerdn$& during subsequent processing.
13962 If certificate verification fails it may refer to a failing chain element
13963 which is not the leaf.
13964
13965 The deprecated &$tls_peerdn$& variable refers to the inbound side
13966 except when used in the context of an outbound SMTP delivery, when it refers to
13967 the outbound.
13968
13969 .vitem &$tls_out_peerdn$&
13970 .vindex "&$tls_out_peerdn$&"
13971 When a message is being delivered to a remote host over an encrypted SMTP
13972 connection, and Exim is configured to request a certificate from the server,
13973 the value of the Distinguished Name of the certificate is made available in the
13974 &$tls_out_peerdn$& during subsequent processing.
13975 If certificate verification fails it may refer to a failing chain element
13976 which is not the leaf.
13977
13978
13979 .vitem &$tls_in_resumption$& &&&
13980        &$tls_out_resumption$&
13981 .vindex &$tls_in_resumption$&
13982 .vindex &$tls_out_resumption$&
13983 .cindex TLS resumption
13984 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13985
13986
13987 .tvar &$tls_in_sni$&
13988 .vindex "&$tls_sni$&"
13989 .cindex "TLS" "Server Name Indication"
13990 .cindex "TLS" SNI
13991 .cindex SNI "observability on server"
13992 When a TLS session is being established, if the client sends the Server
13993 Name Indication extension, the value will be placed in this variable.
13994 If the variable appears in &%tls_certificate%& then this option and
13995 some others, described in &<<SECTtlssni>>&,
13996 will be re-expanded early in the TLS session, to permit
13997 a different certificate to be presented (and optionally a different key to be
13998 used) to the client, based upon the value of the SNI extension.
13999
14000 The deprecated &$tls_sni$& variable refers to the inbound side
14001 except when used in the context of an outbound SMTP delivery, when it refers to
14002 the outbound.
14003
14004 .vitem &$tls_out_sni$&
14005 .vindex "&$tls_out_sni$&"
14006 .cindex "TLS" "Server Name Indication"
14007 .cindex "TLS" SNI
14008 .cindex SNI "observability in client"
14009 During outbound
14010 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14011 the transport.
14012
14013 .vitem &$tls_out_tlsa_usage$&
14014 .vindex &$tls_out_tlsa_usage$&
14015 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14016
14017 .vitem &$tls_in_ver$&
14018 .vindex "&$tls_in_ver$&"
14019 When a message is received from a remote host over an encrypted SMTP connection
14020 this variable is set to the protocol version, eg &'TLS1.2'&.
14021
14022 .vitem &$tls_out_ver$&
14023 .vindex "&$tls_out_ver$&"
14024 When a message is being delivered to a remote host over an encrypted SMTP connection
14025 this variable is set to the protocol version.
14026
14027
14028 .vitem &$tod_bsdinbox$&
14029 .vindex "&$tod_bsdinbox$&"
14030 The time of day and the date, in the format required for BSD-style mailbox
14031 files, for example: Thu Oct 17 17:14:09 1995.
14032
14033 .vitem &$tod_epoch$&
14034 .vindex "&$tod_epoch$&"
14035 The time and date as a number of seconds since the start of the Unix epoch.
14036
14037 .vitem &$tod_epoch_l$&
14038 .vindex "&$tod_epoch_l$&"
14039 The time and date as a number of microseconds since the start of the Unix epoch.
14040
14041 .vitem &$tod_full$&
14042 .vindex "&$tod_full$&"
14043 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14044 +0100. The timezone is always given as a numerical offset from UTC, with
14045 positive values used for timezones that are ahead (east) of UTC, and negative
14046 values for those that are behind (west).
14047
14048 .vitem &$tod_log$&
14049 .vindex "&$tod_log$&"
14050 The time and date in the format used for writing Exim's log files, for example:
14051 1995-10-12 15:32:29, but without a timezone.
14052
14053 .vitem &$tod_logfile$&
14054 .vindex "&$tod_logfile$&"
14055 This variable contains the date in the format yyyymmdd. This is the format that
14056 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14057 flag.
14058
14059 .vitem &$tod_zone$&
14060 .vindex "&$tod_zone$&"
14061 This variable contains the numerical value of the local timezone, for example:
14062 -0500.
14063
14064 .vitem &$tod_zulu$&
14065 .vindex "&$tod_zulu$&"
14066 This variable contains the UTC date and time in &"Zulu"& format, as specified
14067 by ISO 8601, for example: 20030221154023Z.
14068
14069 .vitem &$transport_name$&
14070 .cindex "transport" "name"
14071 .cindex "name" "of transport"
14072 .vindex "&$transport_name$&"
14073 During the running of a transport, this variable contains its name.
14074
14075 .vitem &$value$&
14076 .vindex "&$value$&"
14077 This variable contains the result of an expansion lookup, extraction operation,
14078 or external command, as described above. It is also used during a
14079 &*reduce*& expansion.
14080
14081 .vitem &$verify_mode$&
14082 .vindex "&$verify_mode$&"
14083 While a router or transport is being run in verify mode or for cutthrough delivery,
14084 contains "S" for sender-verification or "R" for recipient-verification.
14085 Otherwise, empty.
14086
14087 .vitem &$version_number$&
14088 .vindex "&$version_number$&"
14089 The version number of Exim. Same as &$exim_version$&, may be overridden
14090 by the &%exim_version%& main config option.
14091
14092 .vitem &$warn_message_delay$&
14093 .vindex "&$warn_message_delay$&"
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
14097 .vitem &$warn_message_recipients$&
14098 .vindex "&$warn_message_recipients$&"
14099 This variable is set only during the creation of a message warning about a
14100 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14101 .endlist
14102 .ecindex IIDstrexp
14103
14104
14105
14106 . ////////////////////////////////////////////////////////////////////////////
14107 . ////////////////////////////////////////////////////////////////////////////
14108
14109 .chapter "Embedded Perl" "CHAPperl"
14110 .scindex IIDperl "Perl" "calling from Exim"
14111 Exim can be built to include an embedded Perl interpreter. When this is done,
14112 Perl subroutines can be called as part of the string expansion process. To make
14113 use of the Perl support, you need version 5.004 or later of Perl installed on
14114 your system. To include the embedded interpreter in the Exim binary, include
14115 the line
14116 .code
14117 EXIM_PERL = perl.o
14118 .endd
14119 in your &_Local/Makefile_& and then build Exim in the normal way.
14120
14121
14122 .section "Setting up so Perl can be used" "SECID85"
14123 .oindex "&%perl_startup%&"
14124 Access to Perl subroutines is via a global configuration option called
14125 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14126 no &%perl_startup%& option in the Exim configuration file then no Perl
14127 interpreter is started and there is almost no overhead for Exim (since none of
14128 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14129 option then the associated value is taken to be Perl code which is executed in
14130 a newly created Perl interpreter.
14131
14132 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14133 need backslashes before any characters to escape special meanings. The option
14134 should usually be something like
14135 .code
14136 perl_startup = do '/etc/exim.pl'
14137 .endd
14138 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14139 use from Exim. Exim can be configured either to start up a Perl interpreter as
14140 soon as it is entered, or to wait until the first time it is needed. Starting
14141 the interpreter at the beginning ensures that it is done while Exim still has
14142 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14143 fact used in a particular run. Also, note that this does not mean that Exim is
14144 necessarily running as root when Perl is called at a later time. By default,
14145 the interpreter is started only when it is needed, but this can be changed in
14146 two ways:
14147
14148 .ilist
14149 .oindex "&%perl_at_start%&"
14150 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14151 a startup when Exim is entered.
14152 .next
14153 The command line option &%-ps%& also requests a startup when Exim is entered,
14154 overriding the setting of &%perl_at_start%&.
14155 .endlist
14156
14157 There is also a command line option &%-pd%& (for delay) which suppresses the
14158 initial startup, even if &%perl_at_start%& is set.
14159
14160 .ilist
14161 .oindex "&%perl_taintmode%&"
14162 .cindex "Perl" "taintmode"
14163 To provide more security executing Perl code via the embedded Perl
14164 interpreter, the &%perl_taintmode%& option can be set. This enables the
14165 taint mode of the Perl interpreter. You are encouraged to set this
14166 option to a true value. To avoid breaking existing installations, it
14167 defaults to false.
14168
14169 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14170
14171
14172 .section "Calling Perl subroutines" "SECID86"
14173 When the configuration file includes a &%perl_startup%& option you can make use
14174 of the string expansion item to call the Perl subroutines that are defined
14175 by the &%perl_startup%& code. The operator is used in any of the following
14176 forms:
14177 .code
14178 ${perl{foo}}
14179 ${perl{foo}{argument}}
14180 ${perl{foo}{argument1}{argument2} ... }
14181 .endd
14182 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14183 arguments may be passed. Passing more than this results in an expansion failure
14184 with an error message of the form
14185 .code
14186 Too many arguments passed to Perl subroutine "foo" (max is 8)
14187 .endd
14188 The return value of the Perl subroutine is evaluated in a scalar context before
14189 it is passed back to Exim to be inserted into the expanded string. If the
14190 return value is &'undef'&, the expansion is forced to fail in the same way as
14191 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14192 by obeying Perl's &%die%& function, the expansion fails with the error message
14193 that was passed to &%die%&.
14194
14195
14196 .section "Calling Exim functions from Perl" "SECID87"
14197 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14198 is available to call back into Exim's string expansion function. For example,
14199 the Perl code
14200 .code
14201 my $lp = Exim::expand_string('$local_part');
14202 .endd
14203 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14204 Note those are single quotes and not double quotes to protect against
14205 &$local_part$& being interpolated as a Perl variable.
14206
14207 If the string expansion is forced to fail by a &"fail"& item, the result of
14208 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14209 expansion string, the Perl call from the original expansion string fails with
14210 an appropriate error message, in the same way as if &%die%& were used.
14211
14212 .cindex "debugging" "from embedded Perl"
14213 .cindex "log" "writing from embedded Perl"
14214 Two other Exim functions are available for use from within Perl code.
14215 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14216 debugging is enabled. If you want a newline at the end, you must supply it.
14217 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14218 timestamp. In this case, you should not supply a terminating newline.
14219
14220
14221 .section "Use of standard output and error by Perl" "SECID88"
14222 .cindex "Perl" "standard output and error"
14223 You should not write to the standard error or output streams from within your
14224 Perl code, as it is not defined how these are set up. In versions of Exim
14225 before 4.50, it is possible for the standard output or error to refer to the
14226 SMTP connection during message reception via the daemon. Writing to this stream
14227 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14228 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14229 avoided, but the output is lost.
14230
14231 .cindex "Perl" "use of &%warn%&"
14232 The Perl &%warn%& statement writes to the standard error stream by default.
14233 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14234 you have no control. When Exim starts up the Perl interpreter, it arranges for
14235 output from the &%warn%& statement to be written to the Exim main log. You can
14236 change this by including appropriate Perl magic somewhere in your Perl code.
14237 For example, to discard &%warn%& output completely, you need this:
14238 .code
14239 $SIG{__WARN__} = sub { };
14240 .endd
14241 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14242 example, the code for the subroutine is empty, so it does nothing, but you can
14243 include any Perl code that you like. The text of the &%warn%& message is passed
14244 as the first subroutine argument.
14245 .ecindex IIDperl
14246
14247
14248 . ////////////////////////////////////////////////////////////////////////////
14249 . ////////////////////////////////////////////////////////////////////////////
14250
14251 .chapter "Starting the daemon and the use of network interfaces" &&&
14252          "CHAPinterfaces" &&&
14253          "Starting the daemon"
14254 .cindex "daemon" "starting"
14255 .cindex "interface" "listening"
14256 .cindex "network interface"
14257 .cindex "interface" "network"
14258 .cindex "IP address" "for listening"
14259 .cindex "daemon" "listening IP addresses"
14260 .cindex "TCP/IP" "setting listening interfaces"
14261 .cindex "TCP/IP" "setting listening ports"
14262 A host that is connected to a TCP/IP network may have one or more physical
14263 hardware network interfaces. Each of these interfaces may be configured as one
14264 or more &"logical"& interfaces, which are the entities that a program actually
14265 works with. Each of these logical interfaces is associated with an IP address.
14266 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14267 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14268 knowledge about the host's interfaces for use in three different circumstances:
14269
14270 .olist
14271 When a listening daemon is started, Exim needs to know which interfaces
14272 and ports to listen on.
14273 .next
14274 When Exim is routing an address, it needs to know which IP addresses
14275 are associated with local interfaces. This is required for the correct
14276 processing of MX lists by removing the local host and others with the
14277 same or higher priority values. Also, Exim needs to detect cases
14278 when an address is routed to an IP address that in fact belongs to the
14279 local host. Unless the &%self%& router option or the &%allow_localhost%&
14280 option of the smtp transport is set (as appropriate), this is treated
14281 as an error situation.
14282 .next
14283 When Exim connects to a remote host, it may need to know which interface to use
14284 for the outgoing connection.
14285 .endlist
14286
14287
14288 Exim's default behaviour is likely to be appropriate in the vast majority
14289 of cases. If your host has only one interface, and you want all its IP
14290 addresses to be treated in the same way, and you are using only the
14291 standard SMTP port, you should not need to take any special action. The
14292 rest of this chapter does not apply to you.
14293
14294 In a more complicated situation you may want to listen only on certain
14295 interfaces, or on different ports, and for this reason there are a number of
14296 options that can be used to influence Exim's behaviour. The rest of this
14297 chapter describes how they operate.
14298
14299 When a message is received over TCP/IP, the interface and port that were
14300 actually used are set in &$received_ip_address$& and &$received_port$&.
14301
14302
14303
14304 .section "Starting a listening daemon" "SECID89"
14305 When a listening daemon is started (by means of the &%-bd%& command line
14306 option), the interfaces and ports on which it listens are controlled by the
14307 following options:
14308
14309 .ilist
14310 &%daemon_smtp_ports%& contains a list of default ports
14311 or service names.
14312 (For backward compatibility, this option can also be specified in the singular.)
14313 .next
14314 &%local_interfaces%& contains list of interface IP addresses on which to
14315 listen. Each item may optionally also specify a port.
14316 .endlist
14317
14318 The default list separator in both cases is a colon, but this can be changed as
14319 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14320 it is usually best to change the separator to avoid having to double all the
14321 colons. For example:
14322 .code
14323 local_interfaces = <; 127.0.0.1 ; \
14324                       192.168.23.65 ; \
14325                       ::1 ; \
14326                       3ffe:ffff:836f::fe86:a061
14327 .endd
14328 There are two different formats for specifying a port along with an IP address
14329 in &%local_interfaces%&:
14330
14331 .olist
14332 The port is added onto the address with a dot separator. For example, to listen
14333 on port 1234 on two different IP addresses:
14334 .code
14335 local_interfaces = <; 192.168.23.65.1234 ; \
14336                       3ffe:ffff:836f::fe86:a061.1234
14337 .endd
14338 .next
14339 The IP address is enclosed in square brackets, and the port is added
14340 with a colon separator, for example:
14341 .code
14342 local_interfaces = <; [192.168.23.65]:1234 ; \
14343                       [3ffe:ffff:836f::fe86:a061]:1234
14344 .endd
14345 .endlist
14346
14347 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14348 default setting contains just one port:
14349 .code
14350 daemon_smtp_ports = smtp
14351 .endd
14352 If more than one port is listed, each interface that does not have its own port
14353 specified listens on all of them. Ports that are listed in
14354 &%daemon_smtp_ports%& can be identified either by name (defined in
14355 &_/etc/services_&) or by number. However, when ports are given with individual
14356 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14357
14358
14359
14360 .section "Special IP listening addresses" "SECID90"
14361 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14362 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14363 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14364 instead of setting up separate listening sockets for each interface. The
14365 default value of &%local_interfaces%& is
14366 .code
14367 local_interfaces = 0.0.0.0
14368 .endd
14369 when Exim is built without IPv6 support; otherwise it is:
14370 .code
14371 local_interfaces = <; ::0 ; 0.0.0.0
14372 .endd
14373 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14374
14375
14376
14377 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14378 The &%-oX%& command line option can be used to override the values of
14379 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14380 instance. Another way of doing this would be to use macros and the &%-D%&
14381 option. However, &%-oX%& can be used by any admin user, whereas modification of
14382 the runtime configuration by &%-D%& is allowed only when the caller is root or
14383 exim.
14384
14385 The value of &%-oX%& is a list of items. The default colon separator can be
14386 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14387 If there are any items that do not
14388 contain dots or colons (that is, are not IP addresses), the value of
14389 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14390 items that do contain dots or colons, the value of &%local_interfaces%& is
14391 replaced by those items. Thus, for example,
14392 .code
14393 -oX 1225
14394 .endd
14395 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14396 whereas
14397 .code
14398 -oX 192.168.34.5.1125
14399 .endd
14400 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14401 (However, since &%local_interfaces%& now contains no items without ports, the
14402 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14403
14404
14405
14406 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14407 .cindex "submissions protocol"
14408 .cindex "ssmtp protocol"
14409 .cindex "smtps protocol"
14410 .cindex "SMTP" "ssmtp protocol"
14411 .cindex "SMTP" "smtps protocol"
14412 Exim supports the use of TLS-on-connect, used by mail clients in the
14413 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14414 For some years, IETF Standards Track documents only blessed the
14415 STARTTLS-based Submission service (port 587) while common practice was to support
14416 the same feature set on port 465, but using TLS-on-connect.
14417 If your installation needs to provide service to mail clients
14418 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14419 the 465 TCP ports.
14420
14421 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14422 service names, connections to those ports must first establish TLS, before
14423 proceeding to the application layer use of the SMTP protocol.
14424
14425 The common use of this option is expected to be
14426 .code
14427 tls_on_connect_ports = 465
14428 .endd
14429 per RFC 8314.
14430 There is also a command line option &%-tls-on-connect%&, which forces all ports
14431 to behave in this way when a daemon is started.
14432
14433 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14434 daemon to listen on those ports. You must still specify them in
14435 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14436 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14437 connections via the daemon.)
14438
14439
14440
14441
14442 .section "IPv6 address scopes" "SECID92"
14443 .cindex "IPv6" "address scopes"
14444 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14445 can, in principle, have the same link-local IPv6 address on different
14446 interfaces. Thus, additional information is needed, over and above the IP
14447 address, to distinguish individual interfaces. A convention of using a
14448 percent sign followed by something (often the interface name) has been
14449 adopted in some cases, leading to addresses like this:
14450 .code
14451 fe80::202:b3ff:fe03:45c1%eth0
14452 .endd
14453 To accommodate this usage, a percent sign followed by an arbitrary string is
14454 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14455 to convert a textual IPv6 address for actual use. This function recognizes the
14456 percent convention in operating systems that support it, and it processes the
14457 address appropriately. Unfortunately, some older libraries have problems with
14458 &[getaddrinfo()]&. If
14459 .code
14460 IPV6_USE_INET_PTON=yes
14461 .endd
14462 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14463 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14464 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14465 function.) Of course, this means that the additional functionality of
14466 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14467
14468 .section "Disabling IPv6" "SECID93"
14469 .cindex "IPv6" "disabling"
14470 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14471 run on a host whose kernel does not support IPv6. The binary will fall back to
14472 using IPv4, but it may waste resources looking up AAAA records, and trying to
14473 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14474 .oindex "&%disable_ipv6%&"
14475 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14476 activities take place. AAAA records are never looked up, and any IPv6 addresses
14477 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14478 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14479 to handle IPv6 literal addresses.
14480
14481 On the other hand, when IPv6 is in use, there may be times when you want to
14482 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14483 option to globally suppress the lookup of AAAA records for specified domains,
14484 and you can use the &%ignore_target_hosts%& generic router option to ignore
14485 IPv6 addresses in an individual router.
14486
14487
14488
14489 .section "Examples of starting a listening daemon" "SECID94"
14490 The default case in an IPv6 environment is
14491 .code
14492 daemon_smtp_ports = smtp
14493 local_interfaces = <; ::0 ; 0.0.0.0
14494 .endd
14495 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14496 Either one or two sockets may be used, depending on the characteristics of
14497 the TCP/IP stack. (This is complicated and messy; for more information,
14498 read the comments in the &_daemon.c_& source file.)
14499
14500 To specify listening on ports 25 and 26 on all interfaces:
14501 .code
14502 daemon_smtp_ports = 25 : 26
14503 .endd
14504 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14505 .code
14506 local_interfaces = <; ::0.25     ; ::0.26 \
14507                       0.0.0.0.25 ; 0.0.0.0.26
14508 .endd
14509 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14510 IPv4 loopback address only:
14511 .code
14512 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14513 .endd
14514 To specify listening on the default port on specific interfaces only:
14515 .code
14516 local_interfaces = 10.0.0.67 : 192.168.34.67
14517 .endd
14518 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14519
14520
14521
14522 .section "Recognizing the local host" "SECTreclocipadd"
14523 The &%local_interfaces%& option is also used when Exim needs to determine
14524 whether or not an IP address refers to the local host. That is, the IP
14525 addresses of all the interfaces on which a daemon is listening are always
14526 treated as local.
14527
14528 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14529 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14530 available interfaces from the operating system, and extracts the relevant
14531 (that is, IPv4 or IPv6) addresses to use for checking.
14532
14533 Some systems set up large numbers of virtual interfaces in order to provide
14534 many virtual web servers. In this situation, you may want to listen for
14535 email on only a few of the available interfaces, but nevertheless treat all
14536 interfaces as local when routing. You can do this by setting
14537 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14538 &"all"& wildcard values. These addresses are recognized as local, but are not
14539 used for listening. Consider this example:
14540 .code
14541 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14542                       192.168.53.235 ; \
14543                       3ffe:2101:12:1:a00:20ff:fe86:a061
14544
14545 extra_local_interfaces = <; ::0 ; 0.0.0.0
14546 .endd
14547 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14548 address, but all available interface addresses are treated as local when
14549 Exim is routing.
14550
14551 In some environments the local host name may be in an MX list, but with an IP
14552 address that is not assigned to any local interface. In other cases it may be
14553 desirable to treat other host names as if they referred to the local host. Both
14554 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14555 This contains host names rather than IP addresses. When a host is referenced
14556 during routing, either via an MX record or directly, it is treated as the local
14557 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14558 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14559
14560
14561
14562 .section "Delivering to a remote host" "SECID95"
14563 Delivery to a remote host is handled by the smtp transport. By default, it
14564 allows the system's TCP/IP functions to choose which interface to use (if
14565 there is more than one) when connecting to a remote host. However, the
14566 &%interface%& option can be set to specify which interface is used. See the
14567 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14568 details.
14569
14570
14571
14572
14573 . ////////////////////////////////////////////////////////////////////////////
14574 . ////////////////////////////////////////////////////////////////////////////
14575
14576 .chapter "Main configuration" "CHAPmainconfig"
14577 .scindex IIDconfima "configuration file" "main section"
14578 .scindex IIDmaiconf "main configuration"
14579 The first part of the runtime configuration file contains three types of item:
14580
14581 .ilist
14582 Macro definitions: These lines start with an upper case letter. See section
14583 &<<SECTmacrodefs>>& for details of macro processing.
14584 .next
14585 Named list definitions: These lines start with one of the words &"domainlist"&,
14586 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14587 section &<<SECTnamedlists>>&.
14588 .next
14589 Main configuration settings: Each setting occupies one line of the file
14590 (with possible continuations). If any setting is preceded by the word
14591 &"hide"&, the &%-bP%& command line option displays its value to admin users
14592 only. See section &<<SECTcos>>& for a description of the syntax of these option
14593 settings.
14594 .endlist
14595
14596 This chapter specifies all the main configuration options, along with their
14597 types and default values. For ease of finding a particular option, they appear
14598 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14599 are now so many options, they are first listed briefly in functional groups, as
14600 an aid to finding the name of the option you are looking for. Some options are
14601 listed in more than one group.
14602
14603 .section "Miscellaneous" "SECID96"
14604 .table2
14605 .row &%add_environment%&             "environment variables"
14606 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14607 .row &%debug_store%&                 "do extra internal checks"
14608 .row &%disable_ipv6%&                "do no IPv6 processing"
14609 .row &%keep_environment%&            "environment variables"
14610 .row &%keep_malformed%&              "for broken files &-- should not happen"
14611 .row &%localhost_number%&            "for unique message ids in clusters"
14612 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14613 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14614 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14615 .row &%print_topbitchars%&           "top-bit characters are printing"
14616 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14617 .row &%timezone%&                    "force time zone"
14618 .endtable
14619
14620
14621 .section "Exim parameters" "SECID97"
14622 .table2
14623 .row &%exim_group%&                  "override compiled-in value"
14624 .row &%exim_path%&                   "override compiled-in value"
14625 .row &%exim_user%&                   "override compiled-in value"
14626 .row &%primary_hostname%&            "default from &[uname()]&"
14627 .row &%split_spool_directory%&       "use multiple directories"
14628 .row &%spool_directory%&             "override compiled-in value"
14629 .endtable
14630
14631
14632
14633 .section "Privilege controls" "SECID98"
14634 .table2
14635 .row &%admin_groups%&                "groups that are Exim admin users"
14636 .row &%commandline_checks_require_admin%& "require admin for various checks"
14637 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14638 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14639 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14640 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14641 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14642 .row &%never_users%&                 "do not run deliveries as these"
14643 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14644 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14645 .row &%trusted_groups%&              "groups that are trusted"
14646 .row &%trusted_users%&               "users that are trusted"
14647 .endtable
14648
14649
14650
14651 .section "Logging" "SECID99"
14652 .table2
14653 .row &%event_action%&                "custom logging"
14654 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14655 .row &%log_file_path%&               "override compiled-in value"
14656 .row &%log_selector%&                "set/unset optional logging"
14657 .row &%log_timezone%&                "add timezone to log lines"
14658 .row &%message_logs%&                "create per-message logs"
14659 .row &%preserve_message_logs%&       "after message completion"
14660 .row &%panic_coredump%&              "request coredump on fatal errors"
14661 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14662 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14663 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14664 .row &%syslog_facility%&             "set syslog &""facility""& field"
14665 .row &%syslog_pid%&                  "pid in syslog lines"
14666 .row &%syslog_processname%&          "set syslog &""ident""& field"
14667 .row &%syslog_timestamp%&            "timestamp syslog lines"
14668 .row &%write_rejectlog%&             "control use of message log"
14669 .endtable
14670
14671
14672
14673 .section "Frozen messages" "SECID100"
14674 .table2
14675 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14676 .row &%freeze_tell%&                 "send message when freezing"
14677 .row &%move_frozen_messages%&        "to another directory"
14678 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14679 .endtable
14680
14681
14682
14683 .section "Data lookups" "SECID101"
14684 .table2
14685 .row &%ibase_servers%&               "InterBase servers"
14686 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14687 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14688 .row &%ldap_cert_file%&              "client cert file for LDAP"
14689 .row &%ldap_cert_key%&               "client key file for LDAP"
14690 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14691 .row &%ldap_default_servers%&        "used if no server in query"
14692 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14693 .row &%ldap_start_tls%&              "require TLS within LDAP"
14694 .row &%ldap_version%&                "set protocol version"
14695 .row &%lookup_open_max%&             "lookup files held open"
14696 .row &%mysql_servers%&               "default MySQL servers"
14697 .row &%oracle_servers%&              "Oracle servers"
14698 .row &%pgsql_servers%&               "default PostgreSQL servers"
14699 .row &%sqlite_lock_timeout%&         "as it says"
14700 .endtable
14701
14702
14703
14704 .section "Message ids" "SECID102"
14705 .table2
14706 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14707 .row &%message_id_header_text%&      "ditto"
14708 .endtable
14709
14710
14711
14712 .section "Embedded Perl Startup" "SECID103"
14713 .table2
14714 .row &%perl_at_start%&               "always start the interpreter"
14715 .row &%perl_startup%&                "code to obey when starting Perl"
14716 .row &%perl_taintmode%&              "enable taint mode in Perl"
14717 .endtable
14718
14719
14720
14721 .section "Daemon" "SECID104"
14722 .table2
14723 .row &%daemon_smtp_ports%&           "default ports"
14724 .row &%daemon_startup_retries%&      "number of times to retry"
14725 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14726 .row &%extra_local_interfaces%&      "not necessarily listened on"
14727 .row &%local_interfaces%&            "on which to listen, with optional ports"
14728 .row &%notifier_socket%&             "override compiled-in value"
14729 .row &%pid_file_path%&               "override compiled-in value"
14730 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14731 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14732 .endtable
14733
14734
14735
14736 .section "Resource control" "SECID105"
14737 .table2
14738 .row &%check_log_inodes%&            "before accepting a message"
14739 .row &%check_log_space%&             "before accepting a message"
14740 .row &%check_spool_inodes%&          "before accepting a message"
14741 .row &%check_spool_space%&           "before accepting a message"
14742 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14743 .row &%queue_only_load%&             "queue incoming if load high"
14744 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14745 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14746 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14747 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14748 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14749 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14750 .row &%smtp_accept_max_per_connection%& "messages per connection"
14751 .row &%smtp_accept_max_per_host%&    "connections from one host"
14752 .row &%smtp_accept_queue%&           "queue mail if more connections"
14753 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14754                                            connection"
14755 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14756 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14757 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14758 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14759 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14760 .endtable
14761
14762
14763
14764 .section "Policy controls" "SECID106"
14765 .table2
14766 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14767 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14768 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14769 .row &%acl_smtp_auth%&               "ACL for AUTH"
14770 .row &%acl_smtp_connect%&            "ACL for connection"
14771 .row &%acl_smtp_data%&               "ACL for DATA"
14772 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14773 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14774 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14775 .row &%acl_smtp_expn%&               "ACL for EXPN"
14776 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14777 .row &%acl_smtp_mail%&               "ACL for MAIL"
14778 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14779 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14780 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14781 .row &%acl_smtp_predata%&            "ACL for start of data"
14782 .row &%acl_smtp_quit%&               "ACL for QUIT"
14783 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14784 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14785 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14786 .row &%av_scanner%&                  "specify virus scanner"
14787 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14788                                       words""&"
14789 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14790 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14791 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14792 .row &%header_maxsize%&              "total size of message header"
14793 .row &%header_line_maxsize%&         "individual header line limit"
14794 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14795 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14796 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14797 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14798 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14799 .row &%host_lookup%&                 "host name looked up for these hosts"
14800 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14801 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14802 .row &%host_reject_connection%&      "reject connection from these hosts"
14803 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14804 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14805 .row &%message_size_limit%&          "for all messages"
14806 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14807 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14808 .row &%spamd_address%&               "set interface to SpamAssassin"
14809 .row &%strict_acl_vars%&             "object to unset ACL variables"
14810 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14811 .endtable
14812
14813
14814
14815 .section "Callout cache" "SECID107"
14816 .table2
14817 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14818                                          item"
14819 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14820                                          item"
14821 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14822 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14823 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14824 .endtable
14825
14826
14827
14828 .section "TLS" "SECID108"
14829 .table2
14830 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14831 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14832 .row &%hosts_require_alpn%&          "mandatory ALPN"
14833 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14834 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14835 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14836 .row &%tls_alpn%&                    "acceptable protocol names"
14837 .row &%tls_certificate%&             "location of server certificate"
14838 .row &%tls_crl%&                     "certificate revocation list"
14839 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14840 .row &%tls_dhparam%&                 "DH parameters for server"
14841 .row &%tls_eccurve%&                 "EC curve selection for server"
14842 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14843 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14844 .row &%tls_privatekey%&              "location of server private key"
14845 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14846 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14847 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14848 .row &%tls_verify_certificates%&     "expected client certificates"
14849 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14850 .endtable
14851
14852
14853
14854 .section "Local user handling" "SECID109"
14855 .table2
14856 .row &%finduser_retries%&            "useful in NIS environments"
14857 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14858 .row &%gecos_pattern%&               "ditto"
14859 .row &%max_username_length%&         "for systems that truncate"
14860 .row &%unknown_login%&               "used when no login name found"
14861 .row &%unknown_username%&            "ditto"
14862 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14863 .row &%uucp_from_sender%&            "ditto"
14864 .endtable
14865
14866
14867
14868 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14869 .table2
14870 .row &%header_maxsize%&              "total size of message header"
14871 .row &%header_line_maxsize%&         "individual header line limit"
14872 .row &%message_size_limit%&          "applies to all messages"
14873 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14874 .row &%received_header_text%&        "expanded to make &'Received:'&"
14875 .row &%received_headers_max%&        "for mail loop detection"
14876 .row &%recipients_max%&              "limit per message"
14877 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14878 .endtable
14879
14880
14881
14882
14883 .section "Non-SMTP incoming messages" "SECID111"
14884 .table2
14885 .row &%receive_timeout%&             "for non-SMTP messages"
14886 .endtable
14887
14888
14889
14890
14891
14892 .section "Incoming SMTP messages" "SECID112"
14893 See also the &'Policy controls'& section above.
14894
14895 .table2
14896 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14897 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14898 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14899 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14900 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14901 .row &%dmarc_history_file%&          "DMARC results log"
14902 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14903 .row &%host_lookup%&                 "host name looked up for these hosts"
14904 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14905 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14906 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14907 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14908 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14909 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14910 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14911 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14912 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14913 .row &%smtp_accept_max_per_connection%& "messages per connection"
14914 .row &%smtp_accept_max_per_host%&    "connections from one host"
14915 .row &%smtp_accept_queue%&           "queue mail if more connections"
14916 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14917                                            connection"
14918 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14919 .row &%smtp_active_hostname%&        "host name to use in messages"
14920 .row &%smtp_banner%&                 "text for welcome banner"
14921 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14922 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14923 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14924 .row &%smtp_etrn_command%&           "what to run for ETRN"
14925 .row &%smtp_etrn_serialize%&         "only one at once"
14926 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14927 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14928 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14929 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14930 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14931 .row &%smtp_receive_timeout%&        "per command or data line"
14932 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14933 .row &%smtp_return_error_details%&   "give detail on rejections"
14934 .endtable
14935
14936
14937
14938 .section "SMTP extensions" "SECID113"
14939 .table2
14940 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14941 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14942 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14943 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14944 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14945 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14946 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14947 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14948 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14949 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14950 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14951 .endtable
14952
14953
14954
14955 .section "Processing messages" "SECID114"
14956 .table2
14957 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14958 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14959 .row &%allow_utf8_domains%&          "in addresses"
14960 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14961                                       words""&"
14962 .row &%delivery_date_remove%&        "from incoming messages"
14963 .row &%envelope_to_remove%&          "from incoming messages"
14964 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14965 .row &%headers_charset%&             "default for translations"
14966 .row &%qualify_domain%&              "default for senders"
14967 .row &%qualify_recipient%&           "default for recipients"
14968 .row &%return_path_remove%&          "from incoming messages"
14969 .row &%strip_excess_angle_brackets%& "in addresses"
14970 .row &%strip_trailing_dot%&          "at end of addresses"
14971 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14972 .endtable
14973
14974
14975
14976 .section "System filter" "SECID115"
14977 .table2
14978 .row &%system_filter%&               "locate system filter"
14979 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14980                                             directory"
14981 .row &%system_filter_file_transport%& "transport for delivery to a file"
14982 .row &%system_filter_group%&         "group for filter running"
14983 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14984 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14985 .row &%system_filter_user%&          "user for filter running"
14986 .endtable
14987
14988
14989
14990 .section "Routing and delivery" "SECID116"
14991 .table2
14992 .row &%disable_ipv6%&                "do no IPv6 processing"
14993 .row &%dns_again_means_nonexist%&    "for broken domains"
14994 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14995 .row &%dns_dnssec_ok%&               "parameter for resolver"
14996 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14997 .row &%dns_retrans%&                 "parameter for resolver"
14998 .row &%dns_retry%&                   "parameter for resolver"
14999 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15000 .row &%dns_use_edns0%&               "parameter for resolver"
15001 .row &%hold_domains%&                "hold delivery for these domains"
15002 .row &%local_interfaces%&            "for routing checks"
15003 .row &%queue_domains%&               "no immediate delivery for these"
15004 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15005 .row &%queue_only%&                  "no immediate delivery at all"
15006 .row &%queue_only_file%&             "no immediate delivery if file exists"
15007 .row &%queue_only_load%&             "no immediate delivery if load is high"
15008 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15009 .row &%queue_only_override%&         "allow command line to override"
15010 .row &%queue_run_in_order%&          "order of arrival"
15011 .row &%queue_run_max%&               "of simultaneous queue runners"
15012 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15013 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15014 .row &%remote_sort_domains%&         "order of remote deliveries"
15015 .row &%retry_data_expire%&           "timeout for retry data"
15016 .row &%retry_interval_max%&          "safety net for retry rules"
15017 .endtable
15018
15019
15020
15021 .section "Bounce and warning messages" "SECID117"
15022 .table2
15023 .row &%bounce_message_file%&         "content of bounce"
15024 .row &%bounce_message_text%&         "content of bounce"
15025 .row &%bounce_return_body%&          "include body if returning message"
15026 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15027 .row &%bounce_return_message%&       "include original message in bounce"
15028 .row &%bounce_return_size_limit%&    "limit on returned message"
15029 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15030 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15031 .row &%errors_copy%&                 "copy bounce messages"
15032 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15033 .row &%delay_warning%&               "time schedule"
15034 .row &%delay_warning_condition%&     "condition for warning messages"
15035 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15036 .row &%smtp_return_error_details%&   "give detail on rejections"
15037 .row &%warn_message_file%&           "content of warning message"
15038 .endtable
15039
15040
15041
15042 .section "Alphabetical list of main options" "SECTalomo"
15043 Those options that undergo string expansion before use are marked with
15044 &dagger;.
15045
15046 .option accept_8bitmime main boolean true
15047 .cindex "8BITMIME"
15048 .cindex "8-bit characters"
15049 .cindex "log" "selectors"
15050 .cindex "log" "8BITMIME"
15051 .cindex "ESMTP extensions" 8BITMIME
15052 This option causes Exim to send 8BITMIME in its response to an SMTP
15053 EHLO command, and to accept the BODY= parameter on MAIL commands.
15054 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15055 takes no steps to do anything special with messages received by this route.
15056
15057 Historically Exim kept this option off by default, but the maintainers
15058 feel that in today's Internet, this causes more problems than it solves.
15059 It now defaults to true.
15060 A more detailed analysis of the issues is provided by Dan Bernstein:
15061 .display
15062 &url(https://cr.yp.to/smtp/8bitmime.html)
15063 .endd
15064
15065 To log received 8BITMIME status use
15066 .code
15067 log_selector = +8bitmime
15068 .endd
15069
15070 .option acl_not_smtp main string&!! unset
15071 .cindex "&ACL;" "for non-SMTP messages"
15072 .cindex "non-SMTP messages" "ACLs for"
15073 This option defines the ACL that is run when a non-SMTP message has been
15074 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15075 further details.
15076
15077 .option acl_not_smtp_mime main string&!! unset
15078 This option defines the ACL that is run for individual MIME parts of non-SMTP
15079 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15080 SMTP messages.
15081
15082 .option acl_not_smtp_start main string&!! unset
15083 .cindex "&ACL;" "at start of non-SMTP message"
15084 .cindex "non-SMTP messages" "ACLs for"
15085 This option defines the ACL that is run before Exim starts reading a
15086 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15087
15088 .option acl_smtp_auth main string&!! unset
15089 .cindex "&ACL;" "setting up for SMTP commands"
15090 .cindex "AUTH" "ACL for"
15091 This option defines the ACL that is run when an SMTP AUTH command is
15092 received. See chapter &<<CHAPACL>>& for further details.
15093
15094 .option acl_smtp_connect main string&!! unset
15095 .cindex "&ACL;" "on SMTP connection"
15096 This option defines the ACL that is run when an SMTP connection is received.
15097 See chapter &<<CHAPACL>>& for further details.
15098
15099 .option acl_smtp_data main string&!! unset
15100 .cindex "DATA" "ACL for"
15101 This option defines the ACL that is run after an SMTP DATA command has been
15102 processed and the message itself has been received, but before the final
15103 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15104
15105 .option acl_smtp_data_prdr main string&!! accept
15106 .cindex "PRDR" "ACL for"
15107 .cindex "DATA" "PRDR ACL for"
15108 .cindex "&ACL;" "PRDR-related"
15109 .cindex "&ACL;" "per-user data processing"
15110 This option defines the ACL that,
15111 if the PRDR feature has been negotiated,
15112 is run for each recipient after an SMTP DATA command has been
15113 processed and the message itself has been received, but before the
15114 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15115
15116 .option acl_smtp_dkim main string&!! unset
15117 .cindex DKIM "ACL for"
15118 This option defines the ACL that is run for each DKIM signature
15119 (by default, or as specified in the dkim_verify_signers option)
15120 of a received message.
15121 See section &<<SECDKIMVFY>>& for further details.
15122
15123 .option acl_smtp_etrn main string&!! unset
15124 .cindex "ETRN" "ACL for"
15125 This option defines the ACL that is run when an SMTP ETRN command is
15126 received. See chapter &<<CHAPACL>>& for further details.
15127
15128 .option acl_smtp_expn main string&!! unset
15129 .cindex "EXPN" "ACL for"
15130 This option defines the ACL that is run when an SMTP EXPN command is
15131 received. See chapter &<<CHAPACL>>& for further details.
15132
15133 .option acl_smtp_helo main string&!! unset
15134 .cindex "EHLO" "ACL for"
15135 .cindex "HELO" "ACL for"
15136 This option defines the ACL that is run when an SMTP EHLO or HELO
15137 command is received. See chapter &<<CHAPACL>>& for further details.
15138
15139
15140 .option acl_smtp_mail main string&!! unset
15141 .cindex "MAIL" "ACL for"
15142 This option defines the ACL that is run when an SMTP MAIL command is
15143 received. See chapter &<<CHAPACL>>& for further details.
15144
15145 .option acl_smtp_mailauth main string&!! unset
15146 .cindex "AUTH" "on MAIL command"
15147 This option defines the ACL that is run when there is an AUTH parameter on
15148 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15149 &<<CHAPSMTPAUTH>>& for details of authentication.
15150
15151 .option acl_smtp_mime main string&!! unset
15152 .cindex "MIME content scanning" "ACL for"
15153 This option is available when Exim is built with the content-scanning
15154 extension. It defines the ACL that is run for each MIME part in a message. See
15155 section &<<SECTscanmimepart>>& for details.
15156
15157 .option acl_smtp_notquit main string&!! unset
15158 .cindex "not-QUIT, ACL for"
15159 This option defines the ACL that is run when an SMTP session
15160 ends without a QUIT command being received.
15161 See chapter &<<CHAPACL>>& for further details.
15162
15163 .option acl_smtp_predata main string&!! unset
15164 This option defines the ACL that is run when an SMTP DATA command is
15165 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15166 further details.
15167
15168 .option acl_smtp_quit main string&!! unset
15169 .cindex "QUIT, ACL for"
15170 This option defines the ACL that is run when an SMTP QUIT command is
15171 received. See chapter &<<CHAPACL>>& for further details.
15172
15173 .option acl_smtp_rcpt main string&!! unset
15174 .cindex "RCPT" "ACL for"
15175 This option defines the ACL that is run when an SMTP RCPT command is
15176 received. See chapter &<<CHAPACL>>& for further details.
15177
15178 .option acl_smtp_starttls main string&!! unset
15179 .cindex "STARTTLS, ACL for"
15180 This option defines the ACL that is run when an SMTP STARTTLS command is
15181 received. See chapter &<<CHAPACL>>& for further details.
15182
15183 .option acl_smtp_vrfy main string&!! unset
15184 .cindex "VRFY" "ACL for"
15185 This option defines the ACL that is run when an SMTP VRFY command is
15186 received. See chapter &<<CHAPACL>>& for further details.
15187
15188 .option add_environment main "string list" empty
15189 .cindex "environment" "set values"
15190 This option adds individual environment variables that the
15191 currently linked libraries and programs in child processes may use.
15192 Each list element should be of the form &"name=value"&.
15193
15194 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15195
15196 .option admin_groups main "string list&!!" unset
15197 .cindex "admin user"
15198 This option is expanded just once, at the start of Exim's processing. If the
15199 current group or any of the supplementary groups of an Exim caller is in this
15200 colon-separated list, the caller has admin privileges. If all your system
15201 programmers are in a specific group, for example, you can give them all Exim
15202 admin privileges by putting that group in &%admin_groups%&. However, this does
15203 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15204 To permit this, you have to add individuals to the Exim group.
15205
15206 .option allow_domain_literals main boolean false
15207 .cindex "domain literal"
15208 If this option is set, the RFC 2822 domain literal format is permitted in
15209 email addresses. The option is not set by default, because the domain literal
15210 format is not normally required these days, and few people know about it. It
15211 has, however, been exploited by mail abusers.
15212
15213 Unfortunately, it seems that some DNS black list maintainers are using this
15214 format to report black listing to postmasters. If you want to accept messages
15215 addressed to your hosts by IP address, you need to set
15216 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15217 domains (defined in the named domain list &%local_domains%& in the default
15218 configuration). This &"magic string"& matches the domain literal form of all
15219 the local host's IP addresses.
15220
15221 .option allow_mx_to_ip main boolean false
15222 .cindex "MX record" "pointing to IP address"
15223 It appears that more and more DNS zone administrators are breaking the rules
15224 and putting domain names that look like IP addresses on the right hand side of
15225 MX records. Exim follows the rules and rejects this, giving an error message
15226 that explains the misconfiguration. However, some other MTAs support this
15227 practice, so to avoid &"Why can't Exim do this?"& complaints,
15228 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15229 recommended, except when you have no other choice.
15230
15231 .option allow_utf8_domains main boolean false
15232 .cindex "domain" "UTF-8 characters in"
15233 .cindex "UTF-8" "in domain name"
15234 Lots of discussion is going on about internationalized domain names. One
15235 camp is strongly in favour of just using UTF-8 characters, and it seems
15236 that at least two other MTAs permit this.
15237 This option allows Exim users to experiment if they wish.
15238
15239 If it is set true, Exim's domain parsing function allows valid
15240 UTF-8 multicharacters to appear in domain name components, in addition to
15241 letters, digits, and hyphens.
15242
15243 If Exim is built with internationalization support
15244 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15245 this option can be left as default.
15246 Without that,
15247 if you want to look up such domain names in the DNS, you must also
15248 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15249 suitable setting is:
15250 .code
15251 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15252   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15253 .endd
15254 Alternatively, you can just disable this feature by setting
15255 .code
15256 dns_check_names_pattern =
15257 .endd
15258 That is, set the option to an empty string so that no check is done.
15259
15260
15261 .option auth_advertise_hosts main "host list&!!" *
15262 .cindex "authentication" "advertising"
15263 .cindex "AUTH" "advertising"
15264 .cindex "ESMTP extensions" AUTH
15265 If any server authentication mechanisms are configured, Exim advertises them in
15266 response to an EHLO command only if the calling host matches this list.
15267 Otherwise, Exim does not advertise AUTH.
15268 Exim does not accept AUTH commands from clients to which it has not
15269 advertised the availability of AUTH. The advertising of individual
15270 authentication mechanisms can be controlled by the use of the
15271 &%server_advertise_condition%& generic authenticator option on the individual
15272 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15273
15274 Certain mail clients (for example, Netscape) require the user to provide a name
15275 and password for authentication if AUTH is advertised, even though it may
15276 not be needed (the host may accept messages from hosts on its local LAN without
15277 authentication, for example). The &%auth_advertise_hosts%& option can be used
15278 to make these clients more friendly by excluding them from the set of hosts to
15279 which Exim advertises AUTH.
15280
15281 .cindex "AUTH" "advertising when encrypted"
15282 If you want to advertise the availability of AUTH only when the connection
15283 is encrypted using TLS, you can make use of the fact that the value of this
15284 option is expanded, with a setting like this:
15285 .code
15286 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15287 .endd
15288 .vindex "&$tls_in_cipher$&"
15289 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15290 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15291 expansion is *, which matches all hosts.
15292
15293
15294 .option auto_thaw main time 0s
15295 .cindex "thawing messages"
15296 .cindex "unfreezing messages"
15297 If this option is set to a time greater than zero, a queue runner will try a
15298 new delivery attempt on any frozen message, other than a bounce message, if
15299 this much time has passed since it was frozen. This may result in the message
15300 being re-frozen if nothing has changed since the last attempt. It is a way of
15301 saying &"keep on trying, even though there are big problems"&.
15302
15303 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15304 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15305 thought to be very useful any more, and its use should probably be avoided.
15306
15307
15308 .option av_scanner main string "see below"
15309 This option is available if Exim is built with the content-scanning extension.
15310 It specifies which anti-virus scanner to use. The default value is:
15311 .code
15312 sophie:/var/run/sophie
15313 .endd
15314 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15315 before use. See section &<<SECTscanvirus>>& for further details.
15316
15317
15318 .option bi_command main string unset
15319 .oindex "&%-bi%&"
15320 This option supplies the name of a command that is run when Exim is called with
15321 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15322 just the command name, it is not a complete command line. If an argument is
15323 required, it must come from the &%-oA%& command line option.
15324
15325
15326 .option bounce_message_file main string&!! unset
15327 .cindex "bounce message" "customizing"
15328 .cindex "customizing" "bounce message"
15329 This option defines a template file containing paragraphs of text to be used
15330 for constructing bounce messages.  Details of the file's contents are given in
15331 chapter &<<CHAPemsgcust>>&.
15332 .cindex bounce_message_file "tainted data"
15333 The option is expanded to give the file path, which must be
15334 absolute and untainted.
15335 See also &%warn_message_file%&.
15336
15337
15338 .option bounce_message_text main string unset
15339 When this option is set, its contents are included in the default bounce
15340 message immediately after &"This message was created automatically by mail
15341 delivery software."& It is not used if &%bounce_message_file%& is set.
15342
15343 .option bounce_return_body main boolean true
15344 .cindex "bounce message" "including body"
15345 This option controls whether the body of an incoming message is included in a
15346 bounce message when &%bounce_return_message%& is true. The default setting
15347 causes the entire message, both header and body, to be returned (subject to the
15348 value of &%bounce_return_size_limit%&). If this option is false, only the
15349 message header is included. In the case of a non-SMTP message containing an
15350 error that is detected during reception, only those header lines preceding the
15351 point at which the error was detected are returned.
15352 .cindex "bounce message" "including original"
15353
15354 .option bounce_return_linesize_limit main integer 998
15355 .cindex "size" "of bounce lines, limit"
15356 .cindex "bounce message" "line length limit"
15357 .cindex "limit" "bounce message line length"
15358 This option sets a limit in bytes on the line length of messages
15359 that are returned to senders due to delivery problems,
15360 when &%bounce_return_message%& is true.
15361 The default value corresponds to RFC limits.
15362 If the message being returned has lines longer than this value it is
15363 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15364
15365 The option also applies to bounces returned when an error is detected
15366 during reception of a message.
15367 In this case lines from the original are truncated.
15368
15369 The option does not apply to messages generated by an &(autoreply)& transport.
15370
15371
15372 .option bounce_return_message main boolean true
15373 If this option is set false, none of the original message is included in
15374 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15375 &%bounce_return_body%&.
15376
15377
15378 .option bounce_return_size_limit main integer 100K
15379 .cindex "size" "of bounce, limit"
15380 .cindex "bounce message" "size limit"
15381 .cindex "limit" "bounce message size"
15382 This option sets a limit in bytes on the size of messages that are returned to
15383 senders as part of bounce messages when &%bounce_return_message%& is true. The
15384 limit should be less than the value of the global &%message_size_limit%& and of
15385 any &%message_size_limit%& settings on transports, to allow for the bounce text
15386 that Exim generates. If this option is set to zero there is no limit.
15387
15388 When the body of any message that is to be included in a bounce message is
15389 greater than the limit, it is truncated, and a comment pointing this out is
15390 added at the top. The actual cutoff may be greater than the value given, owing
15391 to the use of buffering for transferring the message in chunks (typically 8K in
15392 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15393 messages.
15394
15395 .option bounce_sender_authentication main string unset
15396 .cindex "bounce message" "sender authentication"
15397 .cindex "authentication" "bounce message"
15398 .cindex "AUTH" "on bounce message"
15399 This option provides an authenticated sender address that is sent with any
15400 bounce messages generated by Exim that are sent over an authenticated SMTP
15401 connection. A typical setting might be:
15402 .code
15403 bounce_sender_authentication = mailer-daemon@my.domain.example
15404 .endd
15405 which would cause bounce messages to be sent using the SMTP command:
15406 .code
15407 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15408 .endd
15409 The value of &%bounce_sender_authentication%& must always be a complete email
15410 address.
15411
15412 .option callout_domain_negative_expire main time 3h
15413 .cindex "caching" "callout timeouts"
15414 .cindex "callout" "caching timeouts"
15415 This option specifies the expiry time for negative callout cache data for a
15416 domain. See section &<<SECTcallver>>& for details of callout verification, and
15417 section &<<SECTcallvercache>>& for details of the caching.
15418
15419
15420 .option callout_domain_positive_expire main time 7d
15421 This option specifies the expiry time for positive callout cache data for a
15422 domain. See section &<<SECTcallver>>& for details of callout verification, and
15423 section &<<SECTcallvercache>>& for details of the caching.
15424
15425
15426 .option callout_negative_expire main time 2h
15427 This option specifies the expiry time for negative callout cache data for an
15428 address. See section &<<SECTcallver>>& for details of callout verification, and
15429 section &<<SECTcallvercache>>& for details of the caching.
15430
15431
15432 .option callout_positive_expire main time 24h
15433 This option specifies the expiry time for positive callout cache data for an
15434 address. See section &<<SECTcallver>>& for details of callout verification, and
15435 section &<<SECTcallvercache>>& for details of the caching.
15436
15437
15438 .option callout_random_local_part main string&!! "see below"
15439 This option defines the &"random"& local part that can be used as part of
15440 callout verification. The default value is
15441 .code
15442 $primary_hostname-$tod_epoch-testing
15443 .endd
15444 See section &<<CALLaddparcall>>& for details of how this value is used.
15445
15446
15447 .option check_log_inodes main integer 100
15448 See &%check_spool_space%& below.
15449
15450
15451 .option check_log_space main integer 10M
15452 See &%check_spool_space%& below.
15453
15454 .oindex "&%check_rfc2047_length%&"
15455 .cindex "RFC 2047" "disabling length check"
15456 .option check_rfc2047_length main boolean true
15457 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15458 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15459 word; strings to be encoded that exceed this length are supposed to use
15460 multiple encoded words. By default, Exim does not recognize encoded words that
15461 exceed the maximum length. However, it seems that some software, in violation
15462 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15463 set false, Exim recognizes encoded words of any length.
15464
15465
15466 .option check_spool_inodes main integer 100
15467 See &%check_spool_space%& below.
15468
15469
15470 .option check_spool_space main integer 10M
15471 .cindex "checking disk space"
15472 .cindex "disk space, checking"
15473 .cindex "spool directory" "checking space"
15474 The four &%check_...%& options allow for checking of disk resources before a
15475 message is accepted.
15476
15477 .vindex "&$log_inodes$&"
15478 .vindex "&$log_space$&"
15479 .vindex "&$spool_inodes$&"
15480 .vindex "&$spool_space$&"
15481 When any of these options are nonzero, they apply to all incoming messages. If you
15482 want to apply different checks to different kinds of message, you can do so by
15483 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15484 &$spool_space$& in an ACL with appropriate additional conditions.
15485
15486
15487 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15488 either value is greater than zero, for example:
15489 .code
15490 check_spool_space = 100M
15491 check_spool_inodes = 100
15492 .endd
15493 The spool partition is the one that contains the directory defined by
15494 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15495 transit.
15496
15497 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15498 files are written if either is greater than zero. These should be set only if
15499 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15500
15501 If there is less space or fewer inodes than requested, Exim refuses to accept
15502 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15503 error response to the MAIL command. If ESMTP is in use and there was a
15504 SIZE parameter on the MAIL command, its value is added to the
15505 &%check_spool_space%& value, and the check is performed even if
15506 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15507
15508 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15509 number of kilobytes (though specified in bytes).
15510 If a non-multiple of 1024 is specified, it is rounded up.
15511
15512 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15513 failure a message is written to stderr and Exim exits with a non-zero code, as
15514 it obviously cannot send an error message of any kind.
15515
15516 There is a slight performance penalty for these checks.
15517 Versions of Exim preceding 4.88 had these disabled by default;
15518 high-rate installations confident they will never run out of resources
15519 may wish to deliberately disable them.
15520
15521 .option chunking_advertise_hosts main "host list&!!" *
15522 .cindex CHUNKING advertisement
15523 .cindex "RFC 3030" "CHUNKING"
15524 .cindex "ESMTP extensions" CHUNKING
15525 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15526 these hosts.
15527 Hosts may use the BDAT command as an alternate to DATA.
15528
15529 .option commandline_checks_require_admin main boolean &`false`&
15530 .cindex "restricting access to features"
15531 This option restricts various basic checking features to require an
15532 administrative user.
15533 This affects most of the &%-b*%& options, such as &%-be%&.
15534
15535 .option debug_store main boolean &`false`&
15536 .cindex debugging "memory corruption"
15537 .cindex memory debugging
15538 This option, when true, enables extra checking in Exim's internal memory
15539 management.  For use when a memory corruption issue is being investigated,
15540 it should normally be left as default.
15541
15542 .option daemon_smtp_ports main string &`smtp`&
15543 .cindex "port" "for daemon"
15544 .cindex "TCP/IP" "setting listening ports"
15545 This option specifies one or more default SMTP ports on which the Exim daemon
15546 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15547 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15548
15549 .option daemon_startup_retries main integer 9
15550 .cindex "daemon startup, retrying"
15551 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15552 the daemon at startup when it cannot immediately bind a listening socket
15553 (typically because the socket is already in use): &%daemon_startup_retries%&
15554 defines the number of retries after the first failure, and
15555 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15556
15557 .option daemon_startup_sleep main time 30s
15558 See &%daemon_startup_retries%&.
15559
15560 .option delay_warning main "time list" 24h
15561 .cindex "warning of delay"
15562 .cindex "delay warning, specifying"
15563 .cindex "queue" "delay warning"
15564 When a message is delayed, Exim sends a warning message to the sender at
15565 intervals specified by this option. The data is a colon-separated list of times
15566 after which to send warning messages. If the value of the option is an empty
15567 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15568 message has been in the queue for longer than the last time, the last interval
15569 between the times is used to compute subsequent warning times. For example,
15570 with
15571 .code
15572 delay_warning = 4h:8h:24h
15573 .endd
15574 the first message is sent after 4 hours, the second after 8 hours, and
15575 the third one after 24 hours. After that, messages are sent every 16 hours,
15576 because that is the interval between the last two times on the list. If you set
15577 just one time, it specifies the repeat interval. For example, with:
15578 .code
15579 delay_warning = 6h
15580 .endd
15581 messages are repeated every six hours. To stop warnings after a given time, set
15582 a very large time at the end of the list. For example:
15583 .code
15584 delay_warning = 2h:12h:99d
15585 .endd
15586 Note that the option is only evaluated at the time a delivery attempt fails,
15587 which depends on retry and queue-runner configuration.
15588 Typically retries will be configured more frequently than warning messages.
15589
15590 .option delay_warning_condition main string&!! "see below"
15591 .vindex "&$domain$&"
15592 The string is expanded at the time a warning message might be sent. If all the
15593 deferred addresses have the same domain, it is set in &$domain$& during the
15594 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15595 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15596 &"false"& (the comparison being done caselessly) then the warning message is
15597 not sent. The default is:
15598 .code
15599 delay_warning_condition = ${if or {\
15600   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15601   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15602   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15603   } {no}{yes}}
15604 .endd
15605 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15606 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15607 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15608 &"auto-replied"& in an &'Auto-Submitted:'& header.
15609
15610 .option deliver_drop_privilege main boolean false
15611 .cindex "unprivileged delivery"
15612 .cindex "delivery" "unprivileged"
15613 If this option is set true, Exim drops its root privilege at the start of a
15614 delivery process, and runs as the Exim user throughout. This severely restricts
15615 the kinds of local delivery that are possible, but is viable in certain types
15616 of configuration. There is a discussion about the use of root privilege in
15617 chapter &<<CHAPsecurity>>&.
15618
15619 .option deliver_queue_load_max main fixed-point unset
15620 .cindex "load average"
15621 .cindex "queue runner" "abandoning"
15622 When this option is set, a queue run is abandoned if the system load average
15623 becomes greater than the value of the option. The option has no effect on
15624 ancient operating systems on which Exim cannot determine the load average.
15625 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15626
15627
15628 .option delivery_date_remove main boolean true
15629 .cindex "&'Delivery-date:'& header line"
15630 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15631 message when it is delivered, in exactly the same way as &'Return-path:'& is
15632 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15633 should not be present in incoming messages, and this option causes them to be
15634 removed at the time the message is received, to avoid any problems that might
15635 occur when a delivered message is subsequently sent on to some other recipient.
15636
15637 .option disable_fsync main boolean false
15638 .cindex "&[fsync()]&, disabling"
15639 This option is available only if Exim was built with the compile-time option
15640 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15641 a runtime configuration generates an &"unknown option"& error. You should not
15642 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15643 really, really, really understand what you are doing. &'No pre-compiled
15644 distributions of Exim should ever make this option available.'&
15645
15646 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15647 updated files' data to be written to disc before continuing. Unexpected events
15648 such as crashes and power outages may cause data to be lost or scrambled.
15649 Here be Dragons. &*Beware.*&
15650
15651
15652 .option disable_ipv6 main boolean false
15653 .cindex "IPv6" "disabling"
15654 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15655 activities take place. AAAA records are never looked up, and any IPv6 addresses
15656 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15657 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15658 to handle IPv6 literal addresses.
15659
15660
15661 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15662 .cindex DKIM "selecting signature algorithms"
15663 This option gives a list of hash types which are acceptable in signatures,
15664 and an order of processing.
15665 Signatures with algorithms not in the list will be ignored.
15666
15667 Acceptable values include:
15668 .code
15669 sha1
15670 sha256
15671 sha512
15672 .endd
15673
15674 Note that the acceptance of sha1 violates RFC 8301.
15675
15676 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15677 This option gives a list of key types which are acceptable in signatures,
15678 and an order of processing.
15679 Signatures with algorithms not in the list will be ignored.
15680
15681
15682 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15683 This option gives a list of key sizes which are acceptable in signatures.
15684 The list is keyed by the algorithm type for the key; the values are in bits.
15685 Signatures with keys smaller than given by this option will fail verification.
15686
15687 The default enforces the RFC 8301 minimum key size for RSA signatures.
15688
15689 .option dkim_verify_minimal main boolean false
15690 If set to true, verification of signatures will terminate after the
15691 first success.
15692
15693 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15694 .cindex DKIM "controlling calls to the ACL"
15695 This option gives a list of DKIM domains for which the DKIM ACL is run.
15696 It is expanded after the message is received; by default it runs
15697 the ACL once for each signature in the message.
15698 See section &<<SECDKIMVFY>>&.
15699
15700
15701 .option dmarc_forensic_sender main string&!! unset
15702 .option dmarc_history_file main string unset
15703 .option dmarc_tld_file main string unset
15704 .cindex DMARC "main section options"
15705 These options control DMARC processing.
15706 See section &<<SECDMARC>>& for details.
15707
15708
15709 .option dns_again_means_nonexist main "domain list&!!" unset
15710 .cindex "DNS" "&""try again""& response; overriding"
15711 DNS lookups give a &"try again"& response for the DNS errors
15712 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15713 keep trying to deliver a message, or to give repeated temporary errors to
15714 incoming mail. Sometimes the effect is caused by a badly set up name server and
15715 may persist for a long time. If a domain which exhibits this problem matches
15716 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15717 This option should be used with care. You can make it apply to reverse lookups
15718 by a setting such as this:
15719 .code
15720 dns_again_means_nonexist = *.in-addr.arpa
15721 .endd
15722 This option applies to all DNS lookups that Exim does,
15723 .new
15724 except for TLSA lookups (where knowing about such failures
15725 is security-relevant).
15726 .wen
15727 It also applies when the
15728 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15729 since these are most likely to be caused by DNS lookup problems. The
15730 &(dnslookup)& router has some options of its own for controlling what happens
15731 when lookups for MX or SRV records give temporary errors. These more specific
15732 options are applied after this global option.
15733
15734 .option dns_check_names_pattern main string "see below"
15735 .cindex "DNS" "pre-check of name syntax"
15736 When this option is set to a non-empty string, it causes Exim to check domain
15737 names for characters that are not allowed in host names before handing them to
15738 the DNS resolver, because some resolvers give temporary errors for names that
15739 contain unusual characters. If a domain name contains any unwanted characters,
15740 a &"not found"& result is forced, and the resolver is not called. The check is
15741 done by matching the domain name against a regular expression, which is the
15742 value of this option. The default pattern is
15743 .code
15744 dns_check_names_pattern = \
15745   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15746 .endd
15747 which permits only letters, digits, slashes, and hyphens in components, but
15748 they must start and end with a letter or digit. Slashes are not, in fact,
15749 permitted in host names, but they are found in certain NS records (which can be
15750 accessed in Exim by using a &%dnsdb%& lookup). If you set
15751 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15752 empty string.
15753
15754 .option dns_csa_search_limit main integer 5
15755 This option controls the depth of parental searching for CSA SRV records in the
15756 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15757
15758 .option dns_csa_use_reverse main boolean true
15759 This option controls whether or not an IP address, given as a CSA domain, is
15760 reversed and looked up in the reverse DNS, as described in more detail in
15761 section &<<SECTverifyCSA>>&.
15762
15763 .option dns_cname_loops main integer 1
15764 .cindex DNS "CNAME following"
15765 This option controls the following of CNAME chains, needed if the resolver does
15766 not do it internally.
15767 As of 2018 most should, and the default can be left.
15768 If you have an ancient one, a value of 10 is likely needed.
15769
15770 The default value of one CNAME-follow is needed
15771 thanks to the observed return for an MX request,
15772 given no MX presence but a CNAME to an A, of the CNAME.
15773
15774
15775 .option dns_dnssec_ok main integer -1
15776 .cindex "DNS" "resolver options"
15777 .cindex "DNS" "DNSSEC"
15778 If this option is set to a non-negative number then Exim will initialise the
15779 DNS resolver library to either use or not use DNSSEC, overriding the system
15780 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15781
15782 If the resolver library does not support DNSSEC then this option has no effect.
15783
15784 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15785 will default to stripping out a successful validation status.
15786 This will break a previously working Exim installation.
15787 Provided that you do trust the resolver (ie, is on localhost) you can tell
15788 glibc to pass through any successful validation with a new option in
15789 &_/etc/resolv.conf_&:
15790 .code
15791 options trust-ad
15792 .endd
15793
15794
15795 .option dns_ipv4_lookup main "domain list&!!" unset
15796 .cindex "IPv6" "DNS lookup for AAAA records"
15797 .cindex "DNS" "IPv6 lookup for AAAA records"
15798 .cindex DNS "IPv6 disabling"
15799 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15800 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15801 (A records) when trying to find IP addresses for hosts, unless the host's
15802 domain matches this list.
15803
15804 This is a fudge to help with name servers that give big delays or otherwise do
15805 not work for the AAAA record type. In due course, when the world's name
15806 servers have all been upgraded, there should be no need for this option.
15807 Note that all lookups, including those done for verification, are affected;
15808 this will result in verify failure for IPv6 connections or ones using names
15809 only valid for IPv6 addresses.
15810
15811
15812 .option dns_retrans main time 0s
15813 .cindex "DNS" "resolver options"
15814 .cindex timeout "dns lookup"
15815 .cindex "DNS" timeout
15816 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15817 retransmission and retry parameters for DNS lookups. Values of zero (the
15818 defaults) leave the system default settings unchanged. The first value is the
15819 time between retries, and the second is the number of retries. It isn't
15820 totally clear exactly how these settings affect the total time a DNS lookup may
15821 take. I haven't found any documentation about timeouts on DNS lookups; these
15822 parameter values are available in the external resolver interface structure,
15823 but nowhere does it seem to describe how they are used or what you might want
15824 to set in them.
15825 See also the &%slow_lookup_log%& option.
15826
15827
15828 .option dns_retry main integer 0
15829 See &%dns_retrans%& above.
15830
15831
15832 .option dns_trust_aa main "domain list&!!" unset
15833 .cindex "DNS" "resolver options"
15834 .cindex "DNS" "DNSSEC"
15835 If this option is set then lookup results marked with the AA bit
15836 (Authoritative Answer) are trusted the same way as if they were
15837 DNSSEC-verified. The authority section's name of the answer must
15838 match with this expanded domain list.
15839
15840 Use this option only if you talk directly to a resolver that is
15841 authoritative for some zones and does not set the AD (Authentic Data)
15842 bit in the answer. Some DNS servers may have an configuration option to
15843 mark the answers from their own zones as verified (they set the AD bit).
15844 Others do not have this option. It is considered as poor practice using
15845 a resolver that is an authoritative server for some zones.
15846
15847 Use this option only if you really have to (e.g. if you want
15848 to use DANE for remote delivery to a server that is listed in the DNS
15849 zones that your resolver is authoritative for).
15850
15851 If the DNS answer packet has the AA bit set and contains resource record
15852 in the answer section, the name of the first NS record appearing in the
15853 authority section is compared against the list. If the answer packet is
15854 authoritative but the answer section is empty, the name of the first SOA
15855 record in the authoritative section is used instead.
15856
15857 .cindex "DNS" "resolver options"
15858 .option dns_use_edns0 main integer -1
15859 .cindex "DNS" "resolver options"
15860 .cindex "DNS" "EDNS0"
15861 .cindex "DNS" "OpenBSD
15862 If this option is set to a non-negative number then Exim will initialise the
15863 DNS resolver library to either use or not use EDNS0 extensions, overriding
15864 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15865 on.
15866
15867 If the resolver library does not support EDNS0 then this option has no effect.
15868
15869 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15870 means that DNSSEC will not work with Exim on that platform either, unless Exim
15871 is linked against an alternative DNS client library.
15872
15873
15874 .option drop_cr main boolean false
15875 This is an obsolete option that is now a no-op. It used to affect the way Exim
15876 handled CR and LF characters in incoming messages. What happens now is
15877 described in section &<<SECTlineendings>>&.
15878
15879 .option dsn_advertise_hosts main "host list&!!" unset
15880 .cindex "bounce messages" "success"
15881 .cindex "DSN" "success"
15882 .cindex "Delivery Status Notification" "success"
15883 .cindex "ESMTP extensions" DSN
15884 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15885 and accepted from, these hosts.
15886 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15887 and RET and ENVID options on MAIL FROM commands.
15888 A NOTIFY=SUCCESS option requests success-DSN messages.
15889 A NOTIFY= option with no argument requests that no delay or failure DSNs
15890 are sent.
15891 &*Note*&: Supplying success-DSN messages has been criticised
15892 on privacy grounds; it can leak details of internal forwarding.
15893
15894 .option dsn_from main "string&!!" "see below"
15895 .cindex "&'From:'& header line" "in bounces"
15896 .cindex "bounce messages" "&'From:'& line, specifying"
15897 This option can be used to vary the contents of &'From:'& header lines in
15898 bounces and other automatically generated messages (&"Delivery Status
15899 Notifications"& &-- hence the name of the option). The default setting is:
15900 .code
15901 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15902 .endd
15903 The value is expanded every time it is needed. If the expansion fails, a
15904 panic is logged, and the default value is used.
15905
15906 .option envelope_to_remove main boolean true
15907 .cindex "&'Envelope-to:'& header line"
15908 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15909 message when it is delivered, in exactly the same way as &'Return-path:'& is
15910 handled. &'Envelope-to:'& records the original recipient address from the
15911 message's envelope that caused the delivery to happen. Such headers should not
15912 be present in incoming messages, and this option causes them to be removed at
15913 the time the message is received, to avoid any problems that might occur when a
15914 delivered message is subsequently sent on to some other recipient.
15915
15916
15917 .option errors_copy main "string list&!!" unset
15918 .cindex "bounce message" "copy to other address"
15919 .cindex "copy of bounce message"
15920 Setting this option causes Exim to send bcc copies of bounce messages that it
15921 generates to other addresses. &*Note*&: This does not apply to bounce messages
15922 coming from elsewhere. The value of the option is a colon-separated list of
15923 items. Each item consists of a pattern, terminated by white space, followed by
15924 a comma-separated list of email addresses. If a pattern contains spaces, it
15925 must be enclosed in double quotes.
15926
15927 Each pattern is processed in the same way as a single item in an address list
15928 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15929 the bounce message, the message is copied to the addresses on the list. The
15930 items are scanned in order, and once a matching one is found, no further items
15931 are examined. For example:
15932 .code
15933 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15934               rqps@mydomain   hostmaster@mydomain.example,\
15935                               postmaster@mydomain.example
15936 .endd
15937 .vindex "&$domain$&"
15938 .vindex "&$local_part$&"
15939 The address list is expanded before use. The expansion variables &$local_part$&
15940 and &$domain$& are set from the original recipient of the error message, and if
15941 there was any wildcard matching in the pattern, the expansion
15942 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15943 variables &$0$&, &$1$&, etc. are set in the normal way.
15944
15945
15946 .option errors_reply_to main string unset
15947 .cindex "bounce message" "&'Reply-to:'& in"
15948 By default, Exim's bounce and delivery warning messages contain the header line
15949 .display
15950 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15951 .endd
15952 .oindex &%quota_warn_message%&
15953 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15954 A warning message that is generated by the &%quota_warn_message%& option in an
15955 &(appendfile)& transport may contain its own &'From:'& header line that
15956 overrides the default.
15957
15958 Experience shows that people reply to bounce messages. If the
15959 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15960 and warning messages. For example:
15961 .code
15962 errors_reply_to = postmaster@my.domain.example
15963 .endd
15964 The value of the option is not expanded. It must specify a valid RFC 2822
15965 address. However, if a warning message that is generated by the
15966 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15967 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15968 not used.
15969
15970
15971 .option event_action main string&!! unset
15972 .cindex events
15973 This option declares a string to be expanded for Exim's events mechanism.
15974 For details see chapter &<<CHAPevents>>&.
15975
15976
15977 .option exim_group main string "compile-time configured"
15978 .cindex "gid (group id)" "Exim's own"
15979 .cindex "Exim group"
15980 This option changes the gid under which Exim runs when it gives up root
15981 privilege. The default value is compiled into the binary. The value of this
15982 option is used only when &%exim_user%& is also set. Unless it consists entirely
15983 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15984 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15985 security issues.
15986
15987
15988 .option exim_path main string "see below"
15989 .cindex "Exim binary, path name"
15990 This option specifies the path name of the Exim binary, which is used when Exim
15991 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15992 the directory configured at compile time by the BIN_DIRECTORY setting. It
15993 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15994 other place.
15995 &*Warning*&: Do not use a macro to define the value of this option, because
15996 you will break those Exim utilities that scan the configuration file to find
15997 where the binary is. (They then use the &%-bP%& option to extract option
15998 settings such as the value of &%spool_directory%&.)
15999
16000
16001 .option exim_user main string "compile-time configured"
16002 .cindex "uid (user id)" "Exim's own"
16003 .cindex "Exim user"
16004 This option changes the uid under which Exim runs when it gives up root
16005 privilege. The default value is compiled into the binary. Ownership of the run
16006 time configuration file and the use of the &%-C%& and &%-D%& command line
16007 options is checked against the values in the binary, not what is set here.
16008
16009 Unless it consists entirely of digits, the string is looked up using
16010 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16011 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16012 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16013
16014
16015 .option exim_version main string "current version"
16016 .cindex "Exim version"
16017 .cindex customizing "version number"
16018 .cindex "version number of Exim" override
16019 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16020 various places.  Use with care; this may fool stupid security scanners.
16021
16022
16023 .option extra_local_interfaces main "string list" unset
16024 This option defines network interfaces that are to be considered local when
16025 routing, but which are not used for listening by the daemon. See section
16026 &<<SECTreclocipadd>>& for details.
16027
16028
16029 . Allow this long option name to split; give it unsplit as a fifth argument
16030 . for the automatic .oindex that is generated by .option.
16031
16032 .option "extract_addresses_remove_arguments" main boolean true &&&
16033          extract_addresses_remove_arguments
16034 .oindex "&%-t%&"
16035 .cindex "command line" "addresses with &%-t%&"
16036 .cindex "Sendmail compatibility" "&%-t%& option"
16037 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16038 are present on the command line when the &%-t%& option is used to build an
16039 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16040 line addresses are removed from the recipients list. This is also how Smail
16041 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16042 command line addresses are added to those obtained from the header lines. When
16043 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16044 argument headers. If it is set false, Exim adds rather than removes argument
16045 addresses.
16046
16047
16048 .option finduser_retries main integer 0
16049 .cindex "NIS, retrying user lookups"
16050 On systems running NIS or other schemes in which user and group information is
16051 distributed from a remote system, there can be times when &[getpwnam()]& and
16052 related functions fail, even when given valid data, because things time out.
16053 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16054 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16055 many extra times to find a user or a group, waiting for one second between
16056 retries.
16057
16058 .cindex "&_/etc/passwd_&" "multiple reading of"
16059 You should not set this option greater than zero if your user information is in
16060 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16061 search the file multiple times for non-existent users, and also cause delay.
16062
16063
16064
16065 .option freeze_tell main "string list, comma separated" unset
16066 .cindex "freezing messages" "sending a message when freezing"
16067 .cindex "frozen messages" "sending a message when freezing"
16068 On encountering certain errors, or when configured to do so in a system filter,
16069 ACL, or special router, Exim freezes a message. This means that no further
16070 delivery attempts take place until an administrator thaws the message, or the
16071 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16072 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16073 warning message whenever it freezes something, unless the message it is
16074 freezing is a locally-generated bounce message. (Without this exception there
16075 is the possibility of looping.) The warning message is sent to the addresses
16076 supplied as the comma-separated value of this option. If several of the
16077 message's addresses cause freezing, only a single message is sent. If the
16078 freezing was automatic, the reason(s) for freezing can be found in the message
16079 log. If you configure freezing in a filter or ACL, you must arrange for any
16080 logging that you require.
16081
16082
16083 .option gecos_name main string&!! unset
16084 .cindex "HP-UX"
16085 .cindex "&""gecos""& field, parsing"
16086 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16087 password file to hold other information in addition to users' real names. Exim
16088 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16089 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16090 of the field are used unchanged, except that, if an ampersand is encountered,
16091 it is replaced by the user's login name with the first character forced to
16092 upper case, since this is a convention that is observed on many systems.
16093
16094 When these options are set, &%gecos_pattern%& is treated as a regular
16095 expression that is to be applied to the field (again with && replaced by the
16096 login name), and if it matches, &%gecos_name%& is expanded and used as the
16097 user's name.
16098
16099 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16100 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16101 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16102 name terminates at the first comma, the following can be used:
16103 .code
16104 gecos_pattern = ([^,]*)
16105 gecos_name = $1
16106 .endd
16107
16108 .option gecos_pattern main string unset
16109 See &%gecos_name%& above.
16110
16111
16112 .option gnutls_compat_mode main boolean unset
16113 This option controls whether GnuTLS is used in compatibility mode in an Exim
16114 server. This reduces security slightly, but improves interworking with older
16115 implementations of TLS.
16116
16117
16118 .option gnutls_allow_auto_pkcs11 main boolean unset
16119 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16120 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16121
16122 See
16123 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16124 for documentation.
16125
16126
16127
16128 .option headers_charset main string "see below"
16129 This option sets a default character set for translating from encoded MIME
16130 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16131 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16132 ultimate default is ISO-8859-1. For more details see the description of header
16133 insertions in section &<<SECTexpansionitems>>&.
16134
16135
16136
16137 .option header_maxsize main integer "see below"
16138 .cindex "header section" "maximum size of"
16139 .cindex "limit" "size of message header section"
16140 This option controls the overall maximum size of a message's header
16141 section. The default is the value of HEADER_MAXSIZE in
16142 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16143 sections are rejected.
16144
16145
16146 .option header_line_maxsize main integer 0
16147 .cindex "header lines" "maximum size of"
16148 .cindex "limit" "size of one header line"
16149 This option limits the length of any individual header line in a message, after
16150 all the continuations have been joined together. Messages with individual
16151 header lines that are longer than the limit are rejected. The default value of
16152 zero means &"no limit"&.
16153
16154
16155
16156
16157 .option helo_accept_junk_hosts main "host list&!!" unset
16158 .cindex "HELO" "accepting junk data"
16159 .cindex "EHLO" "accepting junk data"
16160 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16161 mail, and gives an error response for invalid data. Unfortunately, there are
16162 some SMTP clients that send syntactic junk. They can be accommodated by setting
16163 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16164 if you want to do semantic checking.
16165 See also &%helo_allow_chars%& for a way of extending the permitted character
16166 set.
16167
16168
16169 .option helo_allow_chars main string unset
16170 .cindex "HELO" "underscores in"
16171 .cindex "EHLO" "underscores in"
16172 .cindex "underscore in EHLO/HELO"
16173 This option can be set to a string of rogue characters that are permitted in
16174 all EHLO and HELO names in addition to the standard letters, digits,
16175 hyphens, and dots. If you really must allow underscores, you can set
16176 .code
16177 helo_allow_chars = _
16178 .endd
16179 Note that the value is one string, not a list.
16180
16181
16182 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16183 .cindex "HELO" "forcing reverse lookup"
16184 .cindex "EHLO" "forcing reverse lookup"
16185 If the domain given by a client in a HELO or EHLO command matches this
16186 list, a reverse lookup is done in order to establish the host's true name. The
16187 default forces a lookup if the client host gives the server's name or any of
16188 its IP addresses (in brackets), something that broken clients have been seen to
16189 do.
16190
16191
16192 .option helo_try_verify_hosts main "host list&!!" unset
16193 .cindex "HELO verifying" "optional"
16194 .cindex "EHLO" "verifying, optional"
16195 By default, Exim just checks the syntax of HELO and EHLO commands (see
16196 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16197 to do more extensive checking of the data supplied by these commands. The ACL
16198 condition &`verify = helo`& is provided to make this possible.
16199 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16200 to force the check to occur. From release 4.53 onwards, this is no longer
16201 necessary. If the check has not been done before &`verify = helo`& is
16202 encountered, it is done at that time. Consequently, this option is obsolete.
16203 Its specification is retained here for backwards compatibility.
16204
16205 When an EHLO or HELO command is received, if the calling host matches
16206 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16207 EHLO command either:
16208
16209 .ilist
16210 is an IP literal matching the calling address of the host, or
16211 .next
16212 .cindex "DNS" "reverse lookup"
16213 .cindex "reverse DNS lookup"
16214 matches the host name that Exim obtains by doing a reverse lookup of the
16215 calling host address, or
16216 .next
16217 when looked up in DNS yields the calling host address.
16218 .endlist
16219
16220 However, the EHLO or HELO command is not rejected if any of the checks
16221 fail. Processing continues, but the result of the check is remembered, and can
16222 be detected later in an ACL by the &`verify = helo`& condition.
16223
16224 If DNS was used for successful verification, the variable
16225 .cindex "DNS" "DNSSEC"
16226 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16227
16228 .option helo_verify_hosts main "host list&!!" unset
16229 .cindex "HELO verifying" "mandatory"
16230 .cindex "EHLO" "verifying, mandatory"
16231 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16232 backwards compatibility. For hosts that match this option, Exim checks the host
16233 name given in the HELO or EHLO in the same way as for
16234 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16235 rejected with a 550 error, and entries are written to the main and reject logs.
16236 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16237 error.
16238
16239 .option hold_domains main "domain list&!!" unset
16240 .cindex "domain" "delaying delivery"
16241 .cindex "delivery" "delaying certain domains"
16242 This option allows mail for particular domains to be held in the queue
16243 manually. The option is overridden if a message delivery is forced with the
16244 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16245 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16246 item in &%hold_domains%&, no routing or delivery for that address is done, and
16247 it is deferred every time the message is looked at.
16248
16249 This option is intended as a temporary operational measure for delaying the
16250 delivery of mail while some problem is being sorted out, or some new
16251 configuration tested. If you just want to delay the processing of some
16252 domains until a queue run occurs, you should use &%queue_domains%& or
16253 &%queue_smtp_domains%&, not &%hold_domains%&.
16254
16255 A setting of &%hold_domains%& does not override Exim's code for removing
16256 messages from the queue if they have been there longer than the longest retry
16257 time in any retry rule. If you want to hold messages for longer than the normal
16258 retry times, insert a dummy retry rule with a long retry time.
16259
16260
16261 .option host_lookup main "host list&!!" unset
16262 .cindex "host name" "lookup, forcing"
16263 Exim does not look up the name of a calling host from its IP address unless it
16264 is required to compare against some host list, or the host matches
16265 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16266 option (which normally contains IP addresses rather than host names). The
16267 default configuration file contains
16268 .code
16269 host_lookup = *
16270 .endd
16271 which causes a lookup to happen for all hosts. If the expense of these lookups
16272 is felt to be too great, the setting can be changed or removed.
16273
16274 After a successful reverse lookup, Exim does a forward lookup on the name it
16275 has obtained, to verify that it yields the IP address that it started with. If
16276 this check fails, Exim behaves as if the name lookup failed.
16277
16278 .vindex "&$host_lookup_failed$&"
16279 .vindex "&$sender_host_name$&"
16280 After any kind of failure, the host name (in &$sender_host_name$&) remains
16281 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16282 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16283 &`verify = reverse_host_lookup`& in ACLs.
16284
16285
16286 .option host_lookup_order main "string list" &`bydns:byaddr`&
16287 This option specifies the order of different lookup methods when Exim is trying
16288 to find a host name from an IP address. The default is to do a DNS lookup
16289 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16290 if that fails. You can change the order of these lookups, or omit one entirely,
16291 if you want.
16292
16293 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16294 multiple PTR records in the DNS and the IP address is not listed in
16295 &_/etc/hosts_&. Different operating systems give different results in this
16296 case. That is why the default tries a DNS lookup first.
16297
16298
16299
16300 .option host_reject_connection main "host list&!!" unset
16301 .cindex "host" "rejecting connections from"
16302 If this option is set, incoming SMTP calls from the hosts listed are rejected
16303 as soon as the connection is made.
16304 This option is obsolete, and retained only for backward compatibility, because
16305 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16306 connections immediately.
16307
16308 .new
16309 If the connection is on a TLS-on-connect port then the TCP connection is
16310 just dropped.  Otherwise, an SMTP error is sent first.
16311 .wen
16312
16313 The ability to give an immediate rejection (either by this option or using an
16314 ACL) is provided for use in unusual cases. Many hosts will just try again,
16315 sometimes without much delay. Normally, it is better to use an ACL to reject
16316 incoming messages at a later stage, such as after RCPT commands. See
16317 chapter &<<CHAPACL>>&.
16318
16319
16320 .option hosts_connection_nolog main "host list&!!" unset
16321 .cindex "host" "not logging connections from"
16322 This option defines a list of hosts for which connection logging does not
16323 happen, even though the &%smtp_connection%& log selector is set. For example,
16324 you might want not to log SMTP connections from local processes, or from
16325 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16326 the daemon; you should therefore strive to restrict its value to a short inline
16327 list of IP addresses and networks. To disable logging SMTP connections from
16328 local processes, you must create a host list with an empty item. For example:
16329 .code
16330 hosts_connection_nolog = :
16331 .endd
16332 .new
16333 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16334 lines, as may commonly be produced by a monitoring system.
16335 .wen
16336
16337
16338 .option hosts_require_alpn main "host list&!!" unset
16339 .cindex ALPN "require negotiation in server"
16340 .cindex TLS ALPN
16341 .cindex TLS "Application Layer Protocol Names"
16342 If the TLS library supports ALPN
16343 then a successful negotiation of ALPN will be required for any client
16344 matching the list, for TLS to be used.
16345 See also the &%tls_alpn%& option.
16346
16347 &*Note*&: prevention of fallback to in-clear connection is not
16348 managed by this option, and should be done separately.
16349
16350
16351 .option hosts_require_helo main "host list&!!" *
16352 .cindex "HELO/EHLO" requiring
16353 Exim will require an accepted HELO or EHLO command from a host matching
16354 this list, before accepting a MAIL command.
16355
16356
16357 .option hosts_proxy main "host list&!!" unset
16358 .cindex proxy "proxy protocol"
16359 This option enables use of Proxy Protocol proxies for incoming
16360 connections.  For details see section &<<SECTproxyInbound>>&.
16361
16362
16363 .option hosts_treat_as_local main "domain list&!!" unset
16364 .cindex "local host" "domains treated as"
16365 .cindex "host" "treated as local"
16366 If this option is set, any host names that match the domain list are treated as
16367 if they were the local host when Exim is scanning host lists obtained from MX
16368 records
16369 or other sources. Note that the value of this option is a domain list, not a
16370 host list, because it is always used to check host names, not IP addresses.
16371
16372 This option also applies when Exim is matching the special items
16373 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16374 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16375 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16376 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16377 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16378 interfaces and recognizing the local host.
16379
16380
16381 .option ibase_servers main "string list" unset
16382 .cindex "InterBase" "server list"
16383 This option provides a list of InterBase servers and associated connection data,
16384 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16385 The option is available only if Exim has been built with InterBase support.
16386
16387
16388
16389 .option ignore_bounce_errors_after main time 10w
16390 .cindex "bounce message" "discarding"
16391 .cindex "discarding bounce message"
16392 This option affects the processing of bounce messages that cannot be delivered,
16393 that is, those that suffer a permanent delivery failure. (Bounce messages that
16394 suffer temporary delivery failures are of course retried in the usual way.)
16395
16396 After a permanent delivery failure, bounce messages are frozen,
16397 because there is no sender to whom they can be returned. When a frozen bounce
16398 message has been in the queue for more than the given time, it is unfrozen at
16399 the next queue run, and a further delivery is attempted. If delivery fails
16400 again, the bounce message is discarded. This makes it possible to keep failed
16401 bounce messages around for a shorter time than the normal maximum retry time
16402 for frozen messages. For example,
16403 .code
16404 ignore_bounce_errors_after = 12h
16405 .endd
16406 retries failed bounce message deliveries after 12 hours, discarding any further
16407 failures. If the value of this option is set to a zero time period, bounce
16408 failures are discarded immediately. Setting a very long time (as in the default
16409 value) has the effect of disabling this option. For ways of automatically
16410 dealing with other kinds of frozen message, see &%auto_thaw%& and
16411 &%timeout_frozen_after%&.
16412
16413
16414 .option ignore_fromline_hosts main "host list&!!" unset
16415 .cindex "&""From""& line"
16416 .cindex "UUCP" "&""From""& line"
16417 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16418 the headers of a message. By default this is treated as the start of the
16419 message's body, which means that any following headers are not recognized as
16420 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16421 match those hosts that insist on sending it. If the sender is actually a local
16422 process rather than a remote host, and is using &%-bs%& to inject the messages,
16423 &%ignore_fromline_local%& must be set to achieve this effect.
16424
16425
16426 .option ignore_fromline_local main boolean false
16427 See &%ignore_fromline_hosts%& above.
16428
16429 .option keep_environment main "string list" unset
16430 .cindex "environment" "values from"
16431 This option contains a string list of environment variables to keep.
16432 You have to trust these variables or you have to be sure that
16433 these variables do not impose any security risk. Keep in mind that
16434 during the startup phase Exim is running with an effective UID 0 in most
16435 installations. As the default value is an empty list, the default
16436 environment for using libraries, running embedded Perl code, or running
16437 external binaries is empty, and does not not even contain PATH or HOME.
16438
16439 Actually the list is interpreted as a list of patterns
16440 (&<<SECTlistexpand>>&), except that it is not expanded first.
16441
16442 WARNING: Macro substitution is still done first, so having a macro
16443 FOO and having FOO_HOME in your &%keep_environment%& option may have
16444 unexpected results. You may work around this using a regular expression
16445 that does not match the macro name: ^[F]OO_HOME$.
16446
16447 Current versions of Exim issue a warning during startup if you do not mention
16448 &%keep_environment%& in your runtime configuration file and if your
16449 current environment is not empty. Future versions may not issue that warning
16450 anymore.
16451
16452 See the &%add_environment%& main config option for a way to set
16453 environment variables to a fixed value.  The environment for &(pipe)&
16454 transports is handled separately, see section &<<SECTpipeenv>>& for
16455 details.
16456
16457
16458 .option keep_malformed main time 4d
16459 This option specifies the length of time to keep messages whose spool files
16460 have been corrupted in some way. This should, of course, never happen. At the
16461 next attempt to deliver such a message, it gets removed. The incident is
16462 logged.
16463
16464
16465 .option ldap_ca_cert_dir main string unset
16466 .cindex "LDAP", "TLS CA certificate directory"
16467 .cindex certificate "directory for LDAP"
16468 This option indicates which directory contains CA certificates for verifying
16469 a TLS certificate presented by an LDAP server.
16470 While Exim does not provide a default value, your SSL library may.
16471 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16472 and constrained to be a directory.
16473
16474
16475 .option ldap_ca_cert_file main string unset
16476 .cindex "LDAP", "TLS CA certificate file"
16477 .cindex certificate "file for LDAP"
16478 This option indicates which file contains CA certificates for verifying
16479 a TLS certificate presented by an LDAP server.
16480 While Exim does not provide a default value, your SSL library may.
16481 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16482 and constrained to be a file.
16483
16484
16485 .option ldap_cert_file main string unset
16486 .cindex "LDAP" "TLS client certificate file"
16487 .cindex certificate "file for LDAP"
16488 This option indicates which file contains an TLS client certificate which
16489 Exim should present to the LDAP server during TLS negotiation.
16490 Should be used together with &%ldap_cert_key%&.
16491
16492
16493 .option ldap_cert_key main string unset
16494 .cindex "LDAP" "TLS client key file"
16495 .cindex certificate "key for LDAP"
16496 This option indicates which file contains the secret/private key to use
16497 to prove identity to the LDAP server during TLS negotiation.
16498 Should be used together with &%ldap_cert_file%&, which contains the
16499 identity to be proven.
16500
16501
16502 .option ldap_cipher_suite main string unset
16503 .cindex "LDAP" "TLS cipher suite"
16504 This controls the TLS cipher-suite negotiation during TLS negotiation with
16505 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16506 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16507
16508
16509 .option ldap_default_servers main "string list" unset
16510 .cindex "LDAP" "default servers"
16511 This option provides a list of LDAP servers which are tried in turn when an
16512 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16513 details of LDAP queries. This option is available only when Exim has been built
16514 with LDAP support.
16515
16516
16517 .option ldap_require_cert main string unset.
16518 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16519 This should be one of the values "hard", "demand", "allow", "try" or "never".
16520 A value other than one of these is interpreted as "never".
16521 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16522 Although Exim does not set a default, the LDAP library probably defaults
16523 to hard/demand.
16524
16525
16526 .option ldap_start_tls main boolean false
16527 .cindex "LDAP" "whether or not to negotiate TLS"
16528 If set, Exim will attempt to negotiate TLS with the LDAP server when
16529 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16530 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16531 of SSL-on-connect.
16532 In the event of failure to negotiate TLS, the action taken is controlled
16533 by &%ldap_require_cert%&.
16534 This option is ignored for &`ldapi`& connections.
16535
16536
16537 .option ldap_version main integer unset
16538 .cindex "LDAP" "protocol version, forcing"
16539 This option can be used to force Exim to set a specific protocol version for
16540 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16541 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16542 the LDAP headers; otherwise it is 2. This option is available only when Exim
16543 has been built with LDAP support.
16544
16545
16546
16547 .option local_from_check main boolean true
16548 .cindex "&'Sender:'& header line" "disabling addition of"
16549 .cindex "&'From:'& header line" "disabling checking of"
16550 When a message is submitted locally (that is, not over a TCP/IP connection) by
16551 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16552 checks that the &'From:'& header line matches the login of the calling user and
16553 the domain specified by &%qualify_domain%&.
16554
16555 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16556 locally submitted message is automatically qualified by Exim, unless the
16557 &%-bnq%& command line option is used.
16558
16559 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16560 on the local part. If the &'From:'& header line does not match, Exim adds a
16561 &'Sender:'& header with an address constructed from the calling user's login
16562 and the default qualify domain.
16563
16564 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16565 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16566 &'Sender:'& header lines supplied by untrusted users, you must also set
16567 &%local_sender_retain%& to be true.
16568
16569 .cindex "envelope from"
16570 .cindex "envelope sender"
16571 These options affect only the header lines in the message. The envelope sender
16572 is still forced to be the login id at the qualify domain unless
16573 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16574
16575 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16576 request similar header line checking. See section &<<SECTthesenhea>>&, which
16577 has more details about &'Sender:'& processing.
16578
16579
16580
16581
16582 .option local_from_prefix main string unset
16583 When Exim checks the &'From:'& header line of locally submitted messages for
16584 matching the login id (see &%local_from_check%& above), it can be configured to
16585 ignore certain prefixes and suffixes in the local part of the address. This is
16586 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16587 appropriate lists, in the same form as the &%local_part_prefix%& and
16588 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16589 example, if
16590 .code
16591 local_from_prefix = *-
16592 .endd
16593 is set, a &'From:'& line containing
16594 .code
16595 From: anything-user@your.domain.example
16596 .endd
16597 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16598 matches the actual sender address that is constructed from the login name and
16599 qualify domain.
16600
16601
16602 .option local_from_suffix main string unset
16603 See &%local_from_prefix%& above.
16604
16605
16606 .option local_interfaces main "string list" "see below"
16607 This option controls which network interfaces are used by the daemon for
16608 listening; they are also used to identify the local host when routing. Chapter
16609 &<<CHAPinterfaces>>& contains a full description of this option and the related
16610 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16611 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16612 &%local_interfaces%& is
16613 .code
16614 local_interfaces = 0.0.0.0
16615 .endd
16616 when Exim is built without IPv6 support; otherwise it is
16617 .code
16618 local_interfaces = <; ::0 ; 0.0.0.0
16619 .endd
16620
16621 .option local_scan_timeout main time 5m
16622 .cindex "timeout" "for &[local_scan()]& function"
16623 .cindex "&[local_scan()]& function" "timeout"
16624 This timeout applies to the &[local_scan()]& function (see chapter
16625 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16626 the incoming message is rejected with a temporary error if it is an SMTP
16627 message. For a non-SMTP message, the message is dropped and Exim ends with a
16628 non-zero code. The incident is logged on the main and reject logs.
16629
16630
16631
16632 .option local_sender_retain main boolean false
16633 .cindex "&'Sender:'& header line" "retaining from local submission"
16634 When a message is submitted locally (that is, not over a TCP/IP connection) by
16635 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16636 do not want this to happen, you must set &%local_sender_retain%&, and you must
16637 also set &%local_from_check%& to be false (Exim will complain if you do not).
16638 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16639 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16640
16641
16642
16643
16644 .option localhost_number main string&!! unset
16645 .cindex "host" "locally unique number for"
16646 .cindex "message ids" "with multiple hosts"
16647 .vindex "&$localhost_number$&"
16648 Exim's message ids are normally unique only within the local host. If
16649 uniqueness among a set of hosts is required, each host must set a different
16650 value for the &%localhost_number%& option. The string is expanded immediately
16651 after reading the configuration file (so that a number can be computed from the
16652 host name, for example) and the result of the expansion must be a number in the
16653 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16654 systems). This is available in subsequent string expansions via the variable
16655 &$localhost_number$&. When &%localhost_number is set%&, the final two
16656 characters of the message id, instead of just being a fractional part of the
16657 time, are computed from the time and the local host number as described in
16658 section &<<SECTmessiden>>&.
16659
16660
16661
16662 .option log_file_path main "string list&!!" "set at compile time"
16663 .cindex "log" "file path for"
16664 This option sets the path which is used to determine the names of Exim's log
16665 files, or indicates that logging is to be to syslog, or both. It is expanded
16666 when Exim is entered, so it can, for example, contain a reference to the host
16667 name. If no specific path is set for the log files at compile or runtime,
16668 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16669 they are written in a sub-directory called &_log_& in Exim's spool directory.
16670 A path must start with a slash.
16671 To send to syslog, use the word &"syslog"&.
16672 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16673 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16674 used. If this string is fixed at your installation (contains no expansion
16675 variables) it is recommended that you do not set this option in the
16676 configuration file, but instead supply the path using LOG_FILE_PATH in
16677 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16678 early on &-- in particular, failure to read the configuration file.
16679
16680
16681 .option log_selector main string unset
16682 .cindex "log" "selectors"
16683 This option can be used to reduce or increase the number of things that Exim
16684 writes to its log files. Its argument is made up of names preceded by plus or
16685 minus characters. For example:
16686 .code
16687 log_selector = +arguments -retry_defer
16688 .endd
16689 A list of possible names and what they control is given in the chapter on
16690 logging, in section &<<SECTlogselector>>&.
16691
16692
16693 .option log_timezone main boolean false
16694 .cindex "log" "timezone for entries"
16695 .vindex "&$tod_log$&"
16696 .vindex "&$tod_zone$&"
16697 By default, the timestamps on log lines are in local time without the
16698 timezone. This means that if your timezone changes twice a year, the timestamps
16699 in log lines are ambiguous for an hour when the clocks go back. One way of
16700 avoiding this problem is to set the timezone to UTC. An alternative is to set
16701 &%log_timezone%& true. This turns on the addition of the timezone offset to
16702 timestamps in log lines. Turning on this option can add quite a lot to the size
16703 of log files because each line is extended by 6 characters. Note that the
16704 &$tod_log$& variable contains the log timestamp without the zone, but there is
16705 another variable called &$tod_zone$& that contains just the timezone offset.
16706
16707
16708 .option lookup_open_max main integer 25
16709 .cindex "too many open files"
16710 .cindex "open files, too many"
16711 .cindex "file" "too many open"
16712 .cindex "lookup" "maximum open files"
16713 .cindex "limit" "open files for lookups"
16714 This option limits the number of simultaneously open files for single-key
16715 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16716 Exim normally keeps these files open during routing, because often the same
16717 file is required several times. If the limit is reached, Exim closes the least
16718 recently used file. Note that if you are using the &'ndbm'& library, it
16719 actually opens two files for each logical DBM database, though it still counts
16720 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16721 open files"& errors with NDBM, you need to reduce the value of
16722 &%lookup_open_max%&.
16723
16724
16725 .option max_username_length main integer 0
16726 .cindex "length of login name"
16727 .cindex "user name" "maximum length"
16728 .cindex "limit" "user name length"
16729 Some operating systems are broken in that they truncate long arguments to
16730 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16731 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16732 an argument that is longer behaves as if &[getpwnam()]& failed.
16733
16734
16735 .option message_body_newlines main bool false
16736 .cindex "message body" "newlines in variables"
16737 .cindex "newline" "in message body variables"
16738 .vindex "&$message_body$&"
16739 .vindex "&$message_body_end$&"
16740 By default, newlines in the message body are replaced by spaces when setting
16741 the &$message_body$& and &$message_body_end$& expansion variables. If this
16742 option is set true, this no longer happens.
16743
16744
16745 .option message_body_visible main integer 500
16746 .cindex "body of message" "visible size"
16747 .cindex "message body" "visible size"
16748 .vindex "&$message_body$&"
16749 .vindex "&$message_body_end$&"
16750 This option specifies how much of a message's body is to be included in the
16751 &$message_body$& and &$message_body_end$& expansion variables.
16752
16753
16754 .option message_id_header_domain main string&!! unset
16755 .cindex "&'Message-ID:'& header line"
16756 If this option is set, the string is expanded and used as the right hand side
16757 (domain) of the &'Message-ID:'& header that Exim creates if a
16758 locally-originated incoming message does not have one. &"Locally-originated"&
16759 means &"not received over TCP/IP."&
16760 Otherwise, the primary host name is used.
16761 Only letters, digits, dot and hyphen are accepted; any other characters are
16762 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16763 empty string, the option is ignored.
16764
16765
16766 .option message_id_header_text main string&!! unset
16767 If this variable is set, the string is expanded and used to augment the text of
16768 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16769 message does not have one. The text of this header is required by RFC 2822 to
16770 take the form of an address. By default, Exim uses its internal message id as
16771 the local part, and the primary host name as the domain. If this option is set,
16772 it is expanded, and provided the expansion is not forced to fail, and does not
16773 yield an empty string, the result is inserted into the header immediately
16774 before the @, separated from the internal message id by a dot. Any characters
16775 that are illegal in an address are automatically converted into hyphens. This
16776 means that variables such as &$tod_log$& can be used, because the spaces and
16777 colons will become hyphens.
16778
16779
16780 .option message_logs main boolean true
16781 .cindex "message logs" "disabling"
16782 .cindex "log" "message log; disabling"
16783 If this option is turned off, per-message log files are not created in the
16784 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16785 Exim, by reducing the number of files involved in handling a message from a
16786 minimum of four (header spool file, body spool file, delivery journal, and
16787 per-message log) to three. The other major I/O activity is Exim's main log,
16788 which is not affected by this option.
16789
16790
16791 .option message_size_limit main string&!! 50M
16792 .cindex "message" "size limit"
16793 .cindex "limit" "message size"
16794 .cindex "size" "of message, limit"
16795 This option limits the maximum size of message that Exim will process. The
16796 value is expanded for each incoming connection so, for example, it can be made
16797 to depend on the IP address of the remote host for messages arriving via
16798 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16799 optionally followed by K or M.
16800
16801 .cindex "SIZE" "ESMTP extension, advertising"
16802 .cindex "ESMTP extensions" SIZE
16803 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16804 service extension keyword.
16805
16806 &*Note*&: This limit cannot be made to depend on a message's sender or any
16807 other properties of an individual message, because it has to be advertised in
16808 the server's response to EHLO. String expansion failure causes a temporary
16809 error. A value of zero means no limit, but its use is not recommended. See also
16810 &%bounce_return_size_limit%&.
16811
16812 Incoming SMTP messages are failed with a 552 error if the limit is
16813 exceeded; locally-generated messages either get a stderr message or a delivery
16814 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16815 an oversized message is logged in both the main and the reject logs. See also
16816 the generic transport option &%message_size_limit%&, which limits the size of
16817 message that an individual transport can process.
16818
16819 If you use a virus-scanner and set this option to to a value larger than the
16820 maximum size that your virus-scanner is configured to support, you may get
16821 failures triggered by large mails.  The right size to configure for the
16822 virus-scanner depends upon what data is passed and the options in use but it's
16823 probably safest to just set it to a little larger than this value.  E.g., with a
16824 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16825 some problems may result.
16826
16827 A value of 0 will disable size limit checking; Exim will still advertise the
16828 SIZE extension in an EHLO response, but without a limit, so as to permit
16829 SMTP clients to still indicate the message size along with the MAIL verb.
16830
16831
16832 .option move_frozen_messages main boolean false
16833 .cindex "frozen messages" "moving"
16834 This option, which is available only if Exim has been built with the setting
16835 .code
16836 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16837 .endd
16838 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16839 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16840 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16841 standard utilities for handling such moved messages, and they do not show up in
16842 lists generated by &%-bp%& or by the Exim monitor.
16843
16844
16845 .option mua_wrapper main boolean false
16846 Setting this option true causes Exim to run in a very restrictive mode in which
16847 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16848 contains a full description of this facility.
16849
16850
16851
16852 .option mysql_servers main "string list" unset
16853 .cindex "MySQL" "server list"
16854 This option provides a list of MySQL servers and associated connection data, to
16855 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16856 option is available only if Exim has been built with MySQL support.
16857
16858
16859 .option never_users main "string list&!!" unset
16860 This option is expanded just once, at the start of Exim's processing. Local
16861 message deliveries are normally run in processes that are setuid to the
16862 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16863 It is usually desirable to prevent any deliveries from running as root, as a
16864 safety precaution.
16865
16866 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16867 list of users that must not be used for local deliveries. This list is fixed in
16868 the binary and cannot be overridden by the configuration file. By default, it
16869 contains just the single user name &"root"&. The &%never_users%& runtime option
16870 can be used to add more users to the fixed list.
16871
16872 If a message is to be delivered as one of the users on the fixed list or the
16873 &%never_users%& list, an error occurs, and delivery is deferred. A common
16874 example is
16875 .code
16876 never_users = root:daemon:bin
16877 .endd
16878 Including root is redundant if it is also on the fixed list, but it does no
16879 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16880 transport driver.
16881
16882
16883 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16884 This option gives the name for a unix-domain socket on which the daemon
16885 listens for work and information-requests.
16886 Only installations running multiple daemons sharing a spool directory
16887 should need to modify the default.
16888
16889 The option is expanded before use.
16890 If the platform supports Linux-style abstract socket names, the result
16891 is used with a nul byte prefixed.
16892 Otherwise,
16893 it should be a full path name and use a directory accessible
16894 to Exim.
16895
16896 If this option is set as empty,
16897 or the command line &%-oY%& option is used, or
16898 the command line uses a &%-oX%& option and does not use &%-oP%&,
16899 then a notifier socket is not created.
16900
16901
16902 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16903 .cindex "OpenSSL "compatibility options"
16904 This option allows an administrator to adjust the SSL options applied
16905 by OpenSSL to connections.  It is given as a space-separated list of items,
16906 each one to be +added or -subtracted from the current value.
16907
16908 This option is only available if Exim is built against OpenSSL.  The values
16909 available for this option vary according to the age of your OpenSSL install.
16910 The &"all"& value controls a subset of flags which are available, typically
16911 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16912 list the values known on your system and Exim should support all the
16913 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16914 names lose the leading &"SSL_OP_"& and are lower-cased.
16915
16916 Note that adjusting the options can have severe impact upon the security of
16917 SSL as used by Exim.  It is possible to disable safety checks and shoot
16918 yourself in the foot in various unpleasant ways.  This option should not be
16919 adjusted lightly.  An unrecognised item will be detected at startup, by
16920 invoking Exim with the &%-bV%& flag.
16921
16922 The option affects Exim operating both as a server and as a client.
16923
16924 Historical note: prior to release 4.80, Exim defaulted this value to
16925 "+dont_insert_empty_fragments", which may still be needed for compatibility
16926 with some clients, but which lowers security by increasing exposure to
16927 some now infamous attacks.
16928
16929 Examples:
16930 .code
16931 # Make both old MS and old Eudora happy:
16932 openssl_options = -all +microsoft_big_sslv3_buffer \
16933                        +dont_insert_empty_fragments
16934
16935 # Disable older protocol versions:
16936 openssl_options = +no_sslv2 +no_sslv3
16937 .endd
16938
16939 Possible options may include:
16940 .ilist
16941 &`all`&
16942 .next
16943 &`allow_unsafe_legacy_renegotiation`&
16944 .next
16945 &`cipher_server_preference`&
16946 .next
16947 &`dont_insert_empty_fragments`&
16948 .next
16949 &`ephemeral_rsa`&
16950 .next
16951 &`legacy_server_connect`&
16952 .next
16953 &`microsoft_big_sslv3_buffer`&
16954 .next
16955 &`microsoft_sess_id_bug`&
16956 .next
16957 &`msie_sslv2_rsa_padding`&
16958 .next
16959 &`netscape_challenge_bug`&
16960 .next
16961 &`netscape_reuse_cipher_change_bug`&
16962 .next
16963 &`no_compression`&
16964 .next
16965 &`no_session_resumption_on_renegotiation`&
16966 .next
16967 &`no_sslv2`&
16968 .next
16969 &`no_sslv3`&
16970 .next
16971 &`no_ticket`&
16972 .next
16973 &`no_tlsv1`&
16974 .next
16975 &`no_tlsv1_1`&
16976 .next
16977 &`no_tlsv1_2`&
16978 .next
16979 &`safari_ecdhe_ecdsa_bug`&
16980 .next
16981 &`single_dh_use`&
16982 .next
16983 &`single_ecdh_use`&
16984 .next
16985 &`ssleay_080_client_dh_bug`&
16986 .next
16987 &`sslref2_reuse_cert_type_bug`&
16988 .next
16989 &`tls_block_padding_bug`&
16990 .next
16991 &`tls_d5_bug`&
16992 .next
16993 &`tls_rollback_bug`&
16994 .endlist
16995
16996 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16997 all clients connecting using the MacOS SecureTransport TLS facility prior
16998 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16999 to negotiate TLS then this option value might help, provided that your OpenSSL
17000 release is new enough to contain this work-around.  This may be a situation
17001 where you have to upgrade OpenSSL to get buggy clients working.
17002
17003
17004 .option oracle_servers main "string list" unset
17005 .cindex "Oracle" "server list"
17006 This option provides a list of Oracle servers and associated connection data,
17007 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17008 The option is available only if Exim has been built with Oracle support.
17009
17010
17011 .new
17012 .option panic_coredump main boolean false
17013 This option is rarely needed but can help for some debugging investigations.
17014 If set, when an internal error is detected by Exim which is sufficient
17015 to terminate the process
17016 (all such are logged in the paniclog)
17017 then a coredump is requested.
17018
17019 Note that most systems require additional administrative configuration
17020 to permit write a core file for a setuid program, which is Exim's
17021 common installed configuration.
17022 .wen
17023
17024 .option percent_hack_domains main "domain list&!!" unset
17025 .cindex "&""percent hack""&"
17026 .cindex "source routing" "in email address"
17027 .cindex "address" "source-routed"
17028 The &"percent hack"& is the convention whereby a local part containing a
17029 percent sign is re-interpreted as a new email address, with the percent
17030 replaced by @. This is sometimes called &"source routing"&, though that term is
17031 also applied to RFC 2822 addresses that begin with an @ character. If this
17032 option is set, Exim implements the percent facility for those domains listed,
17033 but no others. This happens before an incoming SMTP address is tested against
17034 an ACL.
17035
17036 &*Warning*&: The &"percent hack"& has often been abused by people who are
17037 trying to get round relaying restrictions. For this reason, it is best avoided
17038 if at all possible. Unfortunately, a number of less security-conscious MTAs
17039 implement it unconditionally. If you are running Exim on a gateway host, and
17040 routing mail through to internal MTAs without processing the local parts, it is
17041 a good idea to reject recipient addresses with percent characters in their
17042 local parts. Exim's default configuration does this.
17043
17044
17045 .option perl_at_start main boolean false
17046 .cindex "Perl"
17047 This option is available only when Exim is built with an embedded Perl
17048 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17049
17050
17051 .option perl_startup main string unset
17052 .cindex "Perl"
17053 This option is available only when Exim is built with an embedded Perl
17054 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17055
17056 .option perl_taintmode main boolean false
17057 .cindex "Perl"
17058 This option enables the taint mode of the embedded Perl interpreter.
17059
17060
17061 .option pgsql_servers main "string list" unset
17062 .cindex "PostgreSQL lookup type" "server list"
17063 This option provides a list of PostgreSQL servers and associated connection
17064 data, to be used in conjunction with &(pgsql)& lookups (see section
17065 &<<SECID72>>&). The option is available only if Exim has been built with
17066 PostgreSQL support.
17067
17068
17069 .option pid_file_path main string&!! "set at compile time"
17070 .cindex "daemon" "pid file path"
17071 .cindex "pid file, path for"
17072 This option sets the name of the file to which the Exim daemon writes its
17073 process id. The string is expanded, so it can contain, for example, references
17074 to the host name:
17075 .code
17076 pid_file_path = /var/log/$primary_hostname/exim.pid
17077 .endd
17078 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17079 spool directory.
17080 The value set by the option can be overridden by the &%-oP%& command line
17081 option. A pid file is not written if a &"non-standard"& daemon is run by means
17082 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17083
17084
17085 .option pipelining_advertise_hosts main "host list&!!" *
17086 .cindex "PIPELINING" "suppressing advertising"
17087 .cindex "ESMTP extensions" PIPELINING
17088 This option can be used to suppress the advertisement of the SMTP
17089 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17090 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17091 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17092 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17093 that clients will use it; &"out of order"& commands that are &"expected"& do
17094 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17095
17096 .option pipelining_connect_advertise_hosts main "host list&!!" *
17097 .cindex "pipelining" "early connection"
17098 .cindex "pipelining" PIPECONNECT
17099 .cindex "ESMTP extensions" PIPECONNECT
17100 If Exim is built without the DISABLE_PIPE_CONNECT build option
17101 this option controls which hosts the facility is advertised to
17102 and from which pipeline early-connection (before MAIL) SMTP
17103 commands are acceptable.
17104 When used, the pipelining saves on roundtrip times.
17105
17106 See also the &%hosts_pipe_connect%& smtp transport option.
17107
17108 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17109 it permits the client to pipeline
17110 TCP connection and hello command (inclear phase),
17111 or TLS-establishment and hello command (encrypted phase),
17112 on later connections to the same host.
17113
17114
17115 .option prdr_enable main boolean false
17116 .cindex "PRDR" "enabling on server"
17117 .cindex "ESMTP extensions" PRDR
17118 This option can be used to enable the Per-Recipient Data Response extension
17119 to SMTP, defined by Eric Hall.
17120 If the option is set, PRDR is advertised by Exim when operating as a server.
17121 If the client requests PRDR, and more than one recipient, for a message
17122 an additional ACL is called for each recipient after the message content
17123 is received.  See section &<<SECTPRDRACL>>&.
17124
17125 .option preserve_message_logs main boolean false
17126 .cindex "message logs" "preserving"
17127 If this option is set, message log files are not deleted when messages are
17128 completed. Instead, they are moved to a sub-directory of the spool directory
17129 called &_msglog.OLD_&, where they remain available for statistical or debugging
17130 purposes. This is a dangerous option to set on systems with any appreciable
17131 volume of mail. Use with care!
17132
17133
17134 .option primary_hostname main string "see below"
17135 .cindex "name" "of local host"
17136 .cindex "host" "name of local"
17137 .cindex "local host" "name of"
17138 .vindex "&$primary_hostname$&"
17139 This specifies the name of the current host. It is used in the default EHLO or
17140 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17141 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17142 The value is also used by default in some SMTP response messages from an Exim
17143 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17144
17145 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17146 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17147 contains only one component, Exim passes it to &[gethostbyname()]& (or
17148 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17149 version. The variable &$primary_hostname$& contains the host name, whether set
17150 explicitly by this option, or defaulted.
17151
17152
17153 .option print_topbitchars main boolean false
17154 .cindex "printing characters"
17155 .cindex "8-bit characters"
17156 By default, Exim considers only those characters whose codes lie in the range
17157 32&--126 to be printing characters. In a number of circumstances (for example,
17158 when writing log entries) non-printing characters are converted into escape
17159 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17160 is set, code values of 128 and above are also considered to be printing
17161 characters.
17162
17163 This option also affects the header syntax checks performed by the
17164 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17165 the user's full name when constructing From: and Sender: addresses (as
17166 described in section &<<SECTconstr>>&). Setting this option can cause
17167 Exim to generate eight bit message headers that do not conform to the
17168 standards.
17169
17170
17171 .option process_log_path main string unset
17172 .cindex "process log path"
17173 .cindex "log" "process log"
17174 .cindex "&'exiwhat'&"
17175 This option sets the name of the file to which an Exim process writes its
17176 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17177 utility script. If this option is unset, the file called &_exim-process.info_&
17178 in Exim's spool directory is used. The ability to specify the name explicitly
17179 can be useful in environments where two different Exims are running, using
17180 different spool directories.
17181
17182
17183 .option prod_requires_admin main boolean true
17184 .cindex "restricting access to features"
17185 .oindex "&%-M%&"
17186 .oindex "&%-R%&"
17187 .oindex "&%-q%&"
17188 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17189 admin user unless &%prod_requires_admin%& is set false. See also
17190 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17191
17192
17193 .option proxy_protocol_timeout main time 3s
17194 .cindex proxy "proxy protocol"
17195 This option sets the timeout for proxy protocol negotiation.
17196 For details see section &<<SECTproxyInbound>>&.
17197
17198
17199 .option qualify_domain main string "see below"
17200 .cindex "domain" "for qualifying addresses"
17201 .cindex "address" "qualification"
17202 This option specifies the domain name that is added to any envelope sender
17203 addresses that do not have a domain qualification. It also applies to
17204 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17205 are accepted by default only for locally-generated messages. Qualification is
17206 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17207 locally-generated messages, unless the &%-bnq%& command line option is used.
17208
17209 Messages from external sources must always contain fully qualified addresses,
17210 unless the sending host matches &%sender_unqualified_hosts%& or
17211 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17212 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17213 necessary. Internally, Exim always works with fully qualified envelope
17214 addresses. If &%qualify_domain%& is not set, it defaults to the
17215 &%primary_hostname%& value.
17216
17217
17218 .option qualify_recipient main string "see below"
17219 This option allows you to specify a different domain for qualifying recipient
17220 addresses to the one that is used for senders. See &%qualify_domain%& above.
17221
17222
17223
17224 .option queue_domains main "domain list&!!" unset
17225 .cindex "domain" "specifying non-immediate delivery"
17226 .cindex "queueing incoming messages"
17227 .cindex "message" "queueing certain domains"
17228 This option lists domains for which immediate delivery is not required.
17229 A delivery process is started whenever a message is received, but only those
17230 domains that do not match are processed. All other deliveries wait until the
17231 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17232
17233
17234 .option queue_fast_ramp main boolean true
17235 .cindex "queue runner" "two phase"
17236 .cindex "queue" "double scanning"
17237 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17238 command line, may start parallel delivery processes during their first
17239 phase.  This will be done when a threshold number of messages have been
17240 routed for a single host.
17241
17242
17243 .option queue_list_requires_admin main boolean true
17244 .cindex "restricting access to features"
17245 .oindex "&%-bp%&"
17246 The &%-bp%& command-line option, which lists the messages that are on the
17247 queue, requires the caller to be an admin user unless
17248 &%queue_list_requires_admin%& is set false.
17249 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17250
17251
17252 .option queue_only main boolean false
17253 .cindex "queueing incoming messages"
17254 .cindex "message" "queueing unconditionally"
17255 If &%queue_only%& is set, a delivery process is not automatically started
17256 whenever a message is received. Instead, the message waits in the queue for the
17257 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17258 delivered immediately when certain conditions (such as heavy load) occur.
17259
17260 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17261 and &%-odi%& command line options override &%queue_only%& unless
17262 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17263 &%queue_only_load%&, and &%smtp_accept_queue%&.
17264
17265
17266 .option queue_only_file main string unset
17267 .cindex "queueing incoming messages"
17268 .cindex "message" "queueing by file existence"
17269 This option can be set to a colon-separated list of absolute path names, each
17270 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17271 it tests for the existence of each listed path using a call to &[stat()]&. For
17272 each path that exists, the corresponding queueing option is set.
17273 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17274 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17275 .code
17276 queue_only_file = smtp/some/file
17277 .endd
17278 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17279 &_/some/file_& exists.
17280
17281
17282 .option queue_only_load main fixed-point unset
17283 .cindex "load average"
17284 .cindex "queueing incoming messages"
17285 .cindex "message" "queueing by load"
17286 If the system load average is higher than this value, incoming messages from
17287 all sources are queued, and no automatic deliveries are started. If this
17288 happens during local or remote SMTP input, all subsequent messages received on
17289 the same SMTP connection are queued by default, whatever happens to the load in
17290 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17291 false.
17292
17293 Deliveries will subsequently be performed by queue runner processes. This
17294 option has no effect on ancient operating systems on which Exim cannot
17295 determine the load average. See also &%deliver_queue_load_max%& and
17296 &%smtp_load_reserve%&.
17297
17298
17299 .option queue_only_load_latch main boolean true
17300 .cindex "load average" "re-evaluating per message"
17301 When this option is true (the default), once one message has been queued
17302 because the load average is higher than the value set by &%queue_only_load%&,
17303 all subsequent messages received on the same SMTP connection are also queued.
17304 This is a deliberate choice; even though the load average may fall below the
17305 threshold, it doesn't seem right to deliver later messages on the same
17306 connection when not delivering earlier ones. However, there are special
17307 circumstances such as very long-lived connections from scanning appliances
17308 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17309 should be set false. This causes the value of the load average to be
17310 re-evaluated for each message.
17311
17312
17313 .option queue_only_override main boolean true
17314 .cindex "queueing incoming messages"
17315 When this option is true, the &%-od%&&'x'& command line options override the
17316 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17317 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17318 to override; they are accepted, but ignored.
17319
17320
17321 .option queue_run_in_order main boolean false
17322 .cindex "queue runner" "processing messages in order"
17323 If this option is set, queue runs happen in order of message arrival instead of
17324 in an arbitrary order. For this to happen, a complete list of the entire queue
17325 must be set up before the deliveries start. When the queue is all held in a
17326 single directory (the default), a single list is created for both the ordered
17327 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17328 single list is not created when &%queue_run_in_order%& is false. In this case,
17329 the sub-directories are processed one at a time (in a random order), and this
17330 avoids setting up one huge list for the whole queue. Thus, setting
17331 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17332 when the queue is large, because of the extra work in setting up the single,
17333 large list. In most situations, &%queue_run_in_order%& should not be set.
17334
17335
17336
17337 .option queue_run_max main integer&!! 5
17338 .cindex "queue runner" "maximum number of"
17339 This controls the maximum number of queue runner processes that an Exim daemon
17340 can run simultaneously. This does not mean that it starts them all at once,
17341 but rather that if the maximum number are still running when the time comes to
17342 start another one, it refrains from starting another one. This can happen with
17343 very large queues and/or very sluggish deliveries. This option does not,
17344 however, interlock with other processes, so additional queue runners can be
17345 started by other means, or by killing and restarting the daemon.
17346
17347 Setting this option to zero does not suppress queue runs; rather, it disables
17348 the limit, allowing any number of simultaneous queue runner processes to be
17349 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17350 the daemon's command line.
17351
17352 .cindex queues named
17353 .cindex "named queues" "resource limit"
17354 To set limits for different named queues use
17355 an expansion depending on the &$queue_name$& variable.
17356
17357 .option queue_smtp_domains main "domain list&!!" unset
17358 .cindex "queueing incoming messages"
17359 .cindex "message" "queueing remote deliveries"
17360 .cindex "first pass routing"
17361 When this option is set, a delivery process is started whenever a message is
17362 received, routing is performed, and local deliveries take place.
17363 However, if any SMTP deliveries are required for domains that match
17364 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17365 message waits in the queue for the next queue run. Since routing of the message
17366 has taken place, Exim knows to which remote hosts it must be delivered, and so
17367 when the queue run happens, multiple messages for the same host are delivered
17368 over a single SMTP connection. The &%-odqs%& command line option causes all
17369 SMTP deliveries to be queued in this way, and is equivalent to setting
17370 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17371 &%queue_domains%&.
17372
17373
17374 .option receive_timeout main time 0s
17375 .cindex "timeout" "for non-SMTP input"
17376 This option sets the timeout for accepting a non-SMTP message, that is, the
17377 maximum time that Exim waits when reading a message on the standard input. If
17378 the value is zero, it will wait forever. This setting is overridden by the
17379 &%-or%& command line option. The timeout for incoming SMTP messages is
17380 controlled by &%smtp_receive_timeout%&.
17381
17382 .option received_header_text main string&!! "see below"
17383 .cindex "customizing" "&'Received:'& header"
17384 .cindex "&'Received:'& header line" "customizing"
17385 This string defines the contents of the &'Received:'& message header that is
17386 added to each message, except for the timestamp, which is automatically added
17387 on at the end (preceded by a semicolon). The string is expanded each time it is
17388 used. If the expansion yields an empty string, no &'Received:'& header line is
17389 added to the message. Otherwise, the string should start with the text
17390 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17391 header lines.
17392 The default setting is:
17393
17394 .code
17395 received_header_text = Received: \
17396   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17397     {${if def:sender_ident \
17398       {from ${quote_local_part:$sender_ident} }}\
17399         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17400   by $primary_hostname \
17401   ${if def:received_protocol {with $received_protocol }}\
17402   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17403   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17404   (Exim $version_number)\n\t\
17405   ${if def:sender_address \
17406   {(envelope-from <$sender_address>)\n\t}}\
17407   id $message_exim_id\
17408   ${if def:received_for {\n\tfor $received_for}}
17409 .endd
17410
17411 The references to the TLS version and cipher are
17412 omitted when Exim is built without TLS
17413 support. The use of conditional expansions ensures that this works for both
17414 locally generated messages and messages received from remote hosts, giving
17415 header lines such as the following:
17416 .code
17417 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17418 by marley.carol.example with esmtp (Exim 4.00)
17419 (envelope-from <bob@carol.example>)
17420 id 16IOWa-00019l-00
17421 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17422 Received: by scrooge.carol.example with local (Exim 4.00)
17423 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17424 .endd
17425 Until the body of the message has been received, the timestamp is the time when
17426 the message started to be received. Once the body has arrived, and all policy
17427 checks have taken place, the timestamp is updated to the time at which the
17428 message was accepted.
17429
17430
17431 .option received_headers_max main integer 30
17432 .cindex "loop" "prevention"
17433 .cindex "mail loop prevention"
17434 .cindex "&'Received:'& header line" "counting"
17435 When a message is to be delivered, the number of &'Received:'& headers is
17436 counted, and if it is greater than this parameter, a mail loop is assumed to
17437 have occurred, the delivery is abandoned, and an error message is generated.
17438 This applies to both local and remote deliveries.
17439
17440
17441 .option recipient_unqualified_hosts main "host list&!!" unset
17442 .cindex "unqualified addresses"
17443 .cindex "host" "unqualified addresses from"
17444 This option lists those hosts from which Exim is prepared to accept unqualified
17445 recipient addresses in message envelopes. The addresses are made fully
17446 qualified by the addition of the &%qualify_recipient%& value. This option also
17447 affects message header lines. Exim does not reject unqualified recipient
17448 addresses in headers, but it qualifies them only if the message came from a
17449 host that matches &%recipient_unqualified_hosts%&,
17450 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17451 option was not set.
17452
17453
17454 .option recipients_max main integer 50000
17455 .cindex "limit" "number of recipients"
17456 .cindex "recipient" "maximum number"
17457 If this option is set greater than zero, it specifies the maximum number of
17458 original recipients for any message. Additional recipients that are generated
17459 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17460 all recipients over the limit; earlier recipients are delivered as normal.
17461 Non-SMTP messages with too many recipients are failed, and no deliveries are
17462 done.
17463
17464 .cindex "RCPT" "maximum number of incoming"
17465 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17466 RCPT commands in a single message.
17467
17468
17469 .option recipients_max_reject main boolean false
17470 If this option is set true, Exim rejects SMTP messages containing too many
17471 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17472 error to the eventual DATA command. Otherwise (the default) it gives a 452
17473 error to the surplus RCPT commands and accepts the message on behalf of the
17474 initial set of recipients. The remote server should then re-send the message
17475 for the remaining recipients at a later time.
17476
17477
17478 .option remote_max_parallel main integer 4
17479 .cindex "delivery" "parallelism for remote"
17480 This option controls parallel delivery of one message to a number of remote
17481 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17482 does all the remote deliveries for a message one by one. Otherwise, if a single
17483 message has to be delivered to more than one remote host, or if several copies
17484 have to be sent to the same remote host, up to &%remote_max_parallel%&
17485 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17486 deliveries are required, the maximum number of processes are started, and as
17487 each one finishes, another is begun. The order of starting processes is the
17488 same as if sequential delivery were being done, and can be controlled by the
17489 &%remote_sort_domains%& option. If parallel delivery takes place while running
17490 with debugging turned on, the debugging output from each delivery process is
17491 tagged with its process id.
17492
17493 This option controls only the maximum number of parallel deliveries for one
17494 message in one Exim delivery process. Because Exim has no central queue
17495 manager, there is no way of controlling the total number of simultaneous
17496 deliveries if the configuration allows a delivery attempt as soon as a message
17497 is received.
17498
17499 See also the &%max_parallel%& generic transport option,
17500 and the &%serialize_hosts%& smtp transport option.
17501
17502 .cindex "number of deliveries"
17503 .cindex "delivery" "maximum number of"
17504 If you want to control the total number of deliveries on the system, you
17505 need to set the &%queue_only%& option. This ensures that all incoming messages
17506 are added to the queue without starting a delivery process. Then set up an Exim
17507 daemon to start queue runner processes at appropriate intervals (probably
17508 fairly often, for example, every minute), and limit the total number of queue
17509 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17510 delivers only one message at a time, the maximum number of deliveries that can
17511 then take place at once is &%queue_run_max%& multiplied by
17512 &%remote_max_parallel%&.
17513
17514 If it is purely remote deliveries you want to control, use
17515 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17516 doing the SMTP routing before queueing, so that several messages for the same
17517 host will eventually get delivered down the same connection.
17518
17519
17520 .option remote_sort_domains main "domain list&!!" unset
17521 .cindex "sorting remote deliveries"
17522 .cindex "delivery" "sorting remote"
17523 When there are a number of remote deliveries for a message, they are sorted by
17524 domain into the order given by this list. For example,
17525 .code
17526 remote_sort_domains = *.cam.ac.uk:*.uk
17527 .endd
17528 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17529 then to those in the &%uk%& domain, then to any others.
17530
17531
17532 .option retry_data_expire main time 7d
17533 .cindex "hints database" "data expiry"
17534 This option sets a &"use before"& time on retry information in Exim's hints
17535 database. Any older retry data is ignored. This means that, for example, once a
17536 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17537 past failures.
17538
17539
17540 .option retry_interval_max main time 24h
17541 .cindex "retry" "limit on interval"
17542 .cindex "limit" "on retry interval"
17543 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17544 intervals between delivery attempts for messages that cannot be delivered
17545 straight away. This option sets an overall limit to the length of time between
17546 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17547 the default value.
17548
17549
17550 .option return_path_remove main boolean true
17551 .cindex "&'Return-path:'& header line" "removing"
17552 RFC 2821, section 4.4, states that an SMTP server must insert a
17553 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17554 The &'Return-path:'& header preserves the sender address as received in the
17555 MAIL command. This description implies that this header should not be present
17556 in an incoming message. If &%return_path_remove%& is true, any existing
17557 &'Return-path:'& headers are removed from messages at the time they are
17558 received. Exim's transports have options for adding &'Return-path:'& headers at
17559 the time of delivery. They are normally used only for final local deliveries.
17560
17561
17562 .option return_size_limit main integer 100K
17563 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17564
17565
17566 .option rfc1413_hosts main "host list&!!" @[]
17567 .cindex "RFC 1413"
17568 .cindex "host" "for RFC 1413 calls"
17569 RFC 1413 identification calls are made to any client host which matches
17570 an item in the list.
17571 The default value specifies just this host, being any local interface
17572 for the system.
17573
17574 .option rfc1413_query_timeout main time 0s
17575 .cindex "RFC 1413" "query timeout"
17576 .cindex "timeout" "for RFC 1413 call"
17577 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17578 no RFC 1413 calls are ever made.
17579
17580
17581 .option sender_unqualified_hosts main "host list&!!" unset
17582 .cindex "unqualified addresses"
17583 .cindex "host" "unqualified addresses from"
17584 This option lists those hosts from which Exim is prepared to accept unqualified
17585 sender addresses. The addresses are made fully qualified by the addition of
17586 &%qualify_domain%&. This option also affects message header lines. Exim does
17587 not reject unqualified addresses in headers that contain sender addresses, but
17588 it qualifies them only if the message came from a host that matches
17589 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17590 using TCP/IP), and the &%-bnq%& option was not set.
17591
17592
17593 .option slow_lookup_log main integer 0
17594 .cindex "logging" "slow lookups"
17595 .cindex "dns" "logging slow lookups"
17596 This option controls logging of slow lookups.
17597 If the value is nonzero it is taken as a number of milliseconds
17598 and lookups taking longer than this are logged.
17599 Currently this applies only to DNS lookups.
17600
17601
17602
17603 .option smtp_accept_keepalive main boolean true
17604 .cindex "keepalive" "on incoming connection"
17605 This option controls the setting of the SO_KEEPALIVE option on incoming
17606 TCP/IP socket connections. When set, it causes the kernel to probe idle
17607 connections periodically, by sending packets with &"old"& sequence numbers. The
17608 other end of the connection should send an acknowledgment if the connection is
17609 still okay or a reset if the connection has been aborted. The reason for doing
17610 this is that it has the beneficial effect of freeing up certain types of
17611 connection that can get stuck when the remote host is disconnected without
17612 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17613 hours to detect unreachable hosts.
17614
17615
17616
17617 .option smtp_accept_max main integer 20
17618 .cindex "limit" "incoming SMTP connections"
17619 .cindex "SMTP" "incoming connection count"
17620 .cindex "inetd"
17621 This option specifies the maximum number of simultaneous incoming SMTP calls
17622 that Exim will accept. It applies only to the listening daemon; there is no
17623 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17624 value is set to zero, no limit is applied. However, it is required to be
17625 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17626 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17627
17628 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17629 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17630 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17631 and &%smtp_load_reserve%& are then checked before accepting the connection.
17632
17633
17634 .option smtp_accept_max_nonmail main integer 10
17635 .cindex "limit" "non-mail SMTP commands"
17636 .cindex "SMTP" "limiting non-mail commands"
17637 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17638 the connection if there are too many. This option defines &"too many"&. The
17639 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17640 client looping sending EHLO, for example. The check is applied only if the
17641 client host matches &%smtp_accept_max_nonmail_hosts%&.
17642
17643 When a new message is expected, one occurrence of RSET is not counted. This
17644 allows a client to send one RSET between messages (this is not necessary,
17645 but some clients do it). Exim also allows one uncounted occurrence of HELO
17646 or EHLO, and one occurrence of STARTTLS between messages. After
17647 starting up a TLS session, another EHLO is expected, and so it too is not
17648 counted. The first occurrence of AUTH in a connection, or immediately
17649 following STARTTLS is not counted. Otherwise, all commands other than
17650 MAIL, RCPT, DATA, and QUIT are counted.
17651
17652
17653 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17654 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17655 check by setting this option. The default value makes it apply to all hosts. By
17656 changing the value, you can exclude any badly-behaved hosts that you have to
17657 live with.
17658
17659
17660 . Allow this long option name to split; give it unsplit as a fifth argument
17661 . for the automatic .oindex that is generated by .option.
17662 . We insert " &~&~" which is both pretty nasty visually and results in
17663 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17664 . zero-width-space, which would be nicer visually and results in (at least)
17665 . html that Firefox will split on when it's forced to reflow (rather than
17666 . inserting a horizontal scrollbar).  However, the text is still not
17667 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17668 . the option name to split.
17669
17670 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17671          smtp_accept_max_per_connection
17672 .cindex "SMTP" "limiting incoming message count"
17673 .cindex "limit" "messages per SMTP connection"
17674 The value of this option limits the number of MAIL commands that Exim is
17675 prepared to accept over a single SMTP connection, whether or not each command
17676 results in the transfer of a message. After the limit is reached, a 421
17677 response is given to subsequent MAIL commands. This limit is a safety
17678 precaution against a client that goes mad (incidents of this type have been
17679 seen).
17680 The option is expanded after the HELO or EHLO is received
17681 and may depend on values available at that time.
17682 An empty or zero value after expansion removes the limit.
17683
17684
17685 .option smtp_accept_max_per_host main string&!! unset
17686 .cindex "limit" "SMTP connections from one host"
17687 .cindex "host" "limiting SMTP connections from"
17688 This option restricts the number of simultaneous IP connections from a single
17689 host (strictly, from a single IP address) to the Exim daemon. The option is
17690 expanded, to enable different limits to be applied to different hosts by
17691 reference to &$sender_host_address$&. Once the limit is reached, additional
17692 connection attempts from the same host are rejected with error code 421. This
17693 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17694 of zero imposes no limit. If this option is set greater than zero, it is
17695 required that &%smtp_accept_max%& be non-zero.
17696
17697 &*Warning*&: When setting this option you should not use any expansion
17698 constructions that take an appreciable amount of time. The expansion and test
17699 happen in the main daemon loop, in order to reject additional connections
17700 without forking additional processes (otherwise a denial-of-service attack
17701 could cause a vast number or processes to be created). While the daemon is
17702 doing this processing, it cannot accept any other incoming connections.
17703
17704
17705
17706 .option smtp_accept_queue main integer 0
17707 .cindex "SMTP" "incoming connection count"
17708 .cindex "queueing incoming messages"
17709 .cindex "message" "queueing by SMTP connection count"
17710 If the number of simultaneous incoming SMTP connections being handled via the
17711 listening daemon exceeds this value, messages received by SMTP are just placed
17712 in the queue; no delivery processes are started automatically. The count is
17713 fixed at the start of an SMTP connection. It cannot be updated in the
17714 subprocess that receives messages, and so the queueing or not queueing applies
17715 to all messages received in the same connection.
17716
17717 A value of zero implies no limit, and clearly any non-zero value is useful only
17718 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17719 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17720 various &%-od%&&'x'& command line options.
17721
17722
17723 . See the comment on smtp_accept_max_per_connection
17724
17725 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17726          smtp_accept_queue_per_connection
17727 .cindex "queueing incoming messages"
17728 .cindex "message" "queueing by message count"
17729 This option limits the number of delivery processes that Exim starts
17730 automatically when receiving messages via SMTP, whether via the daemon or by
17731 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17732 and the number of messages received in a single SMTP session exceeds this
17733 number, subsequent messages are placed in the queue, but no delivery processes
17734 are started. This helps to limit the number of Exim processes when a server
17735 restarts after downtime and there is a lot of mail waiting for it on other
17736 systems. On large systems, the default should probably be increased, and on
17737 dial-in client systems it should probably be set to zero (that is, disabled).
17738
17739
17740 .option smtp_accept_reserve main integer 0
17741 .cindex "SMTP" "incoming call count"
17742 .cindex "host" "reserved"
17743 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17744 number of SMTP connections that are reserved for connections from the hosts
17745 that are specified in &%smtp_reserve_hosts%&. The value set in
17746 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17747 restricted to this number of connections; the option specifies a minimum number
17748 of connection slots for them, not a maximum. It is a guarantee that this group
17749 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17750 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17751 individual host.
17752
17753 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17754 set to 5, once there are 45 active connections (from any hosts), new
17755 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17756 provided the other criteria for acceptance are met.
17757
17758
17759 .option smtp_active_hostname main string&!! unset
17760 .cindex "host" "name in SMTP responses"
17761 .cindex "SMTP" "host name in responses"
17762 .vindex "&$primary_hostname$&"
17763 This option is provided for multi-homed servers that want to masquerade as
17764 several different hosts. At the start of an incoming SMTP connection, its value
17765 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17766 responses. For example, it is used as domain name in the response to an
17767 incoming HELO or EHLO command.
17768
17769 .vindex "&$smtp_active_hostname$&"
17770 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17771 is saved with any messages that are received. It is therefore available for use
17772 in routers and transports when the message is later delivered.
17773
17774 If this option is unset, or if its expansion is forced to fail, or if the
17775 expansion results in an empty string, the value of &$primary_hostname$& is
17776 used. Other expansion failures cause a message to be written to the main and
17777 panic logs, and the SMTP command receives a temporary error. Typically, the
17778 value of &%smtp_active_hostname%& depends on the incoming interface address.
17779 For example:
17780 .code
17781 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17782   {cox.mydomain}{box.mydomain}}
17783 .endd
17784
17785 Although &$smtp_active_hostname$& is primarily concerned with incoming
17786 messages, it is also used as the default for HELO commands in callout
17787 verification if there is no remote transport from which to obtain a
17788 &%helo_data%& value.
17789
17790 .option smtp_backlog_monitor main integer 0
17791 .cindex "connection backlog" monitoring
17792 If this option is set to greater than zero, and the backlog of available
17793 TCP connections on a socket listening for SMTP is larger than it, a line
17794 is logged giving the value and the socket address and port.
17795 The value is retrived jsut before an accept call.
17796 This facility is only available on Linux.
17797
17798 .option smtp_banner main string&!! "see below"
17799 .cindex "SMTP" "welcome banner"
17800 .cindex "banner for SMTP"
17801 .cindex "welcome banner for SMTP"
17802 .cindex "customizing" "SMTP banner"
17803 If a connect ACL does not supply a message,
17804 this string (which is expanded every time it is used) is output as the initial
17805 positive response to an SMTP connection. The default setting is:
17806 .code
17807 smtp_banner = $smtp_active_hostname ESMTP Exim \
17808   $version_number $tod_full
17809 .endd
17810 .new
17811 Failure to expand the string causes a panic error;
17812 a forced fail just closes the connection.
17813 .wen
17814 If you want to create a
17815 multiline response to the initial SMTP connection, use &"\n"& in the string at
17816 appropriate points, but not at the end. Note that the 220 code is not included
17817 in this string. Exim adds it automatically (several times in the case of a
17818 multiline response).
17819
17820
17821 .option smtp_check_spool_space main boolean true
17822 .cindex "checking disk space"
17823 .cindex "disk space, checking"
17824 .cindex "spool directory" "checking space"
17825 When this option is set, if an incoming SMTP session encounters the SIZE
17826 option on a MAIL command, it checks that there is enough space in the
17827 spool directory's partition to accept a message of that size, while still
17828 leaving free the amount specified by &%check_spool_space%& (even if that value
17829 is zero). If there isn't enough space, a temporary error code is returned.
17830
17831
17832 .option smtp_connect_backlog main integer 20
17833 .cindex "connection backlog" "set maximum"
17834 .cindex "SMTP" "connection backlog"
17835 .cindex "backlog of connections"
17836 This option specifies a maximum number of waiting SMTP connections. Exim passes
17837 this value to the TCP/IP system when it sets up its listener. Once this number
17838 of connections are waiting for the daemon's attention, subsequent connection
17839 attempts are refused at the TCP/IP level. At least, that is what the manuals
17840 say; in some circumstances such connection attempts have been observed to time
17841 out instead. For large systems it is probably a good idea to increase the
17842 value (to 50, say). It also gives some protection against denial-of-service
17843 attacks by SYN flooding.
17844
17845
17846 .option smtp_enforce_sync main boolean true
17847 .cindex "SMTP" "synchronization checking"
17848 .cindex "synchronization checking in SMTP"
17849 The SMTP protocol specification requires the client to wait for a response from
17850 the server at certain points in the dialogue. Without PIPELINING these
17851 synchronization points are after every command; with PIPELINING they are
17852 fewer, but they still exist.
17853
17854 Some spamming sites send out a complete set of SMTP commands without waiting
17855 for any response. Exim protects against this by rejecting a message if the
17856 client has sent further input when it should not have. The error response &"554
17857 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17858 for this error cannot be perfect because of transmission delays (unexpected
17859 input may be on its way but not yet received when Exim checks). However, it
17860 does detect many instances.
17861
17862 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17863 If you want to disable the check selectively (for example, only for certain
17864 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17865 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17866
17867
17868
17869 .option smtp_etrn_command main string&!! unset
17870 .cindex "ETRN" "command to be run"
17871 .cindex "ESMTP extensions" ETRN
17872 .vindex "&$domain$&"
17873 If this option is set, the given command is run whenever an SMTP ETRN
17874 command is received from a host that is permitted to issue such commands (see
17875 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17876 are independently expanded. The expansion variable &$domain$& is set to the
17877 argument of the ETRN command, and no syntax checking is done on it. For
17878 example:
17879 .code
17880 smtp_etrn_command = /etc/etrn_command $domain \
17881                     $sender_host_address
17882 .endd
17883 If the option is not set, the argument for the ETRN command must
17884 be a &'#'& followed by an address string.
17885 In this case an &'exim -R <string>'& command is used;
17886 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17887
17888 A new process is created to run the command, but Exim does not wait for it to
17889 complete. Consequently, its status cannot be checked. If the command cannot be
17890 run, a line is written to the panic log, but the ETRN caller still receives
17891 a 250 success response. Exim is normally running under its own uid when
17892 receiving SMTP, so it is not possible for it to change the uid before running
17893 the command.
17894
17895
17896 .option smtp_etrn_serialize main boolean true
17897 .cindex "ETRN" "serializing"
17898 When this option is set, it prevents the simultaneous execution of more than
17899 one identical command as a result of ETRN in an SMTP connection. See
17900 section &<<SECTETRN>>& for details.
17901
17902
17903 .option smtp_load_reserve main fixed-point unset
17904 .cindex "load average"
17905 If the system load average ever gets higher than this, incoming SMTP calls are
17906 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17907 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17908 the load is over the limit. The option has no effect on ancient operating
17909 systems on which Exim cannot determine the load average. See also
17910 &%deliver_queue_load_max%& and &%queue_only_load%&.
17911
17912
17913
17914 .option smtp_max_synprot_errors main integer 3
17915 .cindex "SMTP" "limiting syntax and protocol errors"
17916 .cindex "limit" "SMTP syntax and protocol errors"
17917 Exim rejects SMTP commands that contain syntax or protocol errors. In
17918 particular, a syntactically invalid email address, as in this command:
17919 .code
17920 RCPT TO:<abc xyz@a.b.c>
17921 .endd
17922 causes immediate rejection of the command, before any other tests are done.
17923 (The ACL cannot be run if there is no valid address to set up for it.) An
17924 example of a protocol error is receiving RCPT before MAIL. If there are
17925 too many syntax or protocol errors in one SMTP session, the connection is
17926 dropped. The limit is set by this option.
17927
17928 .cindex "PIPELINING" "expected errors"
17929 When the PIPELINING extension to SMTP is in use, some protocol errors are
17930 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17931 Exim assumes that PIPELINING will be used if it advertises it (see
17932 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17933 not count towards the limit.
17934
17935
17936
17937 .option smtp_max_unknown_commands main integer 3
17938 .cindex "SMTP" "limiting unknown commands"
17939 .cindex "limit" "unknown SMTP commands"
17940 If there are too many unrecognized commands in an incoming SMTP session, an
17941 Exim server drops the connection. This is a defence against some kinds of abuse
17942 that subvert web
17943 clients
17944 into making connections to SMTP ports; in these circumstances, a number of
17945 non-SMTP command lines are sent first.
17946
17947
17948
17949 .option smtp_ratelimit_hosts main "host list&!!" unset
17950 .cindex "SMTP" "rate limiting"
17951 .cindex "limit" "rate of message arrival"
17952 .cindex "RCPT" "rate limiting"
17953 Some sites find it helpful to be able to limit the rate at which certain hosts
17954 can send them messages, and the rate at which an individual message can specify
17955 recipients.
17956
17957 Exim has two rate-limiting facilities. This section describes the older
17958 facility, which can limit rates within a single connection. The newer
17959 &%ratelimit%& ACL condition can limit rates across all connections. See section
17960 &<<SECTratelimiting>>& for details of the newer facility.
17961
17962 When a host matches &%smtp_ratelimit_hosts%&, the values of
17963 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17964 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17965 respectively. Each option, if set, must contain a set of four comma-separated
17966 values:
17967
17968 .ilist
17969 A threshold, before which there is no rate limiting.
17970 .next
17971 An initial time delay. Unlike other times in Exim, numbers with decimal
17972 fractional parts are allowed here.
17973 .next
17974 A factor by which to increase the delay each time.
17975 .next
17976 A maximum value for the delay. This should normally be less than 5 minutes,
17977 because after that time, the client is liable to timeout the SMTP command.
17978 .endlist
17979
17980 For example, these settings have been used successfully at the site which
17981 first suggested this feature, for controlling mail from their customers:
17982 .code
17983 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17984 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17985 .endd
17986 The first setting specifies delays that are applied to MAIL commands after
17987 two have been received over a single connection. The initial delay is 0.5
17988 seconds, increasing by a factor of 1.05 each time. The second setting applies
17989 delays to RCPT commands when more than four occur in a single message.
17990
17991
17992 .option smtp_ratelimit_mail main string unset
17993 See &%smtp_ratelimit_hosts%& above.
17994
17995
17996 .option smtp_ratelimit_rcpt main string unset
17997 See &%smtp_ratelimit_hosts%& above.
17998
17999
18000 .option smtp_receive_timeout main time&!! 5m
18001 .cindex "timeout" "for SMTP input"
18002 .cindex "SMTP" "input timeout"
18003 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
18004 input, including batch SMTP. If a line of input (either an SMTP command or a
18005 data line) is not received within this time, the SMTP connection is dropped and
18006 the message is abandoned.
18007 A line is written to the log containing one of the following messages:
18008 .code
18009 SMTP command timeout on connection from...
18010 SMTP data timeout on connection from...
18011 .endd
18012 The former means that Exim was expecting to read an SMTP command; the latter
18013 means that it was in the DATA phase, reading the contents of a message.
18014
18015 If the first character of the option is a &"$"& the option is
18016 expanded before use and may depend on
18017 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18018
18019
18020 .oindex "&%-os%&"
18021 The value set by this option can be overridden by the
18022 &%-os%& command-line option. A setting of zero time disables the timeout, but
18023 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18024 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18025 timeout is controlled by &%receive_timeout%& and &%-or%&.
18026
18027
18028 .option smtp_reserve_hosts main "host list&!!" unset
18029 This option defines hosts for which SMTP connections are reserved; see
18030 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18031
18032
18033 .option smtp_return_error_details main boolean false
18034 .cindex "SMTP" "details policy failures"
18035 .cindex "policy control" "rejection, returning details"
18036 In the default state, Exim uses bland messages such as
18037 &"Administrative prohibition"& when it rejects SMTP commands for policy
18038 reasons. Many sysadmins like this because it gives away little information
18039 to spammers. However, some other sysadmins who are applying strict checking
18040 policies want to give out much fuller information about failures. Setting
18041 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18042 example, instead of &"Administrative prohibition"&, it might give:
18043 .code
18044 550-Rejected after DATA: '>' missing at end of address:
18045 550 failing address in "From" header is: <user@dom.ain
18046 .endd
18047
18048
18049 .option smtputf8_advertise_hosts main "host list&!!" *
18050 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18051 .cindex "ESMTP extensions" SMTPUTF8
18052 When Exim is built with support for internationalised mail names,
18053 the availability thereof is advertised in
18054 response to EHLO only to those client hosts that match this option. See
18055 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18056
18057
18058 .option spamd_address main string "127.0.0.1 783"
18059 This option is available when Exim is compiled with the content-scanning
18060 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18061 See section &<<SECTscanspamass>>& for more details.
18062
18063
18064
18065 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18066 This option is available when Exim is compiled with SPF support.
18067 See section &<<SECSPF>>& for more details.
18068
18069 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18070 This option is available when Exim is compiled with SPF support.  It
18071 allows the customisation of the SMTP comment that the SPF library
18072 generates.  You are strongly encouraged to link to your own explanative
18073 site. The template must not contain spaces. If you need spaces in the
18074 output, use the proper placeholder. If libspf2 can not parse the
18075 template, it uses a built-in default broken link. The following placeholders
18076 (along with Exim variables (but see below)) are allowed in the template:
18077 .ilist
18078 &*%_*&: A space.
18079 .next
18080 &*%{L}*&: Envelope sender's local part.
18081 .next
18082 &*%{S}*&: Envelope sender.
18083 .next
18084 &*%{O}*&: Envelope sender's domain.
18085 .next
18086 &*%{D}*&: Current(?) domain.
18087 .next
18088 &*%{I}*&: SMTP client Ip.
18089 .next
18090 &*%{C}*&: SMTP client pretty IP.
18091 .next
18092 &*%{T}*&: Epoch time (UTC).
18093 .next
18094 &*%{P}*&: SMTP client domain name.
18095 .next
18096 &*%{V}*&: IP version.
18097 .next
18098 &*%{H}*&: EHLO/HELO domain.
18099 .next
18100 &*%{R}*&: Receiving domain.
18101 .endlist
18102 The capitalized placeholders do proper URL encoding, if you use them
18103 lowercased, no encoding takes place.  This list was compiled from the
18104 libspf2 sources.
18105
18106 A note on using Exim variables: As
18107 currently the SPF library is initialized before the SMTP EHLO phase,
18108 the variables useful for expansion are quite limited.
18109
18110
18111 .option split_spool_directory main boolean false
18112 .cindex "multiple spool directories"
18113 .cindex "spool directory" "split"
18114 .cindex "directories, multiple"
18115 If this option is set, it causes Exim to split its input directory into 62
18116 subdirectories, each with a single alphanumeric character as its name. The
18117 sixth character of the message id is used to allocate messages to
18118 subdirectories; this is the least significant base-62 digit of the time of
18119 arrival of the message.
18120
18121 Splitting up the spool in this way may provide better performance on systems
18122 where there are long mail queues, by reducing the number of files in any one
18123 directory. The msglog directory is also split up in a similar way to the input
18124 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18125 are still placed in the single directory &_msglog.OLD_&.
18126
18127 It is not necessary to take any special action for existing messages when
18128 changing &%split_spool_directory%&. Exim notices messages that are in the
18129 &"wrong"& place, and continues to process them. If the option is turned off
18130 after a period of being on, the subdirectories will eventually empty and be
18131 automatically deleted.
18132
18133 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18134 changes. Instead of creating a list of all messages in the queue, and then
18135 trying to deliver each one, in turn, it constructs a list of those in one
18136 sub-directory and tries to deliver them, before moving on to the next
18137 sub-directory. The sub-directories are processed in a random order. This
18138 spreads out the scanning of the input directories, and uses less memory. It is
18139 particularly beneficial when there are lots of messages in the queue. However,
18140 if &%queue_run_in_order%& is set, none of this new processing happens. The
18141 entire queue has to be scanned and sorted before any deliveries can start.
18142
18143
18144 .option spool_directory main string&!! "set at compile time"
18145 .cindex "spool directory" "path to"
18146 This defines the directory in which Exim keeps its spool, that is, the messages
18147 it is waiting to deliver. The default value is taken from the compile-time
18148 configuration setting, if there is one. If not, this option must be set. The
18149 string is expanded, so it can contain, for example, a reference to
18150 &$primary_hostname$&.
18151
18152 If the spool directory name is fixed on your installation, it is recommended
18153 that you set it at build time rather than from this option, particularly if the
18154 log files are being written to the spool directory (see &%log_file_path%&).
18155 Otherwise log files cannot be used for errors that are detected early on, such
18156 as failures in the configuration file.
18157
18158 By using this option to override the compiled-in path, it is possible to run
18159 tests of Exim without using the standard spool.
18160
18161 .option spool_wireformat main boolean false
18162 .cindex "spool directory" "file formats"
18163 If this option is set, Exim may for some messages use an alternative format
18164 for data-files in the spool which matches the wire format.
18165 Doing this permits more efficient message reception and transmission.
18166 Currently it is only done for messages received using the ESMTP CHUNKING
18167 option.
18168
18169 The following variables will not have useful values:
18170 .code
18171 $max_received_linelength
18172 $body_linecount
18173 $body_zerocount
18174 .endd
18175
18176 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18177 and any external programs which are passed a reference to a message data file
18178 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18179 will need to be aware of the different formats potentially available.
18180
18181 Using any of the ACL conditions noted will negate the reception benefit
18182 (as a Unix-mbox-format file is constructed for them).
18183 The transmission benefit is maintained.
18184
18185 .option sqlite_lock_timeout main time 5s
18186 .cindex "sqlite lookup type" "lock timeout"
18187 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18188 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18189
18190 .option strict_acl_vars main boolean false
18191 .cindex "&ACL;" "variables, handling unset"
18192 This option controls what happens if a syntactically valid but undefined ACL
18193 variable is referenced. If it is false (the default), an empty string
18194 is substituted; if it is true, an error is generated. See section
18195 &<<SECTaclvariables>>& for details of ACL variables.
18196
18197 .option strip_excess_angle_brackets main boolean false
18198 .cindex "angle brackets, excess"
18199 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18200 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18201 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18202 passed on to another MTA, the excess angle brackets are not passed on. If this
18203 option is not set, multiple pairs of angle brackets cause a syntax error.
18204
18205
18206 .option strip_trailing_dot main boolean false
18207 .cindex "trailing dot on domain"
18208 .cindex "dot" "trailing on domain"
18209 If this option is set, a trailing dot at the end of a domain in an address is
18210 ignored. If this is in the envelope and the message is passed on to another
18211 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18212 domain causes a syntax error.
18213 However, addresses in header lines are checked only when an ACL requests header
18214 syntax checking.
18215
18216
18217 .option syslog_duplication main boolean true
18218 .cindex "syslog" "duplicate log lines; suppressing"
18219 When Exim is logging to syslog, it writes the log lines for its three
18220 separate logs at different syslog priorities so that they can in principle
18221 be separated on the logging hosts. Some installations do not require this
18222 separation, and in those cases, the duplication of certain log lines is a
18223 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18224 particular log line is written to syslog. For lines that normally go to
18225 both the main log and the reject log, the reject log version (possibly
18226 containing message header lines) is written, at LOG_NOTICE priority.
18227 Lines that normally go to both the main and the panic log are written at
18228 the LOG_ALERT priority.
18229
18230
18231 .option syslog_facility main string unset
18232 .cindex "syslog" "facility; setting"
18233 This option sets the syslog &"facility"& name, used when Exim is logging to
18234 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18235 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18236 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18237 details of Exim's logging.
18238
18239
18240 .option syslog_pid main boolean true
18241 .cindex "syslog" "pid"
18242 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18243 omitted when these lines are sent to syslog. (Syslog normally prefixes
18244 the log lines with the PID of the logging process automatically.) You need
18245 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18246 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18247
18248
18249
18250 .option syslog_processname main string &`exim`&
18251 .cindex "syslog" "process name; setting"
18252 This option sets the syslog &"ident"& name, used when Exim is logging to
18253 syslog. The value must be no longer than 32 characters. See chapter
18254 &<<CHAPlog>>& for details of Exim's logging.
18255
18256
18257
18258 .option syslog_timestamp main boolean true
18259 .cindex "syslog" "timestamps"
18260 .cindex timestamps syslog
18261 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18262 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18263 details of Exim's logging.
18264
18265
18266 .option system_filter main string&!! unset
18267 .cindex "filter" "system filter"
18268 .cindex "system filter" "specifying"
18269 .cindex "Sieve filter" "not available for system filter"
18270 This option specifies an Exim filter file that is applied to all messages at
18271 the start of each delivery attempt, before any routing is done. System filters
18272 must be Exim filters; they cannot be Sieve filters. If the system filter
18273 generates any deliveries to files or pipes, or any new mail messages, the
18274 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18275 which transports are to be used. Details of this facility are given in chapter
18276 &<<CHAPsystemfilter>>&.
18277 A forced expansion failure results in no filter operation.
18278
18279
18280 .option system_filter_directory_transport main string&!! unset
18281 .vindex "&$address_file$&"
18282 This sets the name of the transport driver that is to be used when the
18283 &%save%& command in a system message filter specifies a path ending in &"/"&,
18284 implying delivery of each message into a separate file in some directory.
18285 During the delivery, the variable &$address_file$& contains the path name.
18286
18287
18288 .option system_filter_file_transport main string&!! unset
18289 .cindex "file" "transport for system filter"
18290 This sets the name of the transport driver that is to be used when the &%save%&
18291 command in a system message filter specifies a path not ending in &"/"&. During
18292 the delivery, the variable &$address_file$& contains the path name.
18293
18294 .option system_filter_group main string unset
18295 .cindex "gid (group id)" "system filter"
18296 This option is used only when &%system_filter_user%& is also set. It sets the
18297 gid under which the system filter is run, overriding any gid that is associated
18298 with the user. The value may be numerical or symbolic.
18299
18300 .option system_filter_pipe_transport main string&!! unset
18301 .cindex "&(pipe)& transport" "for system filter"
18302 .vindex "&$address_pipe$&"
18303 This specifies the transport driver that is to be used when a &%pipe%& command
18304 is used in a system filter. During the delivery, the variable &$address_pipe$&
18305 contains the pipe command.
18306
18307
18308 .option system_filter_reply_transport main string&!! unset
18309 .cindex "&(autoreply)& transport" "for system filter"
18310 This specifies the transport driver that is to be used when a &%mail%& command
18311 is used in a system filter.
18312
18313
18314 .option system_filter_user main string unset
18315 .cindex "uid (user id)" "system filter"
18316 If this option is set to root, the system filter is run in the main Exim
18317 delivery process, as root.  Otherwise, the system filter runs in a separate
18318 process, as the given user, defaulting to the Exim run-time user.
18319 Unless the string consists entirely of digits, it
18320 is looked up in the password data. Failure to find the named user causes a
18321 configuration error. The gid is either taken from the password data, or
18322 specified by &%system_filter_group%&. When the uid is specified numerically,
18323 &%system_filter_group%& is required to be set.
18324
18325 If the system filter generates any pipe, file, or reply deliveries, the uid
18326 under which the filter is run is used when transporting them, unless a
18327 transport option overrides.
18328
18329
18330 .option tcp_nodelay main boolean true
18331 .cindex "daemon" "TCP_NODELAY on sockets"
18332 .cindex "Nagle algorithm"
18333 .cindex "TCP_NODELAY on listening sockets"
18334 If this option is set false, it stops the Exim daemon setting the
18335 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18336 turns off the &"Nagle algorithm"&, which is a way of improving network
18337 performance in interactive (character-by-character) situations. Turning it off
18338 should improve Exim's performance a bit, so that is what happens by default.
18339 However, it appears that some broken clients cannot cope, and time out. Hence
18340 this option. It affects only those sockets that are set up for listening by the
18341 daemon. Sockets created by the smtp transport for delivering mail always set
18342 TCP_NODELAY.
18343
18344
18345 .option timeout_frozen_after main time 0s
18346 .cindex "frozen messages" "timing out"
18347 .cindex "timeout" "frozen messages"
18348 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18349 message of any kind that has been in the queue for longer than the given time
18350 is automatically cancelled at the next queue run. If the frozen message is a
18351 bounce message, it is just discarded; otherwise, a bounce is sent to the
18352 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18353 If you want to timeout frozen bounce messages earlier than other kinds of
18354 frozen message, see &%ignore_bounce_errors_after%&.
18355
18356 &*Note:*& the default value of zero means no timeouts; with this setting,
18357 frozen messages remain in the queue forever (except for any frozen bounce
18358 messages that are released by &%ignore_bounce_errors_after%&).
18359
18360
18361 .option timezone main string unset
18362 .cindex "timezone, setting"
18363 .cindex "environment" "values from"
18364 The value of &%timezone%& is used to set the environment variable TZ while
18365 running Exim (if it is different on entry). This ensures that all timestamps
18366 created by Exim are in the required timezone. If you want all your timestamps
18367 to be in UTC (aka GMT) you should set
18368 .code
18369 timezone = UTC
18370 .endd
18371 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18372 or, if that is not set, from the value of the TZ environment variable when Exim
18373 is built. If &%timezone%& is set to the empty string, either at build or run
18374 time, any existing TZ variable is removed from the environment when Exim
18375 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18376 unfortunately not all, operating systems.
18377
18378
18379 .option tls_advertise_hosts main "host list&!!" *
18380 .cindex "TLS" "advertising"
18381 .cindex "encryption" "on SMTP connection"
18382 .cindex "SMTP" "encrypted connection"
18383 .cindex "ESMTP extensions" STARTTLS
18384 When Exim is built with support for TLS encrypted connections, the availability
18385 of the STARTTLS command to set up an encrypted session is advertised in
18386 response to EHLO only to those client hosts that match this option. See
18387 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18388 Note that the default value requires that a certificate be supplied
18389 using the &%tls_certificate%& option.  If TLS support for incoming connections
18390 is not required the &%tls_advertise_hosts%& option should be set empty.
18391
18392
18393 .option tls_alpn main "string list&!!" "smtp : esmtp"
18394 .cindex TLS "Application Layer Protocol Names"
18395 .cindex TLS ALPN
18396 .cindex ALPN "set acceptable names for server"
18397 If this option is set,
18398 the TLS library supports ALPN,
18399 and the client offers either more than
18400 ALPN name or a name which does not match the list,
18401 the TLS connection is declined.
18402
18403
18404 .option tls_certificate main "string list&!!" unset
18405 .cindex "TLS" "server certificate; location of"
18406 .cindex "certificate" "server, location of"
18407 The value of this option is expanded, and must then be a list of absolute paths to
18408 files which contain the server's certificates (in PEM format).
18409 Commonly only one file is needed.
18410 The server's private key is also
18411 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18412 &<<CHAPTLS>>& for further details.
18413
18414 &*Note*&: The certificates defined by this option are used only when Exim is
18415 receiving incoming messages as a server. If you want to supply certificates for
18416 use when sending messages as a client, you must set the &%tls_certificate%&
18417 option in the relevant &(smtp)& transport.
18418
18419 &*Note*&: If you use filenames based on IP addresses, change the list
18420 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18421
18422 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18423 when a list of more than one
18424 file is used, the &$tls_in_ourcert$& variable is unreliable.
18425 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18426
18427 .cindex SNI "selecting server certificate based on"
18428 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18429 if the OpenSSL build supports TLS extensions and the TLS client sends the
18430 Server Name Indication extension, then this option and others documented in
18431 &<<SECTtlssni>>& will be re-expanded.
18432
18433 If this option is unset or empty a self-signed certificate will be
18434 used.
18435 Under Linux this is generated at daemon startup; on other platforms it will be
18436 generated fresh for every connection.
18437
18438 .option tls_crl main string&!! unset
18439 .cindex "TLS" "server certificate revocation list"
18440 .cindex "certificate" "revocation list for server"
18441 This option specifies a certificate revocation list. The expanded value must
18442 be the name of a file that contains CRLs in PEM format.
18443
18444 Under OpenSSL the option can specify a directory with CRL files.
18445
18446 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18447 for each signing element of the certificate chain (i.e. all but the leaf).
18448 For the file variant this can be multiple PEM blocks in the one file.
18449
18450 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18451
18452
18453 .option tls_dh_max_bits main integer 2236
18454 .cindex "TLS" "D-H bit count"
18455 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18456 the chosen TLS library.  That value might prove to be too high for
18457 interoperability.  This option provides a maximum clamp on the value
18458 suggested, trading off security for interoperability.
18459
18460 The value must be at least 1024.
18461
18462 The value 2236 was chosen because, at time of adding the option, it was the
18463 hard-coded maximum value supported by the NSS cryptographic library, as used
18464 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18465
18466 If you prefer more security and are willing to break some clients, raise this
18467 number.
18468
18469 Note that the value passed to GnuTLS for *generating* a new prime may be a
18470 little less than this figure, because GnuTLS is inexact and may produce a
18471 larger prime than requested.
18472
18473
18474 .option tls_dhparam main string&!! unset
18475 .cindex "TLS" "D-H parameters for server"
18476 The value of this option is expanded and indicates the source of DH parameters
18477 to be used by Exim.
18478
18479 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18480 local DH parameters*&, which has been supported across all versions of Exim.  The
18481 other specific constants available are a fallback so that even when
18482 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18483
18484 If &%tls_dhparam%& is a filename starting with a &`/`&,
18485 then it names a file from which DH
18486 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18487 PKCS#3 representation of the DH prime.  If the file does not exist, for
18488 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18489 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18490 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18491 and treated as though the &%tls_dhparam%& were set to "none".
18492
18493 If this option expands to the string "none", then no DH parameters will be
18494 loaded by Exim.
18495
18496 If this option expands to the string "historic" and Exim is using GnuTLS, then
18497 Exim will attempt to load a file from inside the spool directory.  If the file
18498 does not exist, Exim will attempt to create it.
18499 See section &<<SECTgnutlsparam>>& for further details.
18500
18501 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18502 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18503
18504 In older versions of Exim the default was the 2048 bit prime described in section
18505 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18506 in IKE is assigned number 23.
18507
18508 Otherwise, the option must expand to the name used by Exim for any of a number
18509 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18510 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18511 the number used by IKE, or "default" which corresponds to
18512 &`exim.dev.20160529.3`&.
18513
18514 The available standard primes are:
18515 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18516 &`ike1`&, &`ike2`&, &`ike5`&,
18517 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18518 &`ike22`&, &`ike23`& and &`ike24`&.
18519
18520 The available additional primes are:
18521 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18522
18523 Some of these will be too small to be accepted by clients.
18524 Some may be too large to be accepted by clients.
18525 The open cryptographic community has suspicions about the integrity of some
18526 of the later IKE values, which led into RFC7919 providing new fixed constants
18527 (the "ffdhe" identifiers).
18528
18529 At this point, all of the "ike" values should be considered obsolete;
18530 they are still in Exim to avoid breaking unusual configurations, but are
18531 candidates for removal the next time we have backwards-incompatible changes.
18532 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18533 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18534 SHOULD NOT.
18535 Because of this, Exim regards them as deprecated; if either of the first pair
18536 are used, warnings will be logged in the paniclog, and if any are used then
18537 warnings will be logged in the mainlog.
18538 All four will be removed in a future Exim release.
18539
18540 The TLS protocol does not negotiate an acceptable size for this; clients tend
18541 to hard-drop connections if what is offered by the server is unacceptable,
18542 whether too large or too small, and there's no provision for the client to
18543 tell the server what these constraints are.  Thus, as a server operator, you
18544 need to make an educated guess as to what is most likely to work for your
18545 userbase.
18546
18547 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18548 is most likely to maximise interoperability.  The upper bound comes from
18549 applications using the Mozilla Network Security Services (NSS) library, which
18550 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18551 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18552 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18553 acceptable bound from 1024 to 2048.
18554
18555
18556 .option tls_eccurve main string list&!! &`auto`&
18557 .cindex TLS "EC cryptography"
18558 This option selects EC curves for use by Exim when used with OpenSSL.
18559 It has no effect when Exim is used with GnuTLS
18560 (the equivalent can be done using a priority string for the
18561 &%tls_require_ciphers%& option).
18562
18563 After expansion it must contain
18564 .new
18565 one or (only for OpenSSL versiona 1.1.1 onwards) more
18566 .wen
18567 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18568 Consult your OpenSSL manual for valid curve names.
18569
18570 For OpenSSL versions before (and not including) 1.0.2, the string
18571 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18572 &`auto`& tells the library to choose.
18573
18574 .new
18575 If the option expands to an empty string, the effect is undefined.
18576 .wen
18577
18578
18579 .option tls_ocsp_file main string&!! unset
18580 .cindex TLS "certificate status"
18581 .cindex TLS "OCSP proof file"
18582 This option
18583 must if set expand to the absolute path to a file which contains a current
18584 status proof for the server's certificate, as obtained from the
18585 Certificate Authority.
18586
18587 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18588 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18589
18590 For OpenSSL 1.1.0 or later, and
18591 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18592 of files, to match a list given for the &%tls_certificate%& option.
18593 The ordering of the two lists must match.
18594 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18595
18596 The file(s) should be in DER format,
18597 except for GnuTLS 3.6.3 or later
18598 or for OpenSSL,
18599 when an optional filetype prefix can be used.
18600 The prefix must be one of "DER" or "PEM", followed by
18601 a single space.  If one is used it sets the format for subsequent
18602 files in the list; the initial format is DER.
18603 If multiple proofs are wanted, for multiple chain elements
18604 (this only works under TLS1.3)
18605 they must be coded as a combined OCSP response.
18606
18607 Although GnuTLS will accept PEM files with multiple separate
18608 PEM blobs (ie. separate OCSP responses), it sends them in the
18609 TLS Certificate record interleaved with the certificates of the chain;
18610 although a GnuTLS client is happy with that, an OpenSSL client is not.
18611
18612 .option tls_on_connect_ports main "string list" unset
18613 .cindex SSMTP
18614 .cindex SMTPS
18615 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18616 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18617 set up without waiting for the client to issue a STARTTLS command. For
18618 further details, see section &<<SECTsupobssmt>>&.
18619
18620
18621
18622 .option tls_privatekey main "string list&!!" unset
18623 .cindex "TLS" "server private key; location of"
18624 The value of this option is expanded, and must then be a list of absolute paths to
18625 files which contains the server's private keys.
18626 If this option is unset, or if
18627 the expansion is forced to fail, or the result is an empty string, the private
18628 key is assumed to be in the same file as the server's certificates. See chapter
18629 &<<CHAPTLS>>& for further details.
18630
18631 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18632
18633
18634 .option tls_remember_esmtp main boolean false
18635 .cindex "TLS" "esmtp state; remembering"
18636 .cindex "TLS" "broken clients"
18637 If this option is set true, Exim violates the RFCs by remembering that it is in
18638 &"esmtp"& state after successfully negotiating a TLS session. This provides
18639 support for broken clients that fail to send a new EHLO after starting a
18640 TLS session.
18641
18642
18643 .option tls_require_ciphers main string&!! unset
18644 .cindex "TLS" "requiring specific ciphers"
18645 .cindex "cipher" "requiring specific"
18646 This option controls which ciphers can be used for incoming TLS connections.
18647 The &(smtp)& transport has an option of the same name for controlling outgoing
18648 connections. This option is expanded for each connection, so can be varied for
18649 different clients if required. The value of this option must be a list of
18650 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18651 in somewhat different ways. If GnuTLS is being used, the client controls the
18652 preference order of the available ciphers. Details are given in sections
18653 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18654
18655
18656 .option tls_resumption_hosts main "host list&!!" unset
18657 .cindex TLS resumption
18658 This option controls which connections to offer the TLS resumption feature.
18659 See &<<SECTresumption>>& for details.
18660
18661
18662 .option tls_try_verify_hosts main "host list&!!" unset
18663 .cindex "TLS" "client certificate verification"
18664 .cindex "certificate" "verification of client"
18665 See &%tls_verify_hosts%& below.
18666
18667
18668 .option tls_verify_certificates main string&!! system
18669 .cindex "TLS" "client certificate verification"
18670 .cindex "certificate" "verification of client"
18671 The value of this option is expanded, and must then be either the
18672 word "system"
18673 or the absolute path to
18674 a file or directory containing permitted certificates for clients that
18675 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18676
18677 The "system" value for the option will use a
18678 system default location compiled into the SSL library.
18679 This is not available for GnuTLS versions preceding 3.0.20,
18680 and will be taken as empty; an explicit location
18681 must be specified.
18682
18683 The use of a directory for the option value is not available for GnuTLS versions
18684 preceding 3.3.6 and a single file must be used.
18685
18686 With OpenSSL the certificates specified
18687 explicitly
18688 either by file or directory
18689 are added to those given by the system default location.
18690
18691 These certificates should be for the certificate authorities trusted, rather
18692 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18693 the value is a file then the certificates are sent by Exim as a server to
18694 connecting clients, defining the list of accepted certificate authorities.
18695 Thus the values defined should be considered public data.  To avoid this,
18696 use the explicit directory version. (If your peer is Exim up to 4.85,
18697 using GnuTLS, you may need to send the CAs (thus using the file
18698 variant). Otherwise the peer doesn't send its certificate.)
18699
18700 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18701
18702 A forced expansion failure or setting to an empty string is equivalent to
18703 being unset.
18704
18705
18706 .option tls_verify_hosts main "host list&!!" unset
18707 .cindex "TLS" "client certificate verification"
18708 .cindex "certificate" "verification of client"
18709 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18710 certificates from clients. The expected certificates are defined by
18711 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18712 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18713 &%tls_verify_certificates%& is not set.
18714
18715 Any client that matches &%tls_verify_hosts%& is constrained by
18716 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18717 present one of the listed certificates. If it does not, the connection is
18718 aborted.
18719 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18720 the host to use TLS. It can still send SMTP commands through unencrypted
18721 connections. Forcing a client to use TLS has to be done separately using an
18722 ACL to reject inappropriate commands when the connection is not encrypted.
18723
18724 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18725 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18726 certificate and checks it against &%tls_verify_certificates%&, but does not
18727 abort the connection if there is no certificate or if it does not match. This
18728 state can be detected in an ACL, which makes it possible to implement policies
18729 such as &"accept for relay only if a verified certificate has been received,
18730 but accept for local delivery if encrypted, even without a verified
18731 certificate"&.
18732
18733 Client hosts that match neither of these lists are not asked to present
18734 certificates.
18735
18736
18737 .option trusted_groups main "string list&!!" unset
18738 .cindex "trusted groups"
18739 .cindex "groups" "trusted"
18740 This option is expanded just once, at the start of Exim's processing. If this
18741 option is set, any process that is running in one of the listed groups, or
18742 which has one of them as a supplementary group, is trusted. The groups can be
18743 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18744 details of what trusted callers are permitted to do. If neither
18745 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18746 are trusted.
18747
18748 .option trusted_users main "string list&!!" unset
18749 .cindex "trusted users"
18750 .cindex "user" "trusted"
18751 This option is expanded just once, at the start of Exim's processing. If this
18752 option is set, any process that is running as one of the listed users is
18753 trusted. The users can be specified numerically or by name. See section
18754 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18755 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18756 Exim user are trusted.
18757
18758 .option unknown_login main string&!! unset
18759 .cindex "uid (user id)" "unknown caller"
18760 .vindex "&$caller_uid$&"
18761 This is a specialized feature for use in unusual configurations. By default, if
18762 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18763 gives up. The &%unknown_login%& option can be used to set a login name to be
18764 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18765 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18766 is used for the user's real name (gecos field), unless this has been set by the
18767 &%-F%& option.
18768
18769 .option unknown_username main string unset
18770 See &%unknown_login%&.
18771
18772 .option untrusted_set_sender main "address list&!!" unset
18773 .cindex "trusted users"
18774 .cindex "sender" "setting by untrusted user"
18775 .cindex "untrusted user setting sender"
18776 .cindex "user" "untrusted setting sender"
18777 .cindex "envelope from"
18778 .cindex "envelope sender"
18779 When an untrusted user submits a message to Exim using the standard input, Exim
18780 normally creates an envelope sender address from the user's login and the
18781 default qualification domain. Data from the &%-f%& option (for setting envelope
18782 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18783 is used) is ignored.
18784
18785 However, untrusted users are permitted to set an empty envelope sender address,
18786 to declare that a message should never generate any bounces. For example:
18787 .code
18788 exim -f '<>' user@domain.example
18789 .endd
18790 .vindex "&$sender_ident$&"
18791 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18792 other envelope sender addresses in a controlled way. When it is set, untrusted
18793 users are allowed to set envelope sender addresses that match any of the
18794 patterns in the list. Like all address lists, the string is expanded. The
18795 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18796 users to setting senders that start with their login ids
18797 followed by a hyphen
18798 by a setting like this:
18799 .code
18800 untrusted_set_sender = ^$sender_ident-
18801 .endd
18802 If you want to allow untrusted users to set envelope sender addresses without
18803 restriction, you can use
18804 .code
18805 untrusted_set_sender = *
18806 .endd
18807 The &%untrusted_set_sender%& option applies to all forms of local input, but
18808 only to the setting of the envelope sender. It does not permit untrusted users
18809 to use the other options which trusted user can use to override message
18810 parameters. Furthermore, it does not stop Exim from removing an existing
18811 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18812 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18813 overriding these actions. The handling of the &'Sender:'& header is also
18814 described in section &<<SECTthesenhea>>&.
18815
18816 The log line for a message's arrival shows the envelope sender following
18817 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18818 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18819 envelope sender address, the user's login is shown in parentheses after the
18820 sender address.
18821
18822
18823 .option uucp_from_pattern main string "see below"
18824 .cindex "&""From""& line"
18825 .cindex "UUCP" "&""From""& line"
18826 Some applications that pass messages to an MTA via a command line interface use
18827 an initial line starting with &"From&~"& to pass the envelope sender. In
18828 particular, this is used by UUCP software. Exim recognizes such a line by means
18829 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18830 matches, the sender address is constructed by expanding the contents of
18831 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18832 default pattern recognizes lines in the following two forms:
18833 .code
18834 From ph10 Fri Jan  5 12:35 GMT 1996
18835 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18836 .endd
18837 The pattern can be seen by running
18838 .code
18839 exim -bP uucp_from_pattern
18840 .endd
18841 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18842 year in the second case. The first word after &"From&~"& is matched in the
18843 regular expression by a parenthesized subpattern. The default value for
18844 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18845 (&"ph10"& in the example above) as the message's sender. See also
18846 &%ignore_fromline_hosts%&.
18847
18848
18849 .option uucp_from_sender main string&!! &`$1`&
18850 See &%uucp_from_pattern%& above.
18851
18852
18853 .option warn_message_file main string&!! unset
18854 .cindex "warning of delay" "customizing the message"
18855 .cindex "customizing" "warning message"
18856 This option defines a template file containing paragraphs of text to be used
18857 for constructing the warning message which is sent by Exim when a message has
18858 been in the queue for a specified amount of time, as specified by
18859 &%delay_warning%&. Details of the file's contents are given in chapter
18860 &<<CHAPemsgcust>>&.
18861 .cindex warn_message_file "tainted data"
18862 The option is expanded to give the file path, which must be
18863 absolute and untainted.
18864 See also &%bounce_message_file%&.
18865
18866
18867 .option write_rejectlog main boolean true
18868 .cindex "reject log" "disabling"
18869 If this option is set false, Exim no longer writes anything to the reject log.
18870 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18871 .ecindex IIDconfima
18872 .ecindex IIDmaiconf
18873
18874
18875
18876
18877 . ////////////////////////////////////////////////////////////////////////////
18878 . ////////////////////////////////////////////////////////////////////////////
18879
18880 .chapter "Generic options for routers" "CHAProutergeneric"
18881 .scindex IIDgenoprou1 "options" "generic; for routers"
18882 .scindex IIDgenoprou2 "generic options" "router"
18883 This chapter describes the generic options that apply to all routers.
18884 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18885
18886 For a general description of how a router operates, see sections
18887 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18888 which the preconditions are tested. The order of expansion of the options that
18889 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18890 &%headers_remove%&, &%transport%&.
18891
18892 The name of a router is limited to be &drivernamemax; ASCII characters long;
18893 prior to Exim 4.95 names would be silently truncated at this length, but now
18894 it is enforced.
18895
18896
18897 .option address_data routers string&!! unset
18898 .cindex "router" "data attached to address"
18899 The string is expanded just before the router is run, that is, after all the
18900 precondition tests have succeeded. If the expansion is forced to fail, the
18901 router declines, the value of &%address_data%& remains unchanged, and the
18902 &%more%& option controls what happens next. Other expansion failures cause
18903 delivery of the address to be deferred.
18904
18905 .vindex "&$address_data$&"
18906 When the expansion succeeds, the value is retained with the address, and can be
18907 accessed using the variable &$address_data$& in the current router, subsequent
18908 routers, and the eventual transport.
18909
18910 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18911 that runs a user's filter file, the contents of &$address_data$& are accessible
18912 in the filter. This is not normally a problem, because such data is usually
18913 either not confidential or it &"belongs"& to the current user, but if you do
18914 put confidential data into &$address_data$& you need to remember this point.
18915
18916 Even if the router declines or passes, the value of &$address_data$& remains
18917 with the address, though it can be changed by another &%address_data%& setting
18918 on a subsequent router. If a router generates child addresses, the value of
18919 &$address_data$& propagates to them. This also applies to the special kind of
18920 &"child"& that is generated by a router with the &%unseen%& option.
18921
18922 The idea of &%address_data%& is that you can use it to look up a lot of data
18923 for the address once, and then pick out parts of the data later. For example,
18924 you could use a single LDAP lookup to return a string of the form
18925 .code
18926 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18927 .endd
18928 In the transport you could pick out the mailbox by a setting such as
18929 .code
18930 file = ${extract{mailbox}{$address_data}}
18931 .endd
18932 This makes the configuration file less messy, and also reduces the number of
18933 lookups (though Exim does cache lookups).
18934
18935 See also the &%set%& option below.
18936
18937 .vindex "&$sender_address_data$&"
18938 .vindex "&$address_data$&"
18939 The &%address_data%& facility is also useful as a means of passing information
18940 from one router to another, and from a router to a transport. In addition, if
18941 &$address_data$& is set by a router when verifying a recipient address from an
18942 ACL, it remains available for use in the rest of the ACL statement. After
18943 verifying a sender, the value is transferred to &$sender_address_data$&.
18944
18945
18946
18947 .option address_test routers&!? boolean true
18948 .oindex "&%-bt%&"
18949 .cindex "router" "skipping when address testing"
18950 If this option is set false, the router is skipped when routing is being tested
18951 by means of the &%-bt%& command line option. This can be a convenience when
18952 your first router sends messages to an external scanner, because it saves you
18953 having to set the &"already scanned"& indicator when testing real address
18954 routing.
18955
18956
18957
18958 .option cannot_route_message routers string&!! unset
18959 .cindex "router" "customizing &""cannot route""& message"
18960 .cindex "customizing" "&""cannot route""& message"
18961 This option specifies a text message that is used when an address cannot be
18962 routed because Exim has run out of routers. The default message is
18963 &"Unrouteable address"&. This option is useful only on routers that have
18964 &%more%& set false, or on the very last router in a configuration, because the
18965 value that is used is taken from the last router that is considered. This
18966 includes a router that is skipped because its preconditions are not met, as
18967 well as a router that declines. For example, using the default configuration,
18968 you could put:
18969 .code
18970 cannot_route_message = Remote domain not found in DNS
18971 .endd
18972 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18973 and
18974 .code
18975 cannot_route_message = Unknown local user
18976 .endd
18977 on the final router that checks for local users. If string expansion fails for
18978 this option, the default message is used. Unless the expansion failure was
18979 explicitly forced, a message about the failure is written to the main and panic
18980 logs, in addition to the normal message about the routing failure.
18981
18982
18983 .option caseful_local_part routers boolean false
18984 .cindex "case of local parts"
18985 .cindex "router" "case of local parts"
18986 By default, routers handle the local parts of addresses in a case-insensitive
18987 manner, though the actual case is preserved for transmission with the message.
18988 If you want the case of letters to be significant in a router, you must set
18989 this option true. For individual router options that contain address or local
18990 part lists (for example, &%local_parts%&), case-sensitive matching can be
18991 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18992 more details.
18993
18994 .vindex "&$local_part$&"
18995 .vindex "&$original_local_part$&"
18996 .vindex "&$parent_local_part$&"
18997 The value of the &$local_part$& variable is forced to lower case while a
18998 router is running unless &%caseful_local_part%& is set. When a router assigns
18999 an address to a transport, the value of &$local_part$& when the transport runs
19000 is the same as it was in the router. Similarly, when a router generates child
19001 addresses by aliasing or forwarding, the values of &$original_local_part$&
19002 and &$parent_local_part$& are those that were used by the redirecting router.
19003
19004 This option applies to the processing of an address by a router. When a
19005 recipient address is being processed in an ACL, there is a separate &%control%&
19006 modifier that can be used to specify case-sensitive processing within the ACL
19007 (see section &<<SECTcontrols>>&).
19008
19009
19010
19011 .option check_local_user routers&!? boolean false
19012 .cindex "local user, checking in router"
19013 .cindex "router" "checking for local user"
19014 .cindex "&_/etc/passwd_&"
19015 .vindex "&$home$&"
19016 When this option is true, Exim checks that the local part of the recipient
19017 address (with affixes removed if relevant) is the name of an account on the
19018 local system. The check is done by calling the &[getpwnam()]& function rather
19019 than trying to read &_/etc/passwd_& directly. This means that other methods of
19020 holding password data (such as NIS) are supported. If the local part is a local
19021 user,
19022 .cindex "tainted data" "de-tainting"
19023 .cindex "de-tainting" "using router check_local_user option"
19024 &$local_part_data$& is set to an untainted version of the local part and
19025 &$home$& is set from the password data. The latter can be tested in other
19026 preconditions that are evaluated after this one (the order of evaluation is
19027 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19028 overridden by &%router_home_directory%&. If the local part is not a local user,
19029 the router is skipped.
19030
19031 If you want to check that the local part is either the name of a local user
19032 or matches something else, you cannot combine &%check_local_user%& with a
19033 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19034 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19035 setting to achieve this. For example:
19036 .code
19037 local_parts = passwd;$local_part : lsearch;/etc/other/users
19038 .endd
19039 Note, however, that the side effects of &%check_local_user%& (such as setting
19040 up a home directory) do not occur when a &(passwd)& lookup is used in a
19041 &%local_parts%& (or any other) precondition.
19042
19043
19044
19045 .option condition routers&!? string&!! unset
19046 .cindex "router" "customized precondition"
19047 This option specifies a general precondition test that has to succeed for the
19048 router to be called. The &%condition%& option is the last precondition to be
19049 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19050 result is a forced failure, or an empty string, or one of the strings &"0"& or
19051 &"no"& or &"false"& (checked without regard to the case of the letters), the
19052 router is skipped, and the address is offered to the next one.
19053
19054 If the result is any other value, the router is run (as this is the last
19055 precondition to be evaluated, all the other preconditions must be true).
19056
19057 This option is unusual in that multiple &%condition%& options may be present.
19058 All &%condition%& options must succeed.
19059
19060 The &%condition%& option provides a means of applying custom conditions to the
19061 running of routers. Note that in the case of a simple conditional expansion,
19062 the default expansion values are exactly what is wanted. For example:
19063 .code
19064 condition = ${if >{$message_age}{600}}
19065 .endd
19066 Because of the default behaviour of the string expansion, this is equivalent to
19067 .code
19068 condition = ${if >{$message_age}{600}{true}{}}
19069 .endd
19070
19071 A multiple condition example, which succeeds:
19072 .code
19073 condition = ${if >{$message_age}{600}}
19074 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19075 condition = foobar
19076 .endd
19077
19078 If the expansion fails (other than forced failure) delivery is deferred. Some
19079 of the other precondition options are common special cases that could in fact
19080 be specified using &%condition%&.
19081
19082 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19083 are far older, and use one set of semantics.  ACLs are newer and when
19084 they were created, the ACL &%condition%& process was given far stricter
19085 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19086 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19087 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19088 Router rules processing behavior.
19089
19090 This is best illustrated in an example:
19091 .code
19092 # If used in an ACL condition will fail with a syntax error, but
19093 # in a router condition any extra characters are treated as a string
19094
19095 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19096 true {yes} {no}}
19097
19098 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19099  {yes} {no}}
19100 .endd
19101 In each example above, the &%if%& statement actually ends after
19102 &"{google.com}}"&.  Since no true or false braces were defined, the
19103 default &%if%& behavior is to return a boolean true or a null answer
19104 (which evaluates to false). The rest of the line is then treated as a
19105 string. So the first example resulted in the boolean answer &"true"&
19106 with the string &" {yes} {no}}"& appended to it. The second example
19107 resulted in the null output (indicating false) with the string
19108 &" {yes} {no}}"& appended to it.
19109
19110 In fact you can put excess forward braces in too.  In the router
19111 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19112 mean something, like after a &"$"& or when required as part of a
19113 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19114 string characters.
19115
19116 Thus, in a Router, the above expansion strings will both always evaluate
19117 true, as the result of expansion is a non-empty string which doesn't
19118 match an explicit false value.  This can be tricky to debug.  By
19119 contrast, in an ACL either of those strings will always result in an
19120 expansion error because the result doesn't look sufficiently boolean.
19121
19122
19123 .option debug_print routers string&!! unset
19124 .cindex "testing" "variables in drivers"
19125 If this option is set and debugging is enabled (see the &%-d%& command line
19126 option) or in address-testing mode (see the &%-bt%& command line option),
19127 the string is expanded and included in the debugging output.
19128 If expansion of the string fails, the error message is written to the debugging
19129 output, and Exim carries on processing.
19130 This option is provided to help with checking out the values of variables and
19131 so on when debugging router configurations. For example, if a &%condition%&
19132 option appears not to be working, &%debug_print%& can be used to output the
19133 variables it references. The output happens after checks for &%domains%&,
19134 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19135 are tested. A newline is added to the text if it does not end with one.
19136 The variable &$router_name$& contains the name of the router.
19137
19138
19139
19140 .option disable_logging routers boolean false
19141 If this option is set true, nothing is logged for any routing errors
19142 or for any deliveries caused by this router. You should not set this option
19143 unless you really, really know what you are doing. See also the generic
19144 transport option of the same name.
19145
19146 .option dnssec_request_domains routers "domain list&!!" *
19147 .cindex "MX record" "security"
19148 .cindex "DNSSEC" "MX lookup"
19149 .cindex "security" "MX lookup"
19150 .cindex "DNS" "DNSSEC"
19151 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19152 the DNSSEC request bit set.
19153 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19154
19155 .option dnssec_require_domains routers "domain list&!!" unset
19156 .cindex "MX record" "security"
19157 .cindex "DNSSEC" "MX lookup"
19158 .cindex "security" "MX lookup"
19159 .cindex "DNS" "DNSSEC"
19160 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19161 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19162 (AD bit) set will be ignored and logged as a host-lookup failure.
19163 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19164
19165
19166 .option domains routers&!? "domain list&!!" unset
19167 .cindex "router" "restricting to specific domains"
19168 .vindex "&$domain_data$&"
19169 If this option is set, the router is skipped unless the current domain matches
19170 the list. If the match is achieved by means of a file lookup, the data that the
19171 lookup returned for the domain is placed in &$domain_data$& for use in string
19172 expansions of the driver's private options and in the transport.
19173 See section &<<SECTrouprecon>>& for
19174 a list of the order in which preconditions are evaluated.
19175
19176
19177
19178 .option driver routers string unset
19179 This option must always be set. It specifies which of the available routers is
19180 to be used.
19181
19182
19183 .option dsn_lasthop routers boolean false
19184 .cindex "DSN" "success"
19185 .cindex "Delivery Status Notification" "success"
19186 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19187 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19188 instead send a success DSN as if the next hop does not support DSN.
19189 Not effective on redirect routers.
19190
19191
19192
19193 .option errors_to routers string&!! unset
19194 .cindex "envelope from"
19195 .cindex "envelope sender"
19196 .cindex "router" "changing address for errors"
19197 If a router successfully handles an address, it may assign the address to a
19198 transport for delivery or it may generate child addresses. In both cases, if
19199 there is a delivery problem during later processing, the resulting bounce
19200 message is sent to the address that results from expanding this string,
19201 provided that the address verifies successfully. The &%errors_to%& option is
19202 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19203
19204 The &%errors_to%& setting associated with an address can be overridden if it
19205 subsequently passes through other routers that have their own &%errors_to%&
19206 settings, or if the message is delivered by a transport with a &%return_path%&
19207 setting.
19208
19209 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19210 the expansion fails to verify, the errors address associated with the incoming
19211 address is used. At top level, this is the envelope sender. A non-forced
19212 expansion failure causes delivery to be deferred.
19213
19214 If an address for which &%errors_to%& has been set ends up being delivered over
19215 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19216 any bounces that are generated by other MTAs on the delivery route are also
19217 sent there. You can set &%errors_to%& to the empty string by either of these
19218 settings:
19219 .code
19220 errors_to =
19221 errors_to = ""
19222 .endd
19223 An expansion item that yields an empty string has the same effect. If you do
19224 this, a locally detected delivery error for addresses processed by this router
19225 no longer gives rise to a bounce message; the error is discarded. If the
19226 address is delivered to a remote host, the return path is set to &`<>`&, unless
19227 overridden by the &%return_path%& option on the transport.
19228
19229 .vindex "&$address_data$&"
19230 If for some reason you want to discard local errors, but use a non-empty
19231 MAIL command for remote delivery, you can preserve the original return
19232 path in &$address_data$& in the router, and reinstate it in the transport by
19233 setting &%return_path%&.
19234
19235 The most common use of &%errors_to%& is to direct mailing list bounces to the
19236 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19237 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19238
19239
19240
19241 .option expn routers&!? boolean true
19242 .cindex "address" "testing"
19243 .cindex "testing" "addresses"
19244 .cindex "EXPN" "router skipping"
19245 .cindex "router" "skipping for EXPN"
19246 If this option is turned off, the router is skipped when testing an address
19247 as a result of processing an SMTP EXPN command. You might, for example,
19248 want to turn it off on a router for users' &_.forward_& files, while leaving it
19249 on for the system alias file.
19250 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19251 are evaluated.
19252
19253 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19254 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19255 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19256
19257
19258
19259 .option fail_verify routers boolean false
19260 .cindex "router" "forcing verification failure"
19261 Setting this option has the effect of setting both &%fail_verify_sender%& and
19262 &%fail_verify_recipient%& to the same value.
19263
19264
19265
19266 .option fail_verify_recipient routers boolean false
19267 If this option is true and an address is accepted by this router when
19268 verifying a recipient, verification fails.
19269
19270
19271
19272 .option fail_verify_sender routers boolean false
19273 If this option is true and an address is accepted by this router when
19274 verifying a sender, verification fails.
19275
19276
19277
19278 .option fallback_hosts routers "string list" unset
19279 .cindex "router" "fallback hosts"
19280 .cindex "fallback" "hosts specified on router"
19281 String expansion is not applied to this option. The argument must be a
19282 colon-separated list of host names or IP addresses. The list separator can be
19283 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19284 each name or address. In fact, the format of each item is exactly the same as
19285 defined for the list of hosts in a &(manualroute)& router (see section
19286 &<<SECTformatonehostitem>>&).
19287
19288 If a router queues an address for a remote transport, this host list is
19289 associated with the address, and used instead of the transport's fallback host
19290 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19291 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19292 transport for further details.
19293
19294
19295 .option group routers string&!! "see below"
19296 .cindex "gid (group id)" "local delivery"
19297 .cindex "local transports" "uid and gid"
19298 .cindex "transport" "local"
19299 .cindex "router" "setting group"
19300 When a router queues an address for a transport, and the transport does not
19301 specify a group, the group given here is used when running the delivery
19302 process.
19303 The group may be specified numerically or by name. If expansion fails, the
19304 error is logged and delivery is deferred.
19305 The default is unset, unless &%check_local_user%& is set, when the default
19306 is taken from the password information. See also &%initgroups%& and &%user%&
19307 and the discussion in chapter &<<CHAPenvironment>>&.
19308
19309
19310
19311 .option headers_add routers list&!! unset
19312 .cindex "header lines" "adding"
19313 .cindex "router" "adding header lines"
19314 This option specifies a list of text headers,
19315 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19316 that is associated with any addresses that are accepted by the router.
19317 Each item is separately expanded, at routing time.  However, this
19318 option has no effect when an address is just being verified. The way in which
19319 the text is used to add header lines at transport time is described in section
19320 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19321 message is in the process of being transported. This means that references to
19322 header lines in string expansions in the transport's configuration do not
19323 &"see"& the added header lines.
19324
19325 The &%headers_add%& option is expanded after &%errors_to%&, but before
19326 &%headers_remove%& and &%transport%&. If an item is empty, or if
19327 an item expansion is forced to fail, the item has no effect. Other expansion
19328 failures are treated as configuration errors.
19329
19330 Unlike most options, &%headers_add%& can be specified multiple times
19331 for a router; all listed headers are added.
19332
19333 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19334 router that has the &%one_time%& option set.
19335
19336 .cindex "duplicate addresses"
19337 .oindex "&%unseen%&"
19338 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19339 additions are deleted when the address is passed on to subsequent routers.
19340 For a &%redirect%& router, if a generated address is the same as the incoming
19341 address, this can lead to duplicate addresses with different header
19342 modifications. Exim does not do duplicate deliveries (except, in certain
19343 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19344 which of the duplicates is discarded, so this ambiguous situation should be
19345 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19346
19347
19348
19349 .option headers_remove routers list&!! unset
19350 .cindex "header lines" "removing"
19351 .cindex "router" "removing header lines"
19352 This option specifies a list of text headers,
19353 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19354 that is associated with any addresses that are accepted by the router.
19355 However, the option has no effect when an address is just being verified.
19356 Each list item is separately expanded, at transport time.
19357 If an item ends in *, it will match any header with the given prefix.
19358 The way in which
19359 the text is used to remove header lines at transport time is described in
19360 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19361 the message is in the process of being transported. This means that references
19362 to header lines in string expansions in the transport's configuration still
19363 &"see"& the original header lines.
19364
19365 The &%headers_remove%& option is handled after &%errors_to%& and
19366 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19367 the item has no effect. Other expansion failures are treated as configuration
19368 errors.
19369
19370 Unlike most options, &%headers_remove%& can be specified multiple times
19371 for a router; all listed headers are removed.
19372
19373 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19374 router that has the &%one_time%& option set.
19375
19376 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19377 removal requests are deleted when the address is passed on to subsequent
19378 routers, and this can lead to problems with duplicates -- see the similar
19379 warning for &%headers_add%& above.
19380
19381 &*Warning 3*&: Because of the separate expansion of the list items,
19382 items that contain a list separator must have it doubled.
19383 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19384
19385
19386
19387 .option ignore_target_hosts routers "host list&!!" unset
19388 .cindex "IP address" "discarding"
19389 .cindex "router" "discarding IP addresses"
19390 Although this option is a host list, it should normally contain IP address
19391 entries rather than names. If any host that is looked up by the router has an
19392 IP address that matches an item in this list, Exim behaves as if that IP
19393 address did not exist. This option allows you to cope with rogue DNS entries
19394 like
19395 .code
19396 remote.domain.example.  A  127.0.0.1
19397 .endd
19398 by setting
19399 .code
19400 ignore_target_hosts = 127.0.0.1
19401 .endd
19402 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19403 discarded in this way, the router declines. In a conventional configuration, an
19404 attempt to mail to such a domain would normally provoke the &"unrouteable
19405 domain"& error, and an attempt to verify an address in the domain would fail.
19406 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19407 router declines if presented with one of the listed addresses.
19408
19409 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19410 means of the first or the second of the following settings, respectively:
19411 .code
19412 ignore_target_hosts = 0.0.0.0/0
19413 ignore_target_hosts = <; 0::0/0
19414 .endd
19415 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19416 in the second line matches all IPv6 addresses.
19417
19418 This option may also be useful for ignoring link-local and site-local IPv6
19419 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19420 is expanded before use as a list, it is possible to make it dependent on the
19421 domain that is being routed.
19422
19423 .vindex "&$host_address$&"
19424 During its expansion, &$host_address$& is set to the IP address that is being
19425 checked.
19426
19427 .option initgroups routers boolean false
19428 .cindex "additional groups"
19429 .cindex "groups" "additional"
19430 .cindex "local transports" "uid and gid"
19431 .cindex "transport" "local"
19432 If the router queues an address for a transport, and this option is true, and
19433 the uid supplied by the router is not overridden by the transport, the
19434 &[initgroups()]& function is called when running the transport to ensure that
19435 any additional groups associated with the uid are set up. See also &%group%&
19436 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19437
19438
19439
19440 .option local_part_prefix routers&!? "string list" unset
19441 .cindex affix "router precondition"
19442 .cindex "router" "prefix for local part"
19443 .cindex "prefix" "for local part, used in router"
19444 If this option is set, the router is skipped unless the local part starts with
19445 one of the given strings, or &%local_part_prefix_optional%& is true. See
19446 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19447 evaluated.
19448
19449 The list is scanned from left to right, and the first prefix that matches is
19450 used. A limited form of wildcard is available; if the prefix begins with an
19451 asterisk, it matches the longest possible sequence of arbitrary characters at
19452 the start of the local part. An asterisk should therefore always be followed by
19453 some character that does not occur in normal local parts.
19454 .cindex "multiple mailboxes"
19455 .cindex "mailbox" "multiple"
19456 Wildcarding can be used to set up multiple user mailboxes, as described in
19457 section &<<SECTmulbox>>&.
19458
19459 .vindex "&$local_part$&"
19460 .vindex "&$local_part_prefix$&"
19461 During the testing of the &%local_parts%& option, and while the router is
19462 running, the prefix is removed from the local part, and is available in the
19463 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19464 the router accepts the address, this remains true during subsequent delivery by
19465 a transport. In particular, the local part that is transmitted in the RCPT
19466 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19467 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19468 the relevant transport.
19469
19470 .vindex &$local_part_prefix_v$&
19471 If wildcarding (above) was used then the part of the prefix matching the
19472 wildcard is available in &$local_part_prefix_v$&.
19473
19474 When an address is being verified, &%local_part_prefix%& affects only the
19475 behaviour of the router. If the callout feature of verification is in use, this
19476 means that the full address, including the prefix, will be used during the
19477 callout.
19478
19479 The prefix facility is commonly used to handle local parts of the form
19480 &%owner-something%&. Another common use is to support local parts of the form
19481 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19482 to tell a user their forwarding is broken &-- by placing a router like this one
19483 immediately before the router that handles &_.forward_& files:
19484 .code
19485 real_localuser:
19486   driver = accept
19487   local_part_prefix = real-
19488   check_local_user
19489   transport = local_delivery
19490 .endd
19491 For security, it would probably be a good idea to restrict the use of this
19492 router to locally-generated messages, using a condition such as this:
19493 .code
19494   condition = ${if match {$sender_host_address}\
19495                          {\N^(|127\.0\.0\.1)$\N}}
19496 .endd
19497
19498 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19499 both conditions must be met if not optional. Care must be taken if wildcards
19500 are used in both a prefix and a suffix on the same router. Different
19501 separator characters must be used to avoid ambiguity.
19502
19503
19504 .option local_part_prefix_optional routers boolean false
19505 See &%local_part_prefix%& above.
19506
19507
19508
19509 .option local_part_suffix routers&!? "string list" unset
19510 .cindex "router" "suffix for local part"
19511 .cindex "suffix for local part" "used in router"
19512 This option operates in the same way as &%local_part_prefix%&, except that the
19513 local part must end (rather than start) with the given string, the
19514 &%local_part_suffix_optional%& option determines whether the suffix is
19515 mandatory, and the wildcard * character, if present, must be the last
19516 character of the suffix. This option facility is commonly used to handle local
19517 parts of the form &%something-request%& and multiple user mailboxes of the form
19518 &%username-foo%&.
19519
19520
19521 .option local_part_suffix_optional routers boolean false
19522 See &%local_part_suffix%& above.
19523
19524
19525
19526 .option local_parts routers&!? "local part list&!!" unset
19527 .cindex "router" "restricting to specific local parts"
19528 .cindex "local part" "checking in router"
19529 The router is run only if the local part of the address matches the list.
19530 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19531 are evaluated, and
19532 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19533 string is expanded, it is possible to make it depend on the domain, for
19534 example:
19535 .code
19536 local_parts = dbm;/usr/local/specials/$domain_data
19537 .endd
19538 .vindex "&$local_part_data$&"
19539 If the match is achieved by a lookup, the data that the lookup returned
19540 for the local part is placed in the variable &$local_part_data$& for use in
19541 expansions of the router's private options or in the transport.
19542 You might use this option, for
19543 example, if you have a large number of local virtual domains, and you want to
19544 send all postmaster mail to the same place without having to set up an alias in
19545 each virtual domain:
19546 .code
19547 postmaster:
19548   driver = redirect
19549   local_parts = postmaster
19550   data = postmaster@real.domain.example
19551 .endd
19552
19553
19554 .option log_as_local routers boolean "see below"
19555 .cindex "log" "delivery line"
19556 .cindex "delivery" "log line format"
19557 Exim has two logging styles for delivery, the idea being to make local
19558 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19559 recipient address is given just as the local part, without a domain. The use of
19560 this style is controlled by this option. It defaults to true for the &(accept)&
19561 router, and false for all the others. This option applies only when a
19562 router assigns an address to a transport. It has no effect on routers that
19563 redirect addresses.
19564
19565
19566
19567 .option more routers boolean&!! true
19568 The result of string expansion for this option must be a valid boolean value,
19569 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19570 result causes an error, and delivery is deferred. If the expansion is forced to
19571 fail, the default value for the option (true) is used. Other failures cause
19572 delivery to be deferred.
19573
19574 If this option is set false, and the router declines to handle the address, no
19575 further routers are tried, routing fails, and the address is bounced.
19576 .oindex "&%self%&"
19577 However, if the router explicitly passes an address to the following router by
19578 means of the setting
19579 .code
19580 self = pass
19581 .endd
19582 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19583 does not affect the behaviour if one of the precondition tests fails. In that
19584 case, the address is always passed to the next router.
19585
19586 Note that &%address_data%& is not considered to be a precondition. If its
19587 expansion is forced to fail, the router declines, and the value of &%more%&
19588 controls what happens next.
19589
19590
19591 .option pass_on_timeout routers boolean false
19592 .cindex "timeout" "of router"
19593 .cindex "router" "timeout"
19594 If a router times out during a host lookup, it normally causes deferral of the
19595 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19596 router, overriding &%no_more%&. This may be helpful for systems that are
19597 intermittently connected to the Internet, or those that want to pass to a smart
19598 host any messages that cannot immediately be delivered.
19599
19600 There are occasional other temporary errors that can occur while doing DNS
19601 lookups. They are treated in the same way as a timeout, and this option
19602 applies to all of them.
19603
19604
19605
19606 .option pass_router routers string unset
19607 .cindex "router" "go to after &""pass""&"
19608 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19609 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19610 routing to continue, and overriding a false setting of &%more%&. When one of
19611 these routers returns &"pass"&, the address is normally handed on to the next
19612 router in sequence. This can be changed by setting &%pass_router%& to the name
19613 of another router. However (unlike &%redirect_router%&) the named router must
19614 be below the current router, to avoid loops. Note that this option applies only
19615 to the special case of &"pass"&. It does not apply when a router returns
19616 &"decline"& because it cannot handle an address.
19617
19618
19619
19620 .option redirect_router routers string unset
19621 .cindex "router" "start at after redirection"
19622 Sometimes an administrator knows that it is pointless to reprocess addresses
19623 generated from alias or forward files with the same router again. For
19624 example, if an alias file translates real names into login ids there is no
19625 point searching the alias file a second time, especially if it is a large file.
19626
19627 The &%redirect_router%& option can be set to the name of any router instance.
19628 It causes the routing of any generated addresses to start at the named router
19629 instead of at the first router. This option has no effect if the router in
19630 which it is set does not generate new addresses.
19631
19632
19633
19634 .option require_files routers&!? "string list&!!" unset
19635 .cindex "file" "requiring for router"
19636 .cindex "router" "requiring file existence"
19637 This option provides a general mechanism for predicating the running of a
19638 router on the existence or non-existence of certain files or directories.
19639 Before running a router, as one of its precondition tests, Exim works its way
19640 through the &%require_files%& list, expanding each item separately.
19641
19642 Because the list is split before expansion, any colons in expansion items must
19643 be doubled, or the facility for using a different list separator must be used
19644 (&<<SECTlistsepchange>>&).
19645 If any expansion is forced to fail, the item is ignored. Other expansion
19646 failures cause routing of the address to be deferred.
19647
19648 If any expanded string is empty, it is ignored. Otherwise, except as described
19649 below, each string must be a fully qualified file path, optionally preceded by
19650 &"!"&. The paths are passed to the &[stat()]& function to test for the
19651 existence of the files or directories. The router is skipped if any paths not
19652 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19653
19654 .cindex "NFS"
19655 If &[stat()]& cannot determine whether a file exists or not, delivery of
19656 the message is deferred. This can happen when NFS-mounted filesystems are
19657 unavailable.
19658
19659 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19660 options, so you cannot use it to check for the existence of a file in which to
19661 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19662 full list of the order in which preconditions are evaluated.) However, as
19663 these options are all expanded, you can use the &%exists%& expansion condition
19664 to make such tests. The &%require_files%& option is intended for checking files
19665 that the router may be going to use internally, or which are needed by a
19666 transport (e.g., &_.procmailrc_&).
19667
19668 During delivery, the &[stat()]& function is run as root, but there is a
19669 facility for some checking of the accessibility of a file by another user.
19670 This is not a proper permissions check, but just a &"rough"& check that
19671 operates as follows:
19672
19673 If an item in a &%require_files%& list does not contain any forward slash
19674 characters, it is taken to be the user (and optional group, separated by a
19675 comma) to be checked for subsequent files in the list. If no group is specified
19676 but the user is specified symbolically, the gid associated with the uid is
19677 used. For example:
19678 .code
19679 require_files = mail:/some/file
19680 require_files = $local_part_data:$home/.procmailrc
19681 .endd
19682 If a user or group name in a &%require_files%& list does not exist, the
19683 &%require_files%& condition fails.
19684
19685 Exim performs the check by scanning along the components of the file path, and
19686 checking the access for the given uid and gid. It checks for &"x"& access on
19687 directories, and &"r"& access on the final file. Note that this means that file
19688 access control lists, if the operating system has them, are ignored.
19689
19690 &*Warning 1*&: When the router is being run to verify addresses for an
19691 incoming SMTP message, Exim is not running as root, but under its own uid. This
19692 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19693 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19694 user is not permitted to read one of the directories on the file's path.
19695
19696 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19697 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19698 without root access. In this case, if a check for access by a particular user
19699 is requested, Exim creates a subprocess that runs as that user, and tries the
19700 check again in that process.
19701
19702 The default action for handling an unresolved EACCES is to consider it to
19703 be caused by a configuration error, and routing is deferred because the
19704 existence or non-existence of the file cannot be determined. However, in some
19705 circumstances it may be desirable to treat this condition as if the file did
19706 not exist. If the filename (or the exclamation mark that precedes the filename
19707 for non-existence) is preceded by a plus sign, the EACCES error is treated
19708 as if the file did not exist. For example:
19709 .code
19710 require_files = +/some/file
19711 .endd
19712 If the router is not an essential part of verification (for example, it
19713 handles users' &_.forward_& files), another solution is to set the &%verify%&
19714 option false so that the router is skipped when verifying.
19715
19716
19717
19718 .option retry_use_local_part routers boolean "see below"
19719 .cindex "hints database" "retry keys"
19720 .cindex "local part" "in retry keys"
19721 When a delivery suffers a temporary routing failure, a retry record is created
19722 in Exim's hints database. For addresses whose routing depends only on the
19723 domain, the key for the retry record should not involve the local part, but for
19724 other addresses, both the domain and the local part should be included.
19725 Usually, remote routing is of the former kind, and local routing is of the
19726 latter kind.
19727
19728 This option controls whether the local part is used to form the key for retry
19729 hints for addresses that suffer temporary errors while being handled by this
19730 router. The default value is true for any router that has any of
19731 &%check_local_user%&,
19732 &%local_parts%&,
19733 &%condition%&,
19734 &%local_part_prefix%&,
19735 &%local_part_suffix%&,
19736 &%senders%& or
19737 &%require_files%&
19738 set, and false otherwise. Note that this option does not apply to hints keys
19739 for transport delays; they are controlled by a generic transport option of the
19740 same name.
19741
19742 Failing to set this option when it is needed
19743 (because a remote router handles only some of the local-parts for a domain)
19744 can result in incorrect error messages being generated.
19745
19746 The setting of &%retry_use_local_part%& applies only to the router on which it
19747 appears. If the router generates child addresses, they are routed
19748 independently; this setting does not become attached to them.
19749
19750
19751
19752 .option router_home_directory routers string&!! unset
19753 .cindex "router" "home directory for"
19754 .cindex "home directory" "for router"
19755 .vindex "&$home$&"
19756 This option sets a home directory for use while the router is running. (Compare
19757 &%transport_home_directory%&, which sets a home directory for later
19758 transporting.) In particular, if used on a &(redirect)& router, this option
19759 sets a value for &$home$& while a filter is running. The value is expanded;
19760 forced expansion failure causes the option to be ignored &-- other failures
19761 cause the router to defer.
19762
19763 Expansion of &%router_home_directory%& happens immediately after the
19764 &%check_local_user%& test (if configured), before any further expansions take
19765 place.
19766 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19767 are evaluated.)
19768 While the router is running, &%router_home_directory%& overrides the value of
19769 &$home$& that came from &%check_local_user%&.
19770
19771 When a router accepts an address and assigns it to a local transport (including
19772 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19773 delivery), the home directory setting for the transport is taken from the first
19774 of these values that is set:
19775
19776 .ilist
19777 The &%home_directory%& option on the transport;
19778 .next
19779 The &%transport_home_directory%& option on the router;
19780 .next
19781 The password data if &%check_local_user%& is set on the router;
19782 .next
19783 The &%router_home_directory%& option on the router.
19784 .endlist
19785
19786 In other words, &%router_home_directory%& overrides the password data for the
19787 router, but not for the transport.
19788
19789
19790
19791 .option self routers string freeze
19792 .cindex "MX record" "pointing to local host"
19793 .cindex "local host" "MX pointing to"
19794 This option applies to those routers that use a recipient address to find a
19795 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19796 and &(manualroute)& routers.
19797 Certain configurations of the &(queryprogram)& router can also specify a list
19798 of remote hosts.
19799 Usually such routers are configured to send the message to a remote host via an
19800 &(smtp)& transport. The &%self%& option specifies what happens when the first
19801 host on the list turns out to be the local host.
19802 The way in which Exim checks for the local host is described in section
19803 &<<SECTreclocipadd>>&.
19804
19805 Normally this situation indicates either an error in Exim's configuration (for
19806 example, the router should be configured not to process this domain), or an
19807 error in the DNS (for example, the MX should not point to this host). For this
19808 reason, the default action is to log the incident, defer the address, and
19809 freeze the message. The following alternatives are provided for use in special
19810 cases:
19811
19812 .vlist
19813 .vitem &%defer%&
19814 Delivery of the message is tried again later, but the message is not frozen.
19815
19816 .vitem "&%reroute%&: <&'domain'&>"
19817 The domain is changed to the given domain, and the address is passed back to
19818 be reprocessed by the routers. No rewriting of headers takes place. This
19819 behaviour is essentially a redirection.
19820
19821 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19822 The domain is changed to the given domain, and the address is passed back to be
19823 reprocessed by the routers. Any headers that contain the original domain are
19824 rewritten.
19825
19826 .vitem &%pass%&
19827 .oindex "&%more%&"
19828 .vindex "&$self_hostname$&"
19829 The router passes the address to the next router, or to the router named in the
19830 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19831 subsequent routing and delivery, the variable &$self_hostname$& contains the
19832 name of the local host that the router encountered. This can be used to
19833 distinguish between different cases for hosts with multiple names. The
19834 combination
19835 .code
19836 self = pass
19837 no_more
19838 .endd
19839 ensures that only those addresses that routed to the local host are passed on.
19840 Without &%no_more%&, addresses that were declined for other reasons would also
19841 be passed to the next router.
19842
19843 .vitem &%fail%&
19844 Delivery fails and an error report is generated.
19845
19846 .vitem &%send%&
19847 .cindex "local host" "sending to"
19848 The anomaly is ignored and the address is queued for the transport. This
19849 setting should be used with extreme caution. For an &(smtp)& transport, it
19850 makes sense only in cases where the program that is listening on the SMTP port
19851 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19852 different configuration file that handles the domain in another way.
19853 .endlist
19854
19855
19856
19857 .option senders routers&!? "address list&!!" unset
19858 .cindex "router" "checking senders"
19859 If this option is set, the router is skipped unless the message's sender
19860 address matches something on the list.
19861 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19862 are evaluated.
19863
19864 There are issues concerning verification when the running of routers is
19865 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19866 setting, it sets the sender to the null string. When using the &%-bt%& option
19867 to check a configuration file, it is necessary also to use the &%-f%& option to
19868 set an appropriate sender. For incoming mail, the sender is unset when
19869 verifying the sender, but is available when verifying any recipients. If the
19870 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19871 matters.
19872
19873
19874 .option set routers "string list" unset
19875 .cindex router variables
19876 This option may be used multiple times on a router;
19877 because of this the list aspect is mostly irrelevant.
19878 The list separator is a semicolon but can be changed in the
19879 usual way.
19880
19881 Each list-element given must be of the form &"name = value"&
19882 and the names used must start with the string &"r_"&.
19883 Values containing a list-separator should have them doubled.
19884 When a router runs, the strings are evaluated in order,
19885 to create variables which are added to the set associated with
19886 the address.
19887 This is done immediately after all the preconditions, before the
19888 evaluation of the &%address_data%& option.
19889 The variable is set with the expansion of the value.
19890 The variables can be used by the router options
19891 (not including any preconditions)
19892 and by the transport.
19893 Later definitions of a given named variable will override former ones.
19894 Variable use is via the usual &$r_...$& syntax.
19895
19896 This is similar to the &%address_data%& option, except that
19897 many independent variables can be used, with choice of naming.
19898
19899
19900 .option translate_ip_address routers string&!! unset
19901 .cindex "IP address" "translating"
19902 .cindex "packet radio"
19903 .cindex "router" "IP address translation"
19904 There exist some rare networking situations (for example, packet radio) where
19905 it is helpful to be able to translate IP addresses generated by normal routing
19906 mechanisms into other IP addresses, thus performing a kind of manual IP
19907 routing. This should be done only if the normal IP routing of the TCP/IP stack
19908 is inadequate or broken. Because this is an extremely uncommon requirement, the
19909 code to support this option is not included in the Exim binary unless
19910 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19911
19912 .vindex "&$host_address$&"
19913 The &%translate_ip_address%& string is expanded for every IP address generated
19914 by the router, with the generated address set in &$host_address$&. If the
19915 expansion is forced to fail, no action is taken.
19916 For any other expansion error, delivery of the message is deferred.
19917 If the result of the expansion is an IP address, that replaces the original
19918 address; otherwise the result is assumed to be a host name &-- this is looked
19919 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19920 produce one or more replacement IP addresses. For example, to subvert all IP
19921 addresses in some specific networks, this could be added to a router:
19922 .code
19923 translate_ip_address = \
19924   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19925     {$value}fail}}
19926 .endd
19927 The file would contain lines like
19928 .code
19929 10.2.3.128/26    some.host
19930 10.8.4.34/26     10.44.8.15
19931 .endd
19932 You should not make use of this facility unless you really understand what you
19933 are doing.
19934
19935
19936
19937 .option transport routers string&!! unset
19938 This option specifies the transport to be used when a router accepts an address
19939 and sets it up for delivery. A transport is never needed if a router is used
19940 only for verification. The value of the option is expanded at routing time,
19941 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19942 and result must be the name of one of the configured transports. If it is not,
19943 delivery is deferred.
19944
19945 The &%transport%& option is not used by the &(redirect)& router, but it does
19946 have some private options that set up transports for pipe and file deliveries
19947 (see chapter &<<CHAPredirect>>&).
19948
19949
19950
19951 .option transport_current_directory routers string&!! unset
19952 .cindex "current directory for local transport"
19953 This option associates a current directory with any address that is routed
19954 to a local transport. This can happen either because a transport is
19955 explicitly configured for the router, or because it generates a delivery to a
19956 file or a pipe. During the delivery process (that is, at transport time), this
19957 option string is expanded and is set as the current directory, unless
19958 overridden by a setting on the transport.
19959 If the expansion fails for any reason, including forced failure, an error is
19960 logged, and delivery is deferred.
19961 See chapter &<<CHAPenvironment>>& for details of the local delivery
19962 environment.
19963
19964
19965
19966
19967 .option transport_home_directory routers string&!! "see below"
19968 .cindex "home directory" "for local transport"
19969 This option associates a home directory with any address that is routed to a
19970 local transport. This can happen either because a transport is explicitly
19971 configured for the router, or because it generates a delivery to a file or a
19972 pipe. During the delivery process (that is, at transport time), the option
19973 string is expanded and is set as the home directory, unless overridden by a
19974 setting of &%home_directory%& on the transport.
19975 If the expansion fails for any reason, including forced failure, an error is
19976 logged, and delivery is deferred.
19977
19978 If the transport does not specify a home directory, and
19979 &%transport_home_directory%& is not set for the router, the home directory for
19980 the transport is taken from the password data if &%check_local_user%& is set for
19981 the router. Otherwise it is taken from &%router_home_directory%& if that option
19982 is set; if not, no home directory is set for the transport.
19983
19984 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19985 environment.
19986
19987
19988
19989
19990 .option unseen routers boolean&!! false
19991 .cindex "router" "carrying on after success"
19992 The result of string expansion for this option must be a valid boolean value,
19993 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19994 result causes an error, and delivery is deferred. If the expansion is forced to
19995 fail, the default value for the option (false) is used. Other failures cause
19996 delivery to be deferred.
19997
19998 When this option is set true, routing does not cease if the router accepts the
19999 address. Instead, a copy of the incoming address is passed to the next router,
20000 overriding a false setting of &%more%&. There is little point in setting
20001 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
20002 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20003 sometimes true and sometimes false).
20004
20005 .cindex "copy of message (&%unseen%& option)"
20006 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20007 qualifier in filter files. It can be used to cause copies of messages to be
20008 delivered to some other destination, while also carrying out a normal delivery.
20009 In effect, the current address is made into a &"parent"& that has two children
20010 &-- one that is delivered as specified by this router, and a clone that goes on
20011 to be routed further. For this reason, &%unseen%& may not be combined with the
20012 &%one_time%& option in a &(redirect)& router.
20013
20014 &*Warning*&: Header lines added to the address (or specified for removal) by
20015 this router or by previous routers affect the &"unseen"& copy of the message
20016 only. The clone that continues to be processed by further routers starts with
20017 no added headers and none specified for removal. For a &%redirect%& router, if
20018 a generated address is the same as the incoming address, this can lead to
20019 duplicate addresses with different header modifications. Exim does not do
20020 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20021 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20022 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20023 &%redirect%& router may be of help.
20024
20025 Unlike the handling of header modifications, any data that was set by the
20026 &%address_data%& option in the current or previous routers &'is'& passed on to
20027 subsequent routers.
20028
20029
20030 .option user routers string&!! "see below"
20031 .cindex "uid (user id)" "local delivery"
20032 .cindex "local transports" "uid and gid"
20033 .cindex "transport" "local"
20034 .cindex "router" "user for filter processing"
20035 .cindex "filter" "user for processing"
20036 When a router queues an address for a transport, and the transport does not
20037 specify a user, the user given here is used when running the delivery process.
20038 The user may be specified numerically or by name. If expansion fails, the
20039 error is logged and delivery is deferred.
20040 This user is also used by the &(redirect)& router when running a filter file.
20041 The default is unset, except when &%check_local_user%& is set. In this case,
20042 the default is taken from the password information. If the user is specified as
20043 a name, and &%group%& is not set, the group associated with the user is used.
20044 See also &%initgroups%& and &%group%& and the discussion in chapter
20045 &<<CHAPenvironment>>&.
20046
20047
20048
20049 .option verify routers&!? boolean true
20050 Setting this option has the effect of setting &%verify_sender%& and
20051 &%verify_recipient%& to the same value.
20052
20053
20054 .option verify_only routers&!? boolean false
20055 .cindex "EXPN" "with &%verify_only%&"
20056 .oindex "&%-bv%&"
20057 .cindex "router" "used only when verifying"
20058 If this option is set, the router is used only when verifying an address,
20059 delivering in cutthrough mode or
20060 testing with the &%-bv%& option, not when actually doing a delivery, testing
20061 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20062 restricted to verifying only senders or recipients by means of
20063 &%verify_sender%& and &%verify_recipient%&.
20064
20065 &*Warning*&: When the router is being run to verify addresses for an incoming
20066 SMTP message, Exim is not running as root, but under its own uid. If the router
20067 accesses any files, you need to make sure that they are accessible to the Exim
20068 user or group.
20069
20070
20071 .option verify_recipient routers&!? boolean true
20072 If this option is false, the router is skipped when verifying recipient
20073 addresses,
20074 delivering in cutthrough mode
20075 or testing recipient verification using &%-bv%&.
20076 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20077 are evaluated.
20078 See also the &$verify_mode$& variable.
20079
20080
20081 .option verify_sender routers&!? boolean true
20082 If this option is false, the router is skipped when verifying sender addresses
20083 or testing sender verification using &%-bvs%&.
20084 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20085 are evaluated.
20086 See also the &$verify_mode$& variable.
20087 .ecindex IIDgenoprou1
20088 .ecindex IIDgenoprou2
20089
20090
20091
20092
20093
20094
20095 . ////////////////////////////////////////////////////////////////////////////
20096 . ////////////////////////////////////////////////////////////////////////////
20097
20098 .chapter "The accept router" "CHID4"
20099 .cindex "&(accept)& router"
20100 .cindex "routers" "&(accept)&"
20101 The &(accept)& router has no private options of its own. Unless it is being
20102 used purely for verification (see &%verify_only%&) a transport is required to
20103 be defined by the generic &%transport%& option. If the preconditions that are
20104 specified by generic options are met, the router accepts the address and queues
20105 it for the given transport. The most common use of this router is for setting
20106 up deliveries to local mailboxes. For example:
20107 .code
20108 localusers:
20109   driver = accept
20110   domains = mydomain.example
20111   check_local_user
20112   transport = local_delivery
20113 .endd
20114 The &%domains%& condition in this example checks the domain of the address, and
20115 &%check_local_user%& checks that the local part is the login of a local user.
20116 When both preconditions are met, the &(accept)& router runs, and queues the
20117 address for the &(local_delivery)& transport.
20118
20119
20120
20121
20122
20123
20124 . ////////////////////////////////////////////////////////////////////////////
20125 . ////////////////////////////////////////////////////////////////////////////
20126
20127 .chapter "The dnslookup router" "CHAPdnslookup"
20128 .scindex IIDdnsrou1 "&(dnslookup)& router"
20129 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20130 The &(dnslookup)& router looks up the hosts that handle mail for the
20131 recipient's domain in the DNS. A transport must always be set for this router,
20132 unless &%verify_only%& is set.
20133
20134 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20135 SRV records. If none are found, or if SRV support is not configured,
20136 MX records are looked up. If no MX records exist, address records are sought.
20137 However, &%mx_domains%& can be set to disable the direct use of address
20138 records.
20139
20140 MX records of equal priority are sorted by Exim into a random order. Exim then
20141 looks for address records for the host names obtained from MX or SRV records.
20142 When a host has more than one IP address, they are sorted into a random order,
20143 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20144 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20145 generic option, the router declines.
20146
20147 Unless they have the highest priority (lowest MX value), MX records that point
20148 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20149 are discarded, together with any other MX records of equal or lower priority.
20150
20151 .cindex "MX record" "pointing to local host"
20152 .cindex "local host" "MX pointing to"
20153 .oindex "&%self%&" "in &(dnslookup)& router"
20154 If the host pointed to by the highest priority MX record, or looked up as an
20155 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20156 happens is controlled by the generic &%self%& option.
20157
20158
20159 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20160 There have been problems with DNS servers when SRV records are looked up.
20161 Some misbehaving servers return a DNS error or timeout when a non-existent
20162 SRV record is sought. Similar problems have in the past been reported for
20163 MX records. The global &%dns_again_means_nonexist%& option can help with this
20164 problem, but it is heavy-handed because it is a global option.
20165
20166 For this reason, there are two options, &%srv_fail_domains%& and
20167 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20168 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20169 an attempt to look up an SRV or MX record causes one of these results, and the
20170 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20171 such record"&. In the case of an SRV lookup, this means that the router
20172 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20173 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20174 case routing fails.
20175
20176
20177 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20178 .cindex "&(dnslookup)& router" "declines"
20179 There are a few cases where a &(dnslookup)& router will decline to accept
20180 an address; if such a router is expected to handle "all remaining non-local
20181 domains", then it is important to set &%no_more%&.
20182
20183 The router will defer rather than decline if the domain
20184 is found in the &%fail_defer_domains%& router option.
20185
20186 Reasons for a &(dnslookup)& router to decline currently include:
20187 .ilist
20188 The domain does not exist in DNS
20189 .next
20190 The domain exists but the MX record's host part is just "."; this is a common
20191 convention (borrowed from SRV) used to indicate that there is no such service
20192 for this domain and to not fall back to trying A/AAAA records.
20193 .next
20194 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20195 .next
20196 MX record points to a non-existent host.
20197 .next
20198 MX record points to an IP address and the main section option
20199 &%allow_mx_to_ip%& is not set.
20200 .next
20201 MX records exist and point to valid hosts, but all hosts resolve only to
20202 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20203 .next
20204 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20205 &%dns_check_names_pattern%& for handling one variant of this)
20206 .next
20207 &%check_secondary_mx%& is set on this router but the local host can
20208 not be found in the MX records (see below)
20209 .endlist
20210
20211
20212
20213
20214 .section "Private options for dnslookup" "SECID118"
20215 .cindex "options" "&(dnslookup)& router"
20216 The private options for the &(dnslookup)& router are as follows:
20217
20218 .option check_secondary_mx dnslookup boolean false
20219 .cindex "MX record" "checking for secondary"
20220 If this option is set, the router declines unless the local host is found in
20221 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20222 process domains for which the local host is a secondary mail exchanger
20223 differently to other domains. The way in which Exim decides whether a host is
20224 the local host is described in section &<<SECTreclocipadd>>&.
20225
20226
20227 .option check_srv dnslookup string&!! unset
20228 .cindex "SRV record" "enabling use of"
20229 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20230 addition to MX and address records. The support is disabled by default. To
20231 enable SRV support, set the &%check_srv%& option to the name of the service
20232 required. For example,
20233 .code
20234 check_srv = smtp
20235 .endd
20236 looks for SRV records that refer to the normal smtp service. The option is
20237 expanded, so the service name can vary from message to message or address
20238 to address. This might be helpful if SRV records are being used for a
20239 submission service. If the expansion is forced to fail, the &%check_srv%&
20240 option is ignored, and the router proceeds to look for MX records in the
20241 normal way.
20242
20243 When the expansion succeeds, the router searches first for SRV records for
20244 the given service (it assumes TCP protocol). A single SRV record with a
20245 host name that consists of just a single dot indicates &"no such service for
20246 this domain"&; if this is encountered, the router declines. If other kinds of
20247 SRV record are found, they are used to construct a host list for delivery
20248 according to the rules of RFC 2782. MX records are not sought in this case.
20249
20250 When no SRV records are found, MX records (and address records) are sought in
20251 the traditional way. In other words, SRV records take precedence over MX
20252 records, just as MX records take precedence over address records. Note that
20253 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20254 defined it. It is apparently believed that MX records are sufficient for email
20255 and that SRV records should not be used for this purpose. However, SRV records
20256 have an additional &"weight"& feature which some people might find useful when
20257 trying to split an SMTP load between hosts of different power.
20258
20259 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20260 when there is a DNS lookup error.
20261
20262
20263
20264
20265 .option fail_defer_domains dnslookup "domain list&!!" unset
20266 .cindex "MX record" "not found"
20267 DNS lookups for domains matching &%fail_defer_domains%&
20268 which find no matching record will cause the router to defer
20269 rather than the default behaviour of decline.
20270 This maybe be useful for queueing messages for a newly created
20271 domain while the DNS configuration is not ready.
20272 However, it will result in any message with mistyped domains
20273 also being queued.
20274
20275
20276 .option ipv4_only "string&!!" unset
20277 .cindex IPv6 disabling
20278 .cindex DNS "IPv6 disabling"
20279 The string is expanded, and if the result is anything but a forced failure,
20280 or an empty string, or one of the strings “0” or “no” or “false”
20281 (checked without regard to the case of the letters),
20282 only A records are used.
20283
20284 .option ipv4_prefer "string&!!" unset
20285 .cindex IPv4 preference
20286 .cindex DNS "IPv4 preference"
20287 The string is expanded, and if the result is anything but a forced failure,
20288 or an empty string, or one of the strings “0” or “no” or “false”
20289 (checked without regard to the case of the letters),
20290 A records are sorted before AAAA records (inverting the default).
20291
20292 .option mx_domains dnslookup "domain list&!!" unset
20293 .cindex "MX record" "required to exist"
20294 .cindex "SRV record" "required to exist"
20295 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20296 record in order to be recognized. (The name of this option could be improved.)
20297 For example, if all the mail hosts in &'fict.example'& are known to have MX
20298 records, except for those in &'discworld.fict.example'&, you could use this
20299 setting:
20300 .code
20301 mx_domains = ! *.discworld.fict.example : *.fict.example
20302 .endd
20303 This specifies that messages addressed to a domain that matches the list but
20304 has no MX record should be bounced immediately instead of being routed using
20305 the address record.
20306
20307
20308 .option mx_fail_domains dnslookup "domain list&!!" unset
20309 If the DNS lookup for MX records for one of the domains in this list causes a
20310 DNS lookup error, Exim behaves as if no MX records were found. See section
20311 &<<SECTprowitdnsloo>>& for more discussion.
20312
20313
20314
20315
20316 .option qualify_single dnslookup boolean true
20317 .cindex "DNS" "resolver options"
20318 .cindex "DNS" "qualifying single-component names"
20319 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20320 lookups. Typically, but not standardly, this causes the resolver to qualify
20321 single-component names with the default domain. For example, on a machine
20322 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20323 &'thesaurus.ref.example'& inside the resolver. For details of what your
20324 resolver actually does, consult your man pages for &'resolver'& and
20325 &'resolv.conf'&.
20326
20327
20328
20329 .option rewrite_headers dnslookup boolean true
20330 .cindex "rewriting" "header lines"
20331 .cindex "header lines" "rewriting"
20332 If the domain name in the address that is being processed is not fully
20333 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20334 an address is specified as &'dormouse@teaparty'&, the domain might be
20335 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20336 occur as a result of setting the &%widen_domains%& option. If
20337 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20338 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20339 header lines of the message are rewritten with the full domain name.
20340
20341 This option should be turned off only when it is known that no message is
20342 ever going to be sent outside an environment where the abbreviation makes
20343 sense.
20344
20345 When an MX record is looked up in the DNS and matches a wildcard record, name
20346 servers normally return a record containing the name that has been looked up,
20347 making it impossible to detect whether a wildcard was present or not. However,
20348 some name servers have recently been seen to return the wildcard entry. If the
20349 name returned by a DNS lookup begins with an asterisk, it is not used for
20350 header rewriting.
20351
20352
20353 .option same_domain_copy_routing dnslookup boolean false
20354 .cindex "address" "copying routing"
20355 Addresses with the same domain are normally routed by the &(dnslookup)& router
20356 to the same list of hosts. However, this cannot be presumed, because the router
20357 options and preconditions may refer to the local part of the address. By
20358 default, therefore, Exim routes each address in a message independently. DNS
20359 servers run caches, so repeated DNS lookups are not normally expensive, and in
20360 any case, personal messages rarely have more than a few recipients.
20361
20362 If you are running mailing lists with large numbers of subscribers at the same
20363 domain, and you are using a &(dnslookup)& router which is independent of the
20364 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20365 lookups for identical domains in one message. In this case, when &(dnslookup)&
20366 routes an address to a remote transport, any other unrouted addresses in the
20367 message that have the same domain are automatically given the same routing
20368 without processing them independently,
20369 provided the following conditions are met:
20370
20371 .ilist
20372 No router that processed the address specified &%headers_add%& or
20373 &%headers_remove%&.
20374 .next
20375 The router did not change the address in any way, for example, by &"widening"&
20376 the domain.
20377 .endlist
20378
20379
20380
20381
20382 .option search_parents dnslookup boolean false
20383 .cindex "DNS" "resolver options"
20384 When this option is true, the resolver option RES_DNSRCH is set for DNS
20385 lookups. This is different from the &%qualify_single%& option in that it
20386 applies to domains containing dots. Typically, but not standardly, it causes
20387 the resolver to search for the name in the current domain and in parent
20388 domains. For example, on a machine in the &'fict.example'& domain, if looking
20389 up &'teaparty.wonderland'& failed, the resolver would try
20390 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20391 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20392
20393 Setting this option true can cause problems in domains that have a wildcard MX
20394 record, because any domain that does not have its own MX record matches the
20395 local wildcard.
20396
20397
20398
20399 .option srv_fail_domains dnslookup "domain list&!!" unset
20400 If the DNS lookup for SRV records for one of the domains in this list causes a
20401 DNS lookup error, Exim behaves as if no SRV records were found. See section
20402 &<<SECTprowitdnsloo>>& for more discussion.
20403
20404
20405
20406
20407 .option widen_domains dnslookup "string list" unset
20408 .cindex "domain" "partial; widening"
20409 If a DNS lookup fails and this option is set, each of its strings in turn is
20410 added onto the end of the domain, and the lookup is tried again. For example,
20411 if
20412 .code
20413 widen_domains = fict.example:ref.example
20414 .endd
20415 is set and a lookup of &'klingon.dictionary'& fails,
20416 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20417 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20418 and &%search_parents%& options can cause some widening to be undertaken inside
20419 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20420 when verifying, unless &%rewrite_headers%& is false (not the default).
20421
20422
20423 .section "Effect of qualify_single and search_parents" "SECID119"
20424 When a domain from an envelope recipient is changed by the resolver as a result
20425 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20426 corresponding address in the message's header lines unless &%rewrite_headers%&
20427 is set false. Exim then re-routes the address, using the full domain.
20428
20429 These two options affect only the DNS lookup that takes place inside the router
20430 for the domain of the address that is being routed. They do not affect lookups
20431 such as that implied by
20432 .code
20433 domains = @mx_any
20434 .endd
20435 that may happen while processing a router precondition before the router is
20436 entered. No widening ever takes place for these lookups.
20437 .ecindex IIDdnsrou1
20438 .ecindex IIDdnsrou2
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448 . ////////////////////////////////////////////////////////////////////////////
20449 . ////////////////////////////////////////////////////////////////////////////
20450
20451 .chapter "The ipliteral router" "CHID5"
20452 .cindex "&(ipliteral)& router"
20453 .cindex "domain literal" "routing"
20454 .cindex "routers" "&(ipliteral)&"
20455 This router has no private options. Unless it is being used purely for
20456 verification (see &%verify_only%&) a transport is required to be defined by the
20457 generic &%transport%& option. The router accepts the address if its domain part
20458 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20459 router handles the address
20460 .code
20461 root@[192.168.1.1]
20462 .endd
20463 by setting up delivery to the host with that IP address. IPv4 domain literals
20464 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20465 are similar, but the address is preceded by &`ipv6:`&. For example:
20466 .code
20467 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20468 .endd
20469 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20470 grounds that sooner or later somebody will try it.
20471
20472 .oindex "&%self%&" "in &(ipliteral)& router"
20473 If the IP address matches something in &%ignore_target_hosts%&, the router
20474 declines. If an IP literal turns out to refer to the local host, the generic
20475 &%self%& option determines what happens.
20476
20477 The RFCs require support for domain literals; however, their use is
20478 controversial in today's Internet. If you want to use this router, you must
20479 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20480 Exim will not recognize the domain literal syntax in addresses.
20481
20482
20483
20484 . ////////////////////////////////////////////////////////////////////////////
20485 . ////////////////////////////////////////////////////////////////////////////
20486
20487 .chapter "The iplookup router" "CHID6"
20488 .cindex "&(iplookup)& router"
20489 .cindex "routers" "&(iplookup)&"
20490 The &(iplookup)& router was written to fulfil a specific requirement in
20491 Cambridge University (which in fact no longer exists). For this reason, it is
20492 not included in the binary of Exim by default. If you want to include it, you
20493 must set
20494 .code
20495 ROUTER_IPLOOKUP=yes
20496 .endd
20497 in your &_Local/Makefile_& configuration file.
20498
20499 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20500 connection to one or more specific hosts. The host can then return the same or
20501 a different address &-- in effect rewriting the recipient address in the
20502 message's envelope. The new address is then passed on to subsequent routers. If
20503 this process fails, the address can be passed on to other routers, or delivery
20504 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20505 must not be specified for it.
20506
20507 .cindex "options" "&(iplookup)& router"
20508 .option hosts iplookup string unset
20509 This option must be supplied. Its value is a colon-separated list of host
20510 names. The hosts are looked up using &[gethostbyname()]&
20511 (or &[getipnodebyname()]& when available)
20512 and are tried in order until one responds to the query. If none respond, what
20513 happens is controlled by &%optional%&.
20514
20515
20516 .option optional iplookup boolean false
20517 If &%optional%& is true, if no response is obtained from any host, the address
20518 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20519 delivery to the address is deferred.
20520
20521
20522 .option port iplookup integer 0
20523 .cindex "port" "&(iplookup)& router"
20524 This option must be supplied. It specifies the port number for the TCP or UDP
20525 call.
20526
20527
20528 .option protocol iplookup string udp
20529 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20530 protocols is to be used.
20531
20532
20533 .option query iplookup string&!! "see below"
20534 This defines the content of the query that is sent to the remote hosts. The
20535 default value is:
20536 .code
20537 $local_part@$domain $local_part@$domain
20538 .endd
20539 The repetition serves as a way of checking that a response is to the correct
20540 query in the default case (see &%response_pattern%& below).
20541
20542
20543 .option reroute iplookup string&!! unset
20544 If this option is not set, the rerouted address is precisely the byte string
20545 returned by the remote host, up to the first white space, if any. If set, the
20546 string is expanded to form the rerouted address. It can include parts matched
20547 in the response by &%response_pattern%& by means of numeric variables such as
20548 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20549 whether or not a pattern is in use. In all cases, the rerouted address must end
20550 up in the form &'local_part@domain'&.
20551
20552
20553 .option response_pattern iplookup string unset
20554 This option can be set to a regular expression that is applied to the string
20555 returned from the remote host. If the pattern does not match the response, the
20556 router declines. If &%response_pattern%& is not set, no checking of the
20557 response is done, unless the query was defaulted, in which case there is a
20558 check that the text returned after the first white space is the original
20559 address. This checks that the answer that has been received is in response to
20560 the correct question. For example, if the response is just a new domain, the
20561 following could be used:
20562 .code
20563 response_pattern = ^([^@]+)$
20564 reroute = $local_part@$1
20565 .endd
20566
20567 .option timeout iplookup time 5s
20568 This specifies the amount of time to wait for a response from the remote
20569 machine. The same timeout is used for the &[connect()]& function for a TCP
20570 call. It does not apply to UDP.
20571
20572
20573
20574
20575 . ////////////////////////////////////////////////////////////////////////////
20576 . ////////////////////////////////////////////////////////////////////////////
20577
20578 .chapter "The manualroute router" "CHID7"
20579 .scindex IIDmanrou1 "&(manualroute)& router"
20580 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20581 .cindex "domain" "manually routing"
20582 The &(manualroute)& router is so-called because it provides a way of manually
20583 routing an address according to its domain. It is mainly used when you want to
20584 route addresses to remote hosts according to your own rules, bypassing the
20585 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20586 route to local transports, a facility that may be useful if you want to save
20587 messages for dial-in hosts in local files.
20588
20589 The &(manualroute)& router compares a list of domain patterns with the domain
20590 it is trying to route. If there is no match, the router declines. Each pattern
20591 has associated with it a list of hosts and some other optional data, which may
20592 include a transport. The combination of a pattern and its data is called a
20593 &"routing rule"&. For patterns that do not have an associated transport, the
20594 generic &%transport%& option must specify a transport, unless the router is
20595 being used purely for verification (see &%verify_only%&).
20596
20597 .vindex "&$host$&"
20598 In the case of verification, matching the domain pattern is sufficient for the
20599 router to accept the address. When actually routing an address for delivery,
20600 an address that matches a domain pattern is queued for the associated
20601 transport. If the transport is not a local one, a host list must be associated
20602 with the pattern; IP addresses are looked up for the hosts, and these are
20603 passed to the transport along with the mail address. For local transports, a
20604 host list is optional. If it is present, it is passed in &$host$& as a single
20605 text string.
20606
20607 The list of routing rules can be provided as an inline string in
20608 &%route_list%&, or the data can be obtained by looking up the domain in a file
20609 or database by setting &%route_data%&. Only one of these settings may appear in
20610 any one instance of &(manualroute)&. The format of routing rules is described
20611 below, following the list of private options.
20612
20613
20614 .section "Private options for manualroute" "SECTprioptman"
20615
20616 .cindex "options" "&(manualroute)& router"
20617 The private options for the &(manualroute)& router are as follows:
20618
20619 .option host_all_ignored manualroute string defer
20620 See &%host_find_failed%&.
20621
20622 .option host_find_failed manualroute string freeze
20623 This option controls what happens when &(manualroute)& tries to find an IP
20624 address for a host, and the host does not exist. The option can be set to one
20625 of the following values:
20626 .code
20627 decline
20628 defer
20629 fail
20630 freeze
20631 ignore
20632 pass
20633 .endd
20634 The default (&"freeze"&) assumes that this state is a serious configuration
20635 error. The difference between &"pass"& and &"decline"& is that the former
20636 forces the address to be passed to the next router (or the router defined by
20637 &%pass_router%&),
20638 .oindex "&%more%&"
20639 overriding &%no_more%&, whereas the latter passes the address to the next
20640 router only if &%more%& is true.
20641
20642 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20643 cannot be found. If all the hosts in the list are ignored, the behaviour is
20644 controlled by the &%host_all_ignored%& option. This takes the same values
20645 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20646
20647 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20648 state; if a host lookup gets a temporary error, delivery is deferred unless the
20649 generic &%pass_on_timeout%& option is set.
20650
20651
20652 .option hosts_randomize manualroute boolean false
20653 .cindex "randomized host list"
20654 .cindex "host" "list of; randomized"
20655 If this option is set, the order of the items in a host list in a routing rule
20656 is randomized each time the list is used, unless an option in the routing rule
20657 overrides (see below). Randomizing the order of a host list can be used to do
20658 crude load sharing. However, if more than one mail address is routed by the
20659 same router to the same host list, the host lists are considered to be the same
20660 (even though they may be randomized into different orders) for the purpose of
20661 deciding whether to batch the deliveries into a single SMTP transaction.
20662
20663 When &%hosts_randomize%& is true, a host list may be split
20664 into groups whose order is separately randomized. This makes it possible to
20665 set up MX-like behaviour. The boundaries between groups are indicated by an
20666 item that is just &`+`& in the host list. For example:
20667 .code
20668 route_list = * host1:host2:host3:+:host4:host5
20669 .endd
20670 The order of the first three hosts and the order of the last two hosts is
20671 randomized for each use, but the first three always end up before the last two.
20672 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20673 randomized host list is passed to an &(smtp)& transport that also has
20674 &%hosts_randomize set%&, the list is not re-randomized.
20675
20676
20677 .option route_data manualroute string&!! unset
20678 If this option is set, it must expand to yield the data part of a routing rule.
20679 Typically, the expansion string includes a lookup based on the domain. For
20680 example:
20681 .code
20682 route_data = ${lookup{$domain}dbm{/etc/routes}}
20683 .endd
20684 If the expansion is forced to fail, or the result is an empty string, the
20685 router declines. Other kinds of expansion failure cause delivery to be
20686 deferred.
20687
20688
20689 .option route_list manualroute "string list" unset
20690 This string is a list of routing rules, in the form defined below. Note that,
20691 unlike most string lists, the items are separated by semicolons. This is so
20692 that they may contain colon-separated host lists.
20693
20694
20695 .option same_domain_copy_routing manualroute boolean false
20696 .cindex "address" "copying routing"
20697 Addresses with the same domain are normally routed by the &(manualroute)&
20698 router to the same list of hosts. However, this cannot be presumed, because the
20699 router options and preconditions may refer to the local part of the address. By
20700 default, therefore, Exim routes each address in a message independently. DNS
20701 servers run caches, so repeated DNS lookups are not normally expensive, and in
20702 any case, personal messages rarely have more than a few recipients.
20703
20704 If you are running mailing lists with large numbers of subscribers at the same
20705 domain, and you are using a &(manualroute)& router which is independent of the
20706 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20707 lookups for identical domains in one message. In this case, when
20708 &(manualroute)& routes an address to a remote transport, any other unrouted
20709 addresses in the message that have the same domain are automatically given the
20710 same routing without processing them independently. However, this is only done
20711 if &%headers_add%& and &%headers_remove%& are unset.
20712
20713
20714
20715
20716 .section "Routing rules in route_list" "SECID120"
20717 The value of &%route_list%& is a string consisting of a sequence of routing
20718 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20719 entered as two semicolons. Alternatively, the list separator can be changed as
20720 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20721 Empty rules are ignored. The format of each rule is
20722 .display
20723 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20724 .endd
20725 The following example contains two rules, each with a simple domain pattern and
20726 no options:
20727 .code
20728 route_list = \
20729   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20730   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20731 .endd
20732 The three parts of a rule are separated by white space. The pattern and the
20733 list of hosts can be enclosed in quotes if necessary, and if they are, the
20734 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20735 single domain pattern, which is the only mandatory item in the rule. The
20736 pattern is in the same format as one item in a domain list (see section
20737 &<<SECTdomainlist>>&),
20738 except that it may not be the name of an interpolated file.
20739 That is, it may be wildcarded, or a regular expression, or a file or database
20740 lookup (with semicolons doubled, because of the use of semicolon as a separator
20741 in a &%route_list%&).
20742
20743 The rules in &%route_list%& are searched in order until one of the patterns
20744 matches the domain that is being routed. The list of hosts and then options are
20745 then used as described below. If there is no match, the router declines. When
20746 &%route_list%& is set, &%route_data%& must not be set.
20747
20748
20749
20750 .section "Routing rules in route_data" "SECID121"
20751 The use of &%route_list%& is convenient when there are only a small number of
20752 routing rules. For larger numbers, it is easier to use a file or database to
20753 hold the routing information, and use the &%route_data%& option instead.
20754 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20755 Most commonly, &%route_data%& is set as a string that contains an
20756 expansion lookup. For example, suppose we place two routing rules in a file
20757 like this:
20758 .code
20759 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20760 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20761 .endd
20762 This data can be accessed by setting
20763 .code
20764 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20765 .endd
20766 Failure of the lookup results in an empty string, causing the router to
20767 decline. However, you do not have to use a lookup in &%route_data%&. The only
20768 requirement is that the result of expanding the string is a list of hosts,
20769 possibly followed by options, separated by white space. The list of hosts must
20770 be enclosed in quotes if it contains white space.
20771
20772
20773
20774
20775 .section "Format of the list of hosts" "SECID122"
20776 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20777 always separately expanded before use. If the expansion fails, the router
20778 declines. The result of the expansion must be a colon-separated list of names
20779 and/or IP addresses, optionally also including ports.
20780 If the list is written with spaces, it must be protected with quotes.
20781 The format of each item
20782 in the list is described in the next section. The list separator can be changed
20783 as described in section &<<SECTlistsepchange>>&.
20784
20785 If the list of hosts was obtained from a &%route_list%& item, the following
20786 variables are set during its expansion:
20787
20788 .ilist
20789 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20790 If the domain was matched against a regular expression, the numeric variables
20791 &$1$&, &$2$&, etc. may be set. For example:
20792 .code
20793 route_list = ^domain(\d+)   host-$1.text.example
20794 .endd
20795 .next
20796 &$0$& is always set to the entire domain.
20797 .next
20798 &$1$& is also set when partial matching is done in a file lookup.
20799
20800 .next
20801 .vindex "&$value$&"
20802 If the pattern that matched the domain was a lookup item, the data that was
20803 looked up is available in the expansion variable &$value$&. For example:
20804 .code
20805 route_list = lsearch;;/some/file.routes  $value
20806 .endd
20807 .endlist
20808
20809 Note the doubling of the semicolon in the pattern that is necessary because
20810 semicolon is the default route list separator.
20811
20812
20813
20814 .section "Format of one host item" "SECTformatonehostitem"
20815 Each item in the list of hosts can be either a host name or an IP address,
20816 optionally with an attached port number, or it can be a single "+"
20817 (see &%hosts_randomize%&).
20818 When no port is given, an IP address
20819 is not enclosed in brackets. When a port is specified, it overrides the port
20820 specification on the transport. The port is separated from the name or address
20821 by a colon. This leads to some complications:
20822
20823 .ilist
20824 Because colon is the default separator for the list of hosts, either
20825 the colon that specifies a port must be doubled, or the list separator must
20826 be changed. The following two examples have the same effect:
20827 .code
20828 route_list = * "host1.tld::1225 : host2.tld::1226"
20829 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20830 .endd
20831 .next
20832 When IPv6 addresses are involved, it gets worse, because they contain
20833 colons of their own. To make this case easier, it is permitted to
20834 enclose an IP address (either v4 or v6) in square brackets if a port
20835 number follows. For example:
20836 .code
20837 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20838 .endd
20839 .endlist
20840
20841 .section "How the list of hosts is used" "SECThostshowused"
20842 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20843 the hosts is tried, in the order specified, when carrying out the SMTP
20844 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20845 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20846 transport.
20847
20848 Hosts may be listed by name or by IP address. An unadorned name in the list of
20849 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20850 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20851 records in the DNS. For example:
20852 .code
20853 route_list = *  x.y.z:p.q.r/MX:e.f.g
20854 .endd
20855 If this feature is used with a port specifier, the port must come last. For
20856 example:
20857 .code
20858 route_list = *  dom1.tld/mx::1225
20859 .endd
20860 If the &%hosts_randomize%& option is set, the order of the items in the list is
20861 randomized before any lookups are done. Exim then scans the list; for any name
20862 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20863 be an interface on the local host and the item is not the first in the list,
20864 Exim discards it and any subsequent items. If it is the first item, what
20865 happens is controlled by the
20866 .oindex "&%self%&" "in &(manualroute)& router"
20867 &%self%& option of the router.
20868
20869 A name on the list that is followed by &`/MX`& is replaced with the list of
20870 hosts obtained by looking up MX records for the name. This is always a DNS
20871 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20872 below) are not relevant here. The order of these hosts is determined by the
20873 preference values in the MX records, according to the usual rules. Because
20874 randomizing happens before the MX lookup, it does not affect the order that is
20875 defined by MX preferences.
20876
20877 If the local host is present in the sublist obtained from MX records, but is
20878 not the most preferred host in that list, it and any equally or less
20879 preferred hosts are removed before the sublist is inserted into the main list.
20880
20881 If the local host is the most preferred host in the MX list, what happens
20882 depends on where in the original list of hosts the &`/MX`& item appears. If it
20883 is not the first item (that is, there are previous hosts in the main list),
20884 Exim discards this name and any subsequent items in the main list.
20885
20886 If the MX item is first in the list of hosts, and the local host is the
20887 most preferred host, what happens is controlled by the &%self%& option of the
20888 router.
20889
20890 DNS failures when lookup up the MX records are treated in the same way as DNS
20891 failures when looking up IP addresses: &%pass_on_timeout%& and
20892 &%host_find_failed%& are used when relevant.
20893
20894 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20895 whether obtained from an MX lookup or not.
20896
20897
20898
20899 .section "How the options are used" "SECThowoptused"
20900 The options are a sequence of words, space-separated.
20901 One of the words can be the name of a transport; this overrides the
20902 &%transport%& option on the router for this particular routing rule only. The
20903 other words (if present) control randomization of the list of hosts on a
20904 per-rule basis, and how the IP addresses of the hosts are to be found when
20905 routing to a remote transport. These options are as follows:
20906
20907 .ilist
20908 &%randomize%&: randomize the order of the hosts in this list, overriding the
20909 setting of &%hosts_randomize%& for this routing rule only.
20910 .next
20911 &%no_randomize%&: do not randomize the order of the hosts in this list,
20912 overriding the setting of &%hosts_randomize%& for this routing rule only.
20913 .next
20914 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20915 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20916 also look in &_/etc/hosts_& or other sources of information.
20917 .next
20918 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20919 no address records are found. If there is a temporary DNS error (such as a
20920 timeout), delivery is deferred.
20921 .next
20922 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20923 .next
20924 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20925 .endlist
20926
20927 For example:
20928 .code
20929 route_list = domain1  host1:host2:host3  randomize bydns;\
20930              domain2  host4:host5
20931 .endd
20932 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20933 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20934 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20935 or &[gethostbyname()]&, and the result of the lookup is the result of that
20936 call.
20937
20938 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20939 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20940 instead of TRY_AGAIN. That is why the default action is to try a DNS
20941 lookup first. Only if that gives a definite &"no such host"& is the local
20942 function called.
20943
20944 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20945 inadvertent constraint that a transport name as an option had to be the last
20946 option specified.
20947
20948
20949
20950 If no IP address for a host can be found, what happens is controlled by the
20951 &%host_find_failed%& option.
20952
20953 .vindex "&$host$&"
20954 When an address is routed to a local transport, IP addresses are not looked up.
20955 The host list is passed to the transport in the &$host$& variable.
20956
20957
20958
20959 .section "Manualroute examples" "SECID123"
20960 In some of the examples that follow, the presence of the &%remote_smtp%&
20961 transport, as defined in the default configuration file, is assumed:
20962
20963 .ilist
20964 .cindex "smart host" "example router"
20965 The &(manualroute)& router can be used to forward all external mail to a
20966 &'smart host'&. If you have set up, in the main part of the configuration, a
20967 named domain list that contains your local domains, for example:
20968 .code
20969 domainlist local_domains = my.domain.example
20970 .endd
20971 You can arrange for all other domains to be routed to a smart host by making
20972 your first router something like this:
20973 .code
20974 smart_route:
20975   driver = manualroute
20976   domains = !+local_domains
20977   transport = remote_smtp
20978   route_list = * smarthost.ref.example
20979 .endd
20980 This causes all non-local addresses to be sent to the single host
20981 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20982 they are tried in order
20983 (but you can use &%hosts_randomize%& to vary the order each time).
20984 Another way of configuring the same thing is this:
20985 .code
20986 smart_route:
20987   driver = manualroute
20988   transport = remote_smtp
20989   route_list = !+local_domains  smarthost.ref.example
20990 .endd
20991 There is no difference in behaviour between these two routers as they stand.
20992 However, they behave differently if &%no_more%& is added to them. In the first
20993 example, the router is skipped if the domain does not match the &%domains%&
20994 precondition; the following router is always tried. If the router runs, it
20995 always matches the domain and so can never decline. Therefore, &%no_more%&
20996 would have no effect. In the second case, the router is never skipped; it
20997 always runs. However, if it doesn't match the domain, it declines. In this case
20998 &%no_more%& would prevent subsequent routers from running.
20999
21000 .next
21001 .cindex "mail hub example"
21002 A &'mail hub'& is a host which receives mail for a number of domains via MX
21003 records in the DNS and delivers it via its own private routing mechanism. Often
21004 the final destinations are behind a firewall, with the mail hub being the one
21005 machine that can connect to machines both inside and outside the firewall. The
21006 &(manualroute)& router is usually used on a mail hub to route incoming messages
21007 to the correct hosts. For a small number of domains, the routing can be inline,
21008 using the &%route_list%& option, but for a larger number a file or database
21009 lookup is easier to manage.
21010
21011 If the domain names are in fact the names of the machines to which the mail is
21012 to be sent by the mail hub, the configuration can be quite simple. For
21013 example:
21014 .code
21015 hub_route:
21016   driver = manualroute
21017   transport = remote_smtp
21018   route_list = *.rhodes.tvs.example  $domain
21019 .endd
21020 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21021 whose names are the same as the mail domains. A similar approach can be taken
21022 if the host name can be obtained from the domain name by a string manipulation
21023 that the expansion facilities can handle. Otherwise, a lookup based on the
21024 domain can be used to find the host:
21025 .code
21026 through_firewall:
21027   driver = manualroute
21028   transport = remote_smtp
21029   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21030 .endd
21031 The result of the lookup must be the name or IP address of the host (or
21032 hosts) to which the address is to be routed. If the lookup fails, the route
21033 data is empty, causing the router to decline. The address then passes to the
21034 next router.
21035
21036 .next
21037 .cindex "batched SMTP output example"
21038 .cindex "SMTP" "batched outgoing; example"
21039 You can use &(manualroute)& to deliver messages to pipes or files in batched
21040 SMTP format for onward transportation by some other means. This is one way of
21041 storing mail for a dial-up host when it is not connected. The route list entry
21042 can be as simple as a single domain name in a configuration like this:
21043 .code
21044 save_in_file:
21045   driver = manualroute
21046   transport = batchsmtp_appendfile
21047   route_list = saved.domain.example
21048 .endd
21049 though often a pattern is used to pick up more than one domain. If there are
21050 several domains or groups of domains with different transport requirements,
21051 different transports can be listed in the routing information:
21052 .code
21053 save_in_file:
21054   driver = manualroute
21055   route_list = \
21056     *.saved.domain1.example  $domain  batch_appendfile; \
21057     *.saved.domain2.example  \
21058       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21059       batch_pipe
21060 .endd
21061 .vindex "&$domain$&"
21062 .vindex "&$host$&"
21063 The first of these just passes the domain in the &$host$& variable, which
21064 doesn't achieve much (since it is also in &$domain$&), but the second does a
21065 file lookup to find a value to pass, causing the router to decline to handle
21066 the address if the lookup fails.
21067
21068 .next
21069 .cindex "UUCP" "example of router for"
21070 Routing mail directly to UUCP software is a specific case of the use of
21071 &(manualroute)& in a gateway to another mail environment. This is an example of
21072 one way it can be done:
21073 .code
21074 # Transport
21075 uucp:
21076   driver = pipe
21077   user = nobody
21078   command = /usr/local/bin/uux -r - \
21079     ${substr_-5:$host}!rmail ${local_part}
21080   return_fail_output = true
21081
21082 # Router
21083 uucphost:
21084   transport = uucp
21085   driver = manualroute
21086   route_data = \
21087     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21088 .endd
21089 The file &_/usr/local/exim/uucphosts_& contains entries like
21090 .code
21091 darksite.ethereal.example:           darksite.UUCP
21092 .endd
21093 It can be set up more simply without adding and removing &".UUCP"& but this way
21094 makes clear the distinction between the domain name
21095 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21096 .endlist
21097 .ecindex IIDmanrou1
21098 .ecindex IIDmanrou2
21099
21100
21101
21102
21103
21104
21105
21106
21107 . ////////////////////////////////////////////////////////////////////////////
21108 . ////////////////////////////////////////////////////////////////////////////
21109
21110 .chapter "The queryprogram router" "CHAPdriverlast"
21111 .scindex IIDquerou1 "&(queryprogram)& router"
21112 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21113 .cindex "routing" "by external program"
21114 The &(queryprogram)& router routes an address by running an external command
21115 and acting on its output. This is an expensive way to route, and is intended
21116 mainly for use in lightly-loaded systems, or for performing experiments.
21117 However, if it is possible to use the precondition options (&%domains%&,
21118 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21119 be used in special cases, even on a busy host. There are the following private
21120 options:
21121 .cindex "options" "&(queryprogram)& router"
21122
21123 .option command queryprogram string&!! unset
21124 This option must be set. It specifies the command that is to be run. The
21125 command is split up into a command name and arguments, and then each is
21126 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21127 &<<CHAPpipetransport>>&).
21128
21129
21130 .option command_group queryprogram string unset
21131 .cindex "gid (group id)" "in &(queryprogram)& router"
21132 This option specifies a gid to be set when running the command while routing an
21133 address for deliver. It must be set if &%command_user%& specifies a numerical
21134 uid. If it begins with a digit, it is interpreted as the numerical value of the
21135 gid. Otherwise it is looked up using &[getgrnam()]&.
21136
21137
21138 .option command_user queryprogram string unset
21139 .cindex "uid (user id)" "for &(queryprogram)&"
21140 This option must be set. It specifies the uid which is set when running the
21141 command while routing an address for delivery. If the value begins with a digit,
21142 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21143 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21144 not set, a value for the gid also.
21145
21146 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21147 root, which it does during a normal delivery in a conventional configuration.
21148 However, when an address is being verified during message reception, Exim is
21149 usually running as the Exim user, not as root. If the &(queryprogram)& router
21150 is called from a non-root process, Exim cannot change uid or gid before running
21151 the command. In this circumstance the command runs under the current uid and
21152 gid.
21153
21154
21155 .option current_directory queryprogram string /
21156 This option specifies an absolute path which is made the current directory
21157 before running the command.
21158
21159
21160 .option timeout queryprogram time 1h
21161 If the command does not complete within the timeout period, its process group
21162 is killed and the message is frozen. A value of zero time specifies no
21163 timeout.
21164
21165
21166 The standard output of the command is connected to a pipe, which is read when
21167 the command terminates. It should consist of a single line of output,
21168 containing up to five fields, separated by white space. The maximum length of
21169 the line is 1023 characters. Longer lines are silently truncated. The first
21170 field is one of the following words (case-insensitive):
21171
21172 .ilist
21173 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21174 below).
21175 .next
21176 &'Decline'&: the router declines; pass the address to the next router, unless
21177 &%no_more%& is set.
21178 .next
21179 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21180 subsequent text on the line is an error message. If the router is run as part
21181 of address verification during an incoming SMTP message, the message is
21182 included in the SMTP response.
21183 .next
21184 &'Defer'&: routing could not be completed at this time; try again later. Any
21185 subsequent text on the line is an error message which is logged. It is not
21186 included in any SMTP response.
21187 .next
21188 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21189 .next
21190 &'Pass'&: pass the address to the next router (or the router specified by
21191 &%pass_router%&), overriding &%no_more%&.
21192 .next
21193 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21194 new addresses, which are routed independently, starting with the first router,
21195 or the router specified by &%redirect_router%&, if set.
21196 .endlist
21197
21198 When the first word is &'accept'&, the remainder of the line consists of a
21199 number of keyed data values, as follows (split into two lines here, to fit on
21200 the page):
21201 .code
21202 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21203 LOOKUP=byname|bydns DATA=<text>
21204 .endd
21205 The data items can be given in any order, and all are optional. If no transport
21206 is included, the transport specified by the generic &%transport%& option is
21207 used. The list of hosts and the lookup type are needed only if the transport is
21208 an &(smtp)& transport that does not itself supply a list of hosts.
21209
21210 The format of the list of hosts is the same as for the &(manualroute)& router.
21211 As well as host names and IP addresses with optional port numbers, as described
21212 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21213 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21214 (see section &<<SECThostshowused>>&).
21215
21216 If the lookup type is not specified, Exim behaves as follows when trying to
21217 find an IP address for each host: First, a DNS lookup is done. If this yields
21218 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21219 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21220 result of the lookup is the result of that call.
21221
21222 .vindex "&$address_data$&"
21223 If the DATA field is set, its value is placed in the &$address_data$&
21224 variable. For example, this return line
21225 .code
21226 accept hosts=x1.y.example:x2.y.example data="rule1"
21227 .endd
21228 routes the address to the default transport, passing a list of two hosts. When
21229 the transport runs, the string &"rule1"& is in &$address_data$&.
21230 .ecindex IIDquerou1
21231 .ecindex IIDquerou2
21232
21233
21234
21235
21236 . ////////////////////////////////////////////////////////////////////////////
21237 . ////////////////////////////////////////////////////////////////////////////
21238
21239 .chapter "The redirect router" "CHAPredirect"
21240 .scindex IIDredrou1 "&(redirect)& router"
21241 .scindex IIDredrou2 "routers" "&(redirect)&"
21242 .cindex "alias file" "in a &(redirect)& router"
21243 .cindex "address redirection" "&(redirect)& router"
21244 The &(redirect)& router handles several kinds of address redirection. Its most
21245 common uses are for resolving local part aliases from a central alias file
21246 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21247 files, but it has many other potential uses. The incoming address can be
21248 redirected in several different ways:
21249
21250 .ilist
21251 It can be replaced by one or more new addresses which are themselves routed
21252 independently.
21253 .next
21254 It can be routed to be delivered to a given file or directory.
21255 .next
21256 It can be routed to be delivered to a specified pipe command.
21257 .next
21258 It can cause an automatic reply to be generated.
21259 .next
21260 It can be forced to fail, optionally with a custom error message.
21261 .next
21262 It can be temporarily deferred, optionally with a custom message.
21263 .next
21264 It can be discarded.
21265 .endlist
21266
21267 The generic &%transport%& option must not be set for &(redirect)& routers.
21268 However, there are some private options which define transports for delivery to
21269 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21270 &%pipe_transport%& and &%reply_transport%& descriptions below.
21271
21272 If success DSNs have been requested
21273 .cindex "DSN" "success"
21274 .cindex "Delivery Status Notification" "success"
21275 redirection triggers one and the DSN options are not passed any further.
21276
21277
21278
21279 .section "Redirection data" "SECID124"
21280 The router operates by interpreting a text string which it obtains either by
21281 expanding the contents of the &%data%& option, or by reading the entire
21282 contents of a file whose name is given in the &%file%& option. These two
21283 options are mutually exclusive. The first is commonly used for handling system
21284 aliases, in a configuration like this:
21285 .code
21286 system_aliases:
21287   driver = redirect
21288   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21289 .endd
21290 If the lookup fails, the expanded string in this example is empty. When the
21291 expansion of &%data%& results in an empty string, the router declines. A forced
21292 expansion failure also causes the router to decline; other expansion failures
21293 cause delivery to be deferred.
21294
21295 A configuration using &%file%& is commonly used for handling users'
21296 &_.forward_& files, like this:
21297 .code
21298 userforward:
21299   driver = redirect
21300   check_local_user
21301   file = $home/.forward
21302   no_verify
21303 .endd
21304 If the file does not exist, or causes no action to be taken (for example, it is
21305 empty or consists only of comments), the router declines. &*Warning*&: This
21306 is not the case when the file contains syntactically valid items that happen to
21307 yield empty addresses, for example, items containing only RFC 2822 address
21308 comments.
21309
21310 .cindex "tainted data" "in filenames"
21311 .cindex redirect "tainted data"
21312 Tainted data may not be used for a filename.
21313
21314 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21315 directly for redirection,
21316 as they are provided by a potential attacker.
21317 In the examples above, &$local_part$& is used for looking up data held locally
21318 on the system, and not used directly (the second example derives &$home$& via
21319 the passsword file or database, using &$local_part$&).
21320
21321
21322
21323 .section "Forward files and address verification" "SECID125"
21324 .cindex "address redirection" "while verifying"
21325 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21326 &_.forward_& files, as in the example above. There are two reasons for this:
21327
21328 .ilist
21329 When Exim is receiving an incoming SMTP message from a remote host, it is
21330 running under the Exim uid, not as root. Exim is unable to change uid to read
21331 the file as the user, and it may not be able to read it as the Exim user. So in
21332 practice the router may not be able to operate.
21333 .next
21334 However, even when the router can operate, the existence of a &_.forward_& file
21335 is unimportant when verifying an address. What should be checked is whether the
21336 local part is a valid user name or not. Cutting out the redirection processing
21337 saves some resources.
21338 .endlist
21339
21340
21341
21342
21343
21344
21345 .section "Interpreting redirection data" "SECID126"
21346 .cindex "Sieve filter" "specifying in redirection data"
21347 .cindex "filter" "specifying in redirection data"
21348 The contents of the data string, whether obtained from &%data%& or &%file%&,
21349 can be interpreted in two different ways:
21350
21351 .ilist
21352 If the &%allow_filter%& option is set true, and the data begins with the text
21353 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21354 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21355 respectively. Details of the syntax and semantics of filter files are described
21356 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21357 document is intended for use by end users.
21358 .next
21359 Otherwise, the data must be a comma-separated list of redirection items, as
21360 described in the next section.
21361 .endlist
21362
21363 When a message is redirected to a file (a &"mail folder"&), the filename given
21364 in a non-filter redirection list must always be an absolute path. A filter may
21365 generate a relative path &-- how this is handled depends on the transport's
21366 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21367 for the &(appendfile)& transport.
21368
21369
21370
21371 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21372 .cindex "address redirection" "non-filter list items"
21373 When the redirection data is not an Exim or Sieve filter, for example, if it
21374 comes from a conventional alias or forward file, it consists of a list of
21375 addresses, filenames, pipe commands, or certain special items (see section
21376 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21377 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21378 depending on their default values. The items in the list are separated by
21379 commas or newlines.
21380 If a comma is required in an item, the entire item must be enclosed in double
21381 quotes.
21382
21383 Lines starting with a # character are comments, and are ignored, and # may
21384 also appear following a comma, in which case everything between the # and the
21385 next newline character is ignored.
21386
21387 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21388 double quotes are retained because some forms of mail address require their use
21389 (but never to enclose the entire address). In the following description,
21390 &"item"& refers to what remains after any surrounding double quotes have been
21391 removed.
21392
21393 .vindex "&$local_part$&"
21394 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21395 and the expansion contains a reference to &$local_part$&, you should make use
21396 of the &%quote_local_part%& expansion operator, in case the local part contains
21397 special characters. For example, to redirect all mail for the domain
21398 &'obsolete.example'&, retaining the existing local part, you could use this
21399 setting:
21400 .code
21401 data = ${quote_local_part:$local_part}@newdomain.example
21402 .endd
21403
21404
21405 .section "Redirecting to a local mailbox" "SECTredlocmai"
21406 .cindex "routing" "loops in"
21407 .cindex "loop" "while routing, avoidance of"
21408 .cindex "address redirection" "to local mailbox"
21409 A redirection item may safely be the same as the address currently under
21410 consideration. This does not cause a routing loop, because a router is
21411 automatically skipped if any ancestor of the address that is being processed
21412 is the same as the current address and was processed by the current router.
21413 Such an address is therefore passed to the following routers, so it is handled
21414 as if there were no redirection. When making this loop-avoidance test, the
21415 complete local part, including any prefix or suffix, is used.
21416
21417 .cindex "address redirection" "local part without domain"
21418 Specifying the same local part without a domain is a common usage in personal
21419 filter files when the user wants to have messages delivered to the local
21420 mailbox and also forwarded elsewhere. For example, the user whose login is
21421 &'cleo'& might have a &_.forward_& file containing this:
21422 .code
21423 cleo, cleopatra@egypt.example
21424 .endd
21425 .cindex "backslash in alias file"
21426 .cindex "alias file" "backslash in"
21427 For compatibility with other MTAs, such unqualified local parts may be
21428 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21429 it does make a difference if more than one domain is being handled
21430 synonymously.
21431
21432 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21433 2822 address that does not include a domain, the item is qualified using the
21434 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21435 addresses are qualified using the value in &%qualify_recipient%&, but you can
21436 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21437
21438 Care must be taken if there are alias names for local users.
21439 Consider an MTA handling a single local domain where the system alias file
21440 contains:
21441 .code
21442 Sam.Reman: spqr
21443 .endd
21444 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21445 messages in the local mailbox, and also forward copies elsewhere. He creates
21446 this forward file:
21447 .code
21448 Sam.Reman, spqr@reme.elsewhere.example
21449 .endd
21450 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21451 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21452 second time round, because it has previously routed it,
21453 and the following routers presumably cannot handle the alias. The forward file
21454 should really contain
21455 .code
21456 spqr, spqr@reme.elsewhere.example
21457 .endd
21458 but because this is such a common error, the &%check_ancestor%& option (see
21459 below) exists to provide a way to get round it. This is normally set on a
21460 &(redirect)& router that is handling users' &_.forward_& files.
21461
21462
21463
21464 .section "Special items in redirection lists" "SECTspecitredli"
21465 In addition to addresses, the following types of item may appear in redirection
21466 lists (that is, in non-filter redirection data):
21467
21468 .ilist
21469 .cindex "pipe" "in redirection list"
21470 .cindex "address redirection" "to pipe"
21471 An item is treated as a pipe command if it begins with &"|"& and does not parse
21472 as a valid RFC 2822 address that includes a domain. A transport for running the
21473 command must be specified by the &%pipe_transport%& option.
21474 Normally, either the router or the transport specifies a user and a group under
21475 which to run the delivery. The default is to use the Exim user and group.
21476
21477 Single or double quotes can be used for enclosing the individual arguments of
21478 the pipe command; no interpretation of escapes is done for single quotes. If
21479 the command contains a comma character, it is necessary to put the whole item
21480 in double quotes, for example:
21481 .code
21482 "|/some/command ready,steady,go"
21483 .endd
21484 since items in redirection lists are terminated by commas. Do not, however,
21485 quote just the command. An item such as
21486 .code
21487 |"/some/command ready,steady,go"
21488 .endd
21489 is interpreted as a pipe with a rather strange command name, and no arguments.
21490
21491 Note that the above example assumes that the text comes from a lookup source
21492 of some sort, so that the quotes are part of the data.  If composing a
21493 redirect router with a &%data%& option directly specifying this command, the
21494 quotes will be used by the configuration parser to define the extent of one
21495 string, but will not be passed down into the redirect router itself.  There
21496 are two main approaches to get around this: escape quotes to be part of the
21497 data itself, or avoid using this mechanism and instead create a custom
21498 transport with the &%command%& option set and reference that transport from
21499 an &%accept%& router.
21500
21501 .next
21502 .cindex "file" "in redirection list"
21503 .cindex "address redirection" "to file"
21504 An item is interpreted as a path name if it begins with &"/"& and does not
21505 parse as a valid RFC 2822 address that includes a domain. For example,
21506 .code
21507 /home/world/minbari
21508 .endd
21509 is treated as a filename, but
21510 .code
21511 /s=molari/o=babylon/@x400gate.way
21512 .endd
21513 is treated as an address. For a filename, a transport must be specified using
21514 the &%file_transport%& option. However, if the generated path name ends with a
21515 forward slash character, it is interpreted as a directory name rather than a
21516 filename, and &%directory_transport%& is used instead.
21517
21518 Normally, either the router or the transport specifies a user and a group under
21519 which to run the delivery. The default is to use the Exim user and group.
21520
21521 .cindex "&_/dev/null_&"
21522 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21523 bypassed at a high level, and the log entry shows &"**bypassed**"&
21524 instead of a transport name. In this case the user and group are not used.
21525
21526 .next
21527 .cindex "included address list"
21528 .cindex "address redirection" "included external list"
21529 If an item is of the form
21530 .code
21531 :include:<path name>
21532 .endd
21533 a list of further items is taken from the given file and included at that
21534 point. &*Note*&: Such a file can not be a filter file; it is just an
21535 out-of-line addition to the list. The items in the included list are separated
21536 by commas or newlines and are not subject to expansion. If this is the first
21537 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21538 the alias name. This example is incorrect:
21539 .code
21540 list1    :include:/opt/lists/list1
21541 .endd
21542 It must be given as
21543 .code
21544 list1:   :include:/opt/lists/list1
21545 .endd
21546 .cindex "tainted data" "in filenames"
21547 .cindex redirect "tainted data"
21548 Tainted data may not be used for a filename.
21549 .next
21550 .cindex "address redirection" "to black hole"
21551 .cindex "delivery" "discard"
21552 .cindex "delivery" "blackhole"
21553 .cindex "black hole"
21554 .cindex "abandoning mail"
21555 Sometimes you want to throw away mail to a particular local part.  Making the
21556 &%data%& option expand to an empty string does not work, because that causes
21557 the router to decline. Instead, the alias item
21558 .code
21559 :blackhole:
21560 .endd
21561 can be used. It does what its name implies. No delivery is
21562 done, and no error message is generated. This has the same effect as specifying
21563 &_/dev/null_& as a destination, but it can be independently disabled.
21564
21565 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21566 delivery is done for the original local part, even if other redirection items
21567 are present. If you are generating a multi-item list (for example, by reading a
21568 database) and need the ability to provide a no-op item, you must use
21569 &_/dev/null_&.
21570
21571 .next
21572 .cindex "delivery" "forcing failure"
21573 .cindex "delivery" "forcing deferral"
21574 .cindex "failing delivery" "forcing"
21575 .cindex "deferred delivery, forcing"
21576 .cindex "customizing" "failure message"
21577 An attempt to deliver a particular address can be deferred or forced to fail by
21578 redirection items of the form
21579 .code
21580 :defer:
21581 :fail:
21582 .endd
21583 respectively. When a redirection list contains such an item, it applies
21584 to the entire redirection; any other items in the list are ignored. Any
21585 text following &':fail:'& or &':defer:'& is placed in the error text
21586 associated with the failure. For example, an alias file might contain:
21587 .code
21588 X.Employee:  :fail: Gone away, no forwarding address
21589 .endd
21590 In the case of an address that is being verified from an ACL or as the subject
21591 of a
21592 .cindex "VRFY" "error text, display of"
21593 VRFY command, the text is included in the SMTP error response by
21594 default.
21595 .cindex "EXPN" "error text, display of"
21596 The text is not included in the response to an EXPN command. In non-SMTP cases
21597 the text is included in the error message that Exim generates.
21598
21599 .cindex "SMTP" "error codes"
21600 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21601 &':fail:'&. However, if the message starts with three digits followed by a
21602 space, optionally followed by an extended code of the form &'n.n.n'&, also
21603 followed by a space, and the very first digit is the same as the default error
21604 code, the code from the message is used instead. If the very first digit is
21605 incorrect, a panic error is logged, and the default code is used. You can
21606 suppress the use of the supplied code in a redirect router by setting the
21607 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21608 ignored.
21609
21610 .vindex "&$acl_verify_message$&"
21611 In an ACL, an explicitly provided message overrides the default, but the
21612 default message is available in the variable &$acl_verify_message$& and can
21613 therefore be included in a custom message if this is desired.
21614
21615 Normally the error text is the rest of the redirection list &-- a comma does
21616 not terminate it &-- but a newline does act as a terminator. Newlines are not
21617 normally present in alias expansions. In &(lsearch)& lookups they are removed
21618 as part of the continuation process, but they may exist in other kinds of
21619 lookup and in &':include:'& files.
21620
21621 During routing for message delivery (as opposed to verification), a redirection
21622 containing &':fail:'& causes an immediate failure of the incoming address,
21623 whereas &':defer:'& causes the message to remain in the queue so that a
21624 subsequent delivery attempt can happen at a later time. If an address is
21625 deferred for too long, it will ultimately fail, because the normal retry
21626 rules still apply.
21627
21628 .next
21629 .cindex "alias file" "exception to default"
21630 Sometimes it is useful to use a single-key search type with a default (see
21631 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21632 for exceptions to the default. These can be handled by aliasing them to
21633 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21634 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21635 results in an empty redirection list has the same effect.
21636 .endlist
21637
21638
21639 .section "Duplicate addresses" "SECTdupaddr"
21640 .cindex "duplicate addresses"
21641 .cindex "address duplicate, discarding"
21642 .cindex "pipe" "duplicated"
21643 Exim removes duplicate addresses from the list to which it is delivering, so as
21644 to deliver just one copy to each address. This does not apply to deliveries
21645 routed to pipes by different immediate parent addresses, but an indirect
21646 aliasing scheme of the type
21647 .code
21648 pipe:       |/some/command $local_part
21649 localpart1: pipe
21650 localpart2: pipe
21651 .endd
21652 does not work with a message that is addressed to both local parts, because
21653 when the second is aliased to the intermediate local part &"pipe"& it gets
21654 discarded as being the same as a previously handled address. However, a scheme
21655 such as
21656 .code
21657 localpart1: |/some/command $local_part
21658 localpart2: |/some/command $local_part
21659 .endd
21660 does result in two different pipe deliveries, because the immediate parents of
21661 the pipes are distinct.
21662
21663
21664
21665 .section "Repeated redirection expansion" "SECID128"
21666 .cindex "repeated redirection expansion"
21667 .cindex "address redirection" "repeated for each delivery attempt"
21668 When a message cannot be delivered to all of its recipients immediately,
21669 leading to two or more delivery attempts, redirection expansion is carried out
21670 afresh each time for those addresses whose children were not all previously
21671 delivered. If redirection is being used as a mailing list, this can lead to new
21672 members of the list receiving copies of old messages. The &%one_time%& option
21673 can be used to avoid this.
21674
21675
21676 .section "Errors in redirection lists" "SECID129"
21677 .cindex "address redirection" "errors"
21678 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21679 error is skipped, and an entry is written to the main log. This may be useful
21680 for mailing lists that are automatically managed. Otherwise, if an error is
21681 detected while generating the list of new addresses, the original address is
21682 deferred. See also &%syntax_errors_to%&.
21683
21684
21685
21686 .section "Private options for the redirect router" "SECID130"
21687
21688 .cindex "options" "&(redirect)& router"
21689 The private options for the &(redirect)& router are as follows:
21690
21691
21692 .option allow_defer redirect boolean false
21693 Setting this option allows the use of &':defer:'& in non-filter redirection
21694 data, or the &%defer%& command in an Exim filter file.
21695
21696
21697 .option allow_fail redirect boolean false
21698 .cindex "failing delivery" "from filter"
21699 If this option is true, the &':fail:'& item can be used in a redirection list,
21700 and the &%fail%& command may be used in an Exim filter file.
21701
21702
21703 .option allow_filter redirect boolean false
21704 .cindex "filter" "enabling use of"
21705 .cindex "Sieve filter" "enabling use of"
21706 Setting this option allows Exim to interpret redirection data that starts with
21707 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21708 are some features of Exim filter files that some administrators may wish to
21709 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21710
21711 It is also possible to lock out Exim filters or Sieve filters while allowing
21712 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21713
21714
21715 The filter is run using the uid and gid set by the generic &%user%& and
21716 &%group%& options. These take their defaults from the password data if
21717 &%check_local_user%& is set, so in the normal case of users' personal filter
21718 files, the filter is run as the relevant user. When &%allow_filter%& is set
21719 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21720
21721
21722
21723 .option allow_freeze redirect boolean false
21724 .cindex "freezing messages" "allowing in filter"
21725 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21726 This command is more normally encountered in system filters, and is disabled by
21727 default for redirection filters because it isn't something you usually want to
21728 let ordinary users do.
21729
21730
21731
21732 .option check_ancestor redirect boolean false
21733 This option is concerned with handling generated addresses that are the same
21734 as some address in the list of redirection ancestors of the current address.
21735 Although it is turned off by default in the code, it is set in the default
21736 configuration file for handling users' &_.forward_& files. It is recommended
21737 for this use of the &(redirect)& router.
21738
21739 When &%check_ancestor%& is set, if a generated address (including the domain)
21740 is the same as any ancestor of the current address, it is replaced by a copy of
21741 the current address. This helps in the case where local part A is aliased to B,
21742 and B has a &_.forward_& file pointing back to A. For example, within a single
21743 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21744 &_&~jb/.forward_& contains:
21745 .code
21746 \Joe.Bloggs, <other item(s)>
21747 .endd
21748 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21749 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21750 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21751 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21752 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21753 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21754 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21755 original address. See also the &%repeat_use%& option below.
21756
21757
21758 .option check_group redirect boolean "see below"
21759 When the &%file%& option is used, the group owner of the file is checked only
21760 when this option is set. The permitted groups are those listed in the
21761 &%owngroups%& option, together with the user's default group if
21762 &%check_local_user%& is set. If the file has the wrong group, routing is
21763 deferred. The default setting for this option is true if &%check_local_user%&
21764 is set and the &%modemask%& option permits the group write bit, or if the
21765 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21766
21767
21768
21769 .option check_owner redirect boolean "see below"
21770 When the &%file%& option is used, the owner of the file is checked only when
21771 this option is set. If &%check_local_user%& is set, the local user is
21772 permitted; otherwise the owner must be one of those listed in the &%owners%&
21773 option. The default value for this option is true if &%check_local_user%& or
21774 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21775
21776
21777 .option data redirect string&!! unset
21778 This option is mutually exclusive with &%file%&. One or other of them must be
21779 set, but not both. The contents of &%data%& are expanded, and then used as the
21780 list of forwarding items, or as a set of filtering instructions. If the
21781 expansion is forced to fail, or the result is an empty string or a string that
21782 has no effect (consists entirely of comments), the router declines.
21783
21784 When filtering instructions are used, the string must begin with &"#Exim
21785 filter"&, and all comments in the string, including this initial one, must be
21786 terminated with newline characters. For example:
21787 .code
21788 data = #Exim filter\n\
21789        if $h_to: contains Exim then save $home/mail/exim endif
21790 .endd
21791 If you are reading the data from a database where newlines cannot be included,
21792 you can use the &${sg}$& expansion item to turn the escape string of your
21793 choice into a newline.
21794
21795
21796 .option directory_transport redirect string&!! unset
21797 A &(redirect)& router sets up a direct delivery to a directory when a path name
21798 ending with a slash is specified as a new &"address"&. The transport used is
21799 specified by this option, which, after expansion, must be the name of a
21800 configured transport. This should normally be an &(appendfile)& transport.
21801
21802
21803 .option file redirect string&!! unset
21804 This option specifies the name of a file that contains the redirection data. It
21805 is mutually exclusive with the &%data%& option. The string is expanded before
21806 use; if the expansion is forced to fail, the router declines. Other expansion
21807 failures cause delivery to be deferred. The result of a successful expansion
21808 must be an absolute path. The entire file is read and used as the redirection
21809 data. If the data is an empty string or a string that has no effect (consists
21810 entirely of comments), the router declines.
21811
21812 .cindex "NFS" "checking for file existence"
21813 If the attempt to open the file fails with a &"does not exist"& error, Exim
21814 runs a check on the containing directory,
21815 unless &%ignore_enotdir%& is true (see below).
21816 If the directory does not appear to exist, delivery is deferred. This can
21817 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21818 is a mount problem. If the containing directory does exist, but the file does
21819 not, the router declines.
21820
21821
21822 .option file_transport redirect string&!! unset
21823 .vindex "&$address_file$&"
21824 A &(redirect)& router sets up a direct delivery to a file when a path name not
21825 ending in a slash is specified as a new &"address"&. The transport used is
21826 specified by this option, which, after expansion, must be the name of a
21827 configured transport. This should normally be an &(appendfile)& transport. When
21828 it is running, the filename is in &$address_file$&.
21829
21830
21831 .option filter_prepend_home redirect boolean true
21832 When this option is true, if a &(save)& command in an Exim filter specifies a
21833 relative path, and &$home$& is defined, it is automatically prepended to the
21834 relative path. If this option is set false, this action does not happen. The
21835 relative path is then passed to the transport unmodified.
21836
21837
21838 .option forbid_blackhole redirect boolean false
21839 .cindex "restricting access to features"
21840 .cindex "filter" "locking out certain features"
21841 If this option is true, the &':blackhole:'& item may not appear in a
21842 redirection list.
21843
21844
21845 .option forbid_exim_filter redirect boolean false
21846 .cindex "restricting access to features"
21847 .cindex "filter" "locking out certain features"
21848 If this option is set true, only Sieve filters are permitted when
21849 &%allow_filter%& is true.
21850
21851
21852
21853
21854 .option forbid_file redirect boolean false
21855 .cindex "restricting access to features"
21856 .cindex "delivery" "to file; forbidding"
21857 .cindex "filter" "locking out certain features"
21858 .cindex "Sieve filter" "forbidding delivery to a file"
21859 .cindex "Sieve filter" "&""keep""& facility; disabling"
21860 If this option is true, this router may not generate a new address that
21861 specifies delivery to a local file or directory, either from a filter or from a
21862 conventional forward file. This option is forced to be true if &%one_time%& is
21863 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21864 locks out the Sieve's &"keep"& facility.
21865
21866
21867 .option forbid_filter_dlfunc redirect boolean false
21868 .cindex "restricting access to features"
21869 .cindex "filter" "locking out certain features"
21870 If this option is true, string expansions in Exim filters are not allowed to
21871 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21872 functions.
21873
21874 .option forbid_filter_existstest redirect boolean false
21875 .cindex "restricting access to features"
21876 .cindex "filter" "locking out certain features"
21877 .cindex "expansion" "statting a file"
21878 If this option is true, string expansions in Exim filters are not allowed to
21879 make use of the &%exists%& condition or the &%stat%& expansion item.
21880
21881 .option forbid_filter_logwrite redirect boolean false
21882 .cindex "restricting access to features"
21883 .cindex "filter" "locking out certain features"
21884 If this option is true, use of the logging facility in Exim filters is not
21885 permitted. Logging is in any case available only if the filter is being run
21886 under some unprivileged uid (which is normally the case for ordinary users'
21887 &_.forward_& files).
21888
21889
21890 .option forbid_filter_lookup redirect boolean false
21891 .cindex "restricting access to features"
21892 .cindex "filter" "locking out certain features"
21893 If this option is true, string expansions in Exim filter files are not allowed
21894 to make use of &%lookup%& items.
21895
21896
21897 .option forbid_filter_perl redirect boolean false
21898 .cindex "restricting access to features"
21899 .cindex "filter" "locking out certain features"
21900 This option has an effect only if Exim is built with embedded Perl support. If
21901 it is true, string expansions in Exim filter files are not allowed to make use
21902 of the embedded Perl support.
21903
21904
21905 .option forbid_filter_readfile redirect boolean false
21906 .cindex "restricting access to features"
21907 .cindex "filter" "locking out certain features"
21908 If this option is true, string expansions in Exim filter files are not allowed
21909 to make use of &%readfile%& items.
21910
21911
21912 .option forbid_filter_readsocket redirect boolean false
21913 .cindex "restricting access to features"
21914 .cindex "filter" "locking out certain features"
21915 If this option is true, string expansions in Exim filter files are not allowed
21916 to make use of &%readsocket%& items.
21917
21918
21919 .option forbid_filter_reply redirect boolean false
21920 .cindex "restricting access to features"
21921 .cindex "filter" "locking out certain features"
21922 If this option is true, this router may not generate an automatic reply
21923 message. Automatic replies can be generated only from Exim or Sieve filter
21924 files, not from traditional forward files. This option is forced to be true if
21925 &%one_time%& is set.
21926
21927
21928 .option forbid_filter_run redirect boolean false
21929 .cindex "restricting access to features"
21930 .cindex "filter" "locking out certain features"
21931 If this option is true, string expansions in Exim filter files are not allowed
21932 to make use of &%run%& items.
21933
21934
21935 .option forbid_include redirect boolean false
21936 .cindex "restricting access to features"
21937 .cindex "filter" "locking out certain features"
21938 If this option is true, items of the form
21939 .code
21940 :include:<path name>
21941 .endd
21942 are not permitted in non-filter redirection lists.
21943
21944
21945 .option forbid_pipe redirect boolean false
21946 .cindex "restricting access to features"
21947 .cindex "filter" "locking out certain features"
21948 .cindex "delivery" "to pipe; forbidding"
21949 If this option is true, this router may not generate a new address which
21950 specifies delivery to a pipe, either from an Exim filter or from a conventional
21951 forward file. This option is forced to be true if &%one_time%& is set.
21952
21953
21954 .option forbid_sieve_filter redirect boolean false
21955 .cindex "restricting access to features"
21956 .cindex "filter" "locking out certain features"
21957 If this option is set true, only Exim filters are permitted when
21958 &%allow_filter%& is true.
21959
21960
21961 .cindex "SMTP" "error codes"
21962 .option forbid_smtp_code redirect boolean false
21963 If this option is set true, any SMTP error codes that are present at the start
21964 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21965 the default codes (451 and 550, respectively) are always used.
21966
21967
21968
21969
21970 .option hide_child_in_errmsg redirect boolean false
21971 .cindex "bounce message" "redirection details; suppressing"
21972 If this option is true, it prevents Exim from quoting a child address if it
21973 generates a bounce or delay message for it. Instead it says &"an address
21974 generated from <&'the top level address'&>"&. Of course, this applies only to
21975 bounces generated locally. If a message is forwarded to another host, &'its'&
21976 bounce may well quote the generated address.
21977
21978
21979 .option ignore_eacces redirect boolean false
21980 .cindex "EACCES"
21981 If this option is set and an attempt to open a redirection file yields the
21982 EACCES error (permission denied), the &(redirect)& router behaves as if the
21983 file did not exist.
21984
21985
21986 .option ignore_enotdir redirect boolean false
21987 .cindex "ENOTDIR"
21988 If this option is set and an attempt to open a redirection file yields the
21989 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21990 router behaves as if the file did not exist.
21991
21992 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21993 router that has the &%file%& option set discovers that the file does not exist
21994 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21995 against unmounted NFS directories. If the parent can not be statted, delivery
21996 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21997 is set, because that option tells Exim to ignore &"something on the path is not
21998 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21999 that some operating systems give ENOENT where others give ENOTDIR.
22000
22001
22002
22003 .option include_directory redirect string unset
22004 If this option is set, the path names of any &':include:'& items in a
22005 redirection list must start with this directory.
22006
22007
22008 .option modemask redirect "octal integer" 022
22009 This specifies mode bits which must not be set for a file specified by the
22010 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22011
22012
22013 .option one_time redirect boolean false
22014 .cindex "one-time aliasing/forwarding expansion"
22015 .cindex "alias file" "one-time expansion"
22016 .cindex "forward file" "one-time expansion"
22017 .cindex "mailing lists" "one-time expansion"
22018 .cindex "address redirection" "one-time expansion"
22019 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22020 files each time it tries to deliver a message causes a problem when one or more
22021 of the generated addresses fails be delivered at the first attempt. The problem
22022 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22023 but of what happens when the redirection list changes during the time that the
22024 message is on Exim's queue. This is particularly true in the case of mailing
22025 lists, where new subscribers might receive copies of messages that were posted
22026 before they subscribed.
22027
22028 If &%one_time%& is set and any addresses generated by the router fail to
22029 deliver at the first attempt, the failing addresses are added to the message as
22030 &"top level"& addresses, and the parent address that generated them is marked
22031 &"delivered"&. Thus, redirection does not happen again at the next delivery
22032 attempt.
22033
22034 &*Warning 1*&: Any header line addition or removal that is specified by this
22035 router would be lost if delivery did not succeed at the first attempt. For this
22036 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22037 permitted when &%one_time%& is set.
22038
22039 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22040 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22041 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22042
22043 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22044 &%one_time%&.
22045
22046 The original top-level address is remembered with each of the generated
22047 addresses, and is output in any log messages. However, any intermediate parent
22048 addresses are not recorded. This makes a difference to the log only if
22049 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22050 typically be used for mailing lists, where there is normally just one level of
22051 expansion.
22052
22053
22054 .option owners redirect "string list" unset
22055 .cindex "ownership" "alias file"
22056 .cindex "ownership" "forward file"
22057 .cindex "alias file" "ownership"
22058 .cindex "forward file" "ownership"
22059 This specifies a list of permitted owners for the file specified by &%file%&.
22060 This list is in addition to the local user when &%check_local_user%& is set.
22061 See &%check_owner%& above.
22062
22063
22064 .option owngroups redirect "string list" unset
22065 This specifies a list of permitted groups for the file specified by &%file%&.
22066 The list is in addition to the local user's primary group when
22067 &%check_local_user%& is set. See &%check_group%& above.
22068
22069
22070 .option pipe_transport redirect string&!! unset
22071 .vindex "&$address_pipe$&"
22072 A &(redirect)& router sets up a direct delivery to a pipe when a string
22073 starting with a vertical bar character is specified as a new &"address"&. The
22074 transport used is specified by this option, which, after expansion, must be the
22075 name of a configured transport. This should normally be a &(pipe)& transport.
22076 When the transport is run, the pipe command is in &$address_pipe$&.
22077
22078
22079 .option qualify_domain redirect string&!! unset
22080 .vindex "&$qualify_recipient$&"
22081 If this option is set, and an unqualified address (one without a domain) is
22082 generated, and that address would normally be qualified by the global setting
22083 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22084 expanding this string. If the expansion fails, the router declines. If you want
22085 to revert to the default, you can have the expansion generate
22086 &$qualify_recipient$&.
22087
22088 This option applies to all unqualified addresses generated by Exim filters,
22089 but for traditional &_.forward_& files, it applies only to addresses that are
22090 not preceded by a backslash. Sieve filters cannot generate unqualified
22091 addresses.
22092
22093 .option qualify_preserve_domain redirect boolean false
22094 .cindex "domain" "in redirection; preserving"
22095 .cindex "preserving domain in redirection"
22096 .cindex "address redirection" "domain; preserving"
22097 If this option is set, the router's local &%qualify_domain%& option must not be
22098 set (a configuration error occurs if it is). If an unqualified address (one
22099 without a domain) is generated, it is qualified with the domain of the parent
22100 address (the immediately preceding ancestor) instead of the global
22101 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22102 this applies whether or not the address is preceded by a backslash.
22103
22104
22105 .option repeat_use redirect boolean true
22106 If this option is set false, the router is skipped for a child address that has
22107 any ancestor that was routed by this router. This test happens before any of
22108 the other preconditions are tested. Exim's default anti-looping rules skip
22109 only when the ancestor is the same as the current address. See also
22110 &%check_ancestor%& above and the generic &%redirect_router%& option.
22111
22112
22113 .option reply_transport redirect string&!! unset
22114 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22115 &%vacation%& command is used in a filter file. The transport used is specified
22116 by this option, which, after expansion, must be the name of a configured
22117 transport. This should normally be an &(autoreply)& transport. Other transports
22118 are unlikely to do anything sensible or useful.
22119
22120
22121 .option rewrite redirect boolean true
22122 .cindex "address redirection" "disabling rewriting"
22123 If this option is set false, addresses generated by the router are not
22124 subject to address rewriting. Otherwise, they are treated like new addresses
22125 and are rewritten according to the global rewriting rules.
22126
22127
22128 .option sieve_subaddress redirect string&!! unset
22129 The value of this option is passed to a Sieve filter to specify the
22130 :subaddress part of an address.
22131
22132 .option sieve_useraddress redirect string&!! unset
22133 The value of this option is passed to a Sieve filter to specify the :user part
22134 of an address. However, if it is unset, the entire original local part
22135 (including any prefix or suffix) is used for :user.
22136
22137
22138 .option sieve_vacation_directory redirect string&!! unset
22139 .cindex "Sieve filter" "vacation directory"
22140 To enable the &"vacation"& extension for Sieve filters, you must set
22141 &%sieve_vacation_directory%& to the directory where vacation databases are held
22142 (do not put anything else in that directory), and ensure that the
22143 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22144 needs their own directory; Exim will create it if necessary.
22145
22146
22147
22148 .option skip_syntax_errors redirect boolean false
22149 .cindex "forward file" "broken"
22150 .cindex "address redirection" "broken files"
22151 .cindex "alias file" "broken"
22152 .cindex "broken alias or forward files"
22153 .cindex "ignoring faulty addresses"
22154 .cindex "skipping faulty addresses"
22155 .cindex "error" "skipping bad syntax"
22156 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22157 non-filter redirection data are skipped, and each failing address is logged. If
22158 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22159 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22160 are expanded and placed at the head of the error message generated by
22161 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22162 be the same address as the generic &%errors_to%& option. The
22163 &%skip_syntax_errors%& option is often used when handling mailing lists.
22164
22165 If all the addresses in a redirection list are skipped because of syntax
22166 errors, the router declines to handle the original address, and it is passed to
22167 the following routers.
22168
22169 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22170 error in the filter causes filtering to be abandoned without any action being
22171 taken. The incident is logged, and the router declines to handle the address,
22172 so it is passed to the following routers.
22173
22174 .cindex "Sieve filter" "syntax errors in"
22175 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22176 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22177 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22178
22179 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22180 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22181 option, used with an address that does not get redirected, can be used to
22182 notify users of these errors, by means of a router like this:
22183 .code
22184 userforward:
22185   driver = redirect
22186   allow_filter
22187   check_local_user
22188   file = $home/.forward
22189   file_transport = address_file
22190   pipe_transport = address_pipe
22191   reply_transport = address_reply
22192   no_verify
22193   skip_syntax_errors
22194   syntax_errors_to = real-$local_part@$domain
22195   syntax_errors_text = \
22196    This is an automatically generated message. An error has\n\
22197    been found in your .forward file. Details of the error are\n\
22198    reported below. While this error persists, you will receive\n\
22199    a copy of this message for every message that is addressed\n\
22200    to you. If your .forward file is a filter file, or if it is\n\
22201    a non-filter file containing no valid forwarding addresses,\n\
22202    a copy of each incoming message will be put in your normal\n\
22203    mailbox. If a non-filter file contains at least one valid\n\
22204    forwarding address, forwarding to the valid addresses will\n\
22205    happen, and those will be the only deliveries that occur.
22206 .endd
22207 You also need a router to ensure that local addresses that are prefixed by
22208 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22209 put this immediately before the &(userforward)& router:
22210 .code
22211 real_localuser:
22212   driver = accept
22213   check_local_user
22214   local_part_prefix = real-
22215   transport = local_delivery
22216 .endd
22217 For security, it would probably be a good idea to restrict the use of this
22218 router to locally-generated messages, using a condition such as this:
22219 .code
22220   condition = ${if match {$sender_host_address}\
22221                          {\N^(|127\.0\.0\.1)$\N}}
22222 .endd
22223
22224
22225 .option syntax_errors_text redirect string&!! unset
22226 See &%skip_syntax_errors%& above.
22227
22228
22229 .option syntax_errors_to redirect string unset
22230 See &%skip_syntax_errors%& above.
22231 .ecindex IIDredrou1
22232 .ecindex IIDredrou2
22233
22234
22235
22236
22237
22238
22239 . ////////////////////////////////////////////////////////////////////////////
22240 . ////////////////////////////////////////////////////////////////////////////
22241
22242 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22243          "Environment for local transports"
22244 .scindex IIDenvlotra1 "local transports" "environment for"
22245 .scindex IIDenvlotra2 "environment" "local transports"
22246 .scindex IIDenvlotra3 "transport" "local; environment for"
22247 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22248 transport can be thought of as similar to a pipe.) Exim always runs transports
22249 in subprocesses, under specified uids and gids. Typical deliveries to local
22250 mailboxes run under the uid and gid of the local user.
22251
22252 Exim also sets a specific current directory while running the transport; for
22253 some transports a home directory setting is also relevant. The &(pipe)&
22254 transport is the only one that sets up environment variables; see section
22255 &<<SECTpipeenv>>& for details.
22256
22257 The values used for the uid, gid, and the directories may come from several
22258 different places. In many cases, the router that handles the address associates
22259 settings with that address as a result of its &%check_local_user%&, &%group%&,
22260 or &%user%& options. However, values may also be given in the transport's own
22261 configuration, and these override anything that comes from the router.
22262
22263
22264
22265 .section "Concurrent deliveries" "SECID131"
22266 .cindex "concurrent deliveries"
22267 .cindex "simultaneous deliveries"
22268 If two different messages for the same local recipient arrive more or less
22269 simultaneously, the two delivery processes are likely to run concurrently. When
22270 the &(appendfile)& transport is used to write to a file, Exim applies locking
22271 rules to stop concurrent processes from writing to the same file at the same
22272 time.
22273
22274 However, when you use a &(pipe)& transport, it is up to you to arrange any
22275 locking that is needed. Here is a silly example:
22276 .code
22277 my_transport:
22278   driver = pipe
22279   command = /bin/sh -c 'cat >>/some/file'
22280 .endd
22281 This is supposed to write the message at the end of the file. However, if two
22282 messages arrive at the same time, the file will be scrambled. You can use the
22283 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22284 file using the same algorithm that Exim itself uses.
22285
22286
22287
22288
22289 .section "Uids and gids" "SECTenvuidgid"
22290 .cindex "local transports" "uid and gid"
22291 .cindex "transport" "local; uid and gid"
22292 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22293 overrides any group that the router set in the address, even if &%user%& is not
22294 set for the transport. This makes it possible, for example, to run local mail
22295 delivery under the uid of the recipient (set by the router), but in a special
22296 group (set by the transport). For example:
22297 .code
22298 # Routers ...
22299 # User/group are set by check_local_user in this router
22300 local_users:
22301   driver = accept
22302   check_local_user
22303   transport = group_delivery
22304
22305 # Transports ...
22306 # This transport overrides the group
22307 group_delivery:
22308   driver = appendfile
22309   file = /var/spool/mail/$local_part_data
22310   group = mail
22311 .endd
22312 If &%user%& is set for a transport, its value overrides what is set in the
22313 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22314 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22315 set.
22316
22317 .oindex "&%initgroups%&"
22318 When the uid is taken from the transport's configuration, the &[initgroups()]&
22319 function is called for the groups associated with that uid if the
22320 &%initgroups%& option is set for the transport. When the uid is not specified
22321 by the transport, but is associated with the address by a router, the option
22322 for calling &[initgroups()]& is taken from the router configuration.
22323
22324 .cindex "&(pipe)& transport" "uid for"
22325 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22326 is set and &%user%& is not set, the uid of the process that called Exim to
22327 receive the message is used, and if &%group%& is not set, the corresponding
22328 original gid is also used.
22329
22330 This is the detailed preference order for obtaining a gid; the first of the
22331 following that is set is used:
22332
22333 .ilist
22334 A &%group%& setting of the transport;
22335 .next
22336 A &%group%& setting of the router;
22337 .next
22338 A gid associated with a user setting of the router, either as a result of
22339 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22340 .next
22341 The group associated with a non-numeric &%user%& setting of the transport;
22342 .next
22343 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22344 the uid is the creator's uid;
22345 .next
22346 The Exim gid if the Exim uid is being used as a default.
22347 .endlist
22348
22349 If, for example, the user is specified numerically on the router and there are
22350 no group settings, no gid is available. In this situation, an error occurs.
22351 This is different for the uid, for which there always is an ultimate default.
22352 The first of the following that is set is used:
22353
22354 .ilist
22355 A &%user%& setting of the transport;
22356 .next
22357 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22358 .next
22359 A &%user%& setting of the router;
22360 .next
22361 A &%check_local_user%& setting of the router;
22362 .next
22363 The Exim uid.
22364 .endlist
22365
22366 Of course, an error will still occur if the uid that is chosen is on the
22367 &%never_users%& list.
22368
22369
22370
22371
22372
22373 .section "Current and home directories" "SECID132"
22374 .cindex "current directory for local transport"
22375 .cindex "home directory" "for local transport"
22376 .cindex "transport" "local; home directory for"
22377 .cindex "transport" "local; current directory for"
22378 Routers may set current and home directories for local transports by means of
22379 the &%transport_current_directory%& and &%transport_home_directory%& options.
22380 However, if the transport's &%current_directory%& or &%home_directory%& options
22381 are set, they override the router's values. In detail, the home directory
22382 for a local transport is taken from the first of these values that is set:
22383
22384 .ilist
22385 The &%home_directory%& option on the transport;
22386 .next
22387 The &%transport_home_directory%& option on the router;
22388 .next
22389 The password data if &%check_local_user%& is set on the router;
22390 .next
22391 The &%router_home_directory%& option on the router.
22392 .endlist
22393
22394 The current directory is taken from the first of these values that is set:
22395
22396 .ilist
22397 The &%current_directory%& option on the transport;
22398 .next
22399 The &%transport_current_directory%& option on the router.
22400 .endlist
22401
22402
22403 If neither the router nor the transport sets a current directory, Exim uses the
22404 value of the home directory, if it is set. Otherwise it sets the current
22405 directory to &_/_& before running a local transport.
22406
22407
22408
22409 .section "Expansion variables derived from the address" "SECID133"
22410 .vindex "&$domain$&"
22411 .vindex "&$local_part$&"
22412 .vindex "&$original_domain$&"
22413 Normally a local delivery is handling a single address, and in that case the
22414 variables such as &$domain$& and &$local_part$& are set during local
22415 deliveries. However, in some circumstances more than one address may be handled
22416 at once (for example, while writing batch SMTP for onward transmission by some
22417 other means). In this case, the variables associated with the local part are
22418 never set, &$domain$& is set only if all the addresses have the same domain,
22419 and &$original_domain$& is never set.
22420 .ecindex IIDenvlotra1
22421 .ecindex IIDenvlotra2
22422 .ecindex IIDenvlotra3
22423
22424
22425
22426
22427
22428
22429
22430 . ////////////////////////////////////////////////////////////////////////////
22431 . ////////////////////////////////////////////////////////////////////////////
22432
22433 .chapter "Generic options for transports" "CHAPtransportgeneric"
22434 .scindex IIDgenoptra1 "generic options" "transport"
22435 .scindex IIDgenoptra2 "options" "generic; for transports"
22436 .scindex IIDgenoptra3 "transport" "generic options for"
22437 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22438 prior to Exim 4.95 names would be silently truncated at this length, but now
22439 it is enforced.
22440
22441 The following generic options apply to all transports:
22442
22443
22444 .option body_only transports boolean false
22445 .cindex "transport" "body only"
22446 .cindex "message" "transporting body only"
22447 .cindex "body of message" "transporting"
22448 If this option is set, the message's headers are not transported. It is
22449 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22450 or &(pipe)& transports, the settings of &%message_prefix%& and
22451 &%message_suffix%& should be checked, because this option does not
22452 automatically suppress them.
22453
22454
22455 .option current_directory transports string&!! unset
22456 .cindex "transport" "current directory for"
22457 This specifies the current directory that is to be set while running the
22458 transport, overriding any value that may have been set by the router.
22459 If the expansion fails for any reason, including forced failure, an error is
22460 logged, and delivery is deferred.
22461
22462
22463 .option disable_logging transports boolean false
22464 If this option is set true, nothing is logged for any
22465 deliveries by the transport or for any
22466 transport errors. You should not set this option unless you really, really know
22467 what you are doing.
22468
22469
22470 .option debug_print transports string&!! unset
22471 .cindex "testing" "variables in drivers"
22472 If this option is set and debugging is enabled (see the &%-d%& command line
22473 option), the string is expanded and included in the debugging output when the
22474 transport is run.
22475 If expansion of the string fails, the error message is written to the debugging
22476 output, and Exim carries on processing.
22477 This facility is provided to help with checking out the values of variables and
22478 so on when debugging driver configurations. For example, if a &%headers_add%&
22479 option is not working properly, &%debug_print%& could be used to output the
22480 variables it references. A newline is added to the text if it does not end with
22481 one.
22482 The variables &$transport_name$& and &$router_name$& contain the name of the
22483 transport and the router that called it.
22484
22485 .option delivery_date_add transports boolean false
22486 .cindex "&'Delivery-date:'& header line"
22487 If this option is true, a &'Delivery-date:'& header is added to the message.
22488 This gives the actual time the delivery was made. As this is not a standard
22489 header, Exim has a configuration option (&%delivery_date_remove%&) which
22490 requests its removal from incoming messages, so that delivered messages can
22491 safely be resent to other recipients.
22492
22493
22494 .option driver transports string unset
22495 This specifies which of the available transport drivers is to be used.
22496 There is no default, and this option must be set for every transport.
22497
22498
22499 .option envelope_to_add transports boolean false
22500 .cindex "&'Envelope-to:'& header line"
22501 If this option is true, an &'Envelope-to:'& header is added to the message.
22502 This gives the original address(es) in the incoming envelope that caused this
22503 delivery to happen. More than one address may be present if the transport is
22504 configured to handle several addresses at once, or if more than one original
22505 address was redirected to the same final address. As this is not a standard
22506 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22507 its removal from incoming messages, so that delivered messages can safely be
22508 resent to other recipients.
22509
22510 &*Note:*& If used on a transport handling multiple recipients
22511 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22512 transport if &%batch_max%& is greater than 1)
22513 then information about Bcc recipients will be leaked.
22514 Doing so is generally not advised.
22515
22516
22517 .option event_action transports string&!! unset
22518 .cindex events
22519 This option declares a string to be expanded for Exim's events mechanism.
22520 For details see chapter &<<CHAPevents>>&.
22521
22522
22523 .option group transports string&!! "Exim group"
22524 .cindex "transport" "group; specifying"
22525 This option specifies a gid for running the transport process, overriding any
22526 value that the router supplies, and also overriding any value associated with
22527 &%user%& (see below).
22528
22529
22530 .option headers_add transports list&!! unset
22531 .cindex "header lines" "adding in transport"
22532 .cindex "transport" "header lines; adding"
22533 This option specifies a list of text headers,
22534 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22535 which are (separately) expanded and added to the header
22536 portion of a message as it is transported, as described in section
22537 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22538 routers. If the result of the expansion is an empty string, or if the expansion
22539 is forced to fail, no action is taken. Other expansion failures are treated as
22540 errors and cause the delivery to be deferred.
22541
22542 Unlike most options, &%headers_add%& can be specified multiple times
22543 for a transport; all listed headers are added.
22544
22545
22546 .option headers_only transports boolean false
22547 .cindex "transport" "header lines only"
22548 .cindex "message" "transporting headers only"
22549 .cindex "header lines" "transporting"
22550 If this option is set, the message's body is not transported. It is mutually
22551 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22552 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22553 checked, since this option does not automatically suppress them.
22554
22555
22556 .option headers_remove transports list&!! unset
22557 .cindex "header lines" "removing"
22558 .cindex "transport" "header lines; removing"
22559 This option specifies a list of text headers,
22560 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22561 to be removed from the message.
22562 However, the option has no effect when an address is just being verified.
22563 Each list item is separately expanded.
22564 If the result of the expansion is an empty string, or if the expansion
22565 is forced to fail, no action is taken. Other expansion failures are treated as
22566 errors and cause the delivery to be deferred.
22567 If an item ends in *, it will match any header with the given prefix.
22568
22569 Matching headers are omitted from the message as it is transported, as described
22570 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22571 routers.
22572
22573 Unlike most options, &%headers_remove%& can be specified multiple times
22574 for a transport; all listed headers are removed.
22575
22576 &*Warning*&: Because of the separate expansion of the list items,
22577 items that contain a list separator must have it doubled.
22578 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22579
22580
22581
22582 .option headers_rewrite transports string unset
22583 .cindex "transport" "header lines; rewriting"
22584 .cindex "rewriting" "at transport time"
22585 This option allows addresses in header lines to be rewritten at transport time,
22586 that is, as the message is being copied to its destination. The contents of the
22587 option are a colon-separated list of rewriting rules. Each rule is in exactly
22588 the same form as one of the general rewriting rules that are applied when a
22589 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22590 example,
22591 .code
22592 headers_rewrite = a@b c@d f : \
22593                   x@y w@z
22594 .endd
22595 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22596 &'w@z'& in all address-bearing header lines. The rules are applied to the
22597 header lines just before they are written out at transport time, so they affect
22598 only those copies of the message that pass through the transport. However, only
22599 the message's original header lines, and any that were added by a system
22600 filter, are rewritten. If a router or transport adds header lines, they are not
22601 affected by this option. These rewriting rules are &'not'& applied to the
22602 envelope. You can change the return path using &%return_path%&, but you cannot
22603 change envelope recipients at this time.
22604
22605
22606 .option home_directory transports string&!! unset
22607 .cindex "transport" "home directory for"
22608 .vindex "&$home$&"
22609 This option specifies a home directory setting for a local transport,
22610 overriding any value that may be set by the router. The home directory is
22611 placed in &$home$& while expanding the transport's private options. It is also
22612 used as the current directory if no current directory is set by the
22613 &%current_directory%& option on the transport or the
22614 &%transport_current_directory%& option on the router. If the expansion fails
22615 for any reason, including forced failure, an error is logged, and delivery is
22616 deferred.
22617
22618
22619 .option initgroups transports boolean false
22620 .cindex "additional groups"
22621 .cindex "groups" "additional"
22622 .cindex "transport" "group; additional"
22623 If this option is true and the uid for the delivery process is provided by the
22624 transport, the &[initgroups()]& function is called when running the transport
22625 to ensure that any additional groups associated with the uid are set up.
22626
22627
22628 .option max_parallel transports integer&!! unset
22629 .cindex limit "transport parallelism"
22630 .cindex transport "parallel processes"
22631 .cindex transport "concurrency limit"
22632 .cindex "delivery" "parallelism for transport"
22633 If this option is set and expands to an integer greater than zero
22634 it limits the number of concurrent runs of the transport.
22635 The control does not apply to shadow transports.
22636
22637 .cindex "hints database" "transport concurrency control"
22638 Exim implements this control by means of a hints database in which a record is
22639 incremented whenever a transport process is being created. The record
22640 is decremented and possibly removed when the process terminates.
22641 Obviously there is scope for
22642 records to get left lying around if there is a system or program crash. To
22643 guard against this, Exim ignores any records that are more than six hours old.
22644
22645 If you use this option, you should also arrange to delete the
22646 relevant hints database whenever your system reboots. The names of the files
22647 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22648 may be one or two files, depending on the type of DBM in use. The same files
22649 are used for ETRN and smtp transport serialization.
22650
22651
22652 .option message_size_limit transports string&!! 0
22653 .cindex "limit" "message size per transport"
22654 .cindex "size" "of message, limit"
22655 .cindex "transport" "message size; limiting"
22656 This option controls the size of messages passed through the transport. It is
22657 expanded before use; the result of the expansion must be a sequence of decimal
22658 digits, optionally followed by K or M. If the expansion fails for any reason,
22659 including forced failure, or if the result is not of the required form,
22660 delivery is deferred. If the value is greater than zero and the size of a
22661 message exceeds this limit, the address is failed. If there is any chance that
22662 the resulting bounce message could be routed to the same transport, you should
22663 ensure that &%return_size_limit%& is less than the transport's
22664 &%message_size_limit%&, as otherwise the bounce message will fail to get
22665 delivered.
22666
22667
22668
22669 .option rcpt_include_affixes transports boolean false
22670 .cindex "prefix" "for local part, including in envelope"
22671 .cindex "suffix for local part" "including in envelope"
22672 .cindex "local part" "prefix"
22673 .cindex "local part" "suffix"
22674 When this option is false (the default), and an address that has had any
22675 affixes (prefixes or suffixes) removed from the local part is delivered by any
22676 form of SMTP or LMTP, the affixes are not included. For example, if a router
22677 that contains
22678 .code
22679 local_part_prefix = *-
22680 .endd
22681 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22682 is delivered with
22683 .code
22684 RCPT TO:<xyz@some.domain>
22685 .endd
22686 This is also the case when an ACL-time callout is being used to verify a
22687 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22688 whole local part is included in the RCPT command. This option applies to BSMTP
22689 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22690 &(lmtp)& and &(smtp)& transports.
22691
22692
22693 .option retry_use_local_part transports boolean "see below"
22694 .cindex "hints database" "retry keys"
22695 When a delivery suffers a temporary failure, a retry record is created
22696 in Exim's hints database. For remote deliveries, the key for the retry record
22697 is based on the name and/or IP address of the failing remote host. For local
22698 deliveries, the key is normally the entire address, including both the local
22699 part and the domain. This is suitable for most common cases of local delivery
22700 temporary failure &-- for example, exceeding a mailbox quota should delay only
22701 deliveries to that mailbox, not to the whole domain.
22702
22703 However, in some special cases you may want to treat a temporary local delivery
22704 as a failure associated with the domain, and not with a particular local part.
22705 (For example, if you are storing all mail for some domain in files.) You can do
22706 this by setting &%retry_use_local_part%& false.
22707
22708 For all the local transports, its default value is true. For remote transports,
22709 the default value is false for tidiness, but changing the value has no effect
22710 on a remote transport in the current implementation.
22711
22712
22713 .option return_path transports string&!! unset
22714 .cindex "envelope sender"
22715 .cindex "envelope from"
22716 .cindex "transport" "return path; changing"
22717 .cindex "return path" "changing in transport"
22718 If this option is set, the string is expanded at transport time and replaces
22719 the existing return path (envelope sender) value in the copy of the message
22720 that is being delivered. An empty return path is permitted. This feature is
22721 designed for remote deliveries, where the value of this option is used in the
22722 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22723 only effect is to change the address that is placed in the &'Return-path:'&
22724 header line, if one is added to the message (see the next option).
22725
22726 &*Note:*& A changed return path is not logged unless you add
22727 &%return_path_on_delivery%& to the log selector.
22728
22729 .vindex "&$return_path$&"
22730 The expansion can refer to the existing value via &$return_path$&. This is
22731 either the message's envelope sender, or an address set by the
22732 &%errors_to%& option on a router. If the expansion is forced to fail, no
22733 replacement occurs; if it fails for another reason, delivery is deferred. This
22734 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22735 section &<<SECTverp>>&.
22736
22737 &*Note*&: If a delivery error is detected locally, including the case when a
22738 remote server rejects a message at SMTP time, the bounce message is not sent to
22739 the value of this option. It is sent to the previously set errors address.
22740 This defaults to the incoming sender address, but can be changed by setting
22741 &%errors_to%& in a router.
22742
22743
22744
22745 .option return_path_add transports boolean false
22746 .chindex Return-path:
22747 If this option is true, a &'Return-path:'& header is added to the message.
22748 Although the return path is normally available in the prefix line of BSD
22749 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22750 have easy access to it.
22751
22752 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22753 the delivery SMTP server makes the final delivery"&. This implies that this
22754 header should not be present in incoming messages. Exim has a configuration
22755 option, &%return_path_remove%&, which requests removal of this header from
22756 incoming messages, so that delivered messages can safely be resent to other
22757 recipients.
22758
22759
22760 .option shadow_condition transports string&!! unset
22761 See &%shadow_transport%& below.
22762
22763
22764 .option shadow_transport transports string unset
22765 .cindex "shadow transport"
22766 .cindex "transport" "shadow"
22767 A local transport may set the &%shadow_transport%& option to the name of
22768 another local transport. Shadow remote transports are not supported.
22769
22770 Whenever a delivery to the main transport succeeds, and either
22771 &%shadow_condition%& is unset, or its expansion does not result in the empty
22772 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22773 passed to the shadow transport, with the same delivery address or addresses. If
22774 expansion fails, no action is taken except that non-forced expansion failures
22775 cause a log line to be written.
22776
22777 The result of the shadow transport is discarded and does not affect the
22778 subsequent processing of the message. Only a single level of shadowing is
22779 provided; the &%shadow_transport%& option is ignored on any transport when it
22780 is running as a shadow. Options concerned with output from pipes are also
22781 ignored. The log line for the successful delivery has an item added on the end,
22782 of the form
22783 .code
22784 ST=<shadow transport name>
22785 .endd
22786 If the shadow transport did not succeed, the error message is put in
22787 parentheses afterwards. Shadow transports can be used for a number of different
22788 purposes, including keeping more detailed log information than Exim normally
22789 provides, and implementing automatic acknowledgment policies based on message
22790 headers that some sites insist on.
22791
22792
22793 .option transport_filter transports string&!! unset
22794 .cindex "transport" "filter"
22795 .cindex "filter" "transport filter"
22796 This option sets up a filtering (in the Unix shell sense) process for messages
22797 at transport time. It should not be confused with mail filtering as set up by
22798 individual users or via a system filter.
22799 If unset, or expanding to an empty string, no filtering is done.
22800
22801 When the message is about to be written out, the command specified by
22802 &%transport_filter%& is started up in a separate, parallel process, and
22803 the entire message, including the header lines, is passed to it on its standard
22804 input (this in fact is done from a third process, to avoid deadlock). The
22805 command must be specified as an absolute path.
22806
22807 The lines of the message that are written to the transport filter are
22808 terminated by newline (&"\n"&). The message is passed to the filter before any
22809 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22810 lines beginning with a dot, and also before any processing implied by the
22811 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22812 &(pipe)& transports.
22813
22814 The standard error for the filter process is set to the same destination as its
22815 standard output; this is read and written to the message's ultimate
22816 destination. The process that writes the message to the filter, the
22817 filter itself, and the original process that reads the result and delivers it
22818 are all run in parallel, like a shell pipeline.
22819
22820 The filter can perform any transformations it likes, but of course should take
22821 care not to break RFC 2822 syntax. Exim does not check the result, except to
22822 test for a final newline when SMTP is in use. All messages transmitted over
22823 SMTP must end with a newline, so Exim supplies one if it is missing.
22824
22825 .cindex "content scanning" "per user"
22826 A transport filter can be used to provide content-scanning on a per-user basis
22827 at delivery time if the only required effect of the scan is to modify the
22828 message. For example, a content scan could insert a new header line containing
22829 a spam score. This could be interpreted by a filter in the user's MUA. It is
22830 not possible to discard a message at this stage.
22831
22832 .cindex "SIZE" "ESMTP extension"
22833 A problem might arise if the filter increases the size of a message that is
22834 being sent down an SMTP connection. If the receiving SMTP server has indicated
22835 support for the SIZE parameter, Exim will have sent the size of the message
22836 at the start of the SMTP session. If what is actually sent is substantially
22837 more, the server might reject the message. This can be worked round by setting
22838 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22839 additions to the message, or to disable the use of SIZE altogether.
22840
22841 .vindex "&$pipe_addresses$&"
22842 The value of the &%transport_filter%& option is the command string for starting
22843 the filter, which is run directly from Exim, not under a shell. The string is
22844 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22845 Exim breaks it up into arguments and then expands each argument separately (see
22846 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22847 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22848 of arguments, one for each address that applies to this delivery. (This isn't
22849 an ideal name for this feature here, but as it was already implemented for the
22850 &(pipe)& transport, it seemed sensible not to change it.)
22851
22852 .vindex "&$host$&"
22853 .vindex "&$host_address$&"
22854 The expansion variables &$host$& and &$host_address$& are available when the
22855 transport is a remote one. They contain the name and IP address of the host to
22856 which the message is being sent. For example:
22857 . used to have $sender_address in this cmdline, but it's tainted
22858 .code
22859 transport_filter = /some/directory/transport-filter.pl \
22860   $host $host_address $pipe_addresses
22861 .endd
22862
22863 Two problems arise if you want to use more complicated expansion items to
22864 generate transport filter commands, both of which due to the fact that the
22865 command is split up &'before'& expansion.
22866 .ilist
22867 If an expansion item contains white space, you must quote it, so that it is all
22868 part of the same command item. If the entire option setting is one such
22869 expansion item, you have to take care what kind of quoting you use. For
22870 example:
22871 .code
22872 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22873 .endd
22874 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22875 &(/bin/cmd2)& otherwise.
22876
22877 Option strings in general have any fully-surrounding double quote wrapping
22878 removed early in parsing (see &<<SECTstrings>>&).
22879 Then, for this option, quotes protect against whitespace being
22880 regarded as a separator while splitting into the command argument vector.
22881 Either double or single quotes can be used here;
22882 the former interprets backlash-quoted charachters
22883 and the latter does not.
22884
22885 If double quotes had been used in this example, they would have been
22886 stripped by Exim when it read the option's value. When the value is used, if
22887 the single quotes were missing, the line would be split into two items,
22888 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22889 Exim tried to expand the first one.
22890 .next
22891 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22892 expansion cannot generate multiple arguments, or a command name followed by
22893 arguments. Consider this example:
22894 .code
22895 transport_filter = ${lookup{$host}lsearch{/a/file}\
22896                     {$value}{/bin/cat}}
22897 .endd
22898 The result of the lookup is interpreted as the name of the command, even
22899 if it contains white space. The simplest way round this is to use a shell:
22900 .code
22901 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22902                                {$value}{/bin/cat}}
22903 .endd
22904 .endlist
22905
22906 The filter process is run under the same uid and gid as the normal delivery.
22907 For remote deliveries this is the Exim uid/gid by default. The command should
22908 normally yield a zero return code. Transport filters are not supposed to fail.
22909 A non-zero code is taken to mean that the transport filter encountered some
22910 serious problem. Delivery of the message is deferred; the message remains on
22911 the queue and is tried again later. It is not possible to cause a message to be
22912 bounced from a transport filter.
22913
22914 If a transport filter is set on an autoreply transport, the original message is
22915 passed through the filter as it is being copied into the newly generated
22916 message, which happens if the &%return_message%& option is set.
22917
22918
22919 .option transport_filter_timeout transports time 5m
22920 .cindex "transport" "filter, timeout"
22921 When Exim is reading the output of a transport filter, it applies a timeout
22922 that can be set by this option. Exceeding the timeout is normally treated as a
22923 temporary delivery failure. However, if a transport filter is used with a
22924 &(pipe)& transport, a timeout in the transport filter is treated in the same
22925 way as a timeout in the pipe command itself. By default, a timeout is a hard
22926 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22927 becomes a temporary error.
22928
22929
22930 .option user transports string&!! "Exim user"
22931 .cindex "uid (user id)" "local delivery"
22932 .cindex "transport" "user, specifying"
22933 This option specifies the user under whose uid the delivery process is to be
22934 run, overriding any uid that may have been set by the router. If the user is
22935 given as a name, the uid is looked up from the password data, and the
22936 associated group is taken as the value of the gid to be used if the &%group%&
22937 option is not set.
22938
22939 For deliveries that use local transports, a user and group are normally
22940 specified explicitly or implicitly (for example, as a result of
22941 &%check_local_user%&) by the router or transport.
22942
22943 .cindex "hints database" "access by remote transport"
22944 For remote transports, you should leave this option unset unless you really are
22945 sure you know what you are doing. When a remote transport is running, it needs
22946 to be able to access Exim's hints databases, because each host may have its own
22947 retry data.
22948 .ecindex IIDgenoptra1
22949 .ecindex IIDgenoptra2
22950 .ecindex IIDgenoptra3
22951
22952
22953
22954
22955
22956
22957 . ////////////////////////////////////////////////////////////////////////////
22958 . ////////////////////////////////////////////////////////////////////////////
22959
22960 .chapter "Address batching in local transports" "CHAPbatching" &&&
22961          "Address batching"
22962 .cindex "transport" "local; address batching in"
22963 The only remote transport (&(smtp)&) is normally configured to handle more than
22964 one address at a time, so that when several addresses are routed to the same
22965 remote host, just one copy of the message is sent. Local transports, however,
22966 normally handle one address at a time. That is, a separate instance of the
22967 transport is run for each address that is routed to the transport. A separate
22968 copy of the message is delivered each time.
22969
22970 .cindex "batched local delivery"
22971 .oindex "&%batch_max%&"
22972 .oindex "&%batch_id%&"
22973 In special cases, it may be desirable to handle several addresses at once in a
22974 local transport, for example:
22975
22976 .ilist
22977 In an &(appendfile)& transport, when storing messages in files for later
22978 delivery by some other means, a single copy of the message with multiple
22979 recipients saves space.
22980 .next
22981 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22982 a single copy saves time, and is the normal way LMTP is expected to work.
22983 .next
22984 In a &(pipe)& transport, when passing the message
22985 to a scanner program or
22986 to some other delivery mechanism such as UUCP, multiple recipients may be
22987 acceptable.
22988 .endlist
22989
22990 These three local transports all have the same options for controlling multiple
22991 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22992 repeating the information for each transport, these options are described here.
22993
22994 The &%batch_max%& option specifies the maximum number of addresses that can be
22995 delivered together in a single run of the transport. Its default value is one
22996 (no batching). When more than one address is routed to a transport that has a
22997 &%batch_max%& value greater than one, the addresses are delivered in a batch
22998 (that is, in a single run of the transport with multiple recipients), subject
22999 to certain conditions:
23000
23001 .ilist
23002 .vindex "&$local_part$&"
23003 If any of the transport's options contain a reference to &$local_part$&, no
23004 batching is possible.
23005 .next
23006 .vindex "&$domain$&"
23007 If any of the transport's options contain a reference to &$domain$&, only
23008 addresses with the same domain are batched.
23009 .next
23010 .cindex "customizing" "batching condition"
23011 If &%batch_id%& is set, it is expanded for each address, and only those
23012 addresses with the same expanded value are batched. This allows you to specify
23013 customized batching conditions. Failure of the expansion for any reason,
23014 including forced failure, disables batching, but it does not stop the delivery
23015 from taking place.
23016 .next
23017 Batched addresses must also have the same errors address (where to send
23018 delivery errors), the same header additions and removals, the same user and
23019 group for the transport, and if a host list is present, the first host must
23020 be the same.
23021 .endlist
23022
23023 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23024 both when the file or pipe command is specified in the transport, and when it
23025 is specified by a &(redirect)& router, but all the batched addresses must of
23026 course be routed to the same file or pipe command. These two transports have an
23027 option called &%use_bsmtp%&, which causes them to deliver the message in
23028 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23029 &%check_string%& and &%escape_string%& options are forced to the values
23030 .code
23031 check_string = "."
23032 escape_string = ".."
23033 .endd
23034 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23035 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23036 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23037
23038 .cindex "&'Envelope-to:'& header line"
23039 If the generic &%envelope_to_add%& option is set for a batching transport, the
23040 &'Envelope-to:'& header that is added to the message contains all the addresses
23041 that are being processed together. If you are using a batching &(appendfile)&
23042 transport without &%use_bsmtp%&, the only way to preserve the recipient
23043 addresses is to set the &%envelope_to_add%& option.
23044
23045 .cindex "&(pipe)& transport" "with multiple addresses"
23046 .vindex "&$pipe_addresses$&"
23047 If you are using a &(pipe)& transport without BSMTP, and setting the
23048 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23049 the command. This is not a true variable; it is a bit of magic that causes each
23050 of the recipient addresses to be inserted into the command as a separate
23051 argument. This provides a way of accessing all the addresses that are being
23052 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23053 are specified by a &(redirect)& router.
23054
23055
23056
23057
23058 . ////////////////////////////////////////////////////////////////////////////
23059 . ////////////////////////////////////////////////////////////////////////////
23060
23061 .chapter "The appendfile transport" "CHAPappendfile"
23062 .scindex IIDapptra1 "&(appendfile)& transport"
23063 .scindex IIDapptra2 "transports" "&(appendfile)&"
23064 .cindex "directory creation"
23065 .cindex "creating directories"
23066 The &(appendfile)& transport delivers a message by appending it to an existing
23067 file, or by creating an entirely new file in a specified directory. Single
23068 files to which messages are appended can be in the traditional Unix mailbox
23069 format, or optionally in the MBX format supported by the Pine MUA and
23070 University of Washington IMAP daemon, &'inter alia'&. When each message is
23071 being delivered as a separate file, &"maildir"& format can optionally be used
23072 to give added protection against failures that happen part-way through the
23073 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23074 supported. For all file formats, Exim attempts to create as many levels of
23075 directory as necessary, provided that &%create_directory%& is set.
23076
23077 The code for the optional formats is not included in the Exim binary by
23078 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23079 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23080 included.
23081
23082 .cindex "quota" "system"
23083 Exim recognizes system quota errors, and generates an appropriate message. Exim
23084 also supports its own quota control within the transport, for use when the
23085 system facility is unavailable or cannot be used for some reason.
23086
23087 If there is an error while appending to a file (for example, quota exceeded or
23088 partition filled), Exim attempts to reset the file's length and last
23089 modification time back to what they were before. If there is an error while
23090 creating an entirely new file, the new file is removed.
23091
23092 Before appending to a file, a number of security checks are made, and the
23093 file is locked. A detailed description is given below, after the list of
23094 private options.
23095
23096 The &(appendfile)& transport is most commonly used for local deliveries to
23097 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23098 putting messages into files for remote delivery by some means other than Exim.
23099 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23100 option).
23101
23102
23103
23104 .section "The file and directory options" "SECTfildiropt"
23105 The &%file%& option specifies a single file, to which the message is appended;
23106 the &%directory%& option specifies a directory, in which a new file containing
23107 the message is created. Only one of these two options can be set, and for
23108 normal deliveries to mailboxes, one of them &'must'& be set.
23109
23110 .vindex "&$address_file$&"
23111 .vindex "&$local_part$&"
23112 However, &(appendfile)& is also used for delivering messages to files or
23113 directories whose names (or parts of names) are obtained from alias,
23114 forwarding, or filtering operations (for example, a &%save%& command in a
23115 user's Exim filter). When such a transport is running, &$local_part$& contains
23116 the local part that was aliased or forwarded, and &$address_file$& contains the
23117 name (or partial name) of the file or directory generated by the redirection
23118 operation. There are two cases:
23119
23120 .ilist
23121 If neither &%file%& nor &%directory%& is set, the redirection operation
23122 must specify an absolute path (one that begins with &`/`&). This is the most
23123 common case when users with local accounts use filtering to sort mail into
23124 different folders. See for example, the &(address_file)& transport in the
23125 default configuration. If the path ends with a slash, it is assumed to be the
23126 name of a directory. A delivery to a directory can also be forced by setting
23127 &%maildir_format%& or &%mailstore_format%&.
23128 .next
23129 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23130 used to determine the file or directory name for the delivery. Normally, the
23131 contents of &$address_file$& are used in some way in the string expansion.
23132 .endlist
23133 If the &%create_file%& option is set to a path which
23134 matches (see the option definition below for details)
23135 a file or directory name
23136 for the delivery, that name becomes de-tainted.
23137
23138 .cindex "tainted data" "in filenames"
23139 .cindex appendfile "tainted data"
23140 Tainted data may not be used for a file or directory name.
23141 This means that, for instance, &$local_part$& cannot be used directly
23142 as a component of a path.  It can however be used as the key for a lookup
23143 which returns a path (or component).
23144
23145
23146 .cindex "Sieve filter" "configuring &(appendfile)&"
23147 .cindex "Sieve filter" "relative mailbox path handling"
23148 As an example of the second case, consider an environment where users do not
23149 have home directories. They may be permitted to use Exim filter commands of the
23150 form:
23151 .code
23152 save folder23
23153 .endd
23154 or Sieve filter commands of the form:
23155 .code
23156 require "fileinto";
23157 fileinto "folder23";
23158 .endd
23159 In this situation, the expansion of &%file%& or &%directory%& in the transport
23160 must transform the relative path into an appropriate absolute filename. In the
23161 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23162 is used as a result of a &"keep"& action in the filter. This example shows one
23163 way of handling this requirement:
23164 .code
23165 file = ${if eq{$address_file}{inbox} \
23166             {/var/mail/$local_part_data} \
23167             {${if eq{${substr_0_1:$address_file}}{/} \
23168                   {$address_file} \
23169                   {$home/mail/$address_file} \
23170             }} \
23171        }
23172 .endd
23173 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23174 location, absolute paths are used without change, and other folders are in the
23175 &_mail_& directory within the home directory.
23176
23177 &*Note 1*&: While processing an Exim filter, a relative path such as
23178 &_folder23_& is turned into an absolute path if a home directory is known to
23179 the router. In particular, this is the case if &%check_local_user%& is set. If
23180 you want to prevent this happening at routing time, you can set
23181 &%router_home_directory%& empty. This forces the router to pass the relative
23182 path to the transport.
23183
23184 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23185 the &%file%& or &%directory%& option is still used if it is set.
23186
23187
23188
23189
23190 .section "Private options for appendfile" "SECID134"
23191 .cindex "options" "&(appendfile)& transport"
23192
23193
23194
23195 .option allow_fifo appendfile boolean false
23196 .cindex "fifo (named pipe)"
23197 .cindex "named pipe (fifo)"
23198 .cindex "pipe" "named (fifo)"
23199 Setting this option permits delivery to named pipes (FIFOs) as well as to
23200 regular files. If no process is reading the named pipe at delivery time, the
23201 delivery is deferred.
23202
23203
23204 .option allow_symlink appendfile boolean false
23205 .cindex "symbolic link" "to mailbox"
23206 .cindex "mailbox" "symbolic link"
23207 By default, &(appendfile)& will not deliver if the path name for the file is
23208 that of a symbolic link. Setting this option relaxes that constraint, but there
23209 are security issues involved in the use of symbolic links. Be sure you know
23210 what you are doing if you set this. Details of exactly what this option affects
23211 are included in the discussion which follows this list of options.
23212
23213
23214 .option batch_id appendfile string&!! unset
23215 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23216 However, batching is automatically disabled for &(appendfile)& deliveries that
23217 happen as a result of forwarding or aliasing or other redirection directly to a
23218 file.
23219
23220
23221 .option batch_max appendfile integer 1
23222 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23223
23224
23225 .option check_group appendfile boolean false
23226 When this option is set, the group owner of the file defined by the &%file%&
23227 option is checked to see that it is the same as the group under which the
23228 delivery process is running. The default setting is false because the default
23229 file mode is 0600, which means that the group is irrelevant.
23230
23231
23232 .option check_owner appendfile boolean true
23233 When this option is set, the owner of the file defined by the &%file%& option
23234 is checked to ensure that it is the same as the user under which the delivery
23235 process is running.
23236
23237
23238 .option check_string appendfile string "see below"
23239 .cindex "&""From""& line"
23240 As &(appendfile)& writes the message, the start of each line is tested for
23241 matching &%check_string%&, and if it does, the initial matching characters are
23242 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23243 a literal string, not a regular expression, and the case of any letters it
23244 contains is significant.
23245
23246 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23247 are forced to &"."& and &".."& respectively, and any settings in the
23248 configuration are ignored. Otherwise, they default to &"From&~"& and
23249 &">From&~"& when the &%file%& option is set, and unset when any of the
23250 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23251
23252 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23253 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23254 &"From&~"& indicates the start of a new message. All four options need changing
23255 if another format is used. For example, to deliver to mailboxes in MMDF format:
23256 .cindex "MMDF format mailbox"
23257 .cindex "mailbox" "MMDF format"
23258 .code
23259 check_string = "\1\1\1\1\n"
23260 escape_string = "\1\1\1\1 \n"
23261 message_prefix = "\1\1\1\1\n"
23262 message_suffix = "\1\1\1\1\n"
23263 .endd
23264 .option create_directory appendfile boolean true
23265 .cindex "directory creation"
23266 When this option is true, Exim attempts to create any missing superior
23267 directories for the file that it is about to write. A created directory's mode
23268 is given by the &%directory_mode%& option.
23269
23270 The group ownership of a newly created directory is highly dependent on the
23271 operating system (and possibly the file system) that is being used. For
23272 example, in Solaris, if the parent directory has the setgid bit set, its group
23273 is propagated to the child; if not, the currently set group is used. However,
23274 in FreeBSD, the parent's group is always used.
23275
23276
23277
23278 .option create_file appendfile string anywhere
23279 This option constrains the location of files and directories that are created
23280 by this transport. It applies to files defined by the &%file%& option and
23281 directories defined by the &%directory%& option. In the case of maildir
23282 delivery, it applies to the top level directory, not the maildir directories
23283 beneath.
23284
23285 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23286 &"belowhome"&, or to an absolute path.
23287
23288 In the second and third cases, a home directory must have been
23289 set for the transport, and the file or directory being created must
23290 reside within it.
23291 The "belowhome" checking additionally checks for attempts to use "../"
23292 to evade the testing.
23293 This option is not useful when an explicit filename is
23294 given for normal mailbox deliveries. It is intended for the case when filenames
23295 are generated from users' &_.forward_& files. These are usually handled
23296 by an &(appendfile)& transport called &%address_file%&. See also
23297 &%file_must_exist%&.
23298
23299 In the fourth case,
23300 the value given for this option must be an absolute path for an
23301 existing directory.
23302 The value is used for checking instead of a home directory;
23303 checking is done in "belowhome" mode.
23304
23305 .cindex "tainted data" "de-tainting"
23306 .cindex "de-tainting" "using appendfile create_file option"
23307 If "belowhome" checking is used, the file or directory path
23308 becomes de-tainted.
23309
23310
23311 .option directory appendfile string&!! unset
23312 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23313 or &%directory%& must be set, unless the delivery is the direct result of a
23314 redirection (see section &<<SECTfildiropt>>&).
23315
23316 When &%directory%& is set, the string is expanded, and the message is delivered
23317 into a new file or files in or below the given directory, instead of being
23318 appended to a single mailbox file. A number of different formats are provided
23319 (see &%maildir_format%& and &%mailstore_format%&), and see section
23320 &<<SECTopdir>>& for further details of this form of delivery.
23321
23322 The result of expansion must not be tainted, unless the &%create_file%& option
23323 specifies a path.
23324
23325
23326 .option directory_file appendfile string&!! "see below"
23327 .cindex "base62"
23328 .vindex "&$inode$&"
23329 When &%directory%& is set, but neither &%maildir_format%& nor
23330 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23331 whose name is obtained by expanding this string. The default value is:
23332 .code
23333 q${base62:$tod_epoch}-$inode
23334 .endd
23335 This generates a unique name from the current time, in base 62 form, and the
23336 inode of the file. The variable &$inode$& is available only when expanding this
23337 option.
23338
23339
23340 .option directory_mode appendfile "octal integer" 0700
23341 If &(appendfile)& creates any directories as a result of the
23342 &%create_directory%& option, their mode is specified by this option.
23343
23344
23345 .option escape_string appendfile string "see description"
23346 See &%check_string%& above.
23347
23348
23349 .option file appendfile string&!! unset
23350 This option is mutually exclusive with the &%directory%& option, but one of
23351 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23352 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23353 specifies a single file, to which the message is appended. One or more of
23354 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23355 &%file%&.
23356
23357 The result of expansion must not be tainted, unless the &%create_file%& option
23358 specifies a path.
23359
23360 .cindex "NFS" "lock file"
23361 .cindex "locking files"
23362 .cindex "lock files"
23363 If you are using more than one host to deliver over NFS into the same
23364 mailboxes, you should always use lock files.
23365
23366 The string value is expanded for each delivery, and must yield an absolute
23367 path. The most common settings of this option are variations on one of these
23368 examples:
23369 .code
23370 file = /var/spool/mail/$local_part_data
23371 file = /home/$local_part_data/inbox
23372 file = $home/inbox
23373 .endd
23374 .cindex "&""sticky""& bit"
23375 In the first example, all deliveries are done into the same directory. If Exim
23376 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23377 create a file in the directory, so the &"sticky"& bit must be turned on for
23378 deliveries to be possible, or alternatively the &%group%& option can be used to
23379 run the delivery under a group id which has write access to the directory.
23380
23381
23382
23383 .option file_format appendfile string unset
23384 .cindex "file" "mailbox; checking existing format"
23385 This option requests the transport to check the format of an existing file
23386 before adding to it. The check consists of matching a specific string at the
23387 start of the file. The value of the option consists of an even number of
23388 colon-separated strings. The first of each pair is the test string, and the
23389 second is the name of a transport. If the transport associated with a matched
23390 string is not the current transport, control is passed over to the other
23391 transport. For example, suppose the standard &(local_delivery)& transport has
23392 this added to it:
23393 .code
23394 file_format = "From       : local_delivery :\
23395                \1\1\1\1\n : local_mmdf_delivery"
23396 .endd
23397 Mailboxes that begin with &"From"& are still handled by this transport, but if
23398 a mailbox begins with four binary ones followed by a newline, control is passed
23399 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23400 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23401 is assumed to match the current transport. If the start of a mailbox doesn't
23402 match any string, or if the transport named for a given string is not defined,
23403 delivery is deferred.
23404
23405
23406 .option file_must_exist appendfile boolean false
23407 If this option is true, the file specified by the &%file%& option must exist.
23408 A temporary error occurs if it does not, causing delivery to be deferred.
23409 If this option is false, the file is created if it does not exist.
23410
23411
23412 .option lock_fcntl_timeout appendfile time 0s
23413 .cindex "timeout" "mailbox locking"
23414 .cindex "mailbox" "locking, blocking and non-blocking"
23415 .cindex "locking files"
23416 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23417 when locking an open mailbox file. If the call fails, the delivery process
23418 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23419 Non-blocking calls are used so that the file is not kept open during the wait
23420 for the lock; the reason for this is to make it as safe as possible for
23421 deliveries over NFS in the case when processes might be accessing an NFS
23422 mailbox without using a lock file. This should not be done, but
23423 misunderstandings and hence misconfigurations are not unknown.
23424
23425 On a busy system, however, the performance of a non-blocking lock approach is
23426 not as good as using a blocking lock with a timeout. In this case, the waiting
23427 is done inside the system call, and Exim's delivery process acquires the lock
23428 and can proceed as soon as the previous lock holder releases it.
23429
23430 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23431 timeout, are used. There may still be some retrying: the maximum number of
23432 retries is
23433 .code
23434 (lock_retries * lock_interval) / lock_fcntl_timeout
23435 .endd
23436 rounded up to the next whole number. In other words, the total time during
23437 which &(appendfile)& is trying to get a lock is roughly the same, unless
23438 &%lock_fcntl_timeout%& is set very large.
23439
23440 You should consider setting this option if you are getting a lot of delayed
23441 local deliveries because of errors of the form
23442 .code
23443 failed to lock mailbox /some/file (fcntl)
23444 .endd
23445
23446 .option lock_flock_timeout appendfile time 0s
23447 This timeout applies to file locking when using &[flock()]& (see
23448 &%use_flock%&); the timeout operates in a similar manner to
23449 &%lock_fcntl_timeout%&.
23450
23451
23452 .option lock_interval appendfile time 3s
23453 This specifies the time to wait between attempts to lock the file. See below
23454 for details of locking.
23455
23456
23457 .option lock_retries appendfile integer 10
23458 This specifies the maximum number of attempts to lock the file. A value of zero
23459 is treated as 1. See below for details of locking.
23460
23461
23462 .option lockfile_mode appendfile "octal integer" 0600
23463 This specifies the mode of the created lock file, when a lock file is being
23464 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23465
23466
23467 .option lockfile_timeout appendfile time 30m
23468 .cindex "timeout" "mailbox locking"
23469 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23470 exists and is older than this value, it is assumed to have been left behind by
23471 accident, and Exim attempts to remove it.
23472
23473
23474 .option mailbox_filecount appendfile string&!! unset
23475 .cindex "mailbox" "specifying size of"
23476 .cindex "size" "of mailbox"
23477 If this option is set, it is expanded, and the result is taken as the current
23478 number of files in the mailbox. It must be a decimal number, optionally
23479 followed by K or M. This provides a way of obtaining this information from an
23480 external source that maintains the data.
23481
23482
23483 .option mailbox_size appendfile string&!! unset
23484 .cindex "mailbox" "specifying size of"
23485 .cindex "size" "of mailbox"
23486 If this option is set, it is expanded, and the result is taken as the current
23487 size the mailbox. It must be a decimal number, optionally followed by K or M.
23488 This provides a way of obtaining this information from an external source that
23489 maintains the data. This is likely to be helpful for maildir deliveries where
23490 it is computationally expensive to compute the size of a mailbox.
23491
23492
23493
23494 .option maildir_format appendfile boolean false
23495 .cindex "maildir format" "specifying"
23496 If this option is set with the &%directory%& option, the delivery is into a new
23497 file, in the &"maildir"& format that is used by other mail software. When the
23498 transport is activated directly from a &(redirect)& router (for example, the
23499 &(address_file)& transport in the default configuration), setting
23500 &%maildir_format%& causes the path received from the router to be treated as a
23501 directory, whether or not it ends with &`/`&. This option is available only if
23502 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23503 &<<SECTmaildirdelivery>>& below for further details.
23504
23505
23506 .option maildir_quota_directory_regex appendfile string "See below"
23507 .cindex "maildir format" "quota; directories included in"
23508 .cindex "quota" "maildir; directories included in"
23509 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23510 a regular expression for specifying directories, relative to the quota
23511 directory (see &%quota_directory%&), that should be included in the quota
23512 calculation. The default value is:
23513 .code
23514 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23515 .endd
23516 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23517 (directories whose names begin with a dot). If you want to exclude the
23518 &_Trash_&
23519 folder from the count (as some sites do), you need to change this setting to
23520 .code
23521 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23522 .endd
23523 This uses a negative lookahead in the regular expression to exclude the
23524 directory whose name is &_.Trash_&. When a directory is excluded from quota
23525 calculations, quota processing is bypassed for any messages that are delivered
23526 directly into that directory.
23527
23528
23529 .option maildir_retries appendfile integer 10
23530 This option specifies the number of times to retry when writing a file in
23531 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23532
23533
23534 .option maildir_tag appendfile string&!! unset
23535 This option applies only to deliveries in maildir format, and is described in
23536 section &<<SECTmaildirdelivery>>& below.
23537
23538
23539 .option maildir_use_size_file appendfile&!! boolean false
23540 .cindex "maildir format" "&_maildirsize_& file"
23541 The result of string expansion for this option must be a valid boolean value.
23542 If it is true, it enables support for &_maildirsize_& files. Exim
23543 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23544 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23545 value is zero. See &%maildir_quota_directory_regex%& above and section
23546 &<<SECTmaildirdelivery>>& below for further details.
23547
23548 .option maildirfolder_create_regex appendfile string unset
23549 .cindex "maildir format" "&_maildirfolder_& file"
23550 .cindex "&_maildirfolder_&, creating"
23551 The value of this option is a regular expression. If it is unset, it has no
23552 effect. Otherwise, before a maildir delivery takes place, the pattern is
23553 matched against the name of the maildir directory, that is, the directory
23554 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23555 delivery. If there is a match, Exim checks for the existence of a file called
23556 &_maildirfolder_& in the directory, and creates it if it does not exist.
23557 See section &<<SECTmaildirdelivery>>& for more details.
23558
23559
23560 .option mailstore_format appendfile boolean false
23561 .cindex "mailstore format" "specifying"
23562 If this option is set with the &%directory%& option, the delivery is into two
23563 new files in  &"mailstore"& format. The option is available only if
23564 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23565 below for further details.
23566
23567
23568 .option mailstore_prefix 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 mailstore_suffix appendfile string&!! unset
23574 This option applies only to deliveries in mailstore format, and is described in
23575 section &<<SECTopdir>>& below.
23576
23577
23578 .option mbx_format appendfile boolean false
23579 .cindex "locking files"
23580 .cindex "file" "locking"
23581 .cindex "file" "MBX format"
23582 .cindex "MBX format, specifying"
23583 This option is available only if Exim has been compiled with SUPPORT_MBX
23584 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23585 the message is appended to the mailbox file in MBX format instead of
23586 traditional Unix format. This format is supported by Pine4 and its associated
23587 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23588
23589 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23590 automatically changed by the use of &%mbx_format%&. They should normally be set
23591 empty when using MBX format, so this option almost always appears in this
23592 combination:
23593 .code
23594 mbx_format = true
23595 message_prefix =
23596 message_suffix =
23597 .endd
23598 If none of the locking options are mentioned in the configuration,
23599 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23600 is possible to specify the other kinds of locking with &%mbx_format%&, but
23601 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23602 interworks with &'c-client'&, providing for shared access to the mailbox. It
23603 should not be used if any program that does not use this form of locking is
23604 going to access the mailbox, nor should it be used if the mailbox file is NFS
23605 mounted, because it works only when the mailbox is accessed from a single host.
23606
23607 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23608 the standard version of &'c-client'&, because as long as it has a mailbox open
23609 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23610 append messages to it.
23611
23612
23613 .option message_prefix appendfile string&!! "see below"
23614 .cindex "&""From""& line"
23615 The string specified here is expanded and output at the start of every message.
23616 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23617 in which case it is:
23618 .code
23619 message_prefix = "From ${if def:return_path{$return_path}\
23620   {MAILER-DAEMON}} $tod_bsdinbox\n"
23621 .endd
23622 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23623 &`\n`& to &`\r\n`& in &%message_prefix%&.
23624
23625 .option message_suffix appendfile string&!! "see below"
23626 The string specified here is expanded and output at the end of every message.
23627 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23628 in which case it is a single newline character. The suffix can be suppressed by
23629 setting
23630 .code
23631 message_suffix =
23632 .endd
23633 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23634 &`\n`& to &`\r\n`& in &%message_suffix%&.
23635
23636 .option mode appendfile "octal integer" 0600
23637 If the output file is created, it is given this mode. If it already exists and
23638 has wider permissions, they are reduced to this mode. If it has narrower
23639 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23640 if the delivery is the result of a &%save%& command in a filter file specifying
23641 a particular mode, the mode of the output file is always forced to take that
23642 value, and this option is ignored.
23643
23644
23645 .option mode_fail_narrower appendfile boolean true
23646 This option applies in the case when an existing mailbox file has a narrower
23647 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23648 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23649 continues with the delivery attempt, using the existing mode of the file.
23650
23651
23652 .option notify_comsat appendfile boolean false
23653 If this option is true, the &'comsat'& daemon is notified after every
23654 successful delivery to a user mailbox. This is the daemon that notifies logged
23655 on users about incoming mail.
23656
23657
23658 .option quota appendfile string&!! unset
23659 .cindex "quota" "imposed by Exim"
23660 This option imposes a limit on the size of the file to which Exim is appending,
23661 or to the total space used in the directory tree when the &%directory%& option
23662 is set. In the latter case, computation of the space used is expensive, because
23663 all the files in the directory (and any sub-directories) have to be
23664 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23665 &%maildir_use_size_file%& for ways to avoid this in environments where users
23666 have no shell access to their mailboxes).
23667
23668 As there is no interlock against two simultaneous deliveries into a
23669 multi-file mailbox, it is possible for the quota to be overrun in this case.
23670 For single-file mailboxes, of course, an interlock is a necessity.
23671
23672 A file's size is taken as its &'used'& value. Because of blocking effects, this
23673 may be a lot less than the actual amount of disk space allocated to the file.
23674 If the sizes of a number of files are being added up, the rounding effect can
23675 become quite noticeable, especially on systems that have large block sizes.
23676 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23677 the obvious value which users understand most easily.
23678
23679 The value of the option is expanded, and must then be a numerical value
23680 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23681 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23682 and further option modifiers. If Exim is running on a system with
23683 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23684 be handled.
23685
23686 The option modifier &%no_check%& can be used to force delivery even if the over
23687 quota condition is met. The quota gets updated as usual.
23688
23689 &*Note*&: A value of zero is interpreted as &"no quota"&.
23690
23691 The expansion happens while Exim is running as root, before it changes uid for
23692 the delivery. This means that files that are inaccessible to the end user can
23693 be used to hold quota values that are looked up in the expansion. When delivery
23694 fails because this quota is exceeded, the handling of the error is as for
23695 system quota failures.
23696
23697 By default, Exim's quota checking mimics system quotas, and restricts the
23698 mailbox to the specified maximum size, though the value is not accurate to the
23699 last byte, owing to separator lines and additional headers that may get added
23700 during message delivery. When a mailbox is nearly full, large messages may get
23701 refused even though small ones are accepted, because the size of the current
23702 message is added to the quota when the check is made. This behaviour can be
23703 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23704 for exceeding the quota does not include the current message. Thus, deliveries
23705 continue until the quota has been exceeded; thereafter, no further messages are
23706 delivered. See also &%quota_warn_threshold%&.
23707
23708
23709 .option quota_directory appendfile string&!! unset
23710 This option defines the directory to check for quota purposes when delivering
23711 into individual files. The default is the delivery directory, or, if a file
23712 called &_maildirfolder_& exists in a maildir directory, the parent of the
23713 delivery directory.
23714
23715
23716 .option quota_filecount appendfile string&!! 0
23717 This option applies when the &%directory%& option is set. It limits the total
23718 number of files in the directory (compare the inode limit in system quotas). It
23719 can only be used if &%quota%& is also set. The value is expanded; an expansion
23720 failure causes delivery to be deferred. A value of zero is interpreted as
23721 &"no quota"&.
23722
23723 The option modifier &%no_check%& can be used to force delivery even if the over
23724 quota condition is met. The quota gets updated as usual.
23725
23726 .option quota_is_inclusive appendfile boolean true
23727 See &%quota%& above.
23728
23729
23730 .option quota_size_regex appendfile string unset
23731 This option applies when one of the delivery modes that writes a separate file
23732 for each message is being used. When Exim wants to find the size of one of
23733 these files in order to test the quota, it first checks &%quota_size_regex%&.
23734 If this is set to a regular expression that matches the filename, and it
23735 captures one string, that string is interpreted as a representation of the
23736 file's size. The value of &%quota_size_regex%& is not expanded.
23737
23738 This feature is useful only when users have no shell access to their mailboxes
23739 &-- otherwise they could defeat the quota simply by renaming the files. This
23740 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23741 the file length to the filename. For example:
23742 .code
23743 maildir_tag = ,S=$message_size
23744 quota_size_regex = ,S=(\d+)
23745 .endd
23746 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23747 number of lines in the message.
23748
23749 The regular expression should not assume that the length is at the end of the
23750 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23751 sometimes add other information onto the ends of message filenames.
23752
23753 Section &<<SECID136>>& contains further information.
23754
23755 This option should not be used when other message-handling software
23756 may duplicate messages by making hardlinks to the files.  When that is done Exim
23757 will count the message size once for each filename, in contrast with the actual
23758 disk usage.  When the option is not set, calculating total usage requires
23759 a system-call per file to get the size; the number of links is then available also
23760 as is used to adjust the effective size.
23761
23762
23763 .option quota_warn_message appendfile string&!! "see below"
23764 See below for the use of this option. If it is not set when
23765 &%quota_warn_threshold%& is set, it defaults to
23766 .code
23767 quota_warn_message = "\
23768   To: $local_part@$domain\n\
23769   Subject: Your mailbox\n\n\
23770   This message is automatically created \
23771   by mail delivery software.\n\n\
23772   The size of your mailbox has exceeded \
23773   a warning threshold that is\n\
23774   set by the system administrator.\n"
23775 .endd
23776
23777
23778 .option quota_warn_threshold appendfile string&!! 0
23779 .cindex "quota" "warning threshold"
23780 .cindex "mailbox" "size warning"
23781 .cindex "size" "of mailbox"
23782 This option is expanded in the same way as &%quota%& (see above). If the
23783 resulting value is greater than zero, and delivery of the message causes the
23784 size of the file or total space in the directory tree to cross the given
23785 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23786 may be specified as a percentage of it by following the value with a percent
23787 sign. For example:
23788 .code
23789 quota = 10M
23790 quota_warn_threshold = 75%
23791 .endd
23792 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23793 percent sign is ignored.
23794
23795 The warning message itself is specified by the &%quota_warn_message%& option,
23796 and it must start with a &'To:'& header line containing the recipient(s) of the
23797 warning message. These do not necessarily have to include the recipient(s) of
23798 the original message. A &'Subject:'& line should also normally be supplied. You
23799 can include any other header lines that you want. If you do not include a
23800 &'From:'& line, the default is:
23801 .code
23802 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23803 .endd
23804 .oindex &%errors_reply_to%&
23805 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23806 option.
23807
23808 The &%quota%& option does not have to be set in order to use this option; they
23809 are independent of one another except when the threshold is specified as a
23810 percentage.
23811
23812
23813 .option use_bsmtp appendfile boolean false
23814 .cindex "envelope from"
23815 .cindex "envelope sender"
23816 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23817 format, with the envelope sender and recipient(s) included as SMTP commands. If
23818 you want to include a leading HELO command with such messages, you can do
23819 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23820 for details of batch SMTP.
23821
23822
23823 .option use_crlf appendfile boolean false
23824 .cindex "carriage return"
23825 .cindex "linefeed"
23826 This option causes lines to be terminated with the two-character CRLF sequence
23827 (carriage return, linefeed) instead of just a linefeed character. In the case
23828 of batched SMTP, the byte sequence written to the file is then an exact image
23829 of what would be sent down a real SMTP connection.
23830
23831 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23832 (which are used to supply the traditional &"From&~"& and blank line separators
23833 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23834 carriage return characters if these are needed. In cases where these options
23835 have non-empty defaults, the values end with a single linefeed, so they must be
23836 changed to end with &`\r\n`& if &%use_crlf%& is set.
23837
23838
23839 .option use_fcntl_lock appendfile boolean "see below"
23840 This option controls the use of the &[fcntl()]& function to lock a file for
23841 exclusive use when a message is being appended. It is set by default unless
23842 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23843 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23844 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23845
23846
23847 .option use_flock_lock appendfile boolean false
23848 This option is provided to support the use of &[flock()]& for file locking, for
23849 the few situations where it is needed. Most modern operating systems support
23850 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23851 each other. Exim uses &[fcntl()]& locking by default.
23852
23853 This option is required only if you are using an operating system where
23854 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23855 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23856 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23857
23858 .cindex "Solaris" "&[flock()]& support"
23859 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23860 have it (and some, I think, provide a not quite right version built on top of
23861 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23862 the ability to use it, and any attempt to do so will cause a configuration
23863 error.
23864
23865 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23866 is just being mapped onto &[fcntl()]& by the OS).
23867
23868
23869 .option use_lockfile appendfile boolean "see below"
23870 If this option is turned off, Exim does not attempt to create a lock file when
23871 appending to a mailbox file. In this situation, the only locking is by
23872 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23873 sure that every MUA that is ever going to look at your users' mailboxes uses
23874 &[fcntl()]& rather than a lock file, and even then only when you are not
23875 delivering over NFS from more than one host.
23876
23877 .cindex "NFS" "lock file"
23878 In order to append to an NFS file safely from more than one host, it is
23879 necessary to take out a lock &'before'& opening the file, and the lock file
23880 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23881 file corruption.
23882
23883 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23884 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23885 except when &%mbx_format%& is set.
23886
23887
23888 .option use_mbx_lock appendfile boolean "see below"
23889 This option is available only if Exim has been compiled with SUPPORT_MBX
23890 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23891 locking rules be used. It is set by default if &%mbx_format%& is set and none
23892 of the locking options are mentioned in the configuration. The locking rules
23893 are the same as are used by the &'c-client'& library that underlies Pine and
23894 the IMAP4 and POP daemons that come with it (see the discussion below). The
23895 rules allow for shared access to the mailbox. However, this kind of locking
23896 does not work when the mailbox is NFS mounted.
23897
23898 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23899 &%use_flock_lock%& to control what kind of locking is used in implementing the
23900 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23901 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23902
23903
23904
23905
23906 .section "Operational details for appending" "SECTopappend"
23907 .cindex "appending to a file"
23908 .cindex "file" "appending"
23909 Before appending to a file, the following preparations are made:
23910
23911 .ilist
23912 If the name of the file is &_/dev/null_&, no action is taken, and a success
23913 return is given.
23914
23915 .next
23916 .cindex "directory creation"
23917 If any directories on the file's path are missing, Exim creates them if the
23918 &%create_directory%& option is set. A created directory's mode is given by the
23919 &%directory_mode%& option.
23920
23921 .next
23922 If &%file_format%& is set, the format of an existing file is checked. If this
23923 indicates that a different transport should be used, control is passed to that
23924 transport.
23925
23926 .next
23927 .cindex "file" "locking"
23928 .cindex "locking files"
23929 .cindex "NFS" "lock file"
23930 If &%use_lockfile%& is set, a lock file is built in a way that will work
23931 reliably over NFS, as follows:
23932
23933 .olist
23934 Create a &"hitching post"& file whose name is that of the lock file with the
23935 current time, primary host name, and process id added, by opening for writing
23936 as a new file. If this fails with an access error, delivery is deferred.
23937 .next
23938 Close the hitching post file, and hard link it to the lock filename.
23939 .next
23940 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23941 Unlink the hitching post name.
23942 .next
23943 Otherwise, use &[stat()]& to get information about the hitching post file, and
23944 then unlink hitching post name. If the number of links is exactly two, creation
23945 of the lock file succeeded but something (for example, an NFS server crash and
23946 restart) caused this fact not to be communicated to the &[link()]& call.
23947 .next
23948 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23949 up to &%lock_retries%& times. However, since any program that writes to a
23950 mailbox should complete its task very quickly, it is reasonable to time out old
23951 lock files that are normally the result of user agent and system crashes. If an
23952 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23953 it before trying again.
23954 .endlist olist
23955
23956 .next
23957 A call is made to &[lstat()]& to discover whether the main file exists, and if
23958 so, what its characteristics are. If &[lstat()]& fails for any reason other
23959 than non-existence, delivery is deferred.
23960
23961 .next
23962 .cindex "symbolic link" "to mailbox"
23963 .cindex "mailbox" "symbolic link"
23964 If the file does exist and is a symbolic link, delivery is deferred, unless the
23965 &%allow_symlink%& option is set, in which case the ownership of the link is
23966 checked, and then &[stat()]& is called to find out about the real file, which
23967 is then subjected to the checks below. The check on the top-level link
23968 ownership prevents one user creating a link for another's mailbox in a sticky
23969 directory, though allowing symbolic links in this case is definitely not a good
23970 idea. If there is a chain of symbolic links, the intermediate ones are not
23971 checked.
23972
23973 .next
23974 If the file already exists but is not a regular file, or if the file's owner
23975 and group (if the group is being checked &-- see &%check_group%& above) are
23976 different from the user and group under which the delivery is running,
23977 delivery is deferred.
23978
23979 .next
23980 If the file's permissions are more generous than specified, they are reduced.
23981 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23982 is set false, in which case the delivery is tried using the existing
23983 permissions.
23984
23985 .next
23986 The file's inode number is saved, and the file is then opened for appending.
23987 If this fails because the file has vanished, &(appendfile)& behaves as if it
23988 hadn't existed (see below). For any other failures, delivery is deferred.
23989
23990 .next
23991 If the file is opened successfully, check that the inode number hasn't
23992 changed, that it is still a regular file, and that the owner and permissions
23993 have not changed. If anything is wrong, defer delivery and freeze the message.
23994
23995 .next
23996 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23997 option is set. Otherwise, check that the file is being created in a permitted
23998 directory if the &%create_file%& option is set (deferring on failure), and then
23999 open for writing as a new file, with the O_EXCL and O_CREAT options,
24000 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24001 set). In this case, which can happen if the link points to a non-existent file,
24002 the file is opened for writing using O_CREAT but not O_EXCL, because
24003 that prevents link following.
24004
24005 .next
24006 .cindex "loop" "while file testing"
24007 If opening fails because the file exists, obey the tests given above for
24008 existing files. However, to avoid looping in a situation where the file is
24009 being continuously created and destroyed, the exists/not-exists loop is broken
24010 after 10 repetitions, and the message is then frozen.
24011
24012 .next
24013 If opening fails with any other error, defer delivery.
24014
24015 .next
24016 .cindex "file" "locking"
24017 .cindex "locking files"
24018 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24019 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24020 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24021 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24022 file, and an exclusive lock on the file whose name is
24023 .code
24024 /tmp/.<device-number>.<inode-number>
24025 .endd
24026 using the device and inode numbers of the open mailbox file, in accordance with
24027 the MBX locking rules. This file is created with a mode that is specified by
24028 the &%lockfile_mode%& option.
24029
24030 If Exim fails to lock the file, there are two possible courses of action,
24031 depending on the value of the locking timeout. This is obtained from
24032 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24033
24034 If the timeout value is zero, the file is closed, Exim waits for
24035 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24036 to lock it again. This happens up to &%lock_retries%& times, after which the
24037 delivery is deferred.
24038
24039 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24040 &[flock()]& are used (with the given timeout), so there has already been some
24041 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24042 immediately. It retries up to
24043 .code
24044 (lock_retries * lock_interval) / <timeout>
24045 .endd
24046 times (rounded up).
24047 .endlist
24048
24049 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24050 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24051
24052
24053 .section "Operational details for delivery to a new file" "SECTopdir"
24054 .cindex "delivery" "to single file"
24055 .cindex "&""From""& line"
24056 When the &%directory%& option is set instead of &%file%&, each message is
24057 delivered into a newly-created file or set of files. When &(appendfile)& is
24058 activated directly from a &(redirect)& router, neither &%file%& nor
24059 &%directory%& is normally set, because the path for delivery is supplied by the
24060 router. (See for example, the &(address_file)& transport in the default
24061 configuration.) In this case, delivery is to a new file if either the path name
24062 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24063
24064 No locking is required while writing the message to a new file, so the various
24065 locking options of the transport are ignored. The &"From"& line that by default
24066 separates messages in a single file is not normally needed, nor is the escaping
24067 of message lines that start with &"From"&, and there is no need to ensure a
24068 newline at the end of each message. Consequently, the default values for
24069 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24070 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24071
24072 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24073 the files in the delivery directory by default. However, you can specify a
24074 different directory by setting &%quota_directory%&. Also, for maildir
24075 deliveries (see below) the &_maildirfolder_& convention is honoured.
24076
24077
24078 .cindex "maildir format"
24079 .cindex "mailstore format"
24080 There are three different ways in which delivery to individual files can be
24081 done, controlled by the settings of the &%maildir_format%& and
24082 &%mailstore_format%& options. Note that code to support maildir or mailstore
24083 formats is not included in the binary unless SUPPORT_MAILDIR or
24084 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24085
24086 .cindex "directory creation"
24087 In all three cases an attempt is made to create the directory and any necessary
24088 sub-directories if they do not exist, provided that the &%create_directory%&
24089 option is set (the default). The location of a created directory can be
24090 constrained by setting &%create_file%&. A created directory's mode is given by
24091 the &%directory_mode%& option. If creation fails, or if the
24092 &%create_directory%& option is not set when creation is required, delivery is
24093 deferred.
24094
24095
24096
24097 .section "Maildir delivery" "SECTmaildirdelivery"
24098 .cindex "maildir format" "description of"
24099 If the &%maildir_format%& option is true, Exim delivers each message by writing
24100 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24101 directory that is defined by the &%directory%& option (the &"delivery
24102 directory"&). If the delivery is successful, the file is renamed into the
24103 &_new_& subdirectory.
24104
24105 In the filename, <&'stime'&> is the current time of day in seconds, and
24106 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24107 Exim checks that the time-of-day clock has moved on by at least one microsecond
24108 before terminating the delivery process. This guarantees uniqueness for the
24109 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24110 opening it. If any response other than ENOENT (does not exist) is given,
24111 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24112
24113 Before Exim carries out a maildir delivery, it ensures that subdirectories
24114 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24115 do not exist, Exim tries to create them and any superior directories in their
24116 path, subject to the &%create_directory%& and &%create_file%& options. If the
24117 &%maildirfolder_create_regex%& option is set, and the regular expression it
24118 contains matches the delivery directory, Exim also ensures that a file called
24119 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24120 &_maildirfolder_& file cannot be created, delivery is deferred.
24121
24122 These features make it possible to use Exim to create all the necessary files
24123 and directories in a maildir mailbox, including subdirectories for maildir++
24124 folders. Consider this example:
24125 .code
24126 maildir_format = true
24127 directory = /var/mail/$local_part_data\
24128            ${if eq{$local_part_suffix}{}{}\
24129            {/.${substr_1:$local_part_suffix}}}
24130 maildirfolder_create_regex = /\.[^/]+$
24131 .endd
24132 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24133 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24134 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24135 not match this name, so Exim will not look for or create the file
24136 &_/var/mail/pimbo/maildirfolder_&, though it will create
24137 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24138
24139 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24140 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24141 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24142 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24143 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24144
24145 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24146 not inadvertently match the toplevel maildir directory, because a
24147 &_maildirfolder_& file at top level would completely break quota calculations.
24148
24149 .cindex "quota" "in maildir delivery"
24150 .cindex "maildir++"
24151 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24152 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24153 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24154 Exim assumes the directory is a maildir++ folder directory, which is one level
24155 down from the user's top level mailbox directory. This causes it to start at
24156 the parent directory instead of the current directory when calculating the
24157 amount of space used.
24158
24159 One problem with delivering into a multi-file mailbox is that it is
24160 computationally expensive to compute the size of the mailbox for quota
24161 checking. Various approaches have been taken to reduce the amount of work
24162 needed. The next two sections describe two of them. A third alternative is to
24163 use some external process for maintaining the size data, and use the expansion
24164 of the &%mailbox_size%& option as a way of importing it into Exim.
24165
24166
24167
24168
24169 .section "Using tags to record message sizes" "SECID135"
24170 If &%maildir_tag%& is set, the string is expanded for each delivery.
24171 When the maildir file is renamed into the &_new_& sub-directory, the
24172 tag is added to its name. However, if adding the tag takes the length of the
24173 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24174 the tag is dropped and the maildir file is created with no tag.
24175
24176
24177 .vindex "&$message_size$&"
24178 Tags can be used to encode the size of files in their names; see
24179 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24180 happens after the message has been written. The value of the &$message_size$&
24181 variable is set to the number of bytes actually written. If the expansion is
24182 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24183 be deferred. The expanded tag may contain any printing characters except &"/"&.
24184 Non-printing characters in the string are ignored; if the resulting string is
24185 empty, it is ignored. If it starts with an alphanumeric character, a leading
24186 colon is inserted; this default has not proven to be the path that popular
24187 maildir implementations have chosen (but changing it in Exim would break
24188 backwards compatibility).
24189
24190 For one common implementation, you might set:
24191 .code
24192 maildir_tag = ,S=${message_size}
24193 .endd
24194 but you should check the documentation of the other software to be sure.
24195
24196 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24197 as this allows Exim to extract the size from your tag, instead of having to
24198 &[stat()]& each message file.
24199
24200
24201 .section "Using a maildirsize file" "SECID136"
24202 .cindex "quota" "in maildir delivery"
24203 .cindex "maildir format" "&_maildirsize_& file"
24204 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24205 storing quota and message size information in a file called &_maildirsize_&
24206 within the toplevel maildir directory. If this file does not exist, Exim
24207 creates it, setting the quota from the &%quota%& option of the transport. If
24208 the maildir directory itself does not exist, it is created before any attempt
24209 to write a &_maildirsize_& file.
24210
24211 The &_maildirsize_& file is used to hold information about the sizes of
24212 messages in the maildir, thus speeding up quota calculations. The quota value
24213 in the file is just a cache; if the quota is changed in the transport, the new
24214 value overrides the cached value when the next message is delivered. The cache
24215 is maintained for the benefit of other programs that access the maildir and
24216 need to know the quota.
24217
24218 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24219 file is maintained (with a zero quota setting), but no quota is imposed.
24220
24221 A regular expression is available for controlling which directories in the
24222 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24223 See the description of the &%maildir_quota_directory_regex%& option above for
24224 details.
24225
24226
24227 .section "Mailstore delivery" "SECID137"
24228 .cindex "mailstore format" "description of"
24229 If the &%mailstore_format%& option is true, each message is written as two
24230 files in the given directory. A unique base name is constructed from the
24231 message id and the current delivery process, and the files that are written use
24232 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24233 contains the message's envelope, and the &_.msg_& file contains the message
24234 itself. The base name is placed in the variable &$mailstore_basename$&.
24235
24236 During delivery, the envelope is first written to a file with the suffix
24237 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24238 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24239 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24240 file before accessing either of them. An alternative approach is to wait for
24241 the absence of a &_.tmp_& file.
24242
24243 The envelope file starts with any text defined by the &%mailstore_prefix%&
24244 option, expanded and terminated by a newline if there isn't one. Then follows
24245 the sender address on one line, then all the recipient addresses, one per line.
24246 There can be more than one recipient only if the &%batch_max%& option is set
24247 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24248 appended to the file, followed by a newline if it does not end with one.
24249
24250 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24251 failure, it is ignored. Other expansion errors are treated as serious
24252 configuration errors, and delivery is deferred. The variable
24253 &$mailstore_basename$& is available for use during these expansions.
24254
24255
24256 .section "Non-special new file delivery" "SECID138"
24257 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24258 file is created directly in the named directory. For example, when delivering
24259 messages into files in batched SMTP format for later delivery to some host (see
24260 section &<<SECTbatchSMTP>>&), a setting such as
24261 .code
24262 directory = /var/bsmtp/$host
24263 .endd
24264 might be used. A message is written to a file with a temporary name, which is
24265 then renamed when the delivery is complete. The final name is obtained by
24266 expanding the contents of the &%directory_file%& option.
24267 .ecindex IIDapptra1
24268 .ecindex IIDapptra2
24269
24270
24271
24272
24273
24274
24275 . ////////////////////////////////////////////////////////////////////////////
24276 . ////////////////////////////////////////////////////////////////////////////
24277
24278 .chapter "The autoreply transport" "CHID8"
24279 .scindex IIDauttra1 "transports" "&(autoreply)&"
24280 .scindex IIDauttra2 "&(autoreply)& transport"
24281 The &(autoreply)& transport is not a true transport in that it does not cause
24282 the message to be transmitted. Instead, it generates a new mail message as an
24283 automatic reply to the incoming message. &'References:'& and
24284 &'Auto-Submitted:'& header lines are included. These are constructed according
24285 to the rules in RFCs 2822 and 3834, respectively.
24286
24287 If the router that passes the message to this transport does not have the
24288 &%unseen%& option set, the original message (for the current recipient) is not
24289 delivered anywhere. However, when the &%unseen%& option is set on the router
24290 that passes the message to this transport, routing of the address continues, so
24291 another router can set up a normal message delivery.
24292
24293
24294 The &(autoreply)& transport is usually run as the result of mail filtering, a
24295 &"vacation"& message being the standard example. However, it can also be run
24296 directly from a router like any other transport. To reduce the possibility of
24297 message cascades, messages created by the &(autoreply)& transport always have
24298 empty envelope sender addresses, like bounce messages.
24299
24300 The parameters of the message to be sent can be specified in the configuration
24301 by options described below. However, these are used only when the address
24302 passed to the transport does not contain its own reply information. When the
24303 transport is run as a consequence of a
24304 &%mail%&
24305 or &%vacation%& command in a filter file, the parameters of the message are
24306 supplied by the filter, and passed with the address. The transport's options
24307 that define the message are then ignored (so they are not usually set in this
24308 case). The message is specified entirely by the filter or by the transport; it
24309 is never built from a mixture of options. However, the &%file_optional%&,
24310 &%mode%&, and &%return_message%& options apply in all cases.
24311
24312 &(Autoreply)& is implemented as a local transport. When used as a result of a
24313 command in a user's filter file, &(autoreply)& normally runs under the uid and
24314 gid of the user, and with appropriate current and home directories (see chapter
24315 &<<CHAPenvironment>>&).
24316
24317 There is a subtle difference between routing a message to a &(pipe)& transport
24318 that generates some text to be returned to the sender, and routing it to an
24319 &(autoreply)& transport. This difference is noticeable only if more than one
24320 address from the same message is so handled. In the case of a pipe, the
24321 separate outputs from the different addresses are gathered up and returned to
24322 the sender in a single message, whereas if &(autoreply)& is used, a separate
24323 message is generated for each address that is passed to it.
24324
24325 Non-printing characters are not permitted in the header lines generated for the
24326 message that &(autoreply)& creates, with the exception of newlines that are
24327 immediately followed by white space. If any non-printing characters are found,
24328 the transport defers.
24329 Whether characters with the top bit set count as printing characters or not is
24330 controlled by the &%print_topbitchars%& global option.
24331
24332 If any of the generic options for manipulating headers (for example,
24333 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24334 of the original message that is included in the generated message when
24335 &%return_message%& is set. They do not apply to the generated message itself.
24336
24337 .vindex "&$sender_address$&"
24338 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24339 the message, indicating that there were no recipients, it does not treat this
24340 as an error. This means that autoreplies sent to &$sender_address$& when this
24341 is empty (because the incoming message is a bounce message) do not cause
24342 problems. They are just discarded.
24343
24344
24345
24346 .section "Private options for autoreply" "SECID139"
24347 .cindex "options" "&(autoreply)& transport"
24348
24349 .option bcc autoreply string&!! unset
24350 This specifies the addresses that are to receive &"blind carbon copies"& of the
24351 message when the message is specified by the transport.
24352
24353
24354 .option cc autoreply string&!! unset
24355 This specifies recipients of the message and the contents of the &'Cc:'& header
24356 when the message is specified by the transport.
24357
24358
24359 .option file autoreply string&!! unset
24360 The contents of the file are sent as the body of the message when the message
24361 is specified by the transport. If both &%file%& and &%text%& are set, the text
24362 string comes first.
24363
24364
24365 .option file_expand autoreply boolean false
24366 If this is set, the contents of the file named by the &%file%& option are
24367 subjected to string expansion as they are added to the message.
24368
24369
24370 .option file_optional autoreply boolean false
24371 If this option is true, no error is generated if the file named by the &%file%&
24372 option or passed with the address does not exist or cannot be read.
24373
24374
24375 .option from autoreply string&!! unset
24376 This specifies the contents of the &'From:'& header when the message is
24377 specified by the transport.
24378
24379
24380 .option headers autoreply string&!! unset
24381 This specifies additional RFC 2822 headers that are to be added to the message
24382 when the message is specified by the transport. Several can be given by using
24383 &"\n"& to separate them. There is no check on the format.
24384
24385
24386 .option log autoreply string&!! unset
24387 This option names a file in which a record of every message sent is logged when
24388 the message is specified by the transport.
24389
24390
24391 .option mode autoreply "octal integer" 0600
24392 If either the log file or the &"once"& file has to be created, this mode is
24393 used.
24394
24395
24396 .option never_mail autoreply "address list&!!" unset
24397 If any run of the transport creates a message with a recipient that matches any
24398 item in the list, that recipient is quietly discarded. If all recipients are
24399 discarded, no message is created. This applies both when the recipients are
24400 generated by a filter and when they are specified in the transport.
24401
24402
24403
24404 .option once autoreply string&!! unset
24405 This option names a file or DBM database in which a record of each &'To:'&
24406 recipient is kept when the message is specified by the transport. &*Note*&:
24407 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24408
24409 If &%once%& is unset, or is set to an empty string, the message is always sent.
24410 By default, if &%once%& is set to a non-empty filename, the message
24411 is not sent if a potential recipient is already listed in the database.
24412 However, if the &%once_repeat%& option specifies a time greater than zero, the
24413 message is sent if that much time has elapsed since a message was last sent to
24414 this recipient. A setting of zero time for &%once_repeat%& (the default)
24415 prevents a message from being sent a second time &-- in this case, zero means
24416 infinity.
24417
24418 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24419 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24420 greater than zero, it changes the way Exim implements the &%once%& option.
24421 Instead of using a DBM file to record every recipient it sends to, it uses a
24422 regular file, whose size will never get larger than the given value.
24423
24424 In the file, Exim keeps a linear list of recipient addresses and the times at
24425 which they were sent messages. If the file is full when a new address needs to
24426 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24427 means that a given recipient may receive multiple messages, but at
24428 unpredictable intervals that depend on the rate of turnover of addresses in the
24429 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24430
24431
24432 .option once_file_size autoreply integer 0
24433 See &%once%& above.
24434
24435
24436 .option once_repeat autoreply time&!! 0s
24437 See &%once%& above.
24438 After expansion, the value of this option must be a valid time value.
24439
24440
24441 .option reply_to autoreply string&!! unset
24442 This specifies the contents of the &'Reply-To:'& header when the message is
24443 specified by the transport.
24444
24445
24446 .option return_message autoreply boolean false
24447 If this is set, a copy of the original message is returned with the new
24448 message, subject to the maximum size set in the &%return_size_limit%& global
24449 configuration option.
24450
24451
24452 .option subject autoreply string&!! unset
24453 This specifies the contents of the &'Subject:'& header when the message is
24454 specified by the transport. It is tempting to quote the original subject in
24455 automatic responses. For example:
24456 .code
24457 subject = Re: $h_subject:
24458 .endd
24459 There is a danger in doing this, however. It may allow a third party to
24460 subscribe your users to an opt-in mailing list, provided that the list accepts
24461 bounce messages as subscription confirmations. Well-managed lists require a
24462 non-bounce message to confirm a subscription, so the danger is relatively
24463 small.
24464
24465
24466
24467 .option text autoreply string&!! unset
24468 This specifies a single string to be used as the body of the message when the
24469 message is specified by the transport. If both &%text%& and &%file%& are set,
24470 the text comes first.
24471
24472
24473 .option to autoreply string&!! unset
24474 This specifies recipients of the message and the contents of the &'To:'& header
24475 when the message is specified by the transport.
24476 .ecindex IIDauttra1
24477 .ecindex IIDauttra2
24478
24479
24480
24481
24482 . ////////////////////////////////////////////////////////////////////////////
24483 . ////////////////////////////////////////////////////////////////////////////
24484
24485 .chapter "The lmtp transport" "CHAPLMTP"
24486 .cindex "transports" "&(lmtp)&"
24487 .cindex "&(lmtp)& transport"
24488 .cindex "LMTP" "over a pipe"
24489 .cindex "LMTP" "over a socket"
24490 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24491 specified command
24492 or by interacting with a Unix domain socket.
24493 This transport is something of a cross between the &(pipe)& and &(smtp)&
24494 transports. Exim also has support for using LMTP over TCP/IP; this is
24495 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24496 to be of minority interest, the default build-time configure in &_src/EDITME_&
24497 has it commented out. You need to ensure that
24498 .code
24499 TRANSPORT_LMTP=yes
24500 .endd
24501 .cindex "options" "&(lmtp)& transport"
24502 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24503 included in the Exim binary. The private options of the &(lmtp)& transport are
24504 as follows:
24505
24506 .option batch_id lmtp string&!! unset
24507 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24508
24509
24510 .option batch_max lmtp integer 1
24511 This limits the number of addresses that can be handled in a single delivery.
24512 Most LMTP servers can handle several addresses at once, so it is normally a
24513 good idea to increase this value. See the description of local delivery
24514 batching in chapter &<<CHAPbatching>>&.
24515
24516
24517 .option command lmtp string&!! unset
24518 This option must be set if &%socket%& is not set. The string is a command which
24519 is run in a separate process. It is split up into a command name and list of
24520 arguments, each of which is separately expanded (so expansion cannot change the
24521 number of arguments). The command is run directly, not via a shell. The message
24522 is passed to the new process using the standard input and output to operate the
24523 LMTP protocol.
24524
24525 .option ignore_quota lmtp boolean false
24526 .cindex "LMTP" "ignoring quota errors"
24527 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24528 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24529 in its response to the LHLO command.
24530
24531 .option socket lmtp string&!! unset
24532 This option must be set if &%command%& is not set. The result of expansion must
24533 be the name of a Unix domain socket. The transport connects to the socket and
24534 delivers the message to it using the LMTP protocol.
24535
24536
24537 .option timeout lmtp time 5m
24538 The transport is aborted if the created process or Unix domain socket does not
24539 respond to LMTP commands or message input within this timeout. Delivery
24540 is deferred, and will be tried again later. Here is an example of a typical
24541 LMTP transport:
24542 .code
24543 lmtp:
24544   driver = lmtp
24545   command = /some/local/lmtp/delivery/program
24546   batch_max = 20
24547   user = exim
24548 .endd
24549 This delivers up to 20 addresses at a time, in a mixture of domains if
24550 necessary, running as the user &'exim'&.
24551
24552
24553
24554 . ////////////////////////////////////////////////////////////////////////////
24555 . ////////////////////////////////////////////////////////////////////////////
24556
24557 .chapter "The pipe transport" "CHAPpipetransport"
24558 .scindex IIDpiptra1 "transports" "&(pipe)&"
24559 .scindex IIDpiptra2 "&(pipe)& transport"
24560 The &(pipe)& transport is used to deliver messages via a pipe to a command
24561 running in another process. One example is the use of &(pipe)& as a
24562 pseudo-remote transport for passing messages to some other delivery mechanism
24563 (such as UUCP). Another is the use by individual users to automatically process
24564 their incoming messages. The &(pipe)& transport can be used in one of the
24565 following ways:
24566
24567 .ilist
24568 .vindex "&$local_part$&"
24569 A router routes one address to a transport in the normal way, and the
24570 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24571 contains the local part of the address (as usual), and the command that is run
24572 is specified by the &%command%& option on the transport.
24573 .next
24574 .vindex "&$pipe_addresses$&"
24575 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24576 transport can handle more than one address in a single run. In this case, when
24577 more than one address is routed to the transport, &$local_part$& is not set
24578 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24579 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24580 that are routed to the transport.
24581 .next
24582 .vindex "&$address_pipe$&"
24583 A router redirects an address directly to a pipe command (for example, from an
24584 alias or forward file). In this case, &$address_pipe$& contains the text of the
24585 pipe command, and the &%command%& option on the transport is ignored unless
24586 &%force_command%& is set. If only one address is being transported
24587 (&%batch_max%& is not greater than one, or only one address was redirected to
24588 this pipe command), &$local_part$& contains the local part that was redirected.
24589 .endlist
24590
24591
24592 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24593 deliver messages over pipes using the LMTP interactive protocol. This is
24594 implemented by the &(lmtp)& transport.
24595
24596 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24597 &_.forward_& file, the command runs under the uid and gid of that user. In
24598 other cases, the uid and gid have to be specified explicitly, either on the
24599 transport or on the router that handles the address. Current and &"home"&
24600 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24601 details of the local delivery environment and chapter &<<CHAPbatching>>&
24602 for a discussion of local delivery batching.
24603
24604 .cindex "tainted data" "in pipe command"
24605 .cindex pipe "tainted data"
24606 Tainted data may not be used for the command name.
24607
24608
24609 .section "Concurrent delivery" "SECID140"
24610 If two messages arrive at almost the same time, and both are routed to a pipe
24611 delivery, the two pipe transports may be run concurrently. You must ensure that
24612 any pipe commands you set up are robust against this happening. If the commands
24613 write to a file, the &%exim_lock%& utility might be of use.
24614 Alternatively the &%max_parallel%& option could be used with a value
24615 of "1" to enforce serialization.
24616
24617
24618
24619
24620 .section "Returned status and data" "SECID141"
24621 .cindex "&(pipe)& transport" "returned data"
24622 If the command exits with a non-zero return code, the delivery is deemed to
24623 have failed, unless either the &%ignore_status%& option is set (in which case
24624 the return code is treated as zero), or the return code is one of those listed
24625 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24626 later"&. In this case, delivery is deferred. Details of a permanent failure are
24627 logged, but are not included in the bounce message, which merely contains
24628 &"local delivery failed"&.
24629
24630 If the command exits on a signal and the &%freeze_signal%& option is set then
24631 the message will be frozen in the queue. If that option is not set, a bounce
24632 will be sent as normal.
24633
24634 If the return code is greater than 128 and the command being run is a shell
24635 script, it normally means that the script was terminated by a signal whose
24636 value is the return code minus 128. The &%freeze_signal%& option does not
24637 apply in this case.
24638
24639 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24640 return code is set to 127. This is the value that a shell returns if it is
24641 asked to run a non-existent command. The wording for the log line suggests that
24642 a non-existent command may be the problem.
24643
24644 The &%return_output%& option can affect the result of a pipe delivery. If it is
24645 set and the command produces any output on its standard output or standard
24646 error streams, the command is considered to have failed, even if it gave a zero
24647 return code or if &%ignore_status%& is set. The output from the command is
24648 included as part of the bounce message. The &%return_fail_output%& option is
24649 similar, except that output is returned only when the command exits with a
24650 failure return code, that is, a value other than zero or a code that matches
24651 &%temp_errors%&.
24652
24653
24654
24655 .section "How the command is run" "SECThowcommandrun"
24656 .cindex "&(pipe)& transport" "path for command"
24657 The command line is (by default) broken down into a command name and arguments
24658 by the &(pipe)& transport itself. The &%allow_commands%& and
24659 &%restrict_to_path%& options can be used to restrict the commands that may be
24660 run.
24661
24662 .cindex "quoting" "in pipe command"
24663 Unquoted arguments are delimited by white space. If an argument appears in
24664 double quotes, backslash is interpreted as an escape character in the usual
24665 way. If an argument appears in single quotes, no escaping is done.
24666
24667 String expansion is applied to the command line except when it comes from a
24668 traditional &_.forward_& file (commands from a filter file are expanded). The
24669 expansion is applied to each argument in turn rather than to the whole line.
24670 For this reason, any string expansion item that contains white space must be
24671 quoted so as to be contained within a single argument. A setting such as
24672 .code
24673 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24674 .endd
24675 will not work, because the expansion item gets split between several
24676 arguments. You have to write
24677 .code
24678 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24679 .endd
24680 to ensure that it is all in one argument. The expansion is done in this way,
24681 argument by argument, so that the number of arguments cannot be changed as a
24682 result of expansion, and quotes or backslashes in inserted variables do not
24683 interact with external quoting. However, this leads to problems if you want to
24684 generate multiple arguments (or the command name plus arguments) from a single
24685 expansion. In this situation, the simplest solution is to use a shell. For
24686 example:
24687 .code
24688 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24689 .endd
24690
24691 .cindex "transport" "filter"
24692 .cindex "filter" "transport filter"
24693 .vindex "&$pipe_addresses$&"
24694 Special handling takes place when an argument consists of precisely the text
24695 &`$pipe_addresses`& (no quotes).
24696 This is not a general expansion variable; the only
24697 place this string is recognized is when it appears as an argument for a pipe or
24698 transport filter command. It causes each address that is being handled to be
24699 inserted in the argument list at that point &'as a separate argument'&. This
24700 avoids any problems with spaces or shell metacharacters, and is of use when a
24701 &(pipe)& transport is handling groups of addresses in a batch.
24702
24703 If &%force_command%& is enabled on the transport, special handling takes place
24704 for an argument that consists of precisely the text &`$address_pipe`&.  It
24705 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24706 argument is inserted in the argument list at that point
24707 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24708 the only item in the argument; in fact, if it were then &%force_command%&
24709 should behave as a no-op.  Rather, it should be used to adjust the command
24710 run while preserving the argument vector separation.
24711
24712 After splitting up into arguments and expansion, the resulting command is run
24713 in a subprocess directly from the transport, &'not'& under a shell. The
24714 message that is being delivered is supplied on the standard input, and the
24715 standard output and standard error are both connected to a single pipe that is
24716 read by Exim. The &%max_output%& option controls how much output the command
24717 may produce, and the &%return_output%& and &%return_fail_output%& options
24718 control what is done with it.
24719
24720 Not running the command under a shell (by default) lessens the security risks
24721 in cases when a command from a user's filter file is built out of data that was
24722 taken from an incoming message. If a shell is required, it can of course be
24723 explicitly specified as the command to be run. However, there are circumstances
24724 where existing commands (for example, in &_.forward_& files) expect to be run
24725 under a shell and cannot easily be modified. To allow for these cases, there is
24726 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24727 works. Instead of breaking up the command line as just described, it expands it
24728 as a single string and passes the result to &_/bin/sh_&. The
24729 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24730 with &%use_shell%&, and the whole mechanism is inherently less secure.
24731
24732
24733
24734 .section "Environment variables" "SECTpipeenv"
24735 .cindex "&(pipe)& transport" "environment for command"
24736 .cindex "environment" "&(pipe)& transport"
24737 The environment variables listed below are set up when the command is invoked.
24738 This list is a compromise for maximum compatibility with other MTAs. Note that
24739 the &%environment%& option can be used to add additional variables to this
24740 environment. The environment for the &(pipe)& transport is not subject
24741 to the &%add_environment%& and &%keep_environment%& main config options.
24742 &*Note*&: Using enviroment variables loses track of tainted data.
24743 Writers of &(pipe)& transport commands should be wary of data supplied
24744 by potential attackers.
24745 .display
24746 &`DOMAIN            `&   the domain of the address
24747 &`HOME              `&   the home directory, if set
24748 &`HOST              `&   the host name when called from a router (see below)
24749 &`LOCAL_PART        `&   see below
24750 &`LOCAL_PART_PREFIX `&   see below
24751 &`LOCAL_PART_SUFFIX `&   see below
24752 &`LOGNAME           `&   see below
24753 &`MESSAGE_ID        `&   Exim's local ID for the message
24754 &`PATH              `&   as specified by the &%path%& option below
24755 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24756 &`RECIPIENT         `&   the complete recipient address
24757 &`SENDER            `&   the sender of the message (empty if a bounce)
24758 &`SHELL             `&   &`/bin/sh`&
24759 &`TZ                `&   the value of the &%timezone%& option, if set
24760 &`USER              `&   see below
24761 .endd
24762 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24763 router, LOCAL_PART is set to the local part of the address. When it is
24764 called as a result of a forward or alias expansion, LOCAL_PART is set to
24765 the local part of the address that was expanded. In both cases, any affixes are
24766 removed from the local part, and made available in LOCAL_PART_PREFIX and
24767 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24768 same value as LOCAL_PART for compatibility with other MTAs.
24769
24770 .cindex "HOST"
24771 HOST is set only when a &(pipe)& transport is called from a router that
24772 associates hosts with an address, typically when using &(pipe)& as a
24773 pseudo-remote transport. HOST is set to the first host name specified by
24774 the router.
24775
24776 .cindex "HOME"
24777 If the transport's generic &%home_directory%& option is set, its value is used
24778 for the HOME environment variable. Otherwise, a home directory may be set
24779 by the router's &%transport_home_directory%& option, which defaults to the
24780 user's home directory if &%check_local_user%& is set.
24781
24782
24783 .section "Private options for pipe" "SECID142"
24784 .cindex "options" "&(pipe)& transport"
24785
24786
24787
24788 .option allow_commands pipe "string list&!!" unset
24789 .cindex "&(pipe)& transport" "permitted commands"
24790 The string is expanded, and is then interpreted as a colon-separated list of
24791 permitted commands. If &%restrict_to_path%& is not set, the only commands
24792 permitted are those in the &%allow_commands%& list. They need not be absolute
24793 paths; the &%path%& option is still used for relative paths. If
24794 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24795 in the &%allow_commands%& list, or a name without any slashes that is found on
24796 the path. In other words, if neither &%allow_commands%& nor
24797 &%restrict_to_path%& is set, there is no restriction on the command, but
24798 otherwise only commands that are permitted by one or the other are allowed. For
24799 example, if
24800 .code
24801 allow_commands = /usr/bin/vacation
24802 .endd
24803 and &%restrict_to_path%& is not set, the only permitted command is
24804 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24805 &%use_shell%& is set.
24806
24807
24808 .option batch_id pipe string&!! unset
24809 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24810
24811
24812 .option batch_max pipe integer 1
24813 This limits the number of addresses that can be handled in a single delivery.
24814 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24815
24816
24817 .option check_string pipe string unset
24818 As &(pipe)& writes the message, the start of each line is tested for matching
24819 &%check_string%&, and if it does, the initial matching characters are replaced
24820 by the contents of &%escape_string%&, provided both are set. The value of
24821 &%check_string%& is a literal string, not a regular expression, and the case of
24822 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24823 of &%check_string%& and &%escape_string%& are forced to values that implement
24824 the SMTP escaping protocol. Any settings made in the configuration file are
24825 ignored.
24826
24827
24828 .option command pipe string&!! unset
24829 This option need not be set when &(pipe)& is being used to deliver to pipes
24830 obtained directly from address redirections. In other cases, the option must be
24831 set, to provide a command to be run. It need not yield an absolute path (see
24832 the &%path%& option below). The command is split up into separate arguments by
24833 Exim, and each argument is separately expanded, as described in section
24834 &<<SECThowcommandrun>>& above.
24835
24836 .cindex "tainted data"
24837 No part of the resulting command may be tainted.
24838
24839
24840 .option environment pipe string&!! unset
24841 .cindex "&(pipe)& transport" "environment for command"
24842 .cindex "environment" "&(pipe)& transport"
24843 This option is used to add additional variables to the environment in which the
24844 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24845 a string which is expanded, and then interpreted as a colon-separated list of
24846 environment settings of the form <&'name'&>=<&'value'&>.
24847
24848
24849 .option escape_string pipe string unset
24850 See &%check_string%& above.
24851
24852
24853 .option freeze_exec_fail pipe boolean false
24854 .cindex "exec failure"
24855 .cindex "failure of exec"
24856 .cindex "&(pipe)& transport" "failure of exec"
24857 Failure to exec the command in a pipe transport is by default treated like
24858 any other failure while running the command. However, if &%freeze_exec_fail%&
24859 is set, failure to exec is treated specially, and causes the message to be
24860 frozen, whatever the setting of &%ignore_status%&.
24861
24862
24863 .option freeze_signal pipe boolean false
24864 .cindex "signal exit"
24865 .cindex "&(pipe)& transport", "signal exit"
24866 Normally if the process run by a command in a pipe transport exits on a signal,
24867 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24868 frozen in Exim's queue instead.
24869
24870
24871 .option force_command pipe boolean false
24872 .cindex "force command"
24873 .cindex "&(pipe)& transport", "force command"
24874 Normally when a router redirects an address directly to a pipe command
24875 the &%command%& option on the transport is ignored.  If &%force_command%&
24876 is set, the &%command%& option will used. This is especially
24877 useful for forcing a wrapper or additional argument to be added to the
24878 command. For example:
24879 .code
24880 command = /usr/bin/remote_exec myhost -- $address_pipe
24881 force_command
24882 .endd
24883
24884 Note that &$address_pipe$& is handled specially in &%command%& when
24885 &%force_command%& is set, expanding out to the original argument vector as
24886 separate items, similarly to a Unix shell &`"$@"`& construct.
24887
24888
24889 .option ignore_status pipe boolean false
24890 If this option is true, the status returned by the subprocess that is set up to
24891 run the command is ignored, and Exim behaves as if zero had been returned.
24892 Otherwise, a non-zero status or termination by signal causes an error return
24893 from the transport unless the status value is one of those listed in
24894 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24895
24896 &*Note*&: This option does not apply to timeouts, which do not return a status.
24897 See the &%timeout_defer%& option for how timeouts are handled.
24898
24899
24900 .option log_defer_output pipe boolean false
24901 .cindex "&(pipe)& transport" "logging output"
24902 If this option is set, and the status returned by the command is
24903 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24904 and any output was produced on stdout or stderr, the first line of it is
24905 written to the main log.
24906
24907
24908 .option log_fail_output pipe boolean false
24909 If this option is set, and the command returns any output on stdout or
24910 stderr, and also ends with a return code that is neither zero nor one of
24911 the return codes listed in &%temp_errors%& (that is, the delivery
24912 failed), the first line of output is written to the main log. This
24913 option and &%log_output%& are mutually exclusive.  Only one of them may
24914 be set.
24915
24916
24917 .option log_output pipe boolean false
24918 If this option is set and the command returns any output on stdout or
24919 stderr, the first line of output is written to the main log, whatever
24920 the return code. This option and &%log_fail_output%& are mutually
24921 exclusive. Only one of them may be set.
24922
24923
24924 .option max_output pipe integer 20K
24925 This specifies the maximum amount of output that the command may produce on its
24926 standard output and standard error file combined. If the limit is exceeded, the
24927 process running the command is killed. This is intended as a safety measure to
24928 catch runaway processes. The limit is applied independently of the settings of
24929 the options that control what is done with such output (for example,
24930 &%return_output%&). Because of buffering effects, the amount of output may
24931 exceed the limit by a small amount before Exim notices.
24932
24933
24934 .option message_prefix pipe string&!! "see below"
24935 The string specified here is expanded and output at the start of every message.
24936 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24937 .code
24938 message_prefix = \
24939   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24940   ${tod_bsdinbox}\n
24941 .endd
24942 .cindex "Cyrus"
24943 .cindex "&%tmail%&"
24944 .cindex "&""From""& line"
24945 This is required by the commonly used &_/usr/bin/vacation_& program.
24946 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24947 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24948 setting
24949 .code
24950 message_prefix =
24951 .endd
24952 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24953 &`\n`& to &`\r\n`& in &%message_prefix%&.
24954
24955
24956 .option message_suffix pipe string&!! "see below"
24957 The string specified here is expanded and output at the end of every message.
24958 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24959 The suffix can be suppressed by setting
24960 .code
24961 message_suffix =
24962 .endd
24963 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24964 &`\n`& to &`\r\n`& in &%message_suffix%&.
24965
24966
24967 .option path pipe string&!! "/bin:/usr/bin"
24968 This option is expanded and
24969 specifies the string that is set up in the PATH environment
24970 variable of the subprocess.
24971 If the &%command%& option does not yield an absolute path name, the command is
24972 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24973 apply to a command specified as a transport filter.
24974
24975
24976 .option permit_coredump pipe boolean false
24977 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24978 a core-dump of a pipe command, enable this command.  This enables core-dumps
24979 during delivery and affects both the Exim binary and the pipe command run.
24980 It is recommended that this option remain off unless and until you have a need
24981 for it and that this only be enabled when needed, as the risk of excessive
24982 resource consumption can be quite high.  Note also that Exim is typically
24983 installed as a setuid binary and most operating systems will inhibit coredumps
24984 of these by default, so further OS-specific action may be required.
24985
24986
24987 .option pipe_as_creator pipe boolean false
24988 .cindex "uid (user id)" "local delivery"
24989 If the generic &%user%& option is not set and this option is true, the delivery
24990 process is run under the uid that was in force when Exim was originally called
24991 to accept the message. If the group id is not otherwise set (via the generic
24992 &%group%& option), the gid that was in force when Exim was originally called to
24993 accept the message is used.
24994
24995
24996 .option restrict_to_path pipe boolean false
24997 When this option is set, any command name not listed in &%allow_commands%& must
24998 contain no slashes. The command is searched for only in the directories listed
24999 in the &%path%& option. This option is intended for use in the case when a pipe
25000 command has been generated from a user's &_.forward_& file. This is usually
25001 handled by a &(pipe)& transport called &%address_pipe%&.
25002
25003
25004 .option return_fail_output pipe boolean false
25005 If this option is true, and the command produced any output and ended with a
25006 return code other than zero or one of the codes listed in &%temp_errors%& (that
25007 is, the delivery failed), the output is returned in the bounce message.
25008 However, if the message has a null sender (that is, it is itself a bounce
25009 message), output from the command is discarded. This option and
25010 &%return_output%& are mutually exclusive. Only one of them may be set.
25011
25012
25013
25014 .option return_output pipe boolean false
25015 If this option is true, and the command produced any output, the delivery is
25016 deemed to have failed whatever the return code from the command, and the output
25017 is returned in the bounce message. Otherwise, the output is just discarded.
25018 However, if the message has a null sender (that is, it is a bounce message),
25019 output from the command is always discarded, whatever the setting of this
25020 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25021 of them may be set.
25022
25023
25024
25025 .option temp_errors pipe "string list" "see below"
25026 .cindex "&(pipe)& transport" "temporary failure"
25027 This option contains either a colon-separated list of numbers, or a single
25028 asterisk. If &%ignore_status%& is false
25029 and &%return_output%& is not set,
25030 and the command exits with a non-zero return code, the failure is treated as
25031 temporary and the delivery is deferred if the return code matches one of the
25032 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25033 codes are treated as permanent errors. The default setting contains the codes
25034 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25035 compiled on a system that does not define these macros, it assumes values of 75
25036 and 73, respectively.
25037
25038
25039 .option timeout pipe time 1h
25040 If the command fails to complete within this time, it is killed. This normally
25041 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25042 specifies no timeout. In order to ensure that any subprocesses created by the
25043 command are also killed, Exim makes the initial process a process group leader,
25044 and kills the whole process group on a timeout. However, this can be defeated
25045 if one of the processes starts a new process group.
25046
25047 .option timeout_defer pipe boolean false
25048 A timeout in a &(pipe)& transport, either in the command that the transport
25049 runs, or in a transport filter that is associated with it, is by default
25050 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25051 is set true, both kinds of timeout become temporary errors, causing the
25052 delivery to be deferred.
25053
25054 .option umask pipe "octal integer" 022
25055 This specifies the umask setting for the subprocess that runs the command.
25056
25057
25058 .option use_bsmtp pipe boolean false
25059 .cindex "envelope sender"
25060 If this option is set true, the &(pipe)& transport writes messages in &"batch
25061 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25062 commands. If you want to include a leading HELO command with such messages,
25063 you can do so by setting the &%message_prefix%& option. See section
25064 &<<SECTbatchSMTP>>& for details of batch SMTP.
25065
25066 .option use_classresources pipe boolean false
25067 .cindex "class resources (BSD)"
25068 This option is available only when Exim is running on FreeBSD, NetBSD, or
25069 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25070 resource limits when a &(pipe)& transport is run to perform a delivery. The
25071 limits for the uid under which the pipe is to run are obtained from the login
25072 class database.
25073
25074
25075 .option use_crlf pipe boolean false
25076 .cindex "carriage return"
25077 .cindex "linefeed"
25078 This option causes lines to be terminated with the two-character CRLF sequence
25079 (carriage return, linefeed) instead of just a linefeed character. In the case
25080 of batched SMTP, the byte sequence written to the pipe is then an exact image
25081 of what would be sent down a real SMTP connection.
25082
25083 The contents of the &%message_prefix%& and &%message_suffix%& options are
25084 written verbatim, so must contain their own carriage return characters if these
25085 are needed. When &%use_bsmtp%& is not set, the default values for both
25086 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25087 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25088
25089
25090 .option use_shell pipe boolean false
25091 .vindex "&$pipe_addresses$&"
25092 If this option is set, it causes the command to be passed to &_/bin/sh_&
25093 instead of being run directly from the transport, as described in section
25094 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25095 where the command is expected to be run under a shell and cannot easily be
25096 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25097 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25098 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25099 its &%-c%& option.
25100
25101
25102
25103 .section "Using an external local delivery agent" "SECID143"
25104 .cindex "local delivery" "using an external agent"
25105 .cindex "&'procmail'&"
25106 .cindex "external local delivery"
25107 .cindex "delivery" "&'procmail'&"
25108 .cindex "delivery" "by external agent"
25109 The &(pipe)& transport can be used to pass all messages that require local
25110 delivery to a separate local delivery agent such as &%procmail%&. When doing
25111 this, care must be taken to ensure that the pipe is run under an appropriate
25112 uid and gid. In some configurations one wants this to be a uid that is trusted
25113 by the delivery agent to supply the correct sender of the message. It may be
25114 necessary to recompile or reconfigure the delivery agent so that it trusts an
25115 appropriate user. The following is an example transport and router
25116 configuration for &%procmail%&:
25117 .code
25118 # transport
25119 procmail_pipe:
25120   driver = pipe
25121   command = /usr/local/bin/procmail -d $local_part_data
25122   return_path_add
25123   delivery_date_add
25124   envelope_to_add
25125   check_string = "From "
25126   escape_string = ">From "
25127   umask = 077
25128   user = $local_part_data
25129   group = mail
25130
25131 # router
25132 procmail:
25133   driver = accept
25134   check_local_user
25135   transport = procmail_pipe
25136 .endd
25137 In this example, the pipe is run as the local user, but with the group set to
25138 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25139 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25140 user to supply a correct sender address. If you do not specify either a
25141 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25142 home directory is the user's home directory by default.
25143
25144 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25145 .code
25146 IFS=" "
25147 .endd
25148 as shown in some &%procmail%& documentation, because Exim does not by default
25149 use a shell to run pipe commands.
25150
25151 .cindex "Cyrus"
25152 The next example shows a transport and a router for a system where local
25153 deliveries are handled by the Cyrus IMAP server.
25154 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25155 . but that suffix is tainted so cannot be used in a command arg
25156 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25157 .code
25158 # transport
25159 local_delivery_cyrus:
25160   driver = pipe
25161   command = /usr/cyrus/bin/deliver \
25162             -- $local_part_data
25163   user = cyrus
25164   group = mail
25165   return_output
25166   log_output
25167   message_prefix =
25168   message_suffix =
25169
25170 # router
25171 local_user_cyrus:
25172   driver = accept
25173   check_local_user
25174   transport = local_delivery_cyrus
25175 .endd
25176 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25177 &%return_output%& to cause any text written by Cyrus to be returned to the
25178 sender.
25179 .ecindex IIDpiptra1
25180 .ecindex IIDpiptra2
25181
25182
25183 . ////////////////////////////////////////////////////////////////////////////
25184 . ////////////////////////////////////////////////////////////////////////////
25185
25186 .chapter "The smtp transport" "CHAPsmtptrans"
25187 .scindex IIDsmttra1 "transports" "&(smtp)&"
25188 .scindex IIDsmttra2 "&(smtp)& transport"
25189 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25190 or LMTP protocol. The list of hosts to try can either be taken from the address
25191 that is being processed (having been set up by the router), or specified
25192 explicitly for the transport. Timeout and retry processing (see chapter
25193 &<<CHAPretry>>&) is applied to each IP address independently.
25194
25195
25196 .section "Multiple messages on a single connection" "SECID144"
25197 The sending of multiple messages over a single TCP/IP connection can arise in
25198 two ways:
25199
25200 .ilist
25201 If a message contains more than &%max_rcpt%& (see below) addresses that are
25202 routed to the same host, more than one copy of the message has to be sent to
25203 that host. In this situation, multiple copies may be sent in a single run of
25204 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25205 does when it has too many addresses to send in one message also depends on the
25206 value of the global &%remote_max_parallel%& option. Details are given in
25207 section &<<SECToutSMTPTCP>>&.)
25208 .next
25209 .cindex "hints database" "remembering routing"
25210 When a message has been successfully delivered over a TCP/IP connection, Exim
25211 looks in its hints database to see if there are any other messages awaiting a
25212 connection to the same host. If there are, a new delivery process is started
25213 for one of them, and the current TCP/IP connection is passed on to it. The new
25214 process may in turn send multiple copies and possibly create yet another
25215 process.
25216 .endlist
25217
25218
25219 For each copy sent over the same TCP/IP connection, a sequence counter is
25220 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25221 no further messages are sent over that connection.
25222
25223
25224
25225 .section "Use of the $host and $host_address variables" "SECID145"
25226 .vindex "&$host$&"
25227 .vindex "&$host_address$&"
25228 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25229 &$host_address$& are the name and IP address of the first host on the host list
25230 passed by the router. However, when the transport is about to connect to a
25231 specific host, and while it is connected to that host, &$host$& and
25232 &$host_address$& are set to the values for that host. These are the values
25233 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25234 &%serialize_hosts%&, and the various TLS options are expanded.
25235
25236
25237 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25238 .vindex &$tls_bits$&
25239 .vindex &$tls_cipher$&
25240 .vindex &$tls_peerdn$&
25241 .vindex &$tls_sni$&
25242 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25243 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25244 are the values that were set when the message was received.
25245 These are the values that are used for options that are expanded before any
25246 SMTP connections are made. Just before each connection is made, these four
25247 variables are emptied. If TLS is subsequently started, they are set to the
25248 appropriate values for the outgoing connection, and these are the values that
25249 are in force when any authenticators are run and when the
25250 &%authenticated_sender%& option is expanded.
25251
25252 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25253 and will be removed in a future release.
25254
25255
25256 .section "Private options for smtp" "SECID146"
25257 .cindex "options" "&(smtp)& transport"
25258 The private options of the &(smtp)& transport are as follows:
25259
25260
25261 .option address_retry_include_sender smtp boolean true
25262 .cindex "4&'xx'& responses" "retrying after"
25263 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25264 is the combination of sender and recipient that is delayed in subsequent queue
25265 runs until the retry time is reached. You can delay the recipient without
25266 reference to the sender (which is what earlier versions of Exim did), by
25267 setting &%address_retry_include_sender%& false. However, this can lead to
25268 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25269
25270 .option allow_localhost smtp boolean false
25271 .cindex "local host" "sending to"
25272 .cindex "fallback" "hosts specified on transport"
25273 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25274 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25275 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25276 the delivery anyway. This should be used only in special cases when the
25277 configuration ensures that no looping will result (for example, a differently
25278 configured Exim is listening on the port to which the message is sent).
25279
25280
25281 .option authenticated_sender smtp string&!! unset
25282 .cindex "Cyrus"
25283 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25284 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25285 overriding any existing authenticated sender value. If the string expansion is
25286 forced to fail, the option is ignored. Other expansion failures cause delivery
25287 to be deferred. If the result of expansion is an empty string, that is also
25288 ignored.
25289
25290 The expansion happens after the outgoing connection has been made and TLS
25291 started, if required. This means that the &$host$&, &$host_address$&,
25292 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25293 particular connection.
25294
25295 If the SMTP session is not authenticated, the expansion of
25296 &%authenticated_sender%& still happens (and can cause the delivery to be
25297 deferred if it fails), but no AUTH= item is added to MAIL commands
25298 unless &%authenticated_sender_force%& is true.
25299
25300 This option allows you to use the &(smtp)& transport in LMTP mode to
25301 deliver mail to Cyrus IMAP and provide the proper local part as the
25302 &"authenticated sender"&, via a setting such as:
25303 .code
25304 authenticated_sender = $local_part
25305 .endd
25306 This removes the need for IMAP subfolders to be assigned special ACLs to
25307 allow direct delivery to those subfolders.
25308
25309 Because of expected uses such as that just described for Cyrus (when no
25310 domain is involved), there is no checking on the syntax of the provided
25311 value.
25312
25313
25314 .option authenticated_sender_force smtp boolean false
25315 If this option is set true, the &%authenticated_sender%& option's value
25316 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25317 authenticated as a client.
25318
25319
25320 .option command_timeout smtp time 5m
25321 .cindex timeout "smtp transport command"
25322 This sets a timeout for receiving a response to an SMTP command that has been
25323 sent out. It is also used when waiting for the initial banner line from the
25324 remote host. Its value must not be zero.
25325
25326
25327 .option connect_timeout smtp time 5m
25328 .cindex timeout "smtp transport connect"
25329 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25330 to a remote host. A setting of zero allows the system timeout (typically
25331 several minutes) to act. To have any effect, the value of this option must be
25332 less than the system timeout. However, it has been observed that on some
25333 systems there is no system timeout, which is why the default value for this
25334 option is 5 minutes, a value recommended by RFC 1123.
25335
25336
25337 .option connection_max_messages smtp integer 500
25338 .cindex "SMTP" "passed connection"
25339 .cindex "SMTP" "multiple deliveries"
25340 .cindex "multiple SMTP deliveries"
25341 This controls the maximum number of separate message deliveries that are sent
25342 over a single TCP/IP connection. If the value is zero, there is no limit.
25343 For testing purposes, this value can be overridden by the &%-oB%& command line
25344 option.
25345
25346
25347 .option dane_require_tls_ciphers smtp string&!! unset
25348 .cindex "TLS" "requiring specific ciphers for DANE"
25349 .cindex "cipher" "requiring specific"
25350 .cindex DANE "TLS ciphers"
25351 This option may be used to override &%tls_require_ciphers%& for connections
25352 where DANE has been determined to be in effect.
25353 If not set, then &%tls_require_ciphers%& will be used.
25354 Normal SMTP delivery is not able to make strong demands of TLS cipher
25355 configuration, because delivery will fall back to plaintext.  Once DANE has
25356 been determined to be in effect, there is no plaintext fallback and making the
25357 TLS cipherlist configuration stronger will increase security, rather than
25358 counter-intuitively decreasing it.
25359 If the option expands to be empty or is forced to fail, then it will
25360 be treated as unset and &%tls_require_ciphers%& will be used instead.
25361
25362
25363 .option data_timeout smtp time 5m
25364 .cindex timeout "for transmitted SMTP data blocks"
25365 This sets a timeout for the transmission of each block in the data portion of
25366 the message. As a result, the overall timeout for a message depends on the size
25367 of the message. Its value must not be zero. See also &%final_timeout%&.
25368
25369
25370 .option dkim_canon smtp string&!! unset
25371 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25372 .option dkim_domain smtp "string list&!!" unset
25373 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25374 .option dkim_hash smtp string&!! sha256
25375 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25376 .option dkim_identity smtp string&!! unset
25377 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25378 .option dkim_private_key smtp string&!! unset
25379 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25380 .option dkim_selector smtp string&!! unset
25381 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25382 .option dkim_strict smtp string&!! unset
25383 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25384 .option dkim_sign_headers smtp string&!! "per RFC"
25385 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25386 .option dkim_timestamps smtp string&!! unset
25387 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25388
25389
25390 .option delay_after_cutoff smtp boolean true
25391 .cindex "final cutoff" "retries, controlling"
25392 .cindex retry "final cutoff"
25393 This option controls what happens when all remote IP addresses for a given
25394 domain have been inaccessible for so long that they have passed their retry
25395 cutoff times.
25396
25397 In the default state, if the next retry time has not been reached for any of
25398 them, the address is bounced without trying any deliveries. In other words,
25399 Exim delays retrying an IP address after the final cutoff time until a new
25400 retry time is reached, and can therefore bounce an address without ever trying
25401 a delivery, when machines have been down for a long time. Some people are
25402 unhappy at this prospect, so...
25403
25404 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25405 addresses are past their final cutoff time, Exim tries to deliver to those
25406 IP addresses that have not been tried since the message arrived. If there are
25407 none, of if they all fail, the address is bounced. In other words, it does not
25408 delay when a new message arrives, but immediately tries those expired IP
25409 addresses that haven't been tried since the message arrived. If there is a
25410 continuous stream of messages for the dead hosts, unsetting
25411 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25412 to them.
25413
25414
25415 .option dns_qualify_single smtp boolean true
25416 If the &%hosts%& or &%fallback_hosts%& option is being used,
25417 and the &%gethostbyname%& option is false,
25418 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25419 in chapter &<<CHAPdnslookup>>& for more details.
25420
25421
25422 .option dns_search_parents smtp boolean false
25423 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25424 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25425 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25426 details.
25427
25428
25429 .option dnssec_request_domains smtp "domain list&!!" *
25430 .cindex "MX record" "security"
25431 .cindex "DNSSEC" "MX lookup"
25432 .cindex "security" "MX lookup"
25433 .cindex "DNS" "DNSSEC"
25434 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25435 the DNSSEC request bit set. Setting this transport option is only useful if the
25436 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25437 router option.
25438
25439
25440
25441 .option dnssec_require_domains smtp "domain list&!!" unset
25442 .cindex "MX record" "security"
25443 .cindex "DNSSEC" "MX lookup"
25444 .cindex "security" "MX lookup"
25445 .cindex "DNS" "DNSSEC"
25446 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25447 the DNSSEC request bit set.  Setting this transport option is only
25448 useful if the transport overrides or sets the host names. See the
25449 &%dnssec_require_domains%& router option.
25450
25451
25452
25453 .option dscp smtp string&!! unset
25454 .cindex "DCSP" "outbound"
25455 This option causes the DSCP value associated with a socket to be set to one
25456 of a number of fixed strings or to numeric value.
25457 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25458 Common values include &`throughput`&, &`mincost`&, and on newer systems
25459 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25460
25461 The outbound packets from Exim will be marked with this value in the header
25462 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25463 that these values will have any effect, not be stripped by networking
25464 equipment, or do much of anything without cooperation with your Network
25465 Engineer and those of all network operators between the source and destination.
25466
25467
25468 .option fallback_hosts smtp "string list" unset
25469 .cindex "fallback" "hosts specified on transport"
25470 String expansion is not applied to this option. The argument must be a
25471 colon-separated list of host names or IP addresses, optionally also including
25472 port numbers, though the separator can be changed, as described in section
25473 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25474 item in a &%route_list%& setting for the &(manualroute)& router, as described
25475 in section &<<SECTformatonehostitem>>&.
25476
25477 Fallback hosts can also be specified on routers, which associate them with the
25478 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25479 &%fallback_hosts%& specified on the transport is used only if the address does
25480 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25481 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25482 However, &%hosts_randomize%& does apply to fallback host lists.
25483
25484 If Exim is unable to deliver to any of the hosts for a particular address, and
25485 the errors are not permanent rejections, the address is put on a separate
25486 transport queue with its host list replaced by the fallback hosts, unless the
25487 address was routed via MX records and the current host was in the original MX
25488 list. In that situation, the fallback host list is not used.
25489
25490 Once normal deliveries are complete, the fallback queue is delivered by
25491 re-running the same transports with the new host lists. If several failing
25492 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25493 copy of the message is sent.
25494
25495 The resolution of the host names on the fallback list is controlled by the
25496 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25497 both to cases when the host list comes with the address and when it is taken
25498 from &%hosts%&. This option provides a &"use a smart host only if delivery
25499 fails"& facility.
25500
25501
25502 .option final_timeout smtp time 10m
25503 .cindex timeout "for transmitted SMTP data accept"
25504 This is the timeout that applies while waiting for the response to the final
25505 line containing just &"."& that terminates a message. Its value must not be
25506 zero.
25507
25508 .option gethostbyname smtp boolean false
25509 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25510 being used, names are looked up using &[gethostbyname()]&
25511 (or &[getipnodebyname()]& when available)
25512 instead of using the DNS. Of course, that function may in fact use the DNS, but
25513 it may also consult other sources of information such as &_/etc/hosts_&.
25514
25515 .option gnutls_compat_mode smtp boolean unset
25516 This option controls whether GnuTLS is used in compatibility mode in an Exim
25517 server. This reduces security slightly, but improves interworking with older
25518 implementations of TLS.
25519
25520 .option helo_data smtp string&!! "see below"
25521 .cindex "HELO" "argument, setting"
25522 .cindex "EHLO" "argument, setting"
25523 .cindex "LHLO argument setting"
25524 The value of this option is expanded after a connection to a another host has
25525 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25526 command that starts the outgoing SMTP or LMTP session. The default value of the
25527 option is:
25528 .code
25529 $primary_hostname
25530 .endd
25531 During the expansion, the variables &$host$& and &$host_address$& are set to
25532 the identity of the remote host, and the variables &$sending_ip_address$& and
25533 &$sending_port$& are set to the local IP address and port number that are being
25534 used. These variables can be used to generate different values for different
25535 servers or different local IP addresses. For example, if you want the string
25536 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25537 interface address, you could use this:
25538 .code
25539 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25540   {${listextract{1}{<\n $value}}} \
25541   {$primary_hostname}}
25542 .endd
25543 The use of &%helo_data%& applies both to sending messages and when doing
25544 callouts.
25545
25546 .option host_name_extract smtp "string list&!!" "see below"
25547 .cindex "load balancer" "hosts behind"
25548 .cindex TLS resumption
25549 Some mail-accepting sites
25550 (notably Microsoft)
25551 operate many servers behind a network load-balancer.  When this is done,
25552 with separated TLS session caches, TLS session resuption becomes problematic.
25553 It will only succeed when the same server happens to be selected by the
25554 load-balancer, matching the session stored in the client's cache.
25555
25556 Exim can pull out a server name, if there is one, from the response to the
25557 client's SMTP EHLO command.
25558 The default value of this option:
25559 .code
25560     ${if and { {match {$host} {.outlook.com\$}} \
25561                {match {$item} {\N^250-([\w.]+)\s\N}} \
25562              } {$1}}
25563 .endd
25564 suffices for one known case.
25565 During the expansion of this option the &$item$& variable will have the
25566 server's EHLO response.
25567 The result of the option expansion is included in the key used to store and
25568 retrieve the TLS session, for session resumption.
25569
25570 Operators of high-load sites may wish to evaluate their logs for indications
25571 of other destination sites operating load-balancers, and develop a suitable
25572 expression for this option.
25573 The smtp:ehlo event and the &$tls_out_resumption$& variable
25574 will be useful for such work.
25575
25576 .option hosts smtp "string list&!!" unset
25577 Hosts are associated with an address by a router such as &(dnslookup)&, which
25578 finds the hosts by looking up the address domain in the DNS, or by
25579 &(manualroute)&, which has lists of hosts in its configuration. However,
25580 email addresses can be passed to the &(smtp)& transport by any router, and not
25581 all of them can provide an associated list of hosts.
25582
25583 The &%hosts%& option specifies a list of hosts to be used if the address being
25584 processed does not have any hosts associated with it. The hosts specified by
25585 &%hosts%& are also used, whether or not the address has its own hosts, if
25586 &%hosts_override%& is set.
25587
25588 The string is first expanded, before being interpreted as a colon-separated
25589 list of host names or IP addresses, possibly including port numbers. The
25590 separator may be changed to something other than colon, as described in section
25591 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25592 item in a &%route_list%& setting for the &(manualroute)& router, as described
25593 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25594 of the &(manualroute)& router is not available here.
25595
25596 If the expansion fails, delivery is deferred. Unless the failure was caused by
25597 the inability to complete a lookup, the error is logged to the panic log as
25598 well as the main log. Host names are looked up either by searching directly for
25599 address records in the DNS or by calling &[gethostbyname()]& (or
25600 &[getipnodebyname()]& when available), depending on the setting of the
25601 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25602 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25603 address are used.
25604
25605 During delivery, the hosts are tried in order, subject to their retry status,
25606 unless &%hosts_randomize%& is set.
25607
25608
25609 .option hosts_avoid_esmtp smtp "host list&!!" unset
25610 .cindex "ESMTP, avoiding use of"
25611 .cindex "HELO" "forcing use of"
25612 .cindex "EHLO" "avoiding use of"
25613 .cindex "PIPELINING" "avoiding the use of"
25614 This option is for use with broken hosts that announce ESMTP facilities (for
25615 example, PIPELINING) and then fail to implement them properly. When a host
25616 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25617 start of the SMTP session. This means that it cannot use any of the ESMTP
25618 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25619
25620
25621 .option hosts_avoid_pipelining smtp "host list&!!" unset
25622 .cindex "PIPELINING" "avoiding the use of"
25623 .cindex "ESMTP extensions" PIPELINING
25624 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25625 that matches this list, even if the server host advertises PIPELINING support.
25626
25627 .option hosts_pipe_connect smtp "host list&!!" unset
25628 .cindex "pipelining" "early connection"
25629 .cindex "pipelining" PIPECONNECT
25630 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25631 this option controls which to hosts the facility watched for
25632 and recorded, and used for subsequent connections.
25633
25634 The retry hints database is used for the record,
25635 and records are subject to the &%retry_data_expire%& option.
25636 When used, the pipelining saves on roundtrip times.
25637 It also turns SMTP into a client-first protocol
25638 so combines well with TCP Fast Open.
25639
25640 See also the &%pipelining_connect_advertise_hosts%& main option.
25641
25642 Note:
25643 When the facility is used, if the transport &%interface%& option is unset
25644 the &%helo_data%& option
25645 will be expanded before the &$sending_ip_address$& variable
25646 is filled in.
25647 A check is made for the use of that variable, without the
25648 presence of a &"def:"& test on it, but suitably complex coding
25649 can avoid the check and produce unexpected results.
25650 You have been warned.
25651
25652
25653 .option hosts_avoid_tls smtp "host list&!!" unset
25654 .cindex "TLS" "avoiding for certain hosts"
25655 Exim will not try to start a TLS session when delivering to any host that
25656 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25657
25658 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25659 .cindex "TLS" "avoiding for certain hosts"
25660 Exim will not try to start a TLS session for a verify callout,
25661 or when delivering in cutthrough mode,
25662 to any host that matches this list.
25663
25664
25665 .option hosts_max_try smtp integer 5
25666 .cindex "host" "maximum number to try"
25667 .cindex "limit" "number of hosts tried"
25668 .cindex "limit" "number of MX tried"
25669 .cindex "MX record" "maximum tried"
25670 This option limits the number of IP addresses that are tried for any one
25671 delivery in cases where there are temporary delivery errors. Section
25672 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25673
25674
25675 .option hosts_max_try_hardlimit smtp integer 50
25676 This is an additional check on the maximum number of IP addresses that Exim
25677 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25678 why it exists.
25679
25680
25681
25682 .option hosts_nopass_tls smtp "host list&!!" unset
25683 .cindex "TLS" "passing connection"
25684 .cindex "multiple SMTP deliveries"
25685 .cindex "TLS" "multiple message deliveries"
25686 For any host that matches this list, a connection on which a TLS session has
25687 been started will not be passed to a new delivery process for sending another
25688 message on the same connection. See section &<<SECTmulmessam>>& for an
25689 explanation of when this might be needed.
25690
25691 .option hosts_noproxy_tls smtp "host list&!!" unset
25692 .cindex "TLS" "passing connection"
25693 .cindex "multiple SMTP deliveries"
25694 .cindex "TLS" "multiple message deliveries"
25695 For any host that matches this list, a TLS session which has
25696 been started will not be passed to a new delivery process for sending another
25697 message on the same session.
25698
25699 The traditional implementation closes down TLS and re-starts it in the new
25700 process, on the same open TCP connection, for each successive message
25701 sent.  If permitted by this option a pipe to to the new process is set up
25702 instead, and the original process maintains the TLS connection and proxies
25703 the SMTP connection from and to the new process and any subsequents.
25704 The new process has no access to TLS information, so cannot include it in
25705 logging.
25706
25707
25708
25709 .option hosts_override smtp boolean false
25710 If this option is set and the &%hosts%& option is also set, any hosts that are
25711 attached to the address are ignored, and instead the hosts specified by the
25712 &%hosts%& option are always used. This option does not apply to
25713 &%fallback_hosts%&.
25714
25715
25716 .option hosts_randomize smtp boolean false
25717 .cindex "randomized host list"
25718 .cindex "host" "list of; randomized"
25719 .cindex "fallback" "randomized hosts"
25720 If this option is set, and either the list of hosts is taken from the
25721 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25722 were not obtained from MX records (this includes fallback hosts from the
25723 router), and were not randomized by the router, the order of trying the hosts
25724 is randomized each time the transport runs. Randomizing the order of a host
25725 list can be used to do crude load sharing.
25726
25727 When &%hosts_randomize%& is true, a host list may be split into groups whose
25728 order is separately randomized. This makes it possible to set up MX-like
25729 behaviour. The boundaries between groups are indicated by an item that is just
25730 &`+`& in the host list. For example:
25731 .code
25732 hosts = host1:host2:host3:+:host4:host5
25733 .endd
25734 The order of the first three hosts and the order of the last two hosts is
25735 randomized for each use, but the first three always end up before the last two.
25736 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25737
25738 .option hosts_require_auth smtp "host list&!!" unset
25739 .cindex "authentication" "required by client"
25740 This option provides a list of servers for which authentication must succeed
25741 before Exim will try to transfer a message. If authentication fails for
25742 servers which are not in this list, Exim tries to send unauthenticated. If
25743 authentication fails for one of these servers, delivery is deferred. This
25744 temporary error is detectable in the retry rules, so it can be turned into a
25745 hard failure if required. See also &%hosts_try_auth%&, and chapter
25746 &<<CHAPSMTPAUTH>>& for details of authentication.
25747
25748
25749 .option hosts_request_ocsp smtp "host list&!!" "see below"
25750 .cindex "TLS" "requiring for certain servers"
25751 Exim will request a Certificate Status on a
25752 TLS session for any host that matches this list.
25753 &%tls_verify_certificates%& should also be set for the transport.
25754
25755 .new
25756 The default is &"**"& if DANE is not in use for the connection,
25757 or if DANE-TA us used.
25758 It is empty if DANE-EE is used.
25759 .wen
25760
25761 .option hosts_require_alpn smtp "host list&!!" unset
25762 .cindex ALPN "require negotiation in client"
25763 .cindex TLS ALPN
25764 .cindex TLS "Application Layer Protocol Names"
25765 If the TLS library supports ALPN
25766 then a successful negotiation of ALPN will be required for any host
25767 matching the list, for TLS to be used.
25768 See also the &%tls_alpn%& option.
25769
25770 &*Note*&: prevention of fallback to in-clear connection is not
25771 managed by this option; see &%hosts_require_tls%&.
25772
25773 .option hosts_require_dane smtp "host list&!!" unset
25774 .cindex DANE "transport options"
25775 .cindex DANE "requiring for certain servers"
25776 If built with DANE support, Exim  will require that a DNSSEC-validated
25777 TLSA record is present for any host matching the list,
25778 and that a DANE-verified TLS connection is made.
25779 There will be no fallback to in-clear communication.
25780 See the &%dnssec_request_domains%& router and transport options.
25781 See section &<<SECDANE>>&.
25782
25783 .option hosts_require_ocsp smtp "host list&!!" unset
25784 .cindex "TLS" "requiring for certain servers"
25785 Exim will request, and check for a valid Certificate Status being given, on a
25786 TLS session for any host that matches this list.
25787 &%tls_verify_certificates%& should also be set for the transport.
25788
25789 .option hosts_require_tls smtp "host list&!!" unset
25790 .cindex "TLS" "requiring for certain servers"
25791 Exim will insist on using a TLS session when delivering to any host that
25792 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25793 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25794 incoming messages, use an appropriate ACL.
25795
25796 .option hosts_try_auth smtp "host list&!!" unset
25797 .cindex "authentication" "optional in client"
25798 This option provides a list of servers to which, provided they announce
25799 authentication support, Exim will attempt to authenticate as a client when it
25800 connects. If authentication fails
25801 and &%hosts_require_auth%& permits,
25802 Exim will try to transfer the message unauthenticated.
25803 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25804
25805 .option hosts_try_chunking smtp "host list&!!" *
25806 .cindex CHUNKING "enabling, in client"
25807 .cindex BDAT "SMTP command"
25808 .cindex "RFC 3030" "CHUNKING"
25809 This option provides a list of servers to which, provided they announce
25810 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25811 Unless DKIM signing is being done,
25812 BDAT will not be used in conjunction with a transport filter.
25813
25814 .option hosts_try_dane smtp "host list&!!" *
25815 .cindex DANE "transport options"
25816 .cindex DANE "attempting for certain servers"
25817 If built with DANE support, Exim  will look up a
25818 TLSA record for any host matching the list,
25819 If one is found and that lookup was DNSSEC-validated,
25820 then Exim requires that a DANE-verified TLS connection is made for that host;
25821 there will be no fallback to in-clear communication.
25822 See the &%dnssec_request_domains%& router and transport options.
25823 See section &<<SECDANE>>&.
25824
25825 .option hosts_try_fastopen smtp "host list&!!" *
25826 .cindex "fast open, TCP" "enabling, in client"
25827 .cindex "TCP Fast Open" "enabling, in client"
25828 .cindex "RFC 7413" "TCP Fast Open"
25829 This option provides a list of servers to which, provided
25830 the facility is supported by this system, Exim will attempt to
25831 perform a TCP Fast Open.
25832 No data is sent on the SYN segment but, if the remote server also
25833 supports the facility, it can send its SMTP banner immediately after
25834 the SYN,ACK segment.  This can save up to one round-trip time.
25835
25836 The facility is only active for previously-contacted servers,
25837 as the initiator must present a cookie in the SYN segment.
25838
25839 On (at least some) current Linux distributions the facility must be enabled
25840 in the kernel by the sysadmin before the support is usable.
25841 There is no option for control of the server side; if the system supports
25842 it it is always enabled.  Note that lengthy operations in the connect ACL,
25843 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25844
25845 .option hosts_try_prdr smtp "host list&!!" *
25846 .cindex "PRDR" "enabling, optional in client"
25847 .cindex "ESMTP extensions" PRDR
25848 This option provides a list of servers to which, provided they announce
25849 PRDR support, Exim will attempt to negotiate PRDR
25850 for multi-recipient messages.
25851 The option can usually be left as default.
25852
25853 .option interface smtp "string list&!!" unset
25854 .cindex "bind IP address"
25855 .cindex "IP address" "binding"
25856 .vindex "&$host$&"
25857 .vindex "&$host_address$&"
25858 This option specifies which interface to bind to when making an outgoing SMTP
25859 call. The value is an IP address, not an interface name such as
25860 &`eth0`&. Do not confuse this with the interface address that was used when a
25861 message was received, which is in &$received_ip_address$&, formerly known as
25862 &$interface_address$&. The name was changed to minimize confusion with the
25863 outgoing interface address. There is no variable that contains an outgoing
25864 interface address because, unless it is set by this option, its value is
25865 unknown.
25866
25867 During the expansion of the &%interface%& option the variables &$host$& and
25868 &$host_address$& refer to the host to which a connection is about to be made
25869 during the expansion of the string. Forced expansion failure, or an empty
25870 string result causes the option to be ignored. Otherwise, after expansion, the
25871 string must be a list of IP addresses, colon-separated by default, but the
25872 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25873 For example:
25874 .code
25875 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25876 .endd
25877 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25878 connection. If none of them are the correct type, the option is ignored. If
25879 &%interface%& is not set, or is ignored, the system's IP functions choose which
25880 interface to use if the host has more than one.
25881
25882
25883 .option keepalive smtp boolean true
25884 .cindex "keepalive" "on outgoing connection"
25885 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25886 connections. When set, it causes the kernel to probe idle connections
25887 periodically, by sending packets with &"old"& sequence numbers. The other end
25888 of the connection should send a acknowledgment if the connection is still okay
25889 or a reset if the connection has been aborted. The reason for doing this is
25890 that it has the beneficial effect of freeing up certain types of connection
25891 that can get stuck when the remote host is disconnected without tidying up the
25892 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25893 unreachable hosts.
25894
25895
25896 .option lmtp_ignore_quota smtp boolean false
25897 .cindex "LMTP" "ignoring quota errors"
25898 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25899 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25900 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25901
25902 .option max_rcpt smtp integer&!! 100
25903 .cindex "RCPT" "maximum number of outgoing"
25904 This option,
25905 .new
25906 after expansion,
25907 .wen
25908 limits the number of RCPT commands that are sent in a single
25909 SMTP message transaction.
25910 A value setting of zero disables the limit.
25911
25912 .new
25913 If a constant is given,
25914 .wen
25915 each set of addresses is treated independently, and
25916 so can cause parallel connections to the same host if &%remote_max_parallel%&
25917 permits this.
25918
25919
25920 .option message_linelength_limit smtp integer 998
25921 .cindex "line length" limit
25922 This option sets the maximum line length, in bytes, that the transport
25923 will send.  Any messages with lines exceeding the given value
25924 will fail and a failure-DSN ("bounce") message will if possible be returned
25925 to the sender.
25926 The default value is that defined by the SMTP standards.
25927
25928 It is generally wise to also check in the data ACL so that messages
25929 received via SMTP can be refused without producing a bounce.
25930
25931
25932 .option multi_domain smtp boolean&!! true
25933 .vindex "&$domain$&"
25934 When this option is set, the &(smtp)& transport can handle a number of
25935 addresses containing a mixture of different domains provided they all resolve
25936 to the same list of hosts. Turning the option off restricts the transport to
25937 handling only one domain at a time. This is useful if you want to use
25938 &$domain$& in an expansion for the transport, because it is set only when there
25939 is a single domain involved in a remote delivery.
25940
25941 It is expanded per-address and can depend on any of
25942 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25943 &$host$&, &$host_address$& and &$host_port$&.
25944
25945 If the connection is DANE-enabled then this option is ignored;
25946 only messages having the domain used for the DANE TLSA lookup are
25947 sent on the connection.
25948
25949 .option port smtp string&!! "see below"
25950 .cindex "port" "sending TCP/IP"
25951 .cindex "TCP/IP" "setting outgoing port"
25952 This option specifies the TCP/IP port on the server to which Exim connects.
25953 &*Note:*& Do not confuse this with the port that was used when a message was
25954 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25955 The name was changed to minimize confusion with the outgoing port. There is no
25956 variable that contains an outgoing port.
25957
25958 If the value of this option begins with a digit it is taken as a port number;
25959 otherwise it is looked up using &[getservbyname()]&. The default value is
25960 normally &"smtp"&,
25961 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25962 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25963 If the expansion fails, or if a port number cannot be found, delivery
25964 is deferred.
25965
25966 Note that at least one Linux distribution has been seen failing
25967 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25968
25969
25970
25971 .option protocol smtp string smtp
25972 .cindex "LMTP" "over TCP/IP"
25973 .cindex "ssmtp protocol" "outbound"
25974 .cindex "TLS" "SSL-on-connect outbound"
25975 .vindex "&$port$&"
25976 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25977 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25978 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25979 deliveries into closed message stores. Exim also has support for running LMTP
25980 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25981
25982 If this option is set to &"smtps"&, the default value for the &%port%& option
25983 changes to &"smtps"&, and the transport initiates TLS immediately after
25984 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25985 The Internet standards bodies used to strongly discourage use of this mode,
25986 but as of RFC 8314 it is preferred over STARTTLS for message submission
25987 (as distinct from MTA-MTA communication).
25988
25989
25990 .option retry_include_ip_address smtp boolean&!! true
25991 Exim normally includes both the host name and the IP address in the key it
25992 constructs for indexing retry data after a temporary delivery failure. This
25993 means that when one of several IP addresses for a host is failing, it gets
25994 tried periodically (controlled by the retry rules), but use of the other IP
25995 addresses is not affected.
25996
25997 However, in some dialup environments hosts are assigned a different IP address
25998 each time they connect. In this situation the use of the IP address as part of
25999 the retry key leads to undesirable behaviour. Setting this option false causes
26000 Exim to use only the host name.
26001 Since it is expanded it can be made to depend on the host or domain.
26002
26003
26004 .option serialize_hosts smtp "host list&!!" unset
26005 .cindex "serializing connections"
26006 .cindex "host" "serializing connections"
26007 Because Exim operates in a distributed manner, if several messages for the same
26008 host arrive at around the same time, more than one simultaneous connection to
26009 the remote host can occur. This is not usually a problem except when there is a
26010 slow link between the hosts. In that situation it may be helpful to restrict
26011 Exim to one connection at a time. This can be done by setting
26012 &%serialize_hosts%& to match the relevant hosts.
26013
26014 .cindex "hints database" "serializing deliveries to a host"
26015 Exim implements serialization by means of a hints database in which a record is
26016 written whenever a process connects to one of the restricted hosts. The record
26017 is deleted when the connection is completed. Obviously there is scope for
26018 records to get left lying around if there is a system or program crash. To
26019 guard against this, Exim ignores any records that are more than six hours old.
26020
26021 If you set up this kind of serialization, you should also arrange to delete the
26022 relevant hints database whenever your system reboots. The names of the files
26023 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26024 may be one or two files, depending on the type of DBM in use. The same files
26025 are used for ETRN serialization.
26026
26027 See also the &%max_parallel%& generic transport option.
26028
26029
26030 .option size_addition smtp integer 1024
26031 .cindex "SIZE" "ESMTP extension"
26032 .cindex "message" "size issue for transport filter"
26033 .cindex "size" "of message"
26034 .cindex "transport" "filter"
26035 .cindex "filter" "transport filter"
26036 If a remote SMTP server indicates that it supports the SIZE option of the
26037 MAIL command, Exim uses this to pass over the message size at the start of
26038 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26039 sends, to allow for headers and other text that may be added during delivery by
26040 configuration options or in a transport filter. It may be necessary to increase
26041 this if a lot of text is added to messages.
26042
26043 Alternatively, if the value of &%size_addition%& is set negative, it disables
26044 the use of the SIZE option altogether.
26045
26046
26047 .option socks_proxy smtp string&!! unset
26048 .cindex proxy SOCKS
26049 This option enables use of SOCKS proxies for connections made by the
26050 transport.  For details see section &<<SECTproxySOCKS>>&.
26051
26052
26053 .option tls_alpn smtp string&!! unset
26054 .cindex TLS "Application Layer Protocol Names"
26055 .cindex TLS ALPN
26056 .cindex ALPN "set name in client"
26057 If this option is set
26058 and the TLS library supports ALPN,
26059 the value given is used.
26060
26061 As of writing no value has been standardised for email use.
26062 The authors suggest using &"smtp"&.
26063
26064
26065
26066 .option tls_certificate smtp string&!! unset
26067 .cindex "TLS" "client certificate, location of"
26068 .cindex "certificate" "client, location of"
26069 .vindex "&$host$&"
26070 .vindex "&$host_address$&"
26071 The value of this option must be the absolute path to a file which contains the
26072 client's certificate, for possible use when sending a message over an encrypted
26073 connection. The values of &$host$& and &$host_address$& are set to the name and
26074 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26075 details of TLS.
26076
26077 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26078 certificate when sending messages as a client. The global option of the same
26079 name specifies the certificate for Exim as a server; it is not automatically
26080 assumed that the same certificate should be used when Exim is operating as a
26081 client.
26082
26083
26084 .option tls_crl smtp string&!! unset
26085 .cindex "TLS" "client certificate revocation list"
26086 .cindex "certificate" "revocation list for client"
26087 This option specifies a certificate revocation list. The expanded value must
26088 be the name of a file that contains a CRL in PEM format.
26089
26090
26091 .option tls_dh_min_bits smtp integer 1024
26092 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26093 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26094 key agreement is negotiated, the server will provide a large prime number
26095 for use.  This option establishes the minimum acceptable size of that number.
26096 If the parameter offered by the server is too small, then the TLS handshake
26097 will fail.
26098
26099 Only supported when using GnuTLS.
26100
26101
26102 .option tls_privatekey smtp string&!! unset
26103 .cindex "TLS" "client private key, location of"
26104 .vindex "&$host$&"
26105 .vindex "&$host_address$&"
26106 The value of this option must be the absolute path to a file which contains the
26107 client's private key. This is used when sending a message over an encrypted
26108 connection using a client certificate. The values of &$host$& and
26109 &$host_address$& are set to the name and address of the server during the
26110 expansion. If this option is unset, or the expansion is forced to fail, or the
26111 result is an empty string, the private key is assumed to be in the same file as
26112 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26113
26114
26115 .option tls_require_ciphers smtp string&!! unset
26116 .cindex "TLS" "requiring specific ciphers"
26117 .cindex "cipher" "requiring specific"
26118 .vindex "&$host$&"
26119 .vindex "&$host_address$&"
26120 The value of this option must be a list of permitted cipher suites, for use
26121 when setting up an outgoing encrypted connection. (There is a global option of
26122 the same name for controlling incoming connections.) The values of &$host$& and
26123 &$host_address$& are set to the name and address of the server during the
26124 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26125 is used in different ways by OpenSSL and GnuTLS (see sections
26126 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26127 ciphers is a preference order.
26128
26129
26130 .option tls_resumption_hosts smtp "host list&!!" unset
26131 .cindex TLS resumption
26132 This option controls which connections to use the TLS resumption feature.
26133 See &<<SECTresumption>>& for details.
26134
26135
26136
26137 .option tls_sni smtp string&!! unset
26138 .cindex "TLS" "Server Name Indication"
26139 .cindex "TLS" SNI
26140 .cindex SNI "setting in client"
26141 .vindex "&$tls_sni$&"
26142 If this option is set
26143 and the connection is not DANE-validated
26144 then it sets the $tls_out_sni variable and causes any
26145 TLS session to pass this value as the Server Name Indication extension to
26146 the remote side, which can be used by the remote side to select an appropriate
26147 certificate and private key for the session.
26148
26149 See &<<SECTtlssni>>& for more information.
26150
26151 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26152 TLS extensions.
26153
26154
26155
26156
26157 .option tls_tempfail_tryclear smtp boolean true
26158 .cindex "4&'xx'& responses" "to STARTTLS"
26159 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26160 setting up a TLS session, this option determines whether or not Exim should try
26161 to deliver the message unencrypted. If it is set false, delivery to the
26162 current host is deferred; if there are other hosts, they are tried. If this
26163 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26164 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26165 TLS negotiation fails, Exim closes the current connection (because it is in an
26166 unknown state), opens a new one to the same host, and then tries the delivery
26167 in clear.
26168
26169
26170 .option tls_try_verify_hosts smtp "host list&!!" *
26171 .cindex "TLS" "server certificate verification"
26172 .cindex "certificate" "verification of server"
26173 This option gives a list of hosts for which, on encrypted connections,
26174 certificate verification will be tried but need not succeed.
26175 The &%tls_verify_certificates%& option must also be set.
26176 Note that unless the host is in this list
26177 TLS connections will be denied to hosts using self-signed certificates
26178 when &%tls_verify_certificates%& is matched.
26179 The &$tls_out_certificate_verified$& variable is set when
26180 certificate verification succeeds.
26181
26182
26183 .option tls_verify_cert_hostnames smtp "host list&!!" *
26184 .cindex "TLS" "server certificate hostname verification"
26185 .cindex "certificate" "verification of server"
26186 This option give a list of hosts for which,
26187 while verifying the server certificate,
26188 checks will be included on the host name
26189 (note that this will generally be the result of a DNS MX lookup)
26190 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26191 Wildcard names are permitted,
26192 limited to being the initial component of a 3-or-more component FQDN.
26193
26194 There is no equivalent checking on client certificates.
26195
26196
26197 .option tls_verify_certificates smtp string&!! system
26198 .cindex "TLS" "server certificate verification"
26199 .cindex "certificate" "verification of server"
26200 .vindex "&$host$&"
26201 .vindex "&$host_address$&"
26202 The value of this option must be either the
26203 word "system"
26204 or the absolute path to
26205 a file or directory containing permitted certificates for servers,
26206 for use when setting up an encrypted connection.
26207
26208 The "system" value for the option will use a location compiled into the SSL library.
26209 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26210 is taken as empty and an explicit location
26211 must be specified.
26212
26213 The use of a directory for the option value is not available for GnuTLS versions
26214 preceding 3.3.6 and a single file must be used.
26215
26216 With OpenSSL the certificates specified
26217 explicitly
26218 either by file or directory
26219 are added to those given by the system default location.
26220
26221 The values of &$host$& and
26222 &$host_address$& are set to the name and address of the server during the
26223 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26224
26225 For back-compatibility,
26226 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26227 (a single-colon empty list counts as being set)
26228 and certificate verification fails the TLS connection is closed.
26229
26230
26231 .option tls_verify_hosts smtp "host list&!!" unset
26232 .cindex "TLS" "server certificate verification"
26233 .cindex "certificate" "verification of server"
26234 This option gives a list of hosts for which, on encrypted connections,
26235 certificate verification must succeed.
26236 The &%tls_verify_certificates%& option must also be set.
26237 If both this option and &%tls_try_verify_hosts%& are unset
26238 operation is as if this option selected all hosts.
26239 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26240 that connections use TLS.
26241 Fallback to in-clear communication will be done unless restricted by
26242 the &%hosts_require_tls%& option.
26243
26244 .option utf8_downconvert smtp integer&!! -1
26245 .cindex utf8 "address downconversion"
26246 .cindex i18n "utf8 address downconversion"
26247 If built with internationalization support,
26248 this option controls conversion of UTF-8 in message envelope addresses
26249 to a-label form.
26250 If, after expansion, the value is 1, 0, or -1 then this value overrides
26251 any value previously set for the message.  Otherwise, any previously
26252 set value is used.  To permit use of a previous value,
26253 set this option to an empty string.
26254 For details on the values see section &<<SECTi18nMTA>>&.
26255
26256
26257
26258
26259 .section "How the limits for the number of hosts to try are used" &&&
26260          "SECTvalhosmax"
26261 .cindex "host" "maximum number to try"
26262 .cindex "limit" "hosts; maximum number tried"
26263 There are two options that are concerned with the number of hosts that are
26264 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26265 &%hosts_max_try_hardlimit%&.
26266
26267
26268 The &%hosts_max_try%& option limits the number of hosts that are tried
26269 for a single delivery. However, despite the term &"host"& in its name, the
26270 option actually applies to each IP address independently. In other words, a
26271 multihomed host is treated as several independent hosts, just as it is for
26272 retrying.
26273
26274 Many of the larger ISPs have multiple MX records which often point to
26275 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26276 created as a result of routing one of these domains.
26277
26278 Trying every single IP address on such a long list does not seem sensible; if
26279 several at the top of the list fail, it is reasonable to assume there is some
26280 problem that is likely to affect all of them. Roughly speaking, the value of
26281 &%hosts_max_try%& is the maximum number that are tried before deferring the
26282 delivery. However, the logic cannot be quite that simple.
26283
26284 Firstly, IP addresses that are skipped because their retry times have not
26285 arrived do not count, and in addition, addresses that are past their retry
26286 limits are also not counted, even when they are tried. This means that when
26287 some IP addresses are past their retry limits, more than the value of
26288 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26289 that all IP addresses are considered before timing out an email address (but
26290 see below for an exception).
26291
26292 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26293 list to see if there is a subsequent host with a different (higher valued) MX.
26294 If there is, that host is considered next, and the current IP address is used
26295 but not counted. This behaviour helps in the case of a domain with a retry rule
26296 that hardly ever delays any hosts, as is now explained:
26297
26298 Consider the case of a long list of hosts with one MX value, and a few with a
26299 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26300 hosts at the top of the list are tried at first. With the default retry rule,
26301 which specifies increasing retry times, the higher MX hosts are eventually
26302 tried when those at the top of the list are skipped because they have not
26303 reached their retry times.
26304
26305 However, it is common practice to put a fixed short retry time on domains for
26306 large ISPs, on the grounds that their servers are rarely down for very long.
26307 Unfortunately, these are exactly the domains that tend to resolve to long lists
26308 of hosts. The short retry time means that the lowest MX hosts are tried every
26309 time. The attempts may be in a different order because of random sorting, but
26310 without the special MX check, the higher MX hosts would never be tried until
26311 all the lower MX hosts had timed out (which might be several days), because
26312 there are always some lower MX hosts that have reached their retry times. With
26313 the special check, Exim considers at least one IP address from each MX value at
26314 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26315 reached.
26316
26317 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26318 particular, Exim normally eventually tries all the IP addresses before timing
26319 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26320 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26321 been set up with hundreds of IP addresses for some domains. It can
26322 take a very long time indeed for an address to time out in these cases.
26323
26324 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26325 Exim never tries more than this number of IP addresses; if it hits this limit
26326 and they are all timed out, the email address is bounced, even though not all
26327 possible IP addresses have been tried.
26328 .ecindex IIDsmttra1
26329 .ecindex IIDsmttra2
26330
26331
26332
26333
26334
26335 . ////////////////////////////////////////////////////////////////////////////
26336 . ////////////////////////////////////////////////////////////////////////////
26337
26338 .chapter "Address rewriting" "CHAPrewrite"
26339 .scindex IIDaddrew "rewriting" "addresses"
26340 There are some circumstances in which Exim automatically rewrites domains in
26341 addresses. The two most common are when an address is given without a domain
26342 (referred to as an &"unqualified address"&) or when an address contains an
26343 abbreviated domain that is expanded by DNS lookup.
26344
26345 Unqualified envelope addresses are accepted only for locally submitted
26346 messages, or for messages that are received from hosts matching
26347 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26348 appropriate. Unqualified addresses in header lines are qualified if they are in
26349 locally submitted messages, or messages from hosts that are permitted to send
26350 unqualified envelope addresses. Otherwise, unqualified addresses in header
26351 lines are neither qualified nor rewritten.
26352
26353 One situation in which Exim does &'not'& automatically rewrite a domain is
26354 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26355 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26356 do this. The new RFCs do not contain this suggestion.
26357
26358
26359 .section "Explicitly configured address rewriting" "SECID147"
26360 This chapter describes the rewriting rules that can be used in the
26361 main rewrite section of the configuration file, and also in the generic
26362 &%headers_rewrite%& option that can be set on any transport.
26363
26364 Some people believe that configured address rewriting is a Mortal Sin.
26365 Others believe that life is not possible without it. Exim provides the
26366 facility; you do not have to use it.
26367
26368 The main rewriting rules that appear in the &"rewrite"& section of the
26369 configuration file are applied to addresses in incoming messages, both envelope
26370 addresses and addresses in header lines. Each rule specifies the types of
26371 address to which it applies.
26372
26373 Whether or not addresses in header lines are rewritten depends on the origin of
26374 the headers and the type of rewriting. Global rewriting, that is, rewriting
26375 rules from the rewrite section of the configuration file, is applied only to
26376 those headers that were received with the message. Header lines that are added
26377 by ACLs or by a system filter or by individual routers or transports (which
26378 are specific to individual recipient addresses) are not rewritten by the global
26379 rules.
26380
26381 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26382 applies all headers except those added by routers and transports. That is, as
26383 well as the headers that were received with the message, it also applies to
26384 headers that were added by an ACL or a system filter.
26385
26386
26387 In general, rewriting addresses from your own system or domain has some
26388 legitimacy. Rewriting other addresses should be done only with great care and
26389 in special circumstances. The author of Exim believes that rewriting should be
26390 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26391 Although it can sometimes be used as a routing tool, this is very strongly
26392 discouraged.
26393
26394 There are two commonly encountered circumstances where rewriting is used, as
26395 illustrated by these examples:
26396
26397 .ilist
26398 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26399 exchange mail with each other behind a firewall, but there is only a single
26400 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26401 &'hitch.fict.example'& when sending mail off-site.
26402 .next
26403 A host rewrites the local parts of its own users so that, for example,
26404 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26405 .endlist
26406
26407
26408
26409 .section "When does rewriting happen?" "SECID148"
26410 .cindex "rewriting" "timing of"
26411 .cindex "&ACL;" "rewriting addresses in"
26412 Configured address rewriting can take place at several different stages of a
26413 message's processing.
26414
26415 .vindex "&$sender_address$&"
26416 At the start of an ACL for MAIL, the sender address may have been rewritten
26417 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26418 ordinary rewrite rules have yet been applied. If, however, the sender address
26419 is verified in the ACL, it is rewritten before verification, and remains
26420 rewritten thereafter. The subsequent value of &$sender_address$& is the
26421 rewritten address. This also applies if sender verification happens in a
26422 RCPT ACL. Otherwise, when the sender address is not verified, it is
26423 rewritten as soon as a message's header lines have been received.
26424
26425 .vindex "&$domain$&"
26426 .vindex "&$local_part$&"
26427 Similarly, at the start of an ACL for RCPT, the current recipient's address
26428 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26429 rewrite rules have yet been applied to it. However, the behaviour is different
26430 from the sender address when a recipient is verified. The address is rewritten
26431 for the verification, but the rewriting is not remembered at this stage. The
26432 value of &$local_part$& and &$domain$& after verification are always the same
26433 as they were before (that is, they contain the unrewritten &-- except for
26434 SMTP-time rewriting &-- address).
26435
26436 As soon as a message's header lines have been received, all the envelope
26437 recipient addresses are permanently rewritten, and rewriting is also applied to
26438 the addresses in the header lines (if configured). This happens before adding
26439 any header lines that were specified in MAIL or RCPT ACLs, and
26440 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26441 before the DATA ACL and &[local_scan()]& functions are run.
26442
26443 When an address is being routed, either for delivery or for verification,
26444 rewriting is applied immediately to child addresses that are generated by
26445 redirection, unless &%no_rewrite%& is set on the router.
26446
26447 .cindex "envelope from"
26448 .cindex "envelope sender" "rewriting at transport time"
26449 .cindex "rewriting" "at transport time"
26450 .cindex "header lines" "rewriting at transport time"
26451 At transport time, additional rewriting of addresses in header lines can be
26452 specified by setting the generic &%headers_rewrite%& option on a transport.
26453 This option contains rules that are identical in form to those in the rewrite
26454 section of the configuration file. They are applied to the original message
26455 header lines and any that were added by ACLs or a system filter. They are not
26456 applied to header lines that are added by routers or the transport.
26457
26458 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26459 transport option. However, it is not possible to rewrite envelope recipients at
26460 transport time.
26461
26462
26463
26464
26465 .section "Testing the rewriting rules that apply on input" "SECID149"
26466 .cindex "rewriting" "testing"
26467 .cindex "testing" "rewriting"
26468 Exim's input rewriting configuration appears in a part of the runtime
26469 configuration file headed by &"begin rewrite"&. It can be tested by the
26470 &%-brw%& command line option. This takes an address (which can be a full RFC
26471 2822 address) as its argument. The output is a list of how the address would be
26472 transformed by the rewriting rules for each of the different places it might
26473 appear in an incoming message, that is, for each different header and for the
26474 envelope sender and recipient fields. For example,
26475 .code
26476 exim -brw ph10@exim.workshop.example
26477 .endd
26478 might produce the output
26479 .code
26480 sender: Philip.Hazel@exim.workshop.example
26481 from: Philip.Hazel@exim.workshop.example
26482 to: ph10@exim.workshop.example
26483 cc: ph10@exim.workshop.example
26484 bcc: ph10@exim.workshop.example
26485 reply-to: Philip.Hazel@exim.workshop.example
26486 env-from: Philip.Hazel@exim.workshop.example
26487 env-to: ph10@exim.workshop.example
26488 .endd
26489 which shows that rewriting has been set up for that address when used in any of
26490 the source fields, but not when it appears as a recipient address. At the
26491 present time, there is no equivalent way of testing rewriting rules that are
26492 set for a particular transport.
26493
26494
26495 .section "Rewriting rules" "SECID150"
26496 .cindex "rewriting" "rules"
26497 The rewrite section of the configuration file consists of lines of rewriting
26498 rules in the form
26499 .display
26500 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26501 .endd
26502 Rewriting rules that are specified for the &%headers_rewrite%& generic
26503 transport option are given as a colon-separated list. Each item in the list
26504 takes the same form as a line in the main rewriting configuration (except that
26505 any colons must be doubled, of course).
26506
26507 The formats of source patterns and replacement strings are described below.
26508 Each is terminated by white space, unless enclosed in double quotes, in which
26509 case normal quoting conventions apply inside the quotes. The flags are single
26510 characters which may appear in any order. Spaces and tabs between them are
26511 ignored.
26512
26513 For each address that could potentially be rewritten, the rules are scanned in
26514 order, and replacements for the address from earlier rules can themselves be
26515 replaced by later rules (but see the &"q"& and &"R"& flags).
26516
26517 The order in which addresses are rewritten is undefined, may change between
26518 releases, and must not be relied on, with one exception: when a message is
26519 received, the envelope sender is always rewritten first, before any header
26520 lines are rewritten. For example, the replacement string for a rewrite of an
26521 address in &'To:'& must not assume that the message's address in &'From:'& has
26522 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26523 that the envelope sender has already been rewritten.
26524
26525 .vindex "&$domain$&"
26526 .vindex "&$local_part$&"
26527 The variables &$local_part$& and &$domain$& can be used in the replacement
26528 string to refer to the address that is being rewritten. Note that lookup-driven
26529 rewriting can be done by a rule of the form
26530 .code
26531 *@*   ${lookup ...
26532 .endd
26533 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26534 refer to the address that is being rewritten.
26535
26536
26537 .section "Rewriting patterns" "SECID151"
26538 .cindex "rewriting" "patterns"
26539 .cindex "address list" "in a rewriting pattern"
26540 The source pattern in a rewriting rule is any item which may appear in an
26541 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26542 single-item address list, which means that it is expanded before being tested
26543 against the address. As always, if you use a regular expression as a pattern,
26544 you must take care to escape dollar and backslash characters, or use the &`\N`&
26545 facility to suppress string expansion within the regular expression.
26546
26547 Domains in patterns should be given in lower case. Local parts in patterns are
26548 case-sensitive. If you want to do case-insensitive matching of local parts, you
26549 can use a regular expression that starts with &`^(?i)`&.
26550
26551 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26552 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26553 depending on the type of match which occurred. These can be used in the
26554 replacement string to insert portions of the incoming address. &$0$& always
26555 refers to the complete incoming address. When a regular expression is used, the
26556 numerical variables are set from its capturing subexpressions. For other types
26557 of pattern they are set as follows:
26558
26559 .ilist
26560 If a local part or domain starts with an asterisk, the numerical variables
26561 refer to the character strings matched by asterisks, with &$1$& associated with
26562 the first asterisk, and &$2$& with the second, if present. For example, if the
26563 pattern
26564 .code
26565 *queen@*.fict.example
26566 .endd
26567 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26568 .code
26569 $0 = hearts-queen@wonderland.fict.example
26570 $1 = hearts-
26571 $2 = wonderland
26572 .endd
26573 Note that if the local part does not start with an asterisk, but the domain
26574 does, it is &$1$& that contains the wild part of the domain.
26575
26576 .next
26577 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26578 of the domain are placed in the next available numerical variables. Suppose,
26579 for example, that the address &'foo@bar.baz.example'& is processed by a
26580 rewriting rule of the form
26581 .display
26582 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26583 .endd
26584 and the key in the file that matches the domain is &`*.baz.example`&. Then
26585 .code
26586 $1 = foo
26587 $2 = bar
26588 $3 = baz.example
26589 .endd
26590 If the address &'foo@baz.example'& is looked up, this matches the same
26591 wildcard file entry, and in this case &$2$& is set to the empty string, but
26592 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26593 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26594 whole domain. For non-partial domain lookups, no numerical variables are set.
26595 .endlist
26596
26597
26598 .section "Rewriting replacements" "SECID152"
26599 .cindex "rewriting" "replacements"
26600 If the replacement string for a rule is a single asterisk, addresses that
26601 match the pattern and the flags are &'not'& rewritten, and no subsequent
26602 rewriting rules are scanned. For example,
26603 .code
26604 hatta@lookingglass.fict.example  *  f
26605 .endd
26606 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26607 &'From:'& headers.
26608
26609 .vindex "&$domain$&"
26610 .vindex "&$local_part$&"
26611 If the replacement string is not a single asterisk, it is expanded, and must
26612 yield a fully qualified address. Within the expansion, the variables
26613 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26614 Any letters they contain retain their original case &-- they are not lower
26615 cased. The numerical variables are set up according to the type of pattern that
26616 matched the address, as described above. If the expansion is forced to fail by
26617 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26618 current rule is abandoned, but subsequent rules may take effect. Any other
26619 expansion failure causes the entire rewriting operation to be abandoned, and an
26620 entry written to the panic log.
26621
26622
26623
26624 .subsection "Rewriting flags" "SSECID153"
26625 There are three different kinds of flag that may appear on rewriting rules:
26626
26627 .ilist
26628 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26629 c, f, h, r, s, t.
26630 .next
26631 A flag that specifies rewriting at SMTP time: S.
26632 .next
26633 Flags that control the rewriting process: Q, q, R, w.
26634 .endlist
26635
26636 For rules that are part of the &%headers_rewrite%& generic transport option,
26637 E, F, T, and S are not permitted.
26638
26639
26640
26641 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26642          "SSECID154"
26643 .cindex rewriting flags
26644 If none of the following flag letters, nor the &"S"& flag (see section
26645 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26646 and to both the sender and recipient fields of the envelope, whereas a
26647 transport-time rewriting rule just applies to all headers. Otherwise, the
26648 rewriting rule is skipped unless the relevant addresses are being processed.
26649 .display
26650 &`E`&       rewrite all envelope fields
26651 &`F`&       rewrite the envelope From field
26652 &`T`&       rewrite the envelope To field
26653 &`b`&       rewrite the &'Bcc:'& header
26654 &`c`&       rewrite the &'Cc:'& header
26655 &`f`&       rewrite the &'From:'& header
26656 &`h`&       rewrite all headers
26657 &`r`&       rewrite the &'Reply-To:'& header
26658 &`s`&       rewrite the &'Sender:'& header
26659 &`t`&       rewrite the &'To:'& header
26660 .endd
26661 "All headers" means all of the headers listed above that can be selected
26662 individually, plus their &'Resent-'& versions. It does not include
26663 other headers such as &'Subject:'& etc.
26664
26665 You should be particularly careful about rewriting &'Sender:'& headers, and
26666 restrict this to special known cases in your own domains.
26667
26668
26669 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26670 .cindex SMTP "rewriting malformed addresses"
26671 .cindex RCPT "rewriting argument of"
26672 .cindex MAIL "rewriting argument of"
26673 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26674 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26675 before any other processing; even before syntax checking. The pattern is
26676 required to be a regular expression, and it is matched against the whole of the
26677 data for the command, including any surrounding angle brackets.
26678
26679 .vindex "&$domain$&"
26680 .vindex "&$local_part$&"
26681 This form of rewrite rule allows for the handling of addresses that are not
26682 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26683 input). Because the input is not required to be a syntactically valid address,
26684 the variables &$local_part$& and &$domain$& are not available during the
26685 expansion of the replacement string. The result of rewriting replaces the
26686 original address in the MAIL or RCPT command.
26687
26688
26689 .subsection "Flags controlling the rewriting process" SSECID155
26690 There are four flags which control the way the rewriting process works. These
26691 take effect only when a rule is invoked, that is, when the address is of the
26692 correct type (matches the flags) and matches the pattern:
26693
26694 .ilist
26695 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26696 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26697 absence of &"Q"& the rewritten address must always include a domain.
26698 .next
26699 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26700 even if no rewriting actually takes place because of a &"fail"& in the
26701 expansion. The &"q"& flag is not effective if the address is of the wrong type
26702 (does not match the flags) or does not match the pattern.
26703 .next
26704 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26705 address, up to ten times. It can be combined with the &"q"& flag, to stop
26706 rewriting once it fails to match (after at least one successful rewrite).
26707 .next
26708 .cindex "rewriting" "whole addresses"
26709 When an address in a header is rewritten, the rewriting normally applies only
26710 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26711 left unchanged. For example, rewriting might change
26712 .code
26713 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26714 .endd
26715 into
26716 .code
26717 From: Ford Prefect <prefectf@hitch.fict.example>
26718 .endd
26719 .cindex "RFC 2047"
26720 Sometimes there is a need to replace the whole address item, and this can be
26721 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26722 causes an address in a header line to be rewritten, the entire address is
26723 replaced, not just the working part. The replacement must be a complete RFC
26724 2822 address, including the angle brackets if necessary. If text outside angle
26725 brackets contains a character whose value is greater than 126 or less than 32
26726 (except for tab), the text is encoded according to RFC 2047. The character set
26727 is taken from &%headers_charset%&, which gets its default at build time.
26728
26729 When the &"w"& flag is set on a rule that causes an envelope address to be
26730 rewritten, all but the working part of the replacement address is discarded.
26731 .endlist
26732
26733
26734 .section "Rewriting examples" "SECID156"
26735 Here is an example of the two common rewriting paradigms:
26736 .code
26737 *@*.hitch.fict.example  $1@hitch.fict.example
26738 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26739                      {$value}fail}@hitch.fict.example bctfrF
26740 .endd
26741 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26742 the string expansion to fail if the lookup does not succeed. In this context it
26743 has the effect of leaving the original address unchanged, but Exim goes on to
26744 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26745 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26746 explicitly, which would cause the rewritten address to be the same as before,
26747 at the cost of a small bit of processing. Not supplying either of these is an
26748 error, since the rewritten address would then contain no local part.
26749
26750 The first example above replaces the domain with a superior, more general
26751 domain. This may not be desirable for certain local parts. If the rule
26752 .code
26753 root@*.hitch.fict.example  *
26754 .endd
26755 were inserted before the first rule, rewriting would be suppressed for the
26756 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26757
26758 Rewriting can be made conditional on a number of tests, by making use of
26759 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26760 messages that originate outside the local host:
26761 .code
26762 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26763                          {$1@hitch.fict.example}fail}"
26764 .endd
26765 The replacement string is quoted in this example because it contains white
26766 space.
26767
26768 .cindex "rewriting" "bang paths"
26769 .cindex "bang paths" "rewriting"
26770 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26771 an address it treats it as an unqualified local part which it qualifies with
26772 the local qualification domain (if the source of the message is local or if the
26773 remote host is permitted to send unqualified addresses). Rewriting can
26774 sometimes be used to handle simple bang paths with a fixed number of
26775 components. For example, the rule
26776 .code
26777 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26778 .endd
26779 rewrites a two-component bang path &'host.name!user'& as the domain address
26780 &'user@host.name'&. However, there is a security implication in using this as
26781 a global rewriting rule for envelope addresses. It can provide a backdoor
26782 method for using your system as a relay, because the incoming addresses appear
26783 to be local. If the bang path addresses are received via SMTP, it is safer to
26784 use the &"S"& flag to rewrite them as they are received, so that relay checking
26785 can be done on the rewritten addresses.
26786 .ecindex IIDaddrew
26787
26788
26789
26790
26791
26792 . ////////////////////////////////////////////////////////////////////////////
26793 . ////////////////////////////////////////////////////////////////////////////
26794
26795 .chapter "Retry configuration" "CHAPretry"
26796 .scindex IIDretconf1 "retry" "configuration, description of"
26797 .scindex IIDregconf2 "configuration file" "retry section"
26798 The &"retry"& section of the runtime configuration file contains a list of
26799 retry rules that control how often Exim tries to deliver messages that cannot
26800 be delivered at the first attempt. If there are no retry rules (the section is
26801 empty or not present), there are no retries. In this situation, temporary
26802 errors are treated as permanent. The default configuration contains a single,
26803 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26804 line option can be used to test which retry rule will be used for a given
26805 address, domain and error.
26806
26807 The most common cause of retries is temporary failure to deliver to a remote
26808 host because the host is down, or inaccessible because of a network problem.
26809 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26810 address) basis, not on a per-message basis. Thus, if one message has recently
26811 been delayed, delivery of a new message to the same host is not immediately
26812 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26813 log selector is set, the message
26814 .cindex "retry" "time not reached"
26815 &"retry time not reached"& is written to the main log whenever a delivery is
26816 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26817 the handling of errors during remote deliveries.
26818
26819 Retry processing applies to routing as well as to delivering, except as covered
26820 in the next paragraph. The retry rules do not distinguish between these
26821 actions. It is not possible, for example, to specify different behaviour for
26822 failures to route the domain &'snark.fict.example'& and failures to deliver to
26823 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26824 added complication, so did not implement it. However, although they share the
26825 same retry rule, the actual retry times for routing and transporting a given
26826 domain are maintained independently.
26827
26828 When a delivery is not part of a queue run (typically an immediate delivery on
26829 receipt of a message), the routers are always run, and local deliveries are
26830 always attempted, even if retry times are set for them. This makes for better
26831 behaviour if one particular message is causing problems (for example, causing
26832 quota overflow, or provoking an error in a filter file). If such a delivery
26833 suffers a temporary failure, the retry data is updated as normal, and
26834 subsequent delivery attempts from queue runs occur only when the retry time for
26835 the local address is reached.
26836
26837 .section "Changing retry rules" "SECID157"
26838 If you change the retry rules in your configuration, you should consider
26839 whether or not to delete the retry data that is stored in Exim's spool area in
26840 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26841 always safe; that is why they are called &"hints"&.
26842
26843 The hints retry data contains suggested retry times based on the previous
26844 rules. In the case of a long-running problem with a remote host, it might
26845 record the fact that the host has timed out. If your new rules increase the
26846 timeout time for such a host, you should definitely remove the old retry data
26847 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26848 messages that it should now be retaining.
26849
26850
26851
26852 .section "Format of retry rules" "SECID158"
26853 .cindex "retry" "rules"
26854 Each retry rule occupies one line and consists of three or four parts,
26855 separated by white space: a pattern, an error name, an optional list of sender
26856 addresses, and a list of retry parameters. The pattern and sender lists must be
26857 enclosed in double quotes if they contain white space. The rules are searched
26858 in order until one is found where the pattern, error name, and sender list (if
26859 present) match the failing host or address, the error that occurred, and the
26860 message's sender, respectively.
26861
26862
26863 The pattern is any single item that may appear in an address list (see section
26864 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26865 which means that it is expanded before being tested against the address that
26866 has been delayed. A negated address list item is permitted. Address
26867 list processing treats a plain domain name as if it were preceded by &"*@"&,
26868 which makes it possible for many retry rules to start with just a domain. For
26869 example,
26870 .code
26871 lookingglass.fict.example        *  F,24h,30m;
26872 .endd
26873 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26874 whereas
26875 .code
26876 alice@lookingglass.fict.example  *  F,24h,30m;
26877 .endd
26878 applies only to temporary failures involving the local part &%alice%&.
26879 In practice, almost all rules start with a domain name pattern without a local
26880 part.
26881
26882 .cindex "regular expressions" "in retry rules"
26883 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26884 must match a complete address, not just a domain, because that is how regular
26885 expressions work in address lists.
26886 .display
26887 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26888 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26889 .endd
26890
26891
26892 .section "Choosing which retry rule to use for address errors" "SECID159"
26893 When Exim is looking for a retry rule after a routing attempt has failed (for
26894 example, after a DNS timeout), each line in the retry configuration is tested
26895 against the complete address only if &%retry_use_local_part%& is set for the
26896 router. Otherwise, only the domain is used, except when matching against a
26897 regular expression, when the local part of the address is replaced with &"*"&.
26898 A domain on its own can match a domain pattern, or a pattern that starts with
26899 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26900 &%check_local_user%& is true, and false for other routers.
26901
26902 Similarly, when Exim is looking for a retry rule after a local delivery has
26903 failed (for example, after a mailbox full error), each line in the retry
26904 configuration is tested against the complete address only if
26905 &%retry_use_local_part%& is set for the transport (it defaults true for all
26906 local transports).
26907
26908 .cindex "4&'xx'& responses" "retry rules for"
26909 However, when Exim is looking for a retry rule after a remote delivery attempt
26910 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26911 whole address is always used as the key when searching the retry rules. The
26912 rule that is found is used to create a retry time for the combination of the
26913 failing address and the message's sender. It is the combination of sender and
26914 recipient that is delayed in subsequent queue runs until its retry time is
26915 reached. You can delay the recipient without regard to the sender by setting
26916 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26917 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26918 commands.
26919
26920
26921
26922 .section "Choosing which retry rule to use for host and message errors" &&&
26923          "SECID160"
26924 For a temporary error that is not related to an individual address (for
26925 example, a connection timeout), each line in the retry configuration is checked
26926 twice. First, the name of the remote host is used as a domain name (preceded by
26927 &"*@"& when matching a regular expression). If this does not match the line,
26928 the domain from the email address is tried in a similar fashion. For example,
26929 suppose the MX records for &'a.b.c.example'& are
26930 .code
26931 a.b.c.example  MX  5  x.y.z.example
26932                MX  6  p.q.r.example
26933                MX  7  m.n.o.example
26934 .endd
26935 and the retry rules are
26936 .code
26937 p.q.r.example    *      F,24h,30m;
26938 a.b.c.example    *      F,4d,45m;
26939 .endd
26940 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26941 first rule matches neither the host nor the domain, so Exim looks at the second
26942 rule. This does not match the host, but it does match the domain, so it is used
26943 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26944 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26945 first retry rule is used, because it matches the host.
26946
26947 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26948 first rule to determine retry times, but for all the other hosts for the domain
26949 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26950 routing to &'a.b.c.example'& suffers a temporary failure.
26951
26952 &*Note*&: The host name is used when matching the patterns, not its IP address.
26953 However, if a message is routed directly to an IP address without the use of a
26954 host name, for example, if a &(manualroute)& router contains a setting such as:
26955 .code
26956 route_list = *.a.example  192.168.34.23
26957 .endd
26958 then the &"host name"& that is used when searching for a retry rule is the
26959 textual form of the IP address.
26960
26961 .section "Retry rules for specific errors" "SECID161"
26962 .cindex "retry" "specific errors; specifying"
26963 The second field in a retry rule is the name of a particular error, or an
26964 asterisk, which matches any error. The errors that can be tested for are:
26965
26966 .vlist
26967 .vitem &%auth_failed%&
26968 Authentication failed when trying to send to a host in the
26969 &%hosts_require_auth%& list in an &(smtp)& transport.
26970
26971 .vitem &%data_4xx%&
26972 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26973 after the command, or after sending the message's data.
26974
26975 .vitem &%mail_4xx%&
26976 A 4&'xx'& error was received for an outgoing MAIL command.
26977
26978 .vitem &%rcpt_4xx%&
26979 A 4&'xx'& error was received for an outgoing RCPT command.
26980 .endlist
26981
26982 For the three 4&'xx'& errors, either the first or both of the x's can be given
26983 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26984 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26985 and have retries every ten minutes with a one-hour timeout, you could set up a
26986 retry rule of this form:
26987 .code
26988 the.domain.name  rcpt_452   F,1h,10m
26989 .endd
26990 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26991 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26992
26993 .vlist
26994 .vitem &%lost_connection%&
26995 A server unexpectedly closed the SMTP connection. There may, of course,
26996 legitimate reasons for this (host died, network died), but if it repeats a lot
26997 for the same host, it indicates something odd.
26998
26999 .vitem &%lookup%&
27000 A DNS lookup for a host failed.
27001 Note that a &%dnslookup%& router will need to have matched
27002 its &%fail_defer_domains%& option for this retry type to be usable.
27003 Also note that a &%manualroute%& router will probably need
27004 its &%host_find_failed%& option set to &%defer%&.
27005
27006 .vitem &%refused_MX%&
27007 A connection to a host obtained from an MX record was refused.
27008
27009 .vitem &%refused_A%&
27010 A connection to a host not obtained from an MX record was refused.
27011
27012 .vitem &%refused%&
27013 A connection was refused.
27014
27015 .vitem &%timeout_connect_MX%&
27016 A connection attempt to a host obtained from an MX record timed out.
27017
27018 .vitem &%timeout_connect_A%&
27019 A connection attempt to a host not obtained from an MX record timed out.
27020
27021 .vitem &%timeout_connect%&
27022 A connection attempt timed out.
27023
27024 .vitem &%timeout_MX%&
27025 There was a timeout while connecting or during an SMTP session with a host
27026 obtained from an MX record.
27027
27028 .vitem &%timeout_A%&
27029 There was a timeout while connecting or during an SMTP session with a host not
27030 obtained from an MX record.
27031
27032 .vitem &%timeout%&
27033 There was a timeout while connecting or during an SMTP session.
27034
27035 .vitem &%tls_required%&
27036 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27037 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27038 to STARTTLS, or there was a problem setting up the TLS connection.
27039
27040 .vitem &%quota%&
27041 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27042 transport.
27043
27044 .vitem &%quota_%&<&'time'&>
27045 .cindex "quota" "error testing in retry rule"
27046 .cindex "retry" "quota error testing"
27047 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27048 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27049 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27050 for four days.
27051 .endlist
27052
27053 .cindex "mailbox" "time of last read"
27054 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27055 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27056 it should be based on the last time that the user accessed the mailbox.
27057 However, it is not always possible to determine this. Exim uses the following
27058 heuristic rules:
27059
27060 .ilist
27061 If the mailbox is a single file, the time of last access (the &"atime"&) is
27062 used. As no new messages are being delivered (because the mailbox is over
27063 quota), Exim does not access the file, so this is the time of last user access.
27064 .next
27065 .cindex "maildir format" "time of last read"
27066 For a maildir delivery, the time of last modification of the &_new_&
27067 subdirectory is used. As the mailbox is over quota, no new files are created in
27068 the &_new_& subdirectory, because no new messages are being delivered. Any
27069 change to the &_new_& subdirectory is therefore assumed to be the result of an
27070 MUA moving a new message to the &_cur_& directory when it is first read. The
27071 time that is used is therefore the last time that the user read a new message.
27072 .next
27073 For other kinds of multi-file mailbox, the time of last access cannot be
27074 obtained, so a retry rule that uses this type of error field is never matched.
27075 .endlist
27076
27077 The quota errors apply both to system-enforced quotas and to Exim's own quota
27078 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27079 when a local delivery is deferred because a partition is full (the ENOSPC
27080 error).
27081
27082
27083
27084 .section "Retry rules for specified senders" "SECID162"
27085 .cindex "retry" "rules; sender-specific"
27086 You can specify retry rules that apply only when the failing message has a
27087 specific sender. In particular, this can be used to define retry rules that
27088 apply only to bounce messages. The third item in a retry rule can be of this
27089 form:
27090 .display
27091 &`senders=`&<&'address list'&>
27092 .endd
27093 The retry timings themselves are then the fourth item. For example:
27094 .code
27095 *   rcpt_4xx   senders=:   F,1h,30m
27096 .endd
27097 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27098 host. If the address list contains white space, it must be enclosed in quotes.
27099 For example:
27100 .code
27101 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27102 .endd
27103 &*Warning*&: This facility can be unhelpful if it is used for host errors
27104 (which do not depend on the recipient). The reason is that the sender is used
27105 only to match the retry rule. Once the rule has been found for a host error,
27106 its contents are used to set a retry time for the host, and this will apply to
27107 all messages, not just those with specific senders.
27108
27109 When testing retry rules using &%-brt%&, you can supply a sender using the
27110 &%-f%& command line option, like this:
27111 .code
27112 exim -f "" -brt user@dom.ain
27113 .endd
27114 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27115 list is never matched.
27116
27117
27118
27119
27120
27121 .section "Retry parameters" "SECID163"
27122 .cindex "retry" "parameters in rules"
27123 The third (or fourth, if a senders list is present) field in a retry rule is a
27124 sequence of retry parameter sets, separated by semicolons. Each set consists of
27125 .display
27126 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27127 .endd
27128 The letter identifies the algorithm for computing a new retry time; the cutoff
27129 time is the time beyond which this algorithm no longer applies, and the
27130 arguments vary the algorithm's action. The cutoff time is measured from the
27131 time that the first failure for the domain (combined with the local part if
27132 relevant) was detected, not from the time the message was received.
27133
27134 .cindex "retry" "algorithms"
27135 .cindex "retry" "fixed intervals"
27136 .cindex "retry" "increasing intervals"
27137 .cindex "retry" "random intervals"
27138 The available algorithms are:
27139
27140 .ilist
27141 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27142 the interval.
27143 .next
27144 &'G'&: retry at geometrically increasing intervals. The first argument
27145 specifies a starting value for the interval, and the second a multiplier, which
27146 is used to increase the size of the interval at each retry.
27147 .next
27148 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27149 retry, the previous interval is multiplied by the factor in order to get a
27150 maximum for the next interval. The minimum interval is the first argument of
27151 the parameter, and an actual interval is chosen randomly between them. Such a
27152 rule has been found to be helpful in cluster configurations when all the
27153 members of the cluster restart at once, and may therefore synchronize their
27154 queue processing times.
27155 .endlist
27156
27157 When computing the next retry time, the algorithm definitions are scanned in
27158 order until one whose cutoff time has not yet passed is reached. This is then
27159 used to compute a new retry time that is later than the current time. In the
27160 case of fixed interval retries, this simply means adding the interval to the
27161 current time. For geometrically increasing intervals, retry intervals are
27162 computed from the rule's parameters until one that is greater than the previous
27163 interval is found. The main configuration variable
27164 .cindex "limit" "retry interval"
27165 .cindex "retry" "interval, maximum"
27166 .oindex "&%retry_interval_max%&"
27167 &%retry_interval_max%& limits the maximum interval between retries. It
27168 cannot be set greater than &`24h`&, which is its default value.
27169
27170 A single remote domain may have a number of hosts associated with it, and each
27171 host may have more than one IP address. Retry algorithms are selected on the
27172 basis of the domain name, but are applied to each IP address independently. If,
27173 for example, a host has two IP addresses and one is unusable, Exim will
27174 generate retry times for it and will not try to use it until its next retry
27175 time comes. Thus the good IP address is likely to be tried first most of the
27176 time.
27177
27178 .cindex "hints database" "use for retrying"
27179 Retry times are hints rather than promises. Exim does not make any attempt to
27180 run deliveries exactly at the computed times. Instead, a queue runner process
27181 starts delivery processes for delayed messages periodically, and these attempt
27182 new deliveries only for those addresses that have passed their next retry time.
27183 If a new message arrives for a deferred address, an immediate delivery attempt
27184 occurs only if the address has passed its retry time. In the absence of new
27185 messages, the minimum time between retries is the interval between queue runner
27186 processes. There is not much point in setting retry times of five minutes if
27187 your queue runners happen only once an hour, unless there are a significant
27188 number of incoming messages (which might be the case on a system that is
27189 sending everything to a smart host, for example).
27190
27191 The data in the retry hints database can be inspected by using the
27192 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27193 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27194 &'exinext'& utility script can be used to find out what the next retry times
27195 are for the hosts associated with a particular mail domain, and also for local
27196 deliveries that have been deferred.
27197
27198
27199 .section "Retry rule examples" "SECID164"
27200 Here are some example retry rules:
27201 .code
27202 alice@wonderland.fict.example quota_5d  F,7d,3h
27203 wonderland.fict.example       quota_5d
27204 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27205 lookingglass.fict.example     *         F,24h,30m;
27206 *                 refused_A   F,2h,20m;
27207 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27208 .endd
27209 The first rule sets up special handling for mail to
27210 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27211 mailbox has not been read for at least 5 days. Retries continue every three
27212 hours for 7 days. The second rule handles over-quota errors for all other local
27213 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27214 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27215 fail are bounced immediately if the mailbox has not been read for at least 5
27216 days.
27217
27218 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27219 happen every 15 minutes for an hour, then with geometrically increasing
27220 intervals until two days have passed since a delivery first failed. After the
27221 first hour there is a delay of one hour, then two hours, then four hours, and
27222 so on (this is a rather extreme example).
27223
27224 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27225 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27226 all other domains, with special action for connection refusal from hosts that
27227 were not obtained from an MX record.
27228
27229 The final rule in a retry configuration should always have asterisks in the
27230 first two fields so as to provide a general catch-all for any addresses that do
27231 not have their own special handling. This example tries every 15 minutes for 2
27232 hours, then with intervals starting at one hour and increasing by a factor of
27233 1.5 up to 16 hours, then every 8 hours up to 5 days.
27234
27235
27236
27237 .section "Timeout of retry data" "SECID165"
27238 .cindex "timeout" "of retry data"
27239 .oindex "&%retry_data_expire%&"
27240 .cindex "hints database" "data expiry"
27241 .cindex "retry" "timeout of data"
27242 Exim timestamps the data that it writes to its retry hints database. When it
27243 consults the data during a delivery it ignores any that is older than the value
27244 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27245 been tried for 7 days, Exim will try to deliver to it immediately a message
27246 arrives, and if that fails, it will calculate a retry time as if it were
27247 failing for the first time.
27248
27249 This improves the behaviour for messages routed to rarely-used hosts such as MX
27250 backups. If such a host was down at one time, and happens to be down again when
27251 Exim tries a month later, using the old retry data would imply that it had been
27252 down all the time, which is not a justified assumption.
27253
27254 If a host really is permanently dead, this behaviour causes a burst of retries
27255 every now and again, but only if messages routed to it are rare. If there is a
27256 message at least once every 7 days the retry data never expires.
27257
27258
27259
27260
27261 .section "Long-term failures" "SECID166"
27262 .cindex "delivery failure, long-term"
27263 .cindex "retry" "after long-term failure"
27264 Special processing happens when an email address has been failing for so long
27265 that the cutoff time for the last algorithm is reached. For example, using the
27266 default retry rule:
27267 .code
27268 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27269 .endd
27270 the cutoff time is four days. Reaching the retry cutoff is independent of how
27271 long any specific message has been failing; it is the length of continuous
27272 failure for the recipient address that counts.
27273
27274 When the cutoff time is reached for a local delivery, or for all the IP
27275 addresses associated with a remote delivery, a subsequent delivery failure
27276 causes Exim to give up on the address, and a bounce message is generated.
27277 In order to cater for new messages that use the failing address, a next retry
27278 time is still computed from the final algorithm, and is used as follows:
27279
27280 For local deliveries, one delivery attempt is always made for any subsequent
27281 messages. If this delivery fails, the address fails immediately. The
27282 post-cutoff retry time is not used.
27283
27284 .cindex "final cutoff" "retries, controlling"
27285 .cindex retry "final cutoff"
27286 If the delivery is remote, there are two possibilities, controlled by the
27287 .oindex "&%delay_after_cutoff%&"
27288 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27289 default. Until the post-cutoff retry time for one of the IP addresses,
27290 as set by the &%retry_data_expire%& option, is
27291 reached, the failing email address is bounced immediately, without a delivery
27292 attempt taking place. After that time, one new delivery attempt is made to
27293 those IP addresses that are past their retry times, and if that still fails,
27294 the address is bounced and new retry times are computed.
27295
27296 In other words, when all the hosts for a given email address have been failing
27297 for a long time, Exim bounces rather then defers until one of the hosts' retry
27298 times is reached. Then it tries once, and bounces if that attempt fails. This
27299 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27300 to a broken destination, but if the host does recover, Exim will eventually
27301 notice.
27302
27303 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27304 addresses are past their final cutoff time, Exim tries to deliver to those IP
27305 addresses that have not been tried since the message arrived. If there are
27306 no suitable IP addresses, or if they all fail, the address is bounced. In other
27307 words, it does not delay when a new message arrives, but tries the expired
27308 addresses immediately, unless they have been tried since the message arrived.
27309 If there is a continuous stream of messages for the failing domains, setting
27310 &%delay_after_cutoff%& false means that there will be many more attempts to
27311 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27312 true.
27313
27314 .section "Deliveries that work intermittently" "SECID167"
27315 .cindex "retry" "intermittently working deliveries"
27316 Some additional logic is needed to cope with cases where a host is
27317 intermittently available, or when a message has some attribute that prevents
27318 its delivery when others to the same address get through. In this situation,
27319 because some messages are successfully delivered, the &"retry clock"& for the
27320 host or address keeps getting reset by the successful deliveries, and so
27321 failing messages remain in the queue for ever because the cutoff time is never
27322 reached.
27323
27324 Two exceptional actions are applied to prevent this happening. The first
27325 applies to errors that are related to a message rather than a remote host.
27326 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27327 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27328 commands, and quota failures. For this type of error, if a message's arrival
27329 time is earlier than the &"first failed"& time for the error, the earlier time
27330 is used when scanning the retry rules to decide when to try next and when to
27331 time out the address.
27332
27333 The exceptional second action applies in all cases. If a message has been on
27334 the queue for longer than the cutoff time of any applicable retry rule for a
27335 given address, a delivery is attempted for that address, even if it is not yet
27336 time, and if this delivery fails, the address is timed out. A new retry time is
27337 not computed in this case, so that other messages for the same address are
27338 considered immediately.
27339 .ecindex IIDretconf1
27340 .ecindex IIDregconf2
27341
27342
27343
27344
27345
27346
27347 . ////////////////////////////////////////////////////////////////////////////
27348 . ////////////////////////////////////////////////////////////////////////////
27349
27350 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27351 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27352 .scindex IIDauthconf2 "authentication"
27353 The &"authenticators"& section of Exim's runtime configuration is concerned
27354 with SMTP authentication. This facility is an extension to the SMTP protocol,
27355 described in RFC 2554, which allows a client SMTP host to authenticate itself
27356 to a server. This is a common way for a server to recognize clients that are
27357 permitted to use it as a relay. SMTP authentication is not of relevance to the
27358 transfer of mail between servers that have no managerial connection with each
27359 other.
27360
27361 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27362 prior to Exim 4.95 names would be silently truncated at this length, but now
27363 it is enforced.
27364
27365 .cindex "AUTH" "description of"
27366 .cindex "ESMTP extensions" AUTH
27367 Very briefly, the way SMTP authentication works is as follows:
27368
27369 .olist
27370 The server advertises a number of authentication &'mechanisms'& in response to
27371 the client's EHLO command.
27372 .next
27373 The client issues an AUTH command, naming a specific mechanism. The command
27374 may, optionally, contain some authentication data.
27375 .next
27376 The server may issue one or more &'challenges'&, to which the client must send
27377 appropriate responses. In simple authentication mechanisms, the challenges are
27378 just prompts for user names and passwords. The server does not have to issue
27379 any challenges &-- in some mechanisms the relevant data may all be transmitted
27380 with the AUTH command.
27381 .next
27382 The server either accepts or denies authentication.
27383 .next
27384 If authentication succeeds, the client may optionally make use of the AUTH
27385 option on the MAIL command to pass an authenticated sender in subsequent
27386 mail transactions. Authentication lasts for the remainder of the SMTP
27387 connection.
27388 .next
27389 If authentication fails, the client may give up, or it may try a different
27390 authentication mechanism, or it may try transferring mail over the
27391 unauthenticated connection.
27392 .endlist
27393
27394 If you are setting up a client, and want to know which authentication
27395 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27396 SMTP port) on the server, and issue an EHLO command. The response to this
27397 includes the list of supported mechanisms. For example:
27398 .display
27399 &`$ `&&*&`telnet server.example 25`&*&
27400 &`Trying 192.168.34.25...`&
27401 &`Connected to server.example.`&
27402 &`Escape character is &#x0027;^]&#x0027;.`&
27403 &`220 server.example ESMTP Exim 4.20 ...`&
27404 &*&`ehlo client.example`&*&
27405 &`250-server.example Hello client.example [10.8.4.5]`&
27406 &`250-SIZE 52428800`&
27407 &`250-PIPELINING`&
27408 &`250-AUTH PLAIN`&
27409 &`250 HELP`&
27410 .endd
27411 The second-last line of this example output shows that the server supports
27412 authentication using the PLAIN mechanism. In Exim, the different authentication
27413 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27414 routers and transports, which authenticators are included in the binary is
27415 controlled by build-time definitions. The following are currently available,
27416 included by setting
27417 .code
27418 AUTH_CRAM_MD5=yes
27419 AUTH_CYRUS_SASL=yes
27420 AUTH_DOVECOT=yes
27421 AUTH_EXTERNAL=yes
27422 AUTH_GSASL=yes
27423 AUTH_HEIMDAL_GSSAPI=yes
27424 AUTH_PLAINTEXT=yes
27425 AUTH_SPA=yes
27426 AUTH_TLS=yes
27427 .endd
27428 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27429 authentication mechanism (RFC 2195), and the second provides an interface to
27430 the Cyrus SASL authentication library.
27431 The third is an interface to Dovecot's authentication system, delegating the
27432 work via a socket interface.
27433 The fourth provides for negotiation of authentication done via non-SMTP means,
27434 as defined by RFC 4422 Appendix A.
27435 The fifth provides an interface to the GNU SASL authentication library, which
27436 provides mechanisms but typically not data sources.
27437 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27438 supporting setting a server keytab.
27439 The seventh can be configured to support
27440 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27441 not formally documented, but used by several MUAs.
27442 The eighth authenticator
27443 supports Microsoft's &'Secure Password Authentication'& mechanism.
27444 The last is an Exim authenticator but not an SMTP one;
27445 instead it can use information from a TLS negotiation.
27446
27447 The authenticators are configured using the same syntax as other drivers (see
27448 section &<<SECTfordricon>>&). If no authenticators are required, no
27449 authentication section need be present in the configuration file. Each
27450 authenticator can in principle have both server and client functions. When Exim
27451 is receiving SMTP mail, it is acting as a server; when it is sending out
27452 messages over SMTP, it is acting as a client. Authenticator configuration
27453 options are provided for use in both these circumstances.
27454
27455 To make it clear which options apply to which situation, the prefixes
27456 &%server_%& and &%client_%& are used on option names that are specific to
27457 either the server or the client function, respectively. Server and client
27458 functions are disabled if none of their options are set. If an authenticator is
27459 to be used for both server and client functions, a single definition, using
27460 both sets of options, is required. For example:
27461 .code
27462 cram:
27463   driver = cram_md5
27464   public_name = CRAM-MD5
27465   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27466   client_name = ph10
27467   client_secret = secret2
27468 .endd
27469 The &%server_%& option is used when Exim is acting as a server, and the
27470 &%client_%& options when it is acting as a client.
27471
27472 Descriptions of the individual authenticators are given in subsequent chapters.
27473 The remainder of this chapter covers the generic options for the
27474 authenticators, followed by general discussion of the way authentication works
27475 in Exim.
27476
27477 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27478 per-mechanism basis.  Please read carefully to determine which variables hold
27479 account labels such as usercodes and which hold passwords or other
27480 authenticating data.
27481
27482 Note that some mechanisms support two different identifiers for accounts: the
27483 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27484 and &'authz'& are commonly encountered.  The American spelling is standard here.
27485 Conceptually, authentication data such as passwords are tied to the identifier
27486 used to authenticate; servers may have rules to permit one user to act as a
27487 second user, so that after login the session is treated as though that second
27488 user had logged in.  That second user is the &'authorization id'&.  A robust
27489 configuration might confirm that the &'authz'& field is empty or matches the
27490 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27491 as verified data, the &'authz'& as an unverified request which the server might
27492 choose to honour.
27493
27494 A &'realm'& is a text string, typically a domain name, presented by a server
27495 to a client to help it select an account and credentials to use.  In some
27496 mechanisms, the client and server provably agree on the realm, but clients
27497 typically can not treat the realm as secure data to be blindly trusted.
27498
27499
27500
27501 .section "Generic options for authenticators" "SECID168"
27502 .cindex "authentication" "generic options"
27503 .cindex "options" "generic; for authenticators"
27504
27505 .option client_condition authenticators string&!! unset
27506 When Exim is authenticating as a client, it skips any authenticator whose
27507 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27508 used, for example, to skip plain text authenticators when the connection is not
27509 encrypted by a setting such as:
27510 .code
27511 client_condition = ${if !eq{$tls_out_cipher}{}}
27512 .endd
27513
27514
27515 .option client_set_id authenticators string&!! unset
27516 When client authentication succeeds, this condition is expanded; the
27517 result is used in the log lines for outbound messages.
27518 Typically it will be the user name used for authentication.
27519
27520
27521 .option driver authenticators string unset
27522 This option must always be set. It specifies which of the available
27523 authenticators is to be used.
27524
27525
27526 .option public_name authenticators string unset
27527 This option specifies the name of the authentication mechanism that the driver
27528 implements, and by which it is known to the outside world. These names should
27529 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27530 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27531 defaults to the driver's instance name.
27532
27533
27534 .option server_advertise_condition authenticators string&!! unset
27535 When a server is about to advertise an authentication mechanism, the condition
27536 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27537 mechanism is not advertised.
27538 If the expansion fails, the mechanism is not advertised. If the failure was not
27539 forced, and was not caused by a lookup defer, the incident is logged.
27540 See section &<<SECTauthexiser>>& below for further discussion.
27541
27542
27543 .option server_condition authenticators string&!! unset
27544 This option must be set for a &%plaintext%& server authenticator, where it
27545 is used directly to control authentication. See section &<<SECTplainserver>>&
27546 for details.
27547
27548 For the &(gsasl)& authenticator, this option is required for various
27549 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27550
27551 For the other authenticators, &%server_condition%& can be used as an additional
27552 authentication or authorization mechanism that is applied after the other
27553 authenticator conditions succeed. If it is set, it is expanded when the
27554 authenticator would otherwise return a success code. If the expansion is forced
27555 to fail, authentication fails. Any other expansion failure causes a temporary
27556 error code to be returned. If the result of a successful expansion is an empty
27557 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27558 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27559 other result, a temporary error code is returned, with the expanded string as
27560 the error text.
27561
27562
27563 .option server_debug_print authenticators string&!! unset
27564 If this option is set and authentication debugging is enabled (see the &%-d%&
27565 command line option), the string is expanded and included in the debugging
27566 output when the authenticator is run as a server. This can help with checking
27567 out the values of variables.
27568 If expansion of the string fails, the error message is written to the debugging
27569 output, and Exim carries on processing.
27570
27571
27572 .option server_set_id authenticators string&!! unset
27573 .vindex "&$authenticated_id$&"
27574 .vindex "&$authenticated_fail_id$&"
27575 When an Exim server successfully authenticates a client, this string is
27576 expanded using data from the authentication, and preserved for any incoming
27577 messages in the variable &$authenticated_id$&. It is also included in the log
27578 lines for incoming messages. For example, a user/password authenticator
27579 configuration might preserve the user name that was used to authenticate, and
27580 refer to it subsequently during delivery of the message.
27581 On a failing authentication the expansion result is instead saved in
27582 the &$authenticated_fail_id$& variable.
27583 If expansion fails, the option is ignored.
27584
27585
27586 .option server_mail_auth_condition authenticators string&!! unset
27587 This option allows a server to discard authenticated sender addresses supplied
27588 as part of MAIL commands in SMTP connections that are authenticated by the
27589 driver on which &%server_mail_auth_condition%& is set. The option is not used
27590 as part of the authentication process; instead its (unexpanded) value is
27591 remembered for later use.
27592 How it is used is described in the following section.
27593
27594
27595
27596
27597
27598 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27599 .cindex "authentication" "sender; authenticated"
27600 .cindex "AUTH" "on MAIL command"
27601 When a client supplied an AUTH= item on a MAIL command, Exim applies
27602 the following checks before accepting it as the authenticated sender of the
27603 message:
27604
27605 .ilist
27606 If the connection is not using extended SMTP (that is, HELO was used rather
27607 than EHLO), the use of AUTH= is a syntax error.
27608 .next
27609 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27610 .next
27611 .vindex "&$authenticated_sender$&"
27612 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27613 running, the value of &$authenticated_sender$& is set to the value obtained
27614 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27615 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27616 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27617 given for the MAIL command.
27618 .next
27619 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27620 is accepted and placed in &$authenticated_sender$& only if the client has
27621 authenticated.
27622 .next
27623 If the AUTH= value was accepted by either of the two previous rules, and
27624 the client has authenticated, and the authenticator has a setting for the
27625 &%server_mail_auth_condition%&, the condition is checked at this point. The
27626 valued that was saved from the authenticator is expanded. If the expansion
27627 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27628 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27629 the value of &$authenticated_sender$& is retained and passed on with the
27630 message.
27631 .endlist
27632
27633
27634 When &$authenticated_sender$& is set for a message, it is passed on to other
27635 hosts to which Exim authenticates as a client. Do not confuse this value with
27636 &$authenticated_id$&, which is a string obtained from the authentication
27637 process, and which is not usually a complete email address.
27638
27639 .vindex "&$sender_address$&"
27640 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27641 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27642 therefore make use of &$authenticated_sender$&. The converse is not true: the
27643 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27644 ACL is run.
27645
27646
27647
27648 .section "Authentication on an Exim server" "SECTauthexiser"
27649 .cindex "authentication" "on an Exim server"
27650 When Exim receives an EHLO command, it advertises the public names of those
27651 authenticators that are configured as servers, subject to the following
27652 conditions:
27653
27654 .ilist
27655 The client host must match &%auth_advertise_hosts%& (default *).
27656 .next
27657 If the &%server_advertise_condition%& option is set, its expansion must not
27658 yield the empty string, &"0"&, &"no"&, or &"false"&.
27659 .endlist
27660
27661 The order in which the authenticators are defined controls the order in which
27662 the mechanisms are advertised.
27663
27664 Some mail clients (for example, some versions of Netscape) require the user to
27665 provide a name and password for authentication whenever AUTH is advertised,
27666 even though authentication may not in fact be needed (for example, Exim may be
27667 set up to allow unconditional relaying from the client by an IP address check).
27668 You can make such clients more friendly by not advertising AUTH to them.
27669 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27670 that runs for RCPT) to relay without authentication, you should set
27671 .code
27672 auth_advertise_hosts = ! 10.9.8.0/24
27673 .endd
27674 so that no authentication mechanisms are advertised to them.
27675
27676 The &%server_advertise_condition%& controls the advertisement of individual
27677 authentication mechanisms. For example, it can be used to restrict the
27678 advertisement of a particular mechanism to encrypted connections, by a setting
27679 such as:
27680 .code
27681 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27682 .endd
27683 .vindex "&$tls_in_cipher$&"
27684 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27685 yields &"yes"&, which allows the advertisement to happen.
27686
27687 When an Exim server receives an AUTH command from a client, it rejects it
27688 immediately if AUTH was not advertised in response to an earlier EHLO
27689 command. This is the case if
27690
27691 .ilist
27692 The client host does not match &%auth_advertise_hosts%&; or
27693 .next
27694 No authenticators are configured with server options; or
27695 .next
27696 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27697 server authenticators.
27698 .endlist
27699
27700
27701 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27702 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27703 AUTH is accepted from any client host.
27704
27705 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27706 server authentication mechanism that was advertised in response to EHLO and
27707 that matches the one named in the AUTH command. If it finds one, it runs
27708 the appropriate authentication protocol, and authentication either succeeds or
27709 fails. If there is no matching advertised mechanism, the AUTH command is
27710 rejected with a 504 error.
27711
27712 .vindex "&$received_protocol$&"
27713 .vindex "&$sender_host_authenticated$&"
27714 When a message is received from an authenticated host, the value of
27715 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27716 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27717 public name) of the authenticator driver that successfully authenticated the
27718 client from which the message was received. This variable is empty if there was
27719 no successful authentication.
27720
27721 .cindex authentication "expansion item"
27722 Successful authentication sets up information used by the
27723 &%authresults%& expansion item.
27724
27725 .new
27726 .cindex authentication "failure event, server"
27727 If an authenticator is run and does not succeed,
27728 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27729 While the event is being processed the variables
27730 &$sender_host_authenticated$& (with the authenticator name)
27731 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27732 will be valid.
27733 If the event is serviced and a string is returned then the string will be logged
27734 instead of the default log line.
27735 See <<CHAPevents>> for details on events.
27736 .wen
27737
27738
27739 .section "Testing server authentication" "SECID169"
27740 .cindex "authentication" "testing a server"
27741 .cindex "AUTH" "testing a server"
27742 .cindex "base64 encoding" "creating authentication test data"
27743 Exim's &%-bh%& option can be useful for testing server authentication
27744 configurations. The data for the AUTH command has to be sent using base64
27745 encoding. A quick way to produce such data for testing is the following Perl
27746 script:
27747 .code
27748 use MIME::Base64;
27749 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27750 .endd
27751 .cindex "binary zero" "in authentication data"
27752 This interprets its argument as a Perl string, and then encodes it. The
27753 interpretation as a Perl string allows binary zeros, which are required for
27754 some kinds of authentication, to be included in the data. For example, a
27755 command line to run this script on such data might be
27756 .code
27757 encode '\0user\0password'
27758 .endd
27759 Note the use of single quotes to prevent the shell interpreting the
27760 backslashes, so that they can be interpreted by Perl to specify characters
27761 whose code value is zero.
27762
27763 &*Warning 1*&: If either of the user or password strings starts with an octal
27764 digit, you must use three zeros instead of one after the leading backslash. If
27765 you do not, the octal digit that starts your string will be incorrectly
27766 interpreted as part of the code for the first character.
27767
27768 &*Warning 2*&: If there are characters in the strings that Perl interprets
27769 specially, you must use a Perl escape to prevent them being misinterpreted. For
27770 example, a command such as
27771 .code
27772 encode '\0user@domain.com\0pas$$word'
27773 .endd
27774 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27775
27776 If you have the &%mimencode%& command installed, another way to produce
27777 base64-encoded strings is to run the command
27778 .code
27779 echo -e -n `\0user\0password' | mimencode
27780 .endd
27781 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27782 in the argument, and the &%-n%& option specifies no newline at the end of its
27783 output. However, not all versions of &%echo%& recognize these options, so you
27784 should check your version before relying on this suggestion.
27785
27786
27787
27788 .section "Authentication by an Exim client" "SECID170"
27789 .cindex "authentication" "on an Exim client"
27790 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27791 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27792 announces support for authentication, and the host matches an entry in either
27793 of these options, Exim (as a client) tries to authenticate as follows:
27794
27795 .ilist
27796 For each authenticator that is configured as a client, in the order in which
27797 they are defined in the configuration, it searches the authentication
27798 mechanisms announced by the server for one whose name matches the public name
27799 of the authenticator.
27800 .next
27801 .vindex "&$host$&"
27802 .vindex "&$host_address$&"
27803 When it finds one that matches, it runs the authenticator's client code. The
27804 variables &$host$& and &$host_address$& are available for any string expansions
27805 that the client might do. They are set to the server's name and IP address. If
27806 any expansion is forced to fail, the authentication attempt is abandoned, and
27807 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27808 delivery to be deferred.
27809 .next
27810 If the result of the authentication attempt is a temporary error or a timeout,
27811 Exim abandons trying to send the message to the host for the moment. It will
27812 try again later. If there are any backup hosts available, they are tried in the
27813 usual way.
27814
27815 .new
27816 .next
27817 .cindex authentication "failure event, client"
27818 If the response to authentication is a permanent error (5&'xx'& code),
27819 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27820 While the event is being processed the variable
27821 &$sender_host_authenticated$& (with the authenticator name)
27822 will be valid.
27823 If the event is serviced and a string is returned then the string will be logged.
27824 See <<CHAPevents>> for details on events.
27825 .wen
27826
27827 .next
27828 If the response to authentication is a permanent error (5&'xx'& code), Exim
27829 carries on searching the list of authenticators and tries another one if
27830 possible. If all authentication attempts give permanent errors, or if there are
27831 no attempts because no mechanisms match (or option expansions force failure),
27832 what happens depends on whether the host matches &%hosts_require_auth%& or
27833 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27834 delivery is deferred. The error can be detected in the retry rules, and thereby
27835 turned into a permanent error if you wish. In the second case, Exim tries to
27836 deliver the message unauthenticated.
27837 .endlist
27838
27839 Note that the hostlist test for whether to do authentication can be
27840 confused if name-IP lookups change between the time the peer is decided
27841 upon and the time that the transport runs.  For example, with a manualroute
27842 router given a host name, and with DNS "round-robin" used by that name: if
27843 the local resolver cache times out between the router and the transport
27844 running, the transport may get an IP for the name for its authentication
27845 check which does not match the connection peer IP.
27846 No authentication will then be done, despite the names being identical.
27847
27848 For such cases use a separate transport which always authenticates.
27849
27850 .cindex "AUTH" "on MAIL command"
27851 When Exim has authenticated itself to a remote server, it adds the AUTH
27852 parameter to the MAIL commands it sends, if it has an authenticated sender for
27853 the message. If the message came from a remote host, the authenticated sender
27854 is the one that was receiving on an incoming MAIL command, provided that the
27855 incoming connection was authenticated and the &%server_mail_auth%& condition
27856 allowed the authenticated sender to be retained. If a local process calls Exim
27857 to send a message, the sender address that is built from the login name and
27858 &%qualify_domain%& is treated as authenticated. However, if the
27859 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27860 the authenticated sender that was received with the message.
27861 .ecindex IIDauthconf1
27862 .ecindex IIDauthconf2
27863
27864
27865
27866
27867
27868
27869 . ////////////////////////////////////////////////////////////////////////////
27870 . ////////////////////////////////////////////////////////////////////////////
27871
27872 .chapter "The plaintext authenticator" "CHAPplaintext"
27873 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27874 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27875 The &(plaintext)& authenticator can be configured to support the PLAIN and
27876 LOGIN authentication mechanisms, both of which transfer authentication data as
27877 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27878 security risk; you are strongly advised to insist on the use of SMTP encryption
27879 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27880 use unencrypted plain text, you should not use the same passwords for SMTP
27881 connections as you do for login accounts.
27882
27883 .section "Avoiding cleartext use" "SECTplain_TLS"
27884 The following generic option settings will disable &(plaintext)& authenticators when
27885 TLS is not being used:
27886 .code
27887   server_advertise_condition = ${if def:tls_in_cipher }
27888   client_condition =           ${if def:tls_out_cipher}
27889 .endd
27890
27891 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27892 but is still vulnerable to a Man In The Middle attack unless certificates
27893 (including their names) have been properly verified.
27894
27895 .section "Plaintext server options" "SECID171"
27896 .cindex "options" "&(plaintext)& authenticator (server)"
27897 When configured as a server, &(plaintext)& uses the following options:
27898
27899 .option server_condition authenticators string&!! unset
27900 This is actually a global authentication option, but it must be set in order to
27901 configure the &(plaintext)& driver as a server. Its use is described below.
27902
27903 .option server_prompts plaintext "string list&!!" unset
27904 The contents of this option, after expansion, must be a colon-separated list of
27905 prompt strings. If expansion fails, a temporary authentication rejection is
27906 given.
27907
27908 .section "Using plaintext in a server" "SECTplainserver"
27909 .cindex "AUTH" "in &(plaintext)& authenticator"
27910 .cindex "binary zero" "in &(plaintext)& authenticator"
27911 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27912         "in &(plaintext)& authenticator"
27913 .vindex "&$auth1$&, &$auth2$&, etc"
27914 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27915
27916 When running as a server, &(plaintext)& performs the authentication test by
27917 expanding a string. The data sent by the client with the AUTH command, or in
27918 response to subsequent prompts, is base64 encoded, and so may contain any byte
27919 values when decoded. If any data is supplied with the command, it is treated as
27920 a list of strings, separated by NULs (binary zeros), the first three of which
27921 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27922 (neither LOGIN nor PLAIN uses more than three strings).
27923
27924 For compatibility with previous releases of Exim, the values are also placed in
27925 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27926 variables for this purpose is now deprecated, as it can lead to confusion in
27927 string expansions that also use them for other things.
27928
27929 If there are more strings in &%server_prompts%& than the number of strings
27930 supplied with the AUTH command, the remaining prompts are used to obtain more
27931 data. Each response from the client may be a list of NUL-separated strings.
27932
27933 .vindex "&$authenticated_id$&"
27934 Once a sufficient number of data strings have been received,
27935 &%server_condition%& is expanded. If the expansion is forced to fail,
27936 authentication fails. Any other expansion failure causes a temporary error code
27937 to be returned. If the result of a successful expansion is an empty string,
27938 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27939 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27940 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27941 For any other result, a temporary error code is returned, with the expanded
27942 string as the error text.
27943
27944 &*Warning*&: If you use a lookup in the expansion to find the user's
27945 password, be sure to make the authentication fail if the user is unknown.
27946 There are good and bad examples at the end of the next section.
27947
27948
27949
27950 .section "The PLAIN authentication mechanism" "SECID172"
27951 .cindex "PLAIN authentication mechanism"
27952 .cindex authentication PLAIN
27953 .cindex "binary zero" "in &(plaintext)& authenticator"
27954 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27955 sent as one item of data (that is, one combined string containing two NUL
27956 separators). The data is sent either as part of the AUTH command, or
27957 subsequently in response to an empty prompt from the server.
27958
27959 The second and third strings are a user name and a corresponding password.
27960 Using a single fixed user name and password as an example, this could be
27961 configured as follows:
27962 .code
27963 fixed_plain:
27964   driver = plaintext
27965   public_name = PLAIN
27966   server_prompts = :
27967   server_condition = \
27968     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27969   server_set_id = $auth2
27970 .endd
27971 Note that the default result strings from &%if%& (&"true"& or an empty string)
27972 are exactly what we want here, so they need not be specified. Obviously, if the
27973 password contains expansion-significant characters such as dollar, backslash,
27974 or closing brace, they have to be escaped.
27975
27976 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27977 the end of a string list are ignored). If all the data comes as part of the
27978 AUTH command, as is commonly the case, the prompt is not used. This
27979 authenticator is advertised in the response to EHLO as
27980 .code
27981 250-AUTH PLAIN
27982 .endd
27983 and a client host can authenticate itself by sending the command
27984 .code
27985 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27986 .endd
27987 As this contains three strings (more than the number of prompts), no further
27988 data is required from the client. Alternatively, the client may just send
27989 .code
27990 AUTH PLAIN
27991 .endd
27992 to initiate authentication, in which case the server replies with an empty
27993 prompt. The client must respond with the combined data string.
27994
27995 The data string is base64 encoded, as required by the RFC. This example,
27996 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27997 represents a zero byte. This is split up into three strings, the first of which
27998 is empty. The &%server_condition%& option in the authenticator checks that the
27999 second two are &`username`& and &`mysecret`& respectively.
28000
28001 Having just one fixed user name and password, as in this example, is not very
28002 realistic, though for a small organization with only a handful of
28003 authenticating clients it could make sense.
28004
28005 A more sophisticated instance of this authenticator could use the user name in
28006 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28007 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28008 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28009 This is an incorrect example:
28010 .code
28011 server_condition = \
28012   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28013 .endd
28014 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28015 which it then compares to the supplied password (&$auth3$&). Why is this example
28016 incorrect? It works fine for existing users, but consider what happens if a
28017 non-existent user name is given. The lookup fails, but as no success/failure
28018 strings are given for the lookup, it yields an empty string. Thus, to defeat
28019 the authentication, all a client has to do is to supply a non-existent user
28020 name and an empty password. The correct way of writing this test is:
28021 .code
28022 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28023   {${if eq{$value}{$auth3}}} {false}}
28024 .endd
28025 In this case, if the lookup succeeds, the result is checked; if the lookup
28026 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28027 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28028 always fails if its second argument is empty. However, the second way of
28029 writing the test makes the logic clearer.
28030
28031
28032 .section "The LOGIN authentication mechanism" "SECID173"
28033 .cindex "LOGIN authentication mechanism"
28034 .cindex authentication LOGIN
28035 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28036 in a number of programs. No data is sent with the AUTH command. Instead, a
28037 user name and password are supplied separately, in response to prompts. The
28038 plaintext authenticator can be configured to support this as in this example:
28039 .code
28040 fixed_login:
28041   driver = plaintext
28042   public_name = LOGIN
28043   server_prompts = User Name : Password
28044   server_condition = \
28045     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28046   server_set_id = $auth1
28047 .endd
28048 Because of the way plaintext operates, this authenticator accepts data supplied
28049 with the AUTH command (in contravention of the specification of LOGIN), but
28050 if the client does not supply it (as is the case for LOGIN clients), the prompt
28051 strings are used to obtain two data items.
28052
28053 Some clients are very particular about the precise text of the prompts. For
28054 example, Outlook Express is reported to recognize only &"Username:"& and
28055 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28056 strings. It uses the &%ldapauth%& expansion condition to check the user
28057 name and password by binding to an LDAP server:
28058 .code
28059 login:
28060   driver = plaintext
28061   public_name = LOGIN
28062   server_prompts = Username:: : Password::
28063   server_condition = ${if and{{ \
28064     !eq{}{$auth1} }{ \
28065     ldapauth{\
28066       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28067       pass=${quote:$auth2} \
28068       ldap://ldap.example.org/} }} }
28069   server_set_id = uid=$auth1,ou=people,o=example.org
28070 .endd
28071 We have to check that the username is not empty before using it, because LDAP
28072 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28073 operator to correctly quote the DN for authentication. However, the basic
28074 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28075 correct one to use for the password, because quoting is needed only to make
28076 the password conform to the Exim syntax. At the LDAP level, the password is an
28077 uninterpreted string.
28078
28079
28080 .section "Support for different kinds of authentication" "SECID174"
28081 A number of string expansion features are provided for the purpose of
28082 interfacing to different ways of user authentication. These include checking
28083 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28084 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28085 &<<SECTexpcond>>&.
28086
28087
28088
28089
28090 .section "Using plaintext in a client" "SECID175"
28091 .cindex "options" "&(plaintext)& authenticator (client)"
28092 The &(plaintext)& authenticator has two client options:
28093
28094 .option client_ignore_invalid_base64 plaintext boolean false
28095 If the client receives a server prompt that is not a valid base64 string,
28096 authentication is abandoned by default. However, if this option is set true,
28097 the error in the challenge is ignored and the client sends the response as
28098 usual.
28099
28100 .option client_send plaintext string&!! unset
28101 The string is a colon-separated list of authentication data strings. Each
28102 string is independently expanded before being sent to the server. The first
28103 string is sent with the AUTH command; any more strings are sent in response
28104 to prompts from the server. Before each string is expanded, the value of the
28105 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28106 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28107 way. Thus, the prompt that is received in response to sending the first string
28108 (with the AUTH command) can be used in the expansion of the second string, and
28109 so on. If an invalid base64 string is received when
28110 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28111 &$auth$&<&'n'&> variable.
28112
28113 &*Note*&: You cannot use expansion to create multiple strings, because
28114 splitting takes priority and happens first.
28115
28116 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28117 the data, further processing is applied to each string before it is sent. If
28118 there are any single circumflex characters in the string, they are converted to
28119 NULs. Should an actual circumflex be required as data, it must be doubled in
28120 the string.
28121
28122 This is an example of a client configuration that implements the PLAIN
28123 authentication mechanism with a fixed user name and password:
28124 .code
28125 fixed_plain:
28126   driver = plaintext
28127   public_name = PLAIN
28128   client_send = ^username^mysecret
28129 .endd
28130 The lack of colons means that the entire text is sent with the AUTH
28131 command, with the circumflex characters converted to NULs.
28132 Note that due to the ambiguity of parsing three consectutive circumflex characters
28133 there is no way to provide a password having a leading circumflex.
28134
28135
28136 A similar example
28137 that uses the LOGIN mechanism is:
28138 .code
28139 fixed_login:
28140   driver = plaintext
28141   public_name = LOGIN
28142   client_send = : username : mysecret
28143 .endd
28144 The initial colon means that the first string is empty, so no data is sent with
28145 the AUTH command itself. The remaining strings are sent in response to
28146 prompts.
28147 .ecindex IIDplaiauth1
28148 .ecindex IIDplaiauth2
28149
28150
28151
28152
28153 . ////////////////////////////////////////////////////////////////////////////
28154 . ////////////////////////////////////////////////////////////////////////////
28155
28156 .chapter "The cram_md5 authenticator" "CHID9"
28157 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28158 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28159 .cindex "CRAM-MD5 authentication mechanism"
28160 .cindex authentication CRAM-MD5
28161 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28162 sends a challenge string to the client, and the response consists of a user
28163 name and the CRAM-MD5 digest of the challenge string combined with a secret
28164 string (password) which is known to both server and client. Thus, the secret
28165 is not sent over the network as plain text, which makes this authenticator more
28166 secure than &(plaintext)&. However, the downside is that the secret has to be
28167 available in plain text at either end.
28168
28169
28170 .section "Using cram_md5 as a server" "SECID176"
28171 .cindex "options" "&(cram_md5)& authenticator (server)"
28172 This authenticator has one server option, which must be set to configure the
28173 authenticator as a server:
28174
28175 .option server_secret cram_md5 string&!! unset
28176 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28177 When the server receives the client's response, the user name is placed in
28178 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28179 obtain the password for that user. The server then computes the CRAM-MD5 digest
28180 that the client should have sent, and checks that it received the correct
28181 string. If the expansion of &%server_secret%& is forced to fail, authentication
28182 fails. If the expansion fails for some other reason, a temporary error code is
28183 returned to the client.
28184
28185 For compatibility with previous releases of Exim, the user name is also placed
28186 in &$1$&. However, the use of this variables for this purpose is now
28187 deprecated, as it can lead to confusion in string expansions that also use
28188 numeric variables for other things.
28189
28190 For example, the following authenticator checks that the user name given by the
28191 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28192 user name, authentication fails.
28193 .code
28194 fixed_cram:
28195   driver = cram_md5
28196   public_name = CRAM-MD5
28197   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28198   server_set_id = $auth1
28199 .endd
28200 .vindex "&$authenticated_id$&"
28201 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28202 name in &$authenticated_id$&. A more typical configuration might look up the
28203 secret string in a file, using the user name as the key. For example:
28204 .code
28205 lookup_cram:
28206   driver = cram_md5
28207   public_name = CRAM-MD5
28208   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28209                   {$value}fail}
28210   server_set_id = $auth1
28211 .endd
28212 Note that this expansion explicitly forces failure if the lookup fails
28213 because &$auth1$& contains an unknown user name.
28214
28215 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28216 using the relevant libraries, you need to know the realm to specify in the
28217 lookup and then ask for the &"userPassword"& attribute for that user in that
28218 realm, with:
28219 .code
28220 cyrusless_crammd5:
28221   driver = cram_md5
28222   public_name = CRAM-MD5
28223   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28224                   dbmjz{/etc/sasldb2}{$value}fail}
28225   server_set_id = $auth1
28226 .endd
28227
28228 .section "Using cram_md5 as a client" "SECID177"
28229 .cindex "options" "&(cram_md5)& authenticator (client)"
28230 When used as a client, the &(cram_md5)& authenticator has two options:
28231
28232
28233
28234 .option client_name cram_md5 string&!! "the primary host name"
28235 This string is expanded, and the result used as the user name data when
28236 computing the response to the server's challenge.
28237
28238
28239 .option client_secret cram_md5 string&!! unset
28240 This option must be set for the authenticator to work as a client. Its value is
28241 expanded and the result used as the secret string when computing the response.
28242
28243
28244 .vindex "&$host$&"
28245 .vindex "&$host_address$&"
28246 Different user names and secrets can be used for different servers by referring
28247 to &$host$& or &$host_address$& in the options. Forced failure of either
28248 expansion string is treated as an indication that this authenticator is not
28249 prepared to handle this case. Exim moves on to the next configured client
28250 authenticator. Any other expansion failure causes Exim to give up trying to
28251 send the message to the current server.
28252
28253 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28254 strings, is:
28255 .code
28256 fixed_cram:
28257   driver = cram_md5
28258   public_name = CRAM-MD5
28259   client_name = ph10
28260   client_secret = secret
28261 .endd
28262 .ecindex IIDcramauth1
28263 .ecindex IIDcramauth2
28264
28265
28266
28267 . ////////////////////////////////////////////////////////////////////////////
28268 . ////////////////////////////////////////////////////////////////////////////
28269
28270 .chapter "The cyrus_sasl authenticator" "CHID10"
28271 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28272 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28273 .cindex "Cyrus" "SASL library"
28274 .cindex "Kerberos"
28275 The code for this authenticator was provided by Matthew Byng-Maddick while
28276 at A L Digital Ltd.
28277
28278 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28279 library implementation of the RFC 2222 (&"Simple Authentication and Security
28280 Layer"&). This library supports a number of authentication mechanisms,
28281 including PLAIN and LOGIN, but also several others that Exim does not support
28282 directly. In particular, there is support for Kerberos authentication.
28283
28284 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28285 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28286 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28287 name of the driver to determine which mechanism to support.
28288
28289 Where access to some kind of secret file is required, for example, in GSSAPI
28290 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28291 user, and that the Cyrus SASL library has no way of escalating privileges
28292 by default. You may also find you need to set environment variables,
28293 depending on the driver you are using.
28294
28295 The application name provided by Exim is &"exim"&, so various SASL options may
28296 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28297 Kerberos, note that because of limitations in the GSSAPI interface,
28298 changing the server keytab might need to be communicated down to the Kerberos
28299 layer independently. The mechanism for doing so is dependent upon the Kerberos
28300 implementation.
28301
28302 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28303 may be set to point to an alternative keytab file. Exim will pass this
28304 variable through from its own inherited environment when started as root or the
28305 Exim user. The keytab file needs to be readable by the Exim user.
28306 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28307 environment variable.  In practice, for those releases, the Cyrus authenticator
28308 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28309 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28310
28311
28312 .section "Using cyrus_sasl as a server" "SECID178"
28313 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28314 (on a successful authentication) into &$auth1$&. For compatibility with
28315 previous releases of Exim, the username is also placed in &$1$&. However, the
28316 use of this variable for this purpose is now deprecated, as it can lead to
28317 confusion in string expansions that also use numeric variables for other
28318 things.
28319
28320
28321 .option server_hostname cyrus_sasl string&!! "see below"
28322 This option selects the hostname that is used when communicating with the
28323 library. The default value is &`$primary_hostname`&. It is up to the underlying
28324 SASL plug-in what it does with this data.
28325
28326
28327 .option server_mech cyrus_sasl string "see below"
28328 This option selects the authentication mechanism this driver should use. The
28329 default is the value of the generic &%public_name%& option. This option allows
28330 you to use a different underlying mechanism from the advertised name. For
28331 example:
28332 .code
28333 sasl:
28334   driver = cyrus_sasl
28335   public_name = X-ANYTHING
28336   server_mech = CRAM-MD5
28337   server_set_id = $auth1
28338 .endd
28339
28340 .option server_realm cyrus_sasl string&!! unset
28341 This specifies the SASL realm that the server claims to be in.
28342
28343
28344 .option server_service cyrus_sasl string &`smtp`&
28345 This is the SASL service that the server claims to implement.
28346
28347
28348 For straightforward cases, you do not need to set any of the authenticator's
28349 private options. All you need to do is to specify an appropriate mechanism as
28350 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28351 PLAIN, you could have two authenticators as follows:
28352 .code
28353 sasl_cram_md5:
28354   driver = cyrus_sasl
28355   public_name = CRAM-MD5
28356   server_set_id = $auth1
28357
28358 sasl_plain:
28359   driver = cyrus_sasl
28360   public_name = PLAIN
28361   server_set_id = $auth2
28362 .endd
28363 Cyrus SASL does implement the LOGIN authentication method, even though it is
28364 not a standard method. It is disabled by default in the source distribution,
28365 but it is present in many binary distributions.
28366 .ecindex IIDcyrauth1
28367 .ecindex IIDcyrauth2
28368
28369
28370
28371
28372 . ////////////////////////////////////////////////////////////////////////////
28373 . ////////////////////////////////////////////////////////////////////////////
28374 .chapter "The dovecot authenticator" "CHAPdovecot"
28375 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28376 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28377 This authenticator is an interface to the authentication facility of the
28378 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28379 Note that Dovecot must be configured to use auth-client not auth-userdb.
28380 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28381 to use the same mechanisms for SMTP authentication. This is a server
28382 authenticator only. There is only one non-generic option:
28383
28384 .option server_socket dovecot string unset
28385
28386 This option must specify the UNIX socket that is the interface to Dovecot
28387 authentication. The &%public_name%& option must specify an authentication
28388 mechanism that Dovecot is configured to support. You can have several
28389 authenticators for different mechanisms. For example:
28390 .code
28391 dovecot_plain:
28392   driver = dovecot
28393   public_name = PLAIN
28394   server_advertise_condition = ${if def:tls_in_cipher}
28395   server_socket = /var/run/dovecot/auth-client
28396   server_set_id = $auth1
28397
28398 dovecot_ntlm:
28399   driver = dovecot
28400   public_name = NTLM
28401   server_socket = /var/run/dovecot/auth-client
28402   server_set_id = $auth1
28403 .endd
28404
28405 .new
28406 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28407 should not be advertised on cleartext SMTP connections.
28408 See the discussion in section &<<SECTplain_TLS>>&.
28409 .wen
28410
28411 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28412 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28413 option is passed in the Dovecot authentication command. If, for a TLS
28414 connection, a client certificate has been verified, the &"valid-client-cert"&
28415 option is passed. When authentication succeeds, the identity of the user
28416 who authenticated is placed in &$auth1$&.
28417
28418 The Dovecot configuration to match the above will look
28419 something like:
28420 .code
28421 conf.d/10-master.conf :-
28422
28423 service auth {
28424 ...
28425 #SASL
28426   unix_listener auth-client {
28427     mode = 0660
28428     user = mail
28429   }
28430 ...
28431 }
28432
28433 conf.d/10-auth.conf :-
28434
28435 auth_mechanisms = plain login ntlm
28436 .endd
28437
28438 .ecindex IIDdcotauth1
28439 .ecindex IIDdcotauth2
28440
28441
28442 . ////////////////////////////////////////////////////////////////////////////
28443 . ////////////////////////////////////////////////////////////////////////////
28444 .chapter "The gsasl authenticator" "CHAPgsasl"
28445 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28446 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28447 .cindex "authentication" "GNU SASL"
28448 .cindex "authentication" "SASL"
28449 .cindex "authentication" "EXTERNAL"
28450 .cindex "authentication" "ANONYMOUS"
28451 .cindex "authentication" "PLAIN"
28452 .cindex "authentication" "LOGIN"
28453 .cindex "authentication" "DIGEST-MD5"
28454 .cindex "authentication" "CRAM-MD5"
28455 .cindex "authentication" "SCRAM family"
28456 The &(gsasl)& authenticator provides integration for the GNU SASL
28457 library and the mechanisms it provides.  This is new as of the 4.80 release
28458 and there are a few areas where the library does not let Exim smoothly
28459 scale to handle future authentication mechanisms, so no guarantee can be
28460 made that any particular new authentication mechanism will be supported
28461 without code changes in Exim.
28462
28463 The library is expected to add support in an upcoming
28464 realease for the SCRAM-SHA-256 method.
28465 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28466 when this happens.
28467
28468 To see the list of mechanisms supported by the library run Exim with "auth" debug
28469 enabled and look for a line containing "GNU SASL supports".
28470 Note however that some may not have been tested from Exim.
28471
28472
28473 .option client_authz gsasl string&!! unset
28474 This option can be used to supply an &'authorization id'&
28475 which is different to the &'authentication_id'& provided
28476 by &%client_username%& option.
28477 If unset or (after expansion) empty it is not used,
28478 which is the common case.
28479
28480 .option client_channelbinding gsasl boolean false
28481 See &%server_channelbinding%& below.
28482
28483 .option client_password gsasl string&!! unset
28484 This option is exapanded before use, and should result in
28485 the password to be used, in clear.
28486
28487 .option client_username gsasl string&!! unset
28488 This option is exapanded before use, and should result in
28489 the account name to be used.
28490
28491
28492 .option client_spassword gsasl string&!! unset
28493 This option is only supported for library versions 1.9.1 and greater.
28494 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28495
28496 If a SCRAM mechanism is being used and this option is set
28497 and correctly sized
28498 it is used in preference to &%client_password%&.
28499 The value after expansion should be
28500 a 40 (for SHA-1) or 64 (for SHA-256) character string
28501 with the PBKDF2-prepared password, hex-encoded.
28502
28503 Note that this value will depend on the salt and iteration-count
28504 supplied by the server.
28505 The option is expanded before use.
28506 During the expansion &$auth1$& is set with the client username,
28507 &$auth2$& with the iteration count, and
28508 &$auth3$& with the salt.
28509
28510 The intent of this option
28511 is to support clients that can cache thes salted password
28512 to save on recalculation costs.
28513 The cache lookup should return an unusable value
28514 (eg. an empty string)
28515 if the salt or iteration count has changed
28516
28517 If the authentication succeeds then the above variables are set,
28518 .vindex "&$auth4$&"
28519 plus the calculated salted password value value in &$auth4$&,
28520 during the expansion of the &%client_set_id%& option.
28521 A side-effect of this expansion can be used to prime the cache.
28522
28523
28524 .option server_channelbinding gsasl boolean false
28525 Some authentication mechanisms are able to use external context at both ends
28526 of the session to bind the authentication to that context, and fail the
28527 authentication process if that context differs.  Specifically, some TLS
28528 ciphersuites can provide identifying information about the cryptographic
28529 context.
28530
28531 This should have meant that certificate identity and verification becomes a
28532 non-issue, as a man-in-the-middle attack will cause the correct client and
28533 server to see different identifiers and authentication will fail.
28534
28535 This is
28536 only usable by mechanisms which support "channel binding"; at time of
28537 writing, that's the SCRAM family.
28538 When using this feature the "-PLUS" variants of the method names need to be used.
28539
28540 This defaults off to ensure smooth upgrade across Exim releases, in case
28541 this option causes some clients to start failing.  Some future release
28542 of Exim might have switched the default to be true.
28543
28544 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28545 . Do not plan to rely upon this feature for security, ever, without consulting
28546 . with a subject matter expert (a cryptographic engineer).
28547
28548 This option was deprecated in previous releases due to doubts over
28549 the "Triple Handshake" vulnerability.
28550 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28551 Session Resumption was used) for safety.
28552
28553
28554 .option server_hostname gsasl string&!! "see below"
28555 This option selects the hostname that is used when communicating with the
28556 library. The default value is &`$primary_hostname`&.
28557 Some mechanisms will use this data.
28558
28559
28560 .option server_mech gsasl string "see below"
28561 This option selects the authentication mechanism this driver should use. The
28562 default is the value of the generic &%public_name%& option. This option allows
28563 you to use a different underlying mechanism from the advertised name. For
28564 example:
28565 .code
28566 sasl:
28567   driver = gsasl
28568   public_name = X-ANYTHING
28569   server_mech = CRAM-MD5
28570   server_set_id = $auth1
28571 .endd
28572
28573
28574 .option server_password gsasl string&!! unset
28575 Various mechanisms need access to the cleartext password on the server, so
28576 that proof-of-possession can be demonstrated on the wire, without sending
28577 the password itself.
28578
28579 The data available for lookup varies per mechanism.
28580 In all cases, &$auth1$& is set to the &'authentication id'&.
28581 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28582 if available, else the empty string.
28583 The &$auth3$& variable will always be the &'realm'& if available,
28584 else the empty string.
28585
28586 A forced failure will cause authentication to defer.
28587
28588 If using this option, it may make sense to set the &%server_condition%&
28589 option to be simply "true".
28590
28591
28592 .option server_realm gsasl string&!! unset
28593 This specifies the SASL realm that the server claims to be in.
28594 Some mechanisms will use this data.
28595
28596
28597 .option server_scram_iter gsasl string&!! 4096
28598 This option provides data for the SCRAM family of mechanisms.
28599 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28600 when this option is expanded.
28601
28602 The result of expansion should be a decimal number,
28603 and represents both a lower-bound on the security, and
28604 a compute cost factor imposed on the client
28605 (if it does not cache results, or the server changes
28606 either the iteration count or the salt).
28607 A minimum value of 4096 is required by the standards
28608 for all current SCRAM mechanism variants.
28609
28610 .option server_scram_salt gsasl string&!! unset
28611 This option provides data for the SCRAM family of mechanisms.
28612 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28613 when this option is expanded.
28614 The value should be a base64-encoded string,
28615 of random data typically 4-to-16 bytes long.
28616 If unset or empty after expansion the library will provides a value for the
28617 protocol conversation.
28618
28619
28620 .option server_key gsasl string&!! unset
28621 .option server_skey gsasl string&!! unset
28622 These options can be used for the SCRAM family of mechanisms
28623 to provide stored information related to a password,
28624 the storage of which is preferable to plaintext.
28625
28626 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28627 &%server_skey%& is StoredKey.
28628
28629 They are only available for version 1.9.0 (or later) of the gsasl library.
28630 When this is so, the macros
28631 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28632 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28633 will be defined.
28634
28635 The &$authN$& variables are available when these options are expanded.
28636
28637 If set, the results of expansion should for each
28638 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28639 of base64-coded data, and will be used in preference to the
28640 &%server_password%& option.
28641 If unset or not of the right length, &%server_password%& will be used.
28642
28643 The libgsasl library release includes a utility &'gsasl'& which can be used
28644 to generate these values.
28645
28646
28647 .option server_service gsasl string &`smtp`&
28648 This is the SASL service that the server claims to implement.
28649 Some mechanisms will use this data.
28650
28651
28652 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28653 .vindex "&$auth1$&, &$auth2$&, etc"
28654 These may be set when evaluating specific options, as detailed above.
28655 They will also be set when evaluating &%server_condition%&.
28656
28657 Unless otherwise stated below, the &(gsasl)& integration will use the following
28658 meanings for these variables:
28659
28660 .ilist
28661 .vindex "&$auth1$&"
28662 &$auth1$&: the &'authentication id'&
28663 .next
28664 .vindex "&$auth2$&"
28665 &$auth2$&: the &'authorization id'&
28666 .next
28667 .vindex "&$auth3$&"
28668 &$auth3$&: the &'realm'&
28669 .endlist
28670
28671 On a per-mechanism basis:
28672
28673 .ilist
28674 .cindex "authentication" "EXTERNAL"
28675 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28676 the &%server_condition%& option must be present.
28677 .next
28678 .cindex "authentication" "ANONYMOUS"
28679 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28680 the &%server_condition%& option must be present.
28681 .next
28682 .cindex "authentication" "GSSAPI"
28683 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28684 &$auth2$& will be set to the &'authorization id'&,
28685 the &%server_condition%& option must be present.
28686 .endlist
28687
28688 An &'anonymous token'& is something passed along as an unauthenticated
28689 identifier; this is analogous to FTP anonymous authentication passing an
28690 email address, or software-identifier@, as the "password".
28691
28692
28693 An example showing the password having the realm specified in the callback
28694 and demonstrating a Cyrus SASL to GSASL migration approach is:
28695 .code
28696 gsasl_cyrusless_crammd5:
28697   driver = gsasl
28698   public_name = CRAM-MD5
28699   server_realm = imap.example.org
28700   server_password = ${lookup{$auth1:$auth3:userPassword}\
28701                     dbmjz{/etc/sasldb2}{$value}fail}
28702   server_set_id = ${quote:$auth1}
28703   server_condition = yes
28704 .endd
28705
28706
28707 . ////////////////////////////////////////////////////////////////////////////
28708 . ////////////////////////////////////////////////////////////////////////////
28709
28710 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28711 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28712 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28713 .cindex "authentication" "GSSAPI"
28714 .cindex "authentication" "Kerberos"
28715 The &(heimdal_gssapi)& authenticator provides server integration for the
28716 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28717 reliably.
28718
28719 .option server_hostname heimdal_gssapi string&!! "see below"
28720 This option selects the hostname that is used, with &%server_service%&,
28721 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28722 identifier.  The default value is &`$primary_hostname`&.
28723
28724 .option server_keytab heimdal_gssapi string&!! unset
28725 If set, then Heimdal will not use the system default keytab (typically
28726 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28727 The value should be a pathname, with no &"file:"& prefix.
28728
28729 .option server_service heimdal_gssapi string&!! "smtp"
28730 This option specifies the service identifier used, in conjunction with
28731 &%server_hostname%&, for building the identifier for finding credentials
28732 from the keytab.
28733
28734
28735 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28736 Beware that these variables will typically include a realm, thus will appear
28737 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28738 not verified, so a malicious client can set it to anything.
28739
28740 The &$auth1$& field should be safely trustable as a value from the Key
28741 Distribution Center.  Note that these are not quite email addresses.
28742 Each identifier is for a role, and so the left-hand-side may include a
28743 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28744
28745 .vindex "&$auth1$&, &$auth2$&, etc"
28746 .ilist
28747 .vindex "&$auth1$&"
28748 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28749 .next
28750 .vindex "&$auth2$&"
28751 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28752 authentication.  If that was empty, this will also be set to the
28753 GSS Display Name.
28754 .endlist
28755
28756
28757 . ////////////////////////////////////////////////////////////////////////////
28758 . ////////////////////////////////////////////////////////////////////////////
28759
28760 .chapter "The spa authenticator" "CHAPspa"
28761 .scindex IIDspaauth1 "&(spa)& authenticator"
28762 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28763 .cindex "authentication" "Microsoft Secure Password"
28764 .cindex "authentication" "NTLM"
28765 .cindex "Microsoft Secure Password Authentication"
28766 .cindex "NTLM authentication"
28767 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28768 Password Authentication'& mechanism,
28769 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28770 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28771 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28772 server side was subsequently contributed by Tom Kistner. The mechanism works as
28773 follows:
28774
28775 .ilist
28776 After the AUTH command has been accepted, the client sends an SPA
28777 authentication request based on the user name and optional domain.
28778 .next
28779 The server sends back a challenge.
28780 .next
28781 The client builds a challenge response which makes use of the user's password
28782 and sends it to the server, which then accepts or rejects it.
28783 .endlist
28784
28785 Encryption is used to protect the password in transit.
28786
28787
28788
28789 .section "Using spa as a server" "SECID179"
28790 .cindex "options" "&(spa)& authenticator (server)"
28791 The &(spa)& authenticator has just one server option:
28792
28793 .option server_password spa string&!! unset
28794 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28795 This option is expanded, and the result must be the cleartext password for the
28796 authenticating user, whose name is at this point in &$auth1$&. For
28797 compatibility with previous releases of Exim, the user name is also placed in
28798 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28799 it can lead to confusion in string expansions that also use numeric variables
28800 for other things. For example:
28801 .code
28802 spa:
28803   driver = spa
28804   public_name = NTLM
28805   server_password = \
28806     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28807 .endd
28808 If the expansion is forced to fail, authentication fails. Any other expansion
28809 failure causes a temporary error code to be returned.
28810
28811
28812
28813
28814
28815 .section "Using spa as a client" "SECID180"
28816 .cindex "options" "&(spa)& authenticator (client)"
28817 The &(spa)& authenticator has the following client options:
28818
28819
28820
28821 .option client_domain spa string&!! unset
28822 This option specifies an optional domain for the authentication.
28823
28824
28825 .option client_password spa string&!! unset
28826 This option specifies the user's password, and must be set.
28827
28828
28829 .option client_username spa string&!! unset
28830 This option specifies the user name, and must be set. Here is an example of a
28831 configuration of this authenticator for use with the mail servers at
28832 &'msn.com'&:
28833 .code
28834 msn:
28835   driver = spa
28836   public_name = MSN
28837   client_username = msn/msn_username
28838   client_password = msn_plaintext_password
28839   client_domain = DOMAIN_OR_UNSET
28840 .endd
28841 .ecindex IIDspaauth1
28842 .ecindex IIDspaauth2
28843
28844
28845
28846
28847
28848 . ////////////////////////////////////////////////////////////////////////////
28849 . ////////////////////////////////////////////////////////////////////////////
28850
28851 .chapter "The external authenticator" "CHAPexternauth"
28852 .scindex IIDexternauth1 "&(external)& authenticator"
28853 .scindex IIDexternauth2 "authenticators" "&(external)&"
28854 .cindex "authentication" "Client Certificate"
28855 .cindex "authentication" "X509"
28856 .cindex "Certificate-based authentication"
28857 The &(external)& authenticator provides support for
28858 authentication based on non-SMTP information.
28859 The specification is in RFC 4422 Appendix A
28860 (&url(https://tools.ietf.org/html/rfc4422)).
28861 It is only a transport and negotiation mechanism;
28862 the process of authentication is entirely controlled
28863 by the server configuration.
28864
28865 The client presents an identity in-clear.
28866 It is probably wise for a server to only advertise,
28867 and for clients to only attempt,
28868 this authentication method on a secure (eg. under TLS) connection.
28869
28870 One possible use, compatible with the
28871 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28872 is for using X509 client certificates.
28873
28874 It thus overlaps in function with the TLS authenticator
28875 (see &<<CHAPtlsauth>>&)
28876 but is a full SMTP SASL authenticator
28877 rather than being implicit for TLS-connection carried
28878 client certificates only.
28879
28880 The examples and discussion in this chapter assume that
28881 client-certificate authentication is being done.
28882
28883 The client must present a certificate,
28884 for which it must have been requested via the
28885 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28886 (see &<<CHAPTLS>>&).
28887 For authentication to be effective the certificate should be
28888 verifiable against a trust-anchor certificate known to the server.
28889
28890 .section "External options" "SECTexternsoptions"
28891 .cindex "options" "&(external)& authenticator (server)"
28892 The &(external)& authenticator has two server options:
28893
28894 .option server_param2 external string&!! unset
28895 .option server_param3 external string&!! unset
28896 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28897 These options are expanded before the &%server_condition%& option
28898 and the result are placed in &$auth2$& and &$auth3$& resectively.
28899 If the expansion is forced to fail, authentication fails. Any other expansion
28900 failure causes a temporary error code to be returned.
28901
28902 They can be used to clarify the coding of a complex &%server_condition%&.
28903
28904 .section "Using external in a server" "SECTexternserver"
28905 .cindex "AUTH" "in &(external)& authenticator"
28906 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28907         "in &(external)& authenticator"
28908 .vindex "&$auth1$&, &$auth2$&, etc"
28909 .cindex "base64 encoding" "in &(external)& authenticator"
28910
28911 When running as a server, &(external)& performs the authentication test by
28912 expanding a string. The data sent by the client with the AUTH command, or in
28913 response to subsequent prompts, is base64 encoded, and so may contain any byte
28914 values when decoded. The decoded value is treated as
28915 an identity for authentication and
28916 placed in the expansion variable &$auth1$&.
28917
28918 For compatibility with previous releases of Exim, the value is also placed in
28919 the expansion variable &$1$&. However, the use of this
28920 variable for this purpose is now deprecated, as it can lead to confusion in
28921 string expansions that also use them for other things.
28922
28923 .vindex "&$authenticated_id$&"
28924 Once an identity has been received,
28925 &%server_condition%& is expanded. If the expansion is forced to fail,
28926 authentication fails. Any other expansion failure causes a temporary error code
28927 to be returned. If the result of a successful expansion is an empty string,
28928 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28929 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28930 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28931 For any other result, a temporary error code is returned, with the expanded
28932 string as the error text.
28933
28934 Example:
28935 .code
28936 ext_ccert_san_mail:
28937   driver =            external
28938   public_name =       EXTERNAL
28939
28940   server_advertise_condition = $tls_in_certificate_verified
28941   server_param2 =     ${certextract {subj_altname,mail,>:} \
28942                                     {$tls_in_peercert}}
28943   server_condition =  ${if forany {$auth2} \
28944                             {eq {$item}{$auth1}}}
28945   server_set_id =     $auth1
28946 .endd
28947 This accepts a client certificate that is verifiable against any
28948 of your configured trust-anchors
28949 (which usually means the full set of public CAs)
28950 and which has a mail-SAN matching the claimed identity sent by the client.
28951
28952 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28953 The account name is therefore guessable by an opponent.
28954 TLS 1.3 protects both server and client certificates, and is not vulnerable
28955 in this way.
28956
28957
28958 .section "Using external in a client" "SECTexternclient"
28959 .cindex "options" "&(external)& authenticator (client)"
28960 The &(external)& authenticator has one client option:
28961
28962 .option client_send external string&!! unset
28963 This option is expanded and sent with the AUTH command as the
28964 identity being asserted.
28965
28966 Example:
28967 .code
28968 ext_ccert:
28969   driver =      external
28970   public_name = EXTERNAL
28971
28972   client_condition = ${if !eq{$tls_out_cipher}{}}
28973   client_send = myaccount@smarthost.example.net
28974 .endd
28975
28976
28977 .ecindex IIDexternauth1
28978 .ecindex IIDexternauth2
28979
28980
28981
28982
28983
28984 . ////////////////////////////////////////////////////////////////////////////
28985 . ////////////////////////////////////////////////////////////////////////////
28986
28987 .chapter "The tls authenticator" "CHAPtlsauth"
28988 .scindex IIDtlsauth1 "&(tls)& authenticator"
28989 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28990 .cindex "authentication" "Client Certificate"
28991 .cindex "authentication" "X509"
28992 .cindex "Certificate-based authentication"
28993 The &(tls)& authenticator provides server support for
28994 authentication based on client certificates.
28995
28996 It is not an SMTP authentication mechanism and is not
28997 advertised by the server as part of the SMTP EHLO response.
28998 It is an Exim authenticator in the sense that it affects
28999 the protocol element of the log line, can be tested for
29000 by the &%authenticated%& ACL condition, and can set
29001 the &$authenticated_id$& variable.
29002
29003 The client must present a verifiable certificate,
29004 for which it must have been requested via the
29005 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29006 (see &<<CHAPTLS>>&).
29007
29008 If an authenticator of this type is configured it is
29009 run immediately after a TLS connection being negotiated
29010 (due to either STARTTLS or TLS-on-connect)
29011 and can authenticate the connection.
29012 If it does, SMTP authentication is not subsequently offered.
29013
29014 A maximum of one authenticator of this type may be present.
29015
29016
29017 .cindex "options" "&(tls)& authenticator (server)"
29018 The &(tls)& authenticator has three server options:
29019
29020 .option server_param1 tls string&!! unset
29021 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29022 This option is expanded after the TLS negotiation and
29023 the result is placed in &$auth1$&.
29024 If the expansion is forced to fail, authentication fails. Any other expansion
29025 failure causes a temporary error code to be returned.
29026
29027 .option server_param2 tls string&!! unset
29028 .option server_param3 tls string&!! unset
29029 As above, for &$auth2$& and &$auth3$&.
29030
29031 &%server_param1%& may also be spelled &%server_param%&.
29032
29033
29034 Example:
29035 .code
29036 tls:
29037   driver = tls
29038   server_param1 =     ${certextract {subj_altname,mail,>:} \
29039                                     {$tls_in_peercert}}
29040   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29041                                  {forany {$auth1} \
29042                             {!= {0} \
29043                                 {${lookup ldap{ldap:///\
29044                          mailname=${quote_ldap_dn:${lc:$item}},\
29045                          ou=users,LDAP_DC?mailid} {$value}{0} \
29046                        }    }  } }}}
29047   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29048 .endd
29049 This accepts a client certificate that is verifiable against any
29050 of your configured trust-anchors
29051 (which usually means the full set of public CAs)
29052 and which has a SAN with a good account name.
29053
29054 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29055 The account name is therefore guessable by an opponent.
29056 TLS 1.3 protects both server and client certificates, and is not vulnerable
29057 in this way.
29058 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29059
29060 . An alternative might use
29061 . .code
29062 .   server_param1 = ${sha256:$tls_in_peercert}
29063 . .endd
29064 . to require one of a set of specific certs that define a given account
29065 . (the verification is still required, but mostly irrelevant).
29066 . This would help for per-device use.
29067 .
29068 . However, for the future we really need support for checking a
29069 . user cert in LDAP - which probably wants a base-64 DER.
29070
29071 .ecindex IIDtlsauth1
29072 .ecindex IIDtlsauth2
29073
29074
29075 Note that because authentication is traditionally an SMTP operation,
29076 the &%authenticated%& ACL condition cannot be used in
29077 a connect- or helo-ACL.
29078
29079
29080
29081 . ////////////////////////////////////////////////////////////////////////////
29082 . ////////////////////////////////////////////////////////////////////////////
29083
29084 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29085          "Encrypted SMTP connections"
29086 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29087 .scindex IIDencsmtp2 "SMTP" "encryption"
29088 .cindex "TLS" "on SMTP connection"
29089 .cindex "OpenSSL"
29090 .cindex "GnuTLS"
29091 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29092 Sockets Layer), is implemented by making use of the OpenSSL library or the
29093 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29094 cryptographic code in the Exim distribution itself for implementing TLS. In
29095 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29096 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29097 You also need to understand the basic concepts of encryption at a managerial
29098 level, and in particular, the way that public keys, private keys, and
29099 certificates are used.
29100
29101 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29102 connection is established, the client issues a STARTTLS command. If the
29103 server accepts this, the client and the server negotiate an encryption
29104 mechanism. If the negotiation succeeds, the data that subsequently passes
29105 between them is encrypted.
29106
29107 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29108 and if so, what cipher suite is in use, whether the client supplied a
29109 certificate, and whether or not that certificate was verified. This makes it
29110 possible for an Exim server to deny or accept certain commands based on the
29111 encryption state.
29112
29113 &*Warning*&: Certain types of firewall and certain anti-virus products can
29114 disrupt TLS connections. You need to turn off SMTP scanning for these products
29115 in order to get TLS to work.
29116
29117
29118
29119 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29120          "SECID284"
29121 .cindex "submissions protocol"
29122 .cindex "ssmtp protocol"
29123 .cindex "smtps protocol"
29124 .cindex "SMTP" "submissions protocol"
29125 .cindex "SMTP" "ssmtp protocol"
29126 .cindex "SMTP" "smtps protocol"
29127 The history of port numbers for TLS in SMTP is a little messy and has been
29128 contentious.  As of RFC 8314, the common practice of using the historically
29129 allocated port 465 for "email submission but with TLS immediately upon connect
29130 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29131 by them in preference to STARTTLS.
29132
29133 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29134 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29135 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29136
29137 This approach was, for a while, officially abandoned when encrypted SMTP was
29138 standardized, but many clients kept using it, even as the TCP port number was
29139 reassigned for other use.
29140 Thus you may encounter guidance claiming that you shouldn't enable use of
29141 this port.
29142 In practice, a number of mail-clients have only ever supported submissions,
29143 not submission with STARTTLS upgrade.
29144 Ideally, offer both submission (587) and submissions (465) service.
29145
29146 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29147 global option. Its value must be a list of port numbers;
29148 the most common use is expected to be:
29149 .code
29150 tls_on_connect_ports = 465
29151 .endd
29152 The port numbers specified by this option apply to all SMTP connections, both
29153 via the daemon and via &'inetd'&. You still need to specify all the ports that
29154 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29155 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29156 an extra port &-- rather, it specifies different behaviour on a port that is
29157 defined elsewhere.
29158
29159 There is also a &%-tls-on-connect%& command line option. This overrides
29160 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29161
29162
29163
29164
29165
29166
29167 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29168 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29169 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29170 To build Exim to use OpenSSL you need to set
29171 .code
29172 USE_OPENSSL=yes
29173 .endd
29174 in Local/Makefile.
29175
29176 To build Exim to use GnuTLS, you need to set
29177 .code
29178 USE_GNUTLS=yes
29179 .endd
29180 in Local/Makefile.
29181
29182 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29183 include files and libraries for GnuTLS can be found.
29184
29185 There are some differences in usage when using GnuTLS instead of OpenSSL:
29186
29187 .ilist
29188 The &%tls_verify_certificates%& option
29189 cannot be the path of a directory
29190 for GnuTLS versions before 3.3.6
29191 (for later versions, or OpenSSL, it can be either).
29192 .next
29193 The default value for &%tls_dhparam%& differs for historical reasons.
29194 .next
29195 .vindex "&$tls_in_peerdn$&"
29196 .vindex "&$tls_out_peerdn$&"
29197 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29198 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29199 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29200 .next
29201 OpenSSL identifies cipher suites using hyphens as separators, for example:
29202 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29203 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29204 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29205 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29206 to handle its own older variants) when processing lists of cipher suites in the
29207 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29208 option).
29209 .next
29210 The &%tls_require_ciphers%& options operate differently, as described in the
29211 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29212 .next
29213 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29214 When using OpenSSL, this option is ignored.
29215 (If an API is found to let OpenSSL be configured in this way,
29216 let the Exim Maintainers know and we'll likely use it).
29217 .next
29218 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29219 main option, it must be ordered to match the &%tls_certificate%& list.
29220 .next
29221 Some other recently added features may only be available in one or the other.
29222 This should be documented with the feature.  If the documentation does not
29223 explicitly state that the feature is infeasible in the other TLS
29224 implementation, then patches are welcome.
29225 .next
29226 The output from "exim -bV" will show which (if any) support was included
29227 in the build.
29228 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29229 .endlist
29230
29231
29232 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29233 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29234 an explicit path; if the latter, then the text about generation still applies,
29235 but not the chosen filename.
29236 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29237 See the documentation of &%tls_dhparam%& for more information.
29238
29239 GnuTLS uses D-H parameters that may take a substantial amount of time
29240 to compute. It is unreasonable to re-compute them for every TLS session.
29241 Therefore, Exim keeps this data in a file in its spool directory, called
29242 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29243 of bits requested.
29244 The file is owned by the Exim user and is readable only by
29245 its owner. Every Exim process that start up GnuTLS reads the D-H
29246 parameters from this file. If the file does not exist, the first Exim process
29247 that needs it computes the data and writes it to a temporary file which is
29248 renamed once it is complete. It does not matter if several Exim processes do
29249 this simultaneously (apart from wasting a few resources). Once a file is in
29250 place, new Exim processes immediately start using it.
29251
29252 For maximum security, the parameters that are stored in this file should be
29253 recalculated periodically, the frequency depending on your paranoia level.
29254 If you are avoiding using the fixed D-H primes published in RFCs, then you
29255 are concerned about some advanced attacks and will wish to do this; if you do
29256 not regenerate then you might as well stick to the standard primes.
29257
29258 Arranging this is easy in principle; just delete the file when you want new
29259 values to be computed. However, there may be a problem. The calculation of new
29260 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29261 If the system is not very active, &_/dev/random_& may delay returning data
29262 until enough randomness (entropy) is available. This may cause Exim to hang for
29263 a substantial amount of time, causing timeouts on incoming connections.
29264
29265 The solution is to generate the parameters externally to Exim. They are stored
29266 in &_gnutls-params-N_& in PEM format, which means that they can be
29267 generated externally using the &(certtool)& command that is part of GnuTLS.
29268
29269 To replace the parameters with new ones, instead of deleting the file
29270 and letting Exim re-create it, you can generate new parameters using
29271 &(certtool)& and, when this has been done, replace Exim's cache file by
29272 renaming. The relevant commands are something like this:
29273 .code
29274 # ls
29275 [ look for file; assume gnutls-params-2236 is the most recent ]
29276 # rm -f new-params
29277 # touch new-params
29278 # chown exim:exim new-params
29279 # chmod 0600 new-params
29280 # certtool --generate-dh-params --bits 2236 >>new-params
29281 # openssl dhparam -noout -text -in new-params | head
29282 [ check the first line, make sure it's not more than 2236;
29283   if it is, then go back to the start ("rm") and repeat
29284   until the size generated is at most the size requested ]
29285 # chmod 0400 new-params
29286 # mv new-params gnutls-params-2236
29287 .endd
29288 If Exim never has to generate the parameters itself, the possibility of
29289 stalling is removed.
29290
29291 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29292 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29293 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29294 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29295 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29296 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29297 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29298 which applies to all D-H usage, client or server.  If the value returned by
29299 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29300 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29301 limit, which is still much higher than Exim historically used.
29302
29303 The filename and bits used will change as the GnuTLS maintainers change the
29304 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29305 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29306 2432 bits, while NSS is limited to 2236 bits.
29307
29308 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29309 increase the chance of the generated prime actually being within acceptable
29310 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29311 procedure above.  There is no sane procedure available to Exim to double-check
29312 the size of the generated prime, so it might still be too large.
29313
29314
29315 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29316 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29317 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29318 There is a function in the OpenSSL library that can be passed a list of cipher
29319 suites before the cipher negotiation takes place. This specifies which ciphers
29320 are acceptable for TLS versions prior to 1.3.
29321 The list is colon separated and may contain names like
29322 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29323 directly to this function call.
29324 Many systems will install the OpenSSL manual-pages, so you may have
29325 &'ciphers(1)'& available to you.
29326 The following quotation from the OpenSSL
29327 documentation specifies what forms of item are allowed in the cipher string:
29328
29329 .ilist
29330 It can consist of a single cipher suite such as RC4-SHA.
29331 .next
29332 It can represent a list of cipher suites containing a certain algorithm,
29333 or cipher suites of a certain type. For example SHA1 represents all
29334 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29335 SSL v3 algorithms.
29336 .next
29337 Lists of cipher suites can be combined in a single cipher string using
29338 the + character. This is used as a logical and operation. For example
29339 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29340 algorithms.
29341 .endlist
29342
29343 Each cipher string can be optionally preceded by one of the characters &`!`&,
29344 &`-`& or &`+`&.
29345 .ilist
29346 If &`!`& is used, the ciphers are permanently deleted from the list. The
29347 ciphers deleted can never reappear in the list even if they are explicitly
29348 stated.
29349 .next
29350 If &`-`& is used, the ciphers are deleted from the list, but some or all
29351 of the ciphers can be added again by later options.
29352 .next
29353 If &`+`& is used, the ciphers are moved to the end of the list. This
29354 option does not add any new ciphers; it just moves matching existing ones.
29355 .endlist
29356
29357 If none of these characters is present, the string is interpreted as
29358 a list of ciphers to be appended to the current preference list. If the list
29359 includes any ciphers already present they will be ignored: that is, they will
29360 not be moved to the end of the list.
29361 .endlist
29362
29363 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29364 string:
29365 .code
29366 # note single-quotes to get ! past any shell history expansion
29367 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29368 .endd
29369
29370 This example will let the library defaults be permitted on the MX port, where
29371 there's probably no identity verification anyway, but ups the ante on the
29372 submission ports where the administrator might have some influence on the
29373 choice of clients used:
29374 .code
29375 # OpenSSL variant; see man ciphers(1)
29376 tls_require_ciphers = ${if =={$received_port}{25}\
29377                            {DEFAULT}\
29378                            {HIGH:!MD5:!SHA1}}
29379 .endd
29380
29381 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29382 .code
29383 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29384 .endd
29385
29386 For TLS version 1.3 the control available is less fine-grained
29387 and Exim does not provide access to it at present.
29388 The value of the &%tls_require_ciphers%& option is ignored when
29389 TLS version 1.3 is negotiated.
29390
29391 As of writing the library default cipher suite list for TLSv1.3 is
29392 .code
29393 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29394 .endd
29395
29396
29397 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29398          "SECTreqciphgnu"
29399 .cindex "GnuTLS" "specifying parameters for"
29400 .cindex "TLS" "specifying ciphers (GnuTLS)"
29401 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29402 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29403 .cindex "TLS" "specifying protocols (GnuTLS)"
29404 .cindex "TLS" "specifying priority string (GnuTLS)"
29405 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29406 The GnuTLS library allows the caller to provide a "priority string", documented
29407 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29408 ciphersuite specification in OpenSSL.
29409
29410 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29411 and controls both protocols and ciphers.
29412
29413 The &%tls_require_ciphers%& option is available both as an global option,
29414 controlling how Exim behaves as a server, and also as an option of the
29415 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29416 the value is string expanded.  The resulting string is not an Exim list and
29417 the string is given to the GnuTLS library, so that Exim does not need to be
29418 aware of future feature enhancements of GnuTLS.
29419
29420 Documentation of the strings accepted may be found in the GnuTLS manual, under
29421 "Priority strings".  This is online as
29422 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29423 but beware that this relates to GnuTLS 3, which may be newer than the version
29424 installed on your system.  If you are using GnuTLS 3,
29425 then the example code
29426 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29427 on that site can be used to test a given string.
29428
29429 For example:
29430 .code
29431 # Disable older versions of protocols
29432 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29433 .endd
29434
29435 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29436 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29437 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29438
29439 This example will let the library defaults be permitted on the MX port, where
29440 there's probably no identity verification anyway, and lowers security further
29441 by increasing compatibility; but this ups the ante on the submission ports
29442 where the administrator might have some influence on the choice of clients
29443 used:
29444 .code
29445 # GnuTLS variant
29446 tls_require_ciphers = ${if =={$received_port}{25}\
29447                            {NORMAL:%COMPAT}\
29448                            {SECURE128}}
29449 .endd
29450
29451
29452 .section "Configuring an Exim server to use TLS" "SECID182"
29453 .cindex "TLS" "configuring an Exim server"
29454 .cindex "ESMTP extensions" STARTTLS
29455 When Exim has been built with TLS support, it advertises the availability of
29456 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29457 but not to any others. The default value of this option is *, which means
29458 that STARTTLS is always advertised.  Set it to blank to never advertise;
29459 this is reasonable for systems that want to use TLS only as a client.
29460
29461 If STARTTLS is to be used you
29462 need to set some other options in order to make TLS available.
29463
29464 If a client issues a STARTTLS command and there is some configuration
29465 problem in the server, the command is rejected with a 454 error. If the client
29466 persists in trying to issue SMTP commands, all except QUIT are rejected
29467 with the error
29468 .code
29469 554 Security failure
29470 .endd
29471 If a STARTTLS command is issued within an existing TLS session, it is
29472 rejected with a 554 error code.
29473
29474 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29475 must be set to match some hosts. The default is * which matches all hosts.
29476
29477 If this is all you do, TLS encryption will be enabled but not authentication -
29478 meaning that the peer has no assurance it is actually you he is talking to.
29479 You gain protection from a passive sniffer listening on the wire but not
29480 from someone able to intercept the communication.
29481
29482 Further protection requires some further configuration at the server end.
29483
29484 To make TLS work you need to set, in the server,
29485 .code
29486 tls_certificate = /some/file/name
29487 tls_privatekey = /some/file/name
29488 .endd
29489 These options are, in fact, expanded strings, so you can make them depend on
29490 the identity of the client that is connected if you wish. The first file
29491 contains the server's X509 certificate, and the second contains the private key
29492 that goes with it. These files need to be
29493 PEM format and readable by the Exim user, and must
29494 always be given as full path names.
29495 The key must not be password-protected.
29496 They can be the same file if both the
29497 certificate and the key are contained within it. If &%tls_privatekey%& is not
29498 set, or if its expansion is forced to fail or results in an empty string, this
29499 is assumed to be the case. The certificate file may also contain intermediate
29500 certificates that need to be sent to the client to enable it to authenticate
29501 the server's certificate.
29502
29503 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29504 colon-separated lists of file paths.  Ciphers using given authentication
29505 algorithms require the presence of a suitable certificate to supply the
29506 public-key.  The server selects among the certificates to present to the
29507 client depending on the selected cipher, hence the priority ordering for
29508 ciphers will affect which certificate is used.
29509
29510 If you do not understand about certificates and keys, please try to find a
29511 source of this background information, which is not Exim-specific. (There are a
29512 few comments below in section &<<SECTcerandall>>&.)
29513
29514 &*Note*&: These options do not apply when Exim is operating as a client &--
29515 they apply only in the case of a server. If you need to use a certificate in an
29516 Exim client, you must set the options of the same names in an &(smtp)&
29517 transport.
29518
29519 With just these options, an Exim server will be able to use TLS. It does not
29520 require the client to have a certificate (but see below for how to insist on
29521 this). There is one other option that may be needed in other situations. If
29522 .code
29523 tls_dhparam = /some/file/name
29524 .endd
29525 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29526 with the parameters contained in the file.
29527 Set this to &`none`& to disable use of DH entirely, by making no prime
29528 available:
29529 .code
29530 tls_dhparam = none
29531 .endd
29532 This may also be set to a string identifying a standard prime to be used for
29533 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29534 used is &`ike23`&.  There are a few standard primes available, see the
29535 documentation for &%tls_dhparam%& for the complete list.
29536
29537 See the command
29538 .code
29539 openssl dhparam
29540 .endd
29541 for a way of generating file data.
29542
29543 The strings supplied for these three options are expanded every time a client
29544 host connects. It is therefore possible to use different certificates and keys
29545 for different hosts, if you so wish, by making use of the client's IP address
29546 in &$sender_host_address$& to control the expansion. If a string expansion is
29547 forced to fail, Exim behaves as if the option is not set.
29548
29549 .cindex "cipher" "logging"
29550 .cindex "log" "TLS cipher"
29551 .vindex "&$tls_in_cipher$&"
29552 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29553 an incoming TLS connection. It is included in the &'Received:'& header of an
29554 incoming message (by default &-- you can, of course, change this), and it is
29555 also included in the log line that records a message's arrival, keyed by
29556 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29557 condition can be used to test for specific cipher suites in ACLs.
29558
29559 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29560 can check the name of the cipher suite and vary their actions accordingly. The
29561 cipher suite names vary, depending on which TLS library is being used. For
29562 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29563 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29564 documentation for more details.
29565
29566 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29567 (again depending on the &%tls_cipher%& log selector).
29568
29569
29570 .subsection "Requesting and verifying client certificates"
29571 .cindex "certificate" "verification of client"
29572 .cindex "TLS" "client certificate verification"
29573 If you want an Exim server to request a certificate when negotiating a TLS
29574 session with a client, you must set either &%tls_verify_hosts%& or
29575 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29576 apply to all TLS connections. For any host that matches one of these options,
29577 Exim requests a certificate as part of the setup of the TLS session. The
29578 contents of the certificate are verified by comparing it with a list of
29579 expected trust-anchors or certificates.
29580 These may be the system default set (depending on library version),
29581 an explicit file or,
29582 depending on library version, a directory, identified by
29583 &%tls_verify_certificates%&.
29584
29585 A file can contain multiple certificates, concatenated end to end. If a
29586 directory is used
29587 (OpenSSL only),
29588 each certificate must be in a separate file, with a name (or a symbolic link)
29589 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29590 certificate. You can compute the relevant hash by running the command
29591 .code
29592 openssl x509 -hash -noout -in /cert/file
29593 .endd
29594 where &_/cert/file_& contains a single certificate.
29595
29596 There is no checking of names of the client against the certificate
29597 Subject Name or Subject Alternate Names.
29598
29599 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29600 what happens if the client does not supply a certificate, or if the certificate
29601 does not match any of the certificates in the collection named by
29602 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29603 attempt to set up a TLS session is aborted, and the incoming connection is
29604 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29605 session continues. ACLs that run for subsequent SMTP commands can detect the
29606 fact that no certificate was verified, and vary their actions accordingly. For
29607 example, you can insist on a certificate before accepting a message for
29608 relaying, but not when the message is destined for local delivery.
29609
29610 .vindex "&$tls_in_peerdn$&"
29611 When a client supplies a certificate (whether it verifies or not), the value of
29612 the Distinguished Name of the certificate is made available in the variable
29613 &$tls_in_peerdn$& during subsequent processing of the message.
29614
29615 .cindex "log" "distinguished name"
29616 Because it is often a long text string, it is not included in the log line or
29617 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29618 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29619 &%received_header_text%& to change the &'Received:'& header. When no
29620 certificate is supplied, &$tls_in_peerdn$& is empty.
29621
29622
29623 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29624 .cindex certificate caching
29625 .cindex privatekey caching
29626 .cindex crl caching
29627 .cindex ocsp caching
29628 .cindex ciphers caching
29629 .cindex "CA bundle" caching
29630 .cindex "certificate authorities" caching
29631 .cindex tls_certificate caching
29632 .cindex tls_privatekey caching
29633 .cindex tls_crl caching
29634 .cindex tls_ocsp_file caching
29635 .cindex tls_require_ciphers caching
29636 .cindex tls_verify_certificate caching
29637 .cindex caching certificate
29638 .cindex caching privatekey
29639 .cindex caching crl
29640 .cindex caching ocsp
29641 .cindex caching ciphers
29642 .cindex caching "certificate authorities
29643 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29644 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29645 expandable elements,
29646 then the associated information is loaded at daemon startup.
29647 It is made available
29648 to child processes forked for handling received SMTP connections.
29649
29650 This caching is currently only supported under Linux and FreeBSD.
29651
29652 If caching is not possible, for example if an item has to be dependent
29653 on the peer host so contains a &$sender_host_name$& expansion, the load
29654 of the associated information is done at the startup of the TLS connection.
29655
29656 The cache is invalidated and reloaded after any changes to the directories
29657 containing files specified by these options.
29658
29659 The information specified by the main option &%tls_verify_certificates%&
29660 is similarly cached so long as it specifies files explicitly
29661 or (under GnuTLS) is the string &"system,cache"&.
29662 The latter case is not automatically invalidated;
29663 it is the operator's responsibility to arrange for a daemon restart
29664 any time the system certificate authority bundle is updated.
29665 A HUP signal is sufficient for this.
29666 The value &"system"& results in no caching under GnuTLS.
29667
29668 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29669 is acceptable in configurations for the Exim executavble.
29670
29671 Caching of the system Certificate Authorities bundle can
29672 save siginificant time and processing on every TLS connection
29673 accepted by Exim.
29674
29675
29676
29677
29678 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29679 .cindex "cipher" "logging"
29680 .cindex "log" "TLS cipher"
29681 .cindex "log" "distinguished name"
29682 .cindex "TLS" "configuring an Exim client"
29683 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29684 deliveries as well as to incoming, the latter one causing logging of the
29685 server certificate's DN. The remaining client configuration for TLS is all
29686 within the &(smtp)& transport.
29687
29688 .cindex "ESMTP extensions" STARTTLS
29689 It is not necessary to set any options to have TLS work in the &(smtp)&
29690 transport. If Exim is built with TLS support, and TLS is advertised by a
29691 server, the &(smtp)& transport always tries to start a TLS session. However,
29692 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29693 transport) to a list of server hosts for which TLS should not be used.
29694
29695 If you do not want Exim to attempt to send messages unencrypted when an attempt
29696 to set up an encrypted connection fails in any way, you can set
29697 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29698 those hosts, delivery is always deferred if an encrypted connection cannot be
29699 set up. If there are any other hosts for the address, they are tried in the
29700 usual way.
29701
29702 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29703 the message unencrypted. It always does this if the response to STARTTLS is
29704 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29705 session after a success response code, what happens is controlled by the
29706 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29707 delivery to this host is deferred, and other hosts (if available) are tried. If
29708 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29709 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29710 negotiation fails, Exim closes the current connection (because it is in an
29711 unknown state), opens a new one to the same host, and then tries the delivery
29712 unencrypted.
29713
29714 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29715 transport provide the client with a certificate, which is passed to the server
29716 if it requests it.
29717 This is an optional thing for TLS connections, although either end
29718 may insist on it.
29719 If the server is Exim, it will request a certificate only if
29720 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29721
29722 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29723 for client use (they are usable for server use).
29724 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29725 in failed connections.
29726
29727 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29728 specifies a collection of expected server certificates.
29729 These may be
29730 the system default set (depending on library version),
29731 a file,
29732 or (depending on library version) a directory.
29733 The client verifies the server's certificate
29734 against this collection, taking into account any revoked certificates that are
29735 in the list defined by &%tls_crl%&.
29736 Failure to verify fails the TLS connection unless either of the
29737 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29738
29739 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29740 certificate verification to the listed servers.  Verification either must
29741 or need not succeed respectively.
29742
29743 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29744 name checks are made on the server certificate.
29745 The match against this list is, as per other Exim usage, the
29746 IP for the host.  That is most closely associated with the
29747 name on the DNS A (or AAAA) record for the host.
29748 However, the name that needs to be in the certificate
29749 is the one at the head of any CNAME chain leading to the A record.
29750 The option defaults to always checking.
29751
29752 The &(smtp)& transport has two OCSP-related options:
29753 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29754 is requested and required for the connection to proceed.  The default
29755 value is empty.
29756 &%hosts_request_ocsp%&; a host-list for which (additionally)
29757 a Certificate Status is requested (but not necessarily verified).  The default
29758 value is "*" meaning that requests are made unless configured
29759 otherwise.
29760
29761 The host(s) should also be in &%hosts_require_tls%&, and
29762 &%tls_verify_certificates%& configured for the transport,
29763 for OCSP to be relevant.
29764
29765 If
29766 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29767 list of permitted cipher suites. If either of these checks fails, delivery to
29768 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29769 alternative hosts, if any.
29770
29771  &*Note*&:
29772 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29773 is operating as a client. Exim does not assume that a server certificate (set
29774 by the global options of the same name) should also be used when operating as a
29775 client.
29776
29777 .vindex "&$host$&"
29778 .vindex "&$host_address$&"
29779 All the TLS options in the &(smtp)& transport are expanded before use, with
29780 &$host$& and &$host_address$& containing the name and address of the server to
29781 which the client is connected. Forced failure of an expansion causes Exim to
29782 behave as if the relevant option were unset.
29783
29784 .vindex &$tls_out_bits$&
29785 .vindex &$tls_out_cipher$&
29786 .vindex &$tls_out_peerdn$&
29787 .vindex &$tls_out_sni$&
29788 Before an SMTP connection is established, the
29789 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29790 variables are emptied. (Until the first connection, they contain the values
29791 that were set when the message was received.) If STARTTLS is subsequently
29792 successfully obeyed, these variables are set to the relevant values for the
29793 outgoing connection.
29794
29795
29796
29797 .subsection "Caching of static client configuration items" SECTclientTLScache
29798 .cindex certificate caching
29799 .cindex privatekey caching
29800 .cindex crl caching
29801 .cindex ciphers caching
29802 .cindex "CA bundle" caching
29803 .cindex "certificate authorities" caching
29804 .cindex tls_certificate caching
29805 .cindex tls_privatekey caching
29806 .cindex tls_crl caching
29807 .cindex tls_require_ciphers caching
29808 .cindex tls_verify_certificate caching
29809 .cindex caching certificate
29810 .cindex caching privatekey
29811 .cindex caching crl
29812 .cindex caching ciphers
29813 .cindex caching "certificate authorities
29814 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29815 and &%tls_crl%& have values with no
29816 expandable elements,
29817 then the associated information is loaded per smtp transport
29818 at daemon startup, at the start of a queue run, or on a
29819 command-line specified message delivery.
29820 It is made available
29821 to child processes forked for handling making SMTP connections.
29822
29823 This caching is currently only supported under Linux.
29824
29825 If caching is not possible, the load
29826 of the associated information is done at the startup of the TLS connection.
29827
29828 The cache is invalidated in the daemon
29829 and reloaded after any changes to the directories
29830 containing files specified by these options.
29831
29832 The information specified by the main option &%tls_verify_certificates%&
29833 is similarly cached so long as it specifies files explicitly
29834 or (under GnuTLS) is the string &"system,cache"&.
29835 The latter case is not automatically invaludated;
29836 it is the operator's responsibility to arrange for a daemon restart
29837 any time the system certificate authority bundle is updated.
29838 A HUP signal is sufficient for this.
29839 The value &"system"& results in no caching under GnuTLS.
29840
29841 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29842 is acceptable in configurations for the Exim executavble.
29843
29844 Caching of the system Certificate Authorities bundle can
29845 save siginificant time and processing on every TLS connection
29846 initiated by Exim.
29847
29848
29849
29850
29851 .section "Use of TLS Server Name Indication" "SECTtlssni"
29852 .cindex "TLS" "Server Name Indication"
29853 .cindex "TLS" SNI
29854 .cindex SNI
29855 .vindex "&$tls_in_sni$&"
29856 .oindex "&%tls_in_sni%&"
29857 With TLS1.0 or above, there is an extension mechanism by which extra
29858 information can be included at various points in the protocol.  One of these
29859 extensions, documented in RFC 6066 (and before that RFC 4366) is
29860 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29861 client in the initial handshake, so that the server can examine the servername
29862 within and possibly choose to use different certificates and keys (and more)
29863 for this session.
29864
29865 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29866 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29867 address.
29868
29869 With SMTP to MX, there are the same problems here as in choosing the identity
29870 against which to validate a certificate: you can't rely on insecure DNS to
29871 provide the identity which you then cryptographically verify.  So this will
29872 be of limited use in that environment.
29873
29874 With SMTP to Submission, there is a well-defined hostname which clients are
29875 connecting to and can validate certificates against.  Thus clients &*can*&
29876 choose to include this information in the TLS negotiation.  If this becomes
29877 wide-spread, then hosters can choose to present different certificates to
29878 different clients.  Or even negotiate different cipher suites.
29879
29880 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29881 if not empty, will be sent on a TLS session as part of the handshake.  There's
29882 nothing more to it.  Choosing a sensible value not derived insecurely is the
29883 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29884 for the lifetime of the client connection (including during authentication).
29885
29886 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29887 is forced to the name of the destination host, after any MX- or CNAME-following.
29888
29889 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29890 received from a client.
29891 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29892
29893 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29894 option (prior to expansion) then the following options will be re-expanded
29895 during TLS session handshake, to permit alternative values to be chosen:
29896
29897 .ilist
29898 &%tls_certificate%&
29899 .next
29900 &%tls_crl%&
29901 .next
29902 &%tls_privatekey%&
29903 .next
29904 &%tls_verify_certificates%&
29905 .next
29906 &%tls_ocsp_file%&
29907 .endlist
29908
29909 Great care should be taken to deal with matters of case, various injection
29910 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29911 can always be referenced; it is important to remember that &$tls_in_sni$& is
29912 arbitrary unverified data provided prior to authentication.
29913 Further, the initial certificate is loaded before SNI has arrived, so
29914 an expansion for &%tls_certificate%& must have a default which is used
29915 when &$tls_in_sni$& is empty.
29916
29917 The Exim developers are proceeding cautiously and so far no other TLS options
29918 are re-expanded.
29919
29920 When Exim is built against OpenSSL, OpenSSL must have been built with support
29921 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29922 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29923 see &`-servername`& in the output, then OpenSSL has support.
29924
29925 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29926 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29927 built, then you have SNI support).
29928
29929 .subsection ALPN
29930 .cindex TLS ALPN
29931 .cindex ALPN "general information"
29932 .cindex TLS "Application Layer Protocol Names"
29933 There is a TLS feature related to SNI
29934 called Application Layer Protocol Name (ALPN).
29935 This is intended to declare, or select, what protocol layer will be using a TLS
29936 connection.
29937 The client for the connection proposes a set of protocol names, and
29938 the server responds with a selected one.
29939 It is not, as of 2021, commonly used for SMTP connections.
29940 However, to guard against misdirected or malicious use of web clients
29941 (which often do use ALPN) against MTA ports, Exim by default check that
29942 there is no incompatible ALPN specified by a client for a TLS connection.
29943 If there is, the connection is rejected.
29944
29945 As a client Exim does not supply ALPN by default.
29946 The behaviour of both client and server can be configured using the options
29947 &%tls_alpn%& and &%hosts_require_alpn%&.
29948 There are no variables providing observability.
29949 Some feature-specific logging may appear on denied connections, but this
29950 depends on the behaviour of the peer
29951 (not all peers can send a feature-specific TLS Alert).
29952
29953 This feature is available when Exim is built with
29954 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29955 the macro _HAVE_TLS_ALPN will be defined when this is so.
29956
29957
29958
29959 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29960          "SECTmulmessam"
29961 .cindex "multiple SMTP deliveries with TLS"
29962 .cindex "TLS" "multiple message deliveries"
29963 Exim sends multiple messages down the same TCP/IP connection by starting up
29964 an entirely new delivery process for each message, passing the socket from
29965 one process to the next. This implementation does not fit well with the use
29966 of TLS, because there is quite a lot of state information associated with a TLS
29967 connection, not just a socket identification. Passing all the state information
29968 to a new process is not feasible. Consequently, for sending using TLS Exim
29969 starts an additional proxy process for handling the encryption, piping the
29970 unencrypted data stream from and to the delivery processes.
29971
29972 An older mode of operation can be enabled on a per-host basis by the
29973 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29974 this list the proxy process described above is not used; instead Exim
29975 shuts down an existing TLS session being run by the delivery process
29976 before passing the socket to a new process. The new process may then
29977 try to start a new TLS session, and if successful, may try to re-authenticate
29978 if AUTH is in use, before sending the next message.
29979
29980 The RFC is not clear as to whether or not an SMTP session continues in clear
29981 after TLS has been shut down, or whether TLS may be restarted again later, as
29982 just described. However, if the server is Exim, this shutdown and
29983 reinitialization works. It is not known which (if any) other servers operate
29984 successfully if the client closes a TLS session and continues with unencrypted
29985 SMTP, but there are certainly some that do not work. For such servers, Exim
29986 should not pass the socket to another process, because the failure of the
29987 subsequent attempt to use it would cause Exim to record a temporary host error,
29988 and delay other deliveries to that host.
29989
29990 To test for this case, Exim sends an EHLO command to the server after
29991 closing down the TLS session. If this fails in any way, the connection is
29992 closed instead of being passed to a new delivery process, but no retry
29993 information is recorded.
29994
29995 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29996 &(smtp)& transport to match those hosts for which Exim should not pass
29997 connections to new processes if TLS has been used.
29998
29999
30000
30001
30002 .section "Certificates and all that" "SECTcerandall"
30003 .cindex "certificate" "references to discussion"
30004 In order to understand fully how TLS works, you need to know about
30005 certificates, certificate signing, and certificate authorities.
30006 This is a large topic and an introductory guide is unsuitable for the Exim
30007 reference manual, so instead we provide pointers to existing documentation.
30008
30009 The Apache web-server was for a long time the canonical guide, so their
30010 documentation is a good place to start; their SSL module's Introduction
30011 document is currently at
30012 .display
30013 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30014 .endd
30015 and their FAQ is at
30016 .display
30017 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30018 .endd
30019
30020 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30021 0-201-61598-3) in 2001, contains both introductory and more in-depth
30022 descriptions.
30023 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30024 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30025 Ivan is the author of the popular TLS testing tools at
30026 &url(https://www.ssllabs.com/).
30027
30028
30029 .subsection "Certificate chains" SECID186
30030 A file named by &%tls_certificate%& may contain more than one
30031 certificate. This is useful in the case where the certificate that is being
30032 sent is validated by an intermediate certificate which the other end does
30033 not have. Multiple certificates must be in the correct order in the file.
30034 First the host's certificate itself, then the first intermediate
30035 certificate to validate the issuer of the host certificate, then the next
30036 intermediate certificate to validate the issuer of the first intermediate
30037 certificate, and so on, until finally (optionally) the root certificate.
30038 The root certificate must already be trusted by the recipient for
30039 validation to succeed, of course, but if it's not preinstalled, sending the
30040 root certificate along with the rest makes it available for the user to
30041 install if the receiving end is a client MUA that can interact with a user.
30042
30043 Note that certificates using MD5 are unlikely to work on today's Internet;
30044 even if your libraries allow loading them for use in Exim when acting as a
30045 server, increasingly clients will not accept such certificates.  The error
30046 diagnostics in such a case can be frustratingly vague.
30047
30048
30049
30050 .subsection "Self-signed certificates" SECID187
30051 .cindex "certificate" "self-signed"
30052 You can create a self-signed certificate using the &'req'& command provided
30053 with OpenSSL, like this:
30054 . ==== Do not shorten the duration here without reading and considering
30055 . ==== the text below.  Please leave it at 9999 days.
30056 .code
30057 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30058             -days 9999 -nodes
30059 .endd
30060 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30061 delimited and so can be identified independently. The &%-days%& option
30062 specifies a period for which the certificate is valid. The &%-nodes%& option is
30063 important: if you do not set it, the key is encrypted with a passphrase
30064 that you are prompted for, and any use that is made of the key causes more
30065 prompting for the passphrase. This is not helpful if you are going to use
30066 this certificate and key in an MTA, where prompting is not possible.
30067
30068 . ==== I expect to still be working 26 years from now.  The less technical
30069 . ==== debt I create, in terms of storing up trouble for my later years, the
30070 . ==== happier I will be then.  We really have reached the point where we
30071 . ==== should start, at the very least, provoking thought and making folks
30072 . ==== pause before proceeding, instead of leaving all the fixes until two
30073 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30074 . ==== -pdp, 2012
30075 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30076 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30077 the above command might produce a date in the past.  Think carefully about
30078 the lifetime of the systems you're deploying, and either reduce the duration
30079 of the certificate or reconsider your platform deployment.  (At time of
30080 writing, reducing the duration is the most likely choice, but the inexorable
30081 progression of time takes us steadily towards an era where this will not
30082 be a sensible resolution).
30083
30084 A self-signed certificate made in this way is sufficient for testing, and
30085 may be adequate for all your requirements if you are mainly interested in
30086 encrypting transfers, and not in secure identification.
30087
30088 However, many clients require that the certificate presented by the server be a
30089 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30090 certificate. In this situation, the self-signed certificate described above
30091 must be installed on the client host as a trusted root &'certification
30092 authority'& (CA), and the certificate used by Exim must be a user certificate
30093 signed with that self-signed certificate.
30094
30095 For information on creating self-signed CA certificates and using them to sign
30096 user certificates, see the &'General implementation overview'& chapter of the
30097 Open-source PKI book, available online at
30098 &url(https://sourceforge.net/projects/ospkibook/).
30099
30100
30101 .subsection "Revoked certificates"
30102 .cindex "TLS" "revoked certificates"
30103 .cindex "revocation list"
30104 .cindex "certificate" "revocation list"
30105 .cindex "OCSP" "stapling"
30106 There are three ways for a certificate to be made unusable
30107 before its expiry.
30108
30109 .ilist
30110 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30111 certificates are revoked. If you have such a list, you can pass it to an Exim
30112 server using the global option called &%tls_crl%& and to an Exim client using
30113 an identically named option for the &(smtp)& transport. In each case, the value
30114 of the option is expanded and must then be the name of a file that contains a
30115 CRL in PEM format.
30116 The downside is that clients have to periodically re-download a potentially huge
30117 file from every certificate authority they know of.
30118
30119 .next
30120 The way with most moving parts at query time is Online Certificate
30121 Status Protocol (OCSP), where the client verifies the certificate
30122 against an OCSP server run by the CA.  This lets the CA track all
30123 usage of the certs.  It requires running software with access to the
30124 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30125 is based on HTTP and can be proxied accordingly.
30126
30127 The only widespread OCSP server implementation (known to this writer)
30128 comes as part of OpenSSL and aborts on an invalid request, such as
30129 connecting to the port and then disconnecting.  This requires
30130 re-entering the passphrase each time some random client does this.
30131
30132 .next
30133 The third way is OCSP Stapling; in this, the server using a certificate
30134 issued by the CA periodically requests an OCSP proof of validity from
30135 the OCSP server, then serves it up inline as part of the TLS
30136 negotiation.   This approach adds no extra round trips, does not let the
30137 CA track users, scales well with number of certs issued by the CA and is
30138 resilient to temporary OCSP server failures, as long as the server
30139 starts retrying to fetch an OCSP proof some time before its current
30140 proof expires.  The downside is that it requires server support.
30141
30142 Unless Exim is built with the support disabled,
30143 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30144 support for OCSP stapling is included.
30145
30146 There is a global option called &%tls_ocsp_file%&.
30147 The file specified therein is expected to be in DER format, and contain
30148 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30149 option will be re-expanded for SNI, if the &%tls_certificate%& option
30150 contains &`tls_in_sni`&, as per other TLS options.
30151
30152 Exim does not at this time implement any support for fetching a new OCSP
30153 proof.  The burden is on the administrator to handle this, outside of
30154 Exim.  The file specified should be replaced atomically, so that the
30155 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30156 on each connection, so a new file will be handled transparently on the
30157 next connection.
30158
30159 When built with OpenSSL Exim will check for a valid next update timestamp
30160 in the OCSP proof; if not present, or if the proof has expired, it will be
30161 ignored.
30162
30163 For the client to be able to verify the stapled OCSP the server must
30164 also supply, in its stapled information, any intermediate
30165 certificates for the chain leading to the OCSP proof from the signer
30166 of the server certificate.  There may be zero or one such. These
30167 intermediate certificates should be added to the server OCSP stapling
30168 file named by &%tls_ocsp_file%&.
30169
30170 Note that the proof only covers the terminal server certificate,
30171 not any of the chain from CA to it.
30172
30173 There is no current way to staple a proof for a client certificate.
30174
30175 .code
30176   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30177   OCSP server is supplied.  The server URL may be included in the
30178   server certificate, if the CA is helpful.
30179
30180   One failure mode seen was the OCSP Signer cert expiring before the end
30181   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30182   noted this as invalid overall, but the re-fetch script did not.
30183 .endd
30184 .endlist
30185
30186
30187 .ecindex IIDencsmtp1
30188 .ecindex IIDencsmtp2
30189
30190
30191 .section "TLS Resumption" "SECTresumption"
30192 .cindex TLS resumption
30193 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30194 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30195 (or later).
30196
30197 Session resumption (this is the "stateless" variant) involves the server sending
30198 a "session ticket" to the client on one connection, which can be stored by the
30199 client and used for a later session.  The ticket contains sufficient state for
30200 the server to reconstruct the TLS session, avoiding some expensive crypto
30201 calculation and (on TLS1.2) one full packet roundtrip time.
30202
30203 .ilist
30204 Operational cost/benefit:
30205
30206  The extra data being transmitted costs a minor amount, and the client has
30207  extra costs in storing and retrieving the data.
30208
30209  In the Exim/Gnutls implementation the extra cost on an initial connection
30210  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30211  The saved cost on a subsequent connection is about 4ms; three or more
30212  connections become a net win.  On longer network paths, two or more
30213  connections will have an average lower startup time thanks to the one
30214  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30215  packet roundtrips.
30216
30217 .cindex "hints database" tls
30218  Since a new hints DB is used on the TLS client,
30219  the hints DB maintenance should be updated to additionally handle "tls".
30220
30221 .next
30222 Security aspects:
30223
30224  The session ticket is encrypted, but is obviously an additional security
30225  vulnarability surface.  An attacker able to decrypt it would have access
30226  all connections using the resumed session.
30227  The session ticket encryption key is not committed to storage by the server
30228  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30229  overlap; GnuTLS 6hr but does not specify any overlap).
30230  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30231  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30232
30233  There is a question-mark over the security of the Diffie-Helman parameters
30234  used for session negotiation.
30235
30236 .next
30237 Observability:
30238
30239  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30240  element.
30241
30242  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30243  have bits 0-4 indicating respectively
30244  support built, client requested ticket, client offered session,
30245  server issued ticket, resume used.  A suitable decode list is provided
30246  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30247
30248 .next
30249 Control:
30250
30251 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30252 exim, operating as a server, will offer resumption to clients.
30253 Current best practice is to not offer the feature to MUA connection.
30254 Commonly this can be done like this:
30255 .code
30256 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30257 .endd
30258 If the peer host matches the list after expansion then resumption
30259 is offered and/or accepted.
30260
30261 The &%tls_resumption_hosts%& smtp transport option performs the
30262 equivalent function for operation as a client.
30263 If the peer host matches the list after expansion then resumption
30264 is attempted (if a stored session is available) or the information
30265 stored (if supplied by the peer).
30266
30267
30268 .next
30269 Issues:
30270
30271  In a resumed session:
30272 .ilist
30273   The variables &$tls_{in,out}_cipher$& will have values different
30274  to the original (under GnuTLS).
30275 .next
30276   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30277  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30278 . XXX need to do something with that hosts_require_ocsp
30279 .endlist
30280
30281 .endlist
30282
30283
30284 .section DANE "SECDANE"
30285 .cindex DANE
30286 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30287 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30288 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30289 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30290 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30291 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30292
30293 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30294 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30295 by (a) is thought to be smaller than that of the set of root CAs.
30296
30297 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30298 fail to pass on a server's STARTTLS.
30299
30300 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30301 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30302 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30303
30304 DANE requires a server operator to do three things:
30305 .olist
30306 Run DNSSEC.  This provides assurance to clients
30307 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30308 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30309 DNSSEC.
30310 .next
30311 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30312 .next
30313 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30314 .endlist
30315
30316 There are no changes to Exim specific to server-side operation of DANE.
30317 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30318 in &_Local/Makefile_&.
30319 If it has been included, the macro "_HAVE_DANE" will be defined.
30320
30321 .subsection "DNS records"
30322 A TLSA record consist of 4 fields, the "Certificate Usage", the
30323 "Selector", the "Matching type", and the "Certificate Association Data".
30324 For a detailed description of the TLSA record see
30325 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30326
30327 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30328 These are the "Trust Anchor" and "End Entity" variants.
30329 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30330 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30331 this is appropriate for a single system, using a self-signed certificate.
30332 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30333 well-known one.
30334 A private CA at simplest is just a self-signed certificate (with certain
30335 attributes) which is used to sign server certificates, but running one securely
30336 does require careful arrangement.
30337 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30338 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30339 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30340 all of which point to a single TLSA record.
30341 DANE-TA and DANE-EE can both be used together.
30342
30343 Our recommendation is to use DANE with a certificate from a public CA,
30344 because this enables a variety of strategies for remote clients to verify
30345 your certificate.
30346 You can then publish information both via DANE and another technology,
30347 "MTA-STS", described below.
30348
30349 When you use DANE-TA to publish trust anchor information, you ask entities
30350 outside your administrative control to trust the Certificate Authority for
30351 connections to you.
30352 If using a private CA then you should expect others to still apply the
30353 technical criteria they'd use for a public CA to your certificates.
30354 In particular, you should probably try to follow current best practices for CA
30355 operation around hash algorithms and key sizes.
30356 Do not expect other organizations to lower their security expectations just
30357 because a particular profile might be reasonable for your own internal use.
30358
30359 When this text was last updated, this in practice means to avoid use of SHA-1
30360 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30361 than 4096, for interoperability); to use keyUsage fields correctly; to use
30362 random serial numbers.
30363 The list of requirements is subject to change as best practices evolve.
30364 If you're not already using a private CA, or it doesn't meet these
30365 requirements, then we encourage you to avoid all these issues and use a public
30366 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30367
30368 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30369 a "Matching Type" (3rd) field of SHA2-512(2).
30370
30371 For the "Certificate Authority Data" (4th) field, commands like
30372
30373 .code
30374   openssl x509 -pubkey -noout <certificate.pem \
30375   | openssl rsa -outform der -pubin 2>/dev/null \
30376   | openssl sha512 \
30377   | awk '{print $2}'
30378 .endd
30379
30380 are workable to create a hash of the certificate's public key.
30381
30382 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30383
30384 .code
30385   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30386 .endd
30387
30388 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30389 is useful for quickly generating TLSA records.
30390
30391
30392 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30393
30394 The Certificate issued by the CA published in the DANE-TA model should be
30395 issued using a strong hash algorithm.
30396 Exim, and importantly various other MTAs sending to you, will not
30397 re-enable hash algorithms which have been disabled by default in TLS
30398 libraries.
30399 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30400 interoperability (and probably the maximum too, in 2018).
30401
30402 .subsection "Interaction with OCSP"
30403 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30404 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30405 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30406
30407 .code
30408   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30409                                  {= {4}{$tls_out_tlsa_usage}} } \
30410                          {*}{}}
30411 .endd
30412
30413 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30414 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30415 found. If the definition of &%hosts_request_ocsp%& includes the
30416 string "tls_out_tlsa_usage", they are re-expanded in time to
30417 control the OCSP request.
30418
30419 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30420 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30421
30422
30423 .subsection "Client configuration"
30424 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30425 and &%dane_require_tls_ciphers%&.
30426 The &"require"& variant will result in failure if the target host is not
30427 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30428 the &%dnssec_request_domains%& router or transport option.
30429
30430 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30431
30432 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30433 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30434 will be required for the host.  If it does not, the host will not
30435 be used; there is no fallback to non-DANE or non-TLS.
30436
30437 If DANE is requested and usable, then the TLS cipher list configuration
30438 prefers to use the option &%dane_require_tls_ciphers%& and falls
30439 back to &%tls_require_ciphers%& only if that is unset.
30440 This lets you configure "decent crypto" for DANE and "better than nothing
30441 crypto" as the default.  Note though that while GnuTLS lets the string control
30442 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30443 limited to ciphersuite constraints.
30444
30445 If DANE is requested and useable (see above) the following transport options are ignored:
30446 .code
30447   hosts_require_tls
30448   tls_verify_hosts
30449   tls_try_verify_hosts
30450   tls_verify_certificates
30451   tls_crl
30452   tls_verify_cert_hostnames
30453   tls_sni
30454 .endd
30455
30456 If DANE is not usable, whether requested or not, and CA-anchored
30457 verification evaluation is wanted, the above variables should be set appropriately.
30458
30459 The router and transport option &%dnssec_request_domains%& must not be
30460 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30461
30462 .subsection Observability
30463 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30464
30465 There is a new variable &$tls_out_dane$& which will have "yes" if
30466 verification succeeded using DANE and "no" otherwise (only useful
30467 in combination with events; see &<<CHAPevents>>&),
30468 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30469
30470 .cindex DANE reporting
30471 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30472 to achieve DANE-verified connection, if one was either requested and offered, or
30473 required.  This is intended to support TLS-reporting as defined in
30474 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30475 The &$event_data$& will be one of the Result Types defined in
30476 Section 4.3 of that document.
30477
30478 .subsection General
30479 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30480
30481 DANE is specified in published RFCs and decouples certificate authority trust
30482 selection from a "race to the bottom" of "you must trust everything for mail
30483 to get through".
30484 There is an alternative technology called MTA-STS, which
30485 instead publishes MX trust anchor information on an HTTPS website.  At the
30486 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30487 Exim has no support for MTA-STS as a client, but Exim mail server operators
30488 can choose to publish information describing their TLS configuration using
30489 MTA-STS to let those clients who do use that protocol derive trust
30490 information.
30491
30492 The MTA-STS design requires a certificate from a public Certificate Authority
30493 which is recognized by clients sending to you.
30494 That selection of which CAs are trusted by others is outside your control.
30495
30496 The most interoperable course of action is probably to use
30497 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30498 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30499 records for DANE clients (such as Exim and Postfix) and to publish anchor
30500 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30501 domain itself (with caveats around occasionally broken MTA-STS because of
30502 incompatible specification changes prior to reaching RFC status).
30503
30504
30505
30506 . ////////////////////////////////////////////////////////////////////////////
30507 . ////////////////////////////////////////////////////////////////////////////
30508
30509 .chapter "Access control lists" "CHAPACL"
30510 .scindex IIDacl "&ACL;" "description"
30511 .cindex "control of incoming mail"
30512 .cindex "message" "controlling incoming"
30513 .cindex "policy control" "access control lists"
30514 Access Control Lists (ACLs) are defined in a separate section of the runtime
30515 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30516 name, terminated by a colon. Here is a complete ACL section that contains just
30517 one very small ACL:
30518 .code
30519 begin acl
30520 small_acl:
30521   accept   hosts = one.host.only
30522 .endd
30523 You can have as many lists as you like in the ACL section, and the order in
30524 which they appear does not matter. The lists are self-terminating.
30525
30526 The majority of ACLs are used to control Exim's behaviour when it receives
30527 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30528 when a local process submits a message using SMTP by specifying the &%-bs%&
30529 option. The most common use is for controlling which recipients are accepted
30530 in incoming messages. In addition, you can define an ACL that is used to check
30531 local non-SMTP messages. The default configuration file contains an example of
30532 a realistic ACL for checking RCPT commands. This is discussed in chapter
30533 &<<CHAPdefconfil>>&.
30534
30535
30536 .section "Testing ACLs" "SECID188"
30537 The &%-bh%& command line option provides a way of testing your ACL
30538 configuration locally by running a fake SMTP session with which you interact.
30539
30540
30541 .section "Specifying when ACLs are used" "SECID189"
30542 .cindex "&ACL;" "options for specifying"
30543 In order to cause an ACL to be used, you have to name it in one of the relevant
30544 options in the main part of the configuration. These options are:
30545 .cindex "AUTH" "ACL for"
30546 .cindex "DATA" "ACLs for"
30547 .cindex "ETRN" "ACL for"
30548 .cindex "EXPN" "ACL for"
30549 .cindex "HELO" "ACL for"
30550 .cindex "EHLO" "ACL for"
30551 .cindex "DKIM" "ACL for"
30552 .cindex "MAIL" "ACL for"
30553 .cindex "QUIT, ACL for"
30554 .cindex "RCPT" "ACL for"
30555 .cindex "STARTTLS, ACL for"
30556 .cindex "VRFY" "ACL for"
30557 .cindex "SMTP" "connection, ACL for"
30558 .cindex "non-SMTP messages" "ACLs for"
30559 .cindex "MIME content scanning" "ACL for"
30560 .cindex "PRDR" "ACL for"
30561
30562 .table2 140pt
30563 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30564 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30565 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30566 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30567 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30568 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30569 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30570 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30571 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30572 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30573 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30574 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30575 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30576 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30577 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30578 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30579 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30580 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30581 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30582 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30583 .endtable
30584
30585 For example, if you set
30586 .code
30587 acl_smtp_rcpt = small_acl
30588 .endd
30589 the little ACL defined above is used whenever Exim receives a RCPT command
30590 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30591 done when RCPT commands arrive. A rejection of RCPT should cause the
30592 sending MTA to give up on the recipient address contained in the RCPT
30593 command, whereas rejection at other times may cause the client MTA to keep on
30594 trying to deliver the message. It is therefore recommended that you do as much
30595 testing as possible at RCPT time.
30596
30597
30598 .subsection "The non-SMTP ACLs" SECID190
30599 .cindex "non-SMTP messages" "ACLs for"
30600 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30601 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30602 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30603 the state of the SMTP connection such as encryption and authentication) are not
30604 relevant and are forbidden in these ACLs. However, the sender and recipients
30605 are known, so the &%senders%& and &%sender_domains%& conditions and the
30606 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30607 &$authenticated_sender$& are also available. You can specify added header lines
30608 in any of these ACLs.
30609
30610 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30611 non-SMTP message, before any of the message has been read. (This is the
30612 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30613 batched SMTP input, it runs after the DATA command has been reached. The
30614 result of this ACL is ignored; it cannot be used to reject a message. If you
30615 really need to, you could set a value in an ACL variable here and reject based
30616 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30617 controls, and in particular, it can be used to set
30618 .code
30619 control = suppress_local_fixups
30620 .endd
30621 This cannot be used in the other non-SMTP ACLs because by the time they are
30622 run, it is too late.
30623
30624 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30625 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30626
30627 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30628 kind of rejection is treated as permanent, because there is no way of sending a
30629 temporary error for these kinds of message.
30630
30631
30632 .subsection "The SMTP connect ACL" SECID191
30633 .cindex "SMTP" "connection, ACL for"
30634 .oindex &%smtp_banner%&
30635 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30636 session, after the test specified by &%host_reject_connection%& (which is now
30637 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30638 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30639 the message override the banner message that is otherwise specified by the
30640 &%smtp_banner%& option.
30641
30642 .new
30643 For tls-on-connect connections, the ACL is run before the TLS connection
30644 is accepted; if the ACL does not accept then the TCP connection is dropped without
30645 any TLS startup attempt and without any SMTP response being transmitted.
30646 .wen
30647
30648
30649 .subsection "The EHLO/HELO ACL" SECID192
30650 .cindex "EHLO" "ACL for"
30651 .cindex "HELO" "ACL for"
30652 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30653 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30654 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30655 Note that a client may issue more than one EHLO or HELO command in an SMTP
30656 session, and indeed is required to issue a new EHLO or HELO after successfully
30657 setting up encryption following a STARTTLS command.
30658
30659 Note also that a deny neither forces the client to go away nor means that
30660 mail will be refused on the connection.  Consider checking for
30661 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30662
30663 If the command is accepted by an &%accept%& verb that has a &%message%&
30664 modifier, the message may not contain more than one line (it will be truncated
30665 at the first newline and a panic logged if it does). Such a message cannot
30666 affect the EHLO options that are listed on the second and subsequent lines of
30667 an EHLO response.
30668
30669
30670 .subsection "The DATA ACLs" SECID193
30671 .cindex "DATA" "ACLs for"
30672 Two ACLs are associated with the DATA command, because it is two-stage
30673 command, with two responses being sent to the client.
30674 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30675 is obeyed. This gives you control after all the RCPT commands, but before
30676 the message itself is received. It offers the opportunity to give a negative
30677 response to the DATA command before the data is transmitted. Header lines
30678 added by MAIL or RCPT ACLs are not visible at this time, but any that
30679 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30680
30681 You cannot test the contents of the message, for example, to verify addresses
30682 in the headers, at RCPT time or when the DATA command is received. Such
30683 tests have to appear in the ACL that is run after the message itself has been
30684 received, before the final response to the DATA command is sent. This is
30685 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30686 associated with the DATA command.
30687
30688 .cindex CHUNKING "BDAT command"
30689 .cindex BDAT "SMTP command"
30690 .cindex "RFC 3030" CHUNKING
30691 If CHUNKING was advertised and a BDAT command sequence is received,
30692 the &%acl_smtp_predata%& ACL is not run.
30693 . XXX why not?  It should be possible, for the first BDAT.
30694 The &%acl_smtp_data%& is run after the last BDAT command and all of
30695 the data specified is received.
30696
30697 For both of these ACLs, it is not possible to reject individual recipients. An
30698 error response rejects the entire message. Unfortunately, it is known that some
30699 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30700 before or after the data) correctly &-- they keep the message on their queues
30701 and try again later, but that is their problem, though it does waste some of
30702 your resources.
30703
30704 The &%acl_smtp_data%& ACL is run after
30705 the &%acl_smtp_data_prdr%&,
30706 the &%acl_smtp_dkim%&
30707 and the &%acl_smtp_mime%& ACLs.
30708
30709 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30710 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30711 enabled (which is the default).
30712
30713 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30714 received, and is executed for each DKIM signature found in a message.  If not
30715 otherwise specified, the default action is to accept.
30716
30717 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30718
30719 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30720
30721
30722 .subsection "The SMTP MIME ACL" SECID194
30723 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30724 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30725
30726 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30727
30728
30729 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30730 .cindex "PRDR" "ACL for"
30731 .oindex "&%prdr_enable%&"
30732 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30733 with PRDR support enabled (which is the default).
30734 It becomes active only when the PRDR feature is negotiated between
30735 client and server for a message, and more than one recipient
30736 has been accepted.
30737
30738 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30739 has been received, and is executed once for each recipient of the message
30740 with &$local_part$& and &$domain$& valid.
30741 The test may accept, defer or deny for individual recipients.
30742 The &%acl_smtp_data%& will still be called after this ACL and
30743 can reject the message overall, even if this ACL has accepted it
30744 for some or all recipients.
30745
30746 PRDR may be used to support per-user content filtering.  Without it
30747 one must defer any recipient after the first that has a different
30748 content-filter configuration.  With PRDR, the RCPT-time check
30749 .cindex "PRDR" "variable for"
30750 for this can be disabled when the variable &$prdr_requested$&
30751 is &"yes"&.
30752 Any required difference in behaviour of the main DATA-time
30753 ACL should however depend on the PRDR-time ACL having run, as Exim
30754 will avoid doing so in some situations (e.g. single-recipient mails).
30755
30756 See also the &%prdr_enable%& global option
30757 and the &%hosts_try_prdr%& smtp transport option.
30758
30759 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30760 If the ACL is not defined, processing completes as if
30761 the feature was not requested by the client.
30762
30763 .subsection "The QUIT ACL" SECTQUITACL
30764 .cindex "QUIT, ACL for"
30765 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30766 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30767 does not in fact control any access.
30768 For this reason, it may only accept
30769 or warn as its final result.
30770
30771 This ACL can be used for tasks such as custom logging at the end of an SMTP
30772 session. For example, you can use ACL variables in other ACLs to count
30773 messages, recipients, etc., and log the totals at QUIT time using one or
30774 more &%logwrite%& modifiers on a &%warn%& verb.
30775
30776 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30777 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30778
30779 You do not need to have a final &%accept%&, but if you do, you can use a
30780 &%message%& modifier to specify custom text that is sent as part of the 221
30781 response to QUIT.
30782
30783 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30784 failure (for example, failure to open a log file, or when Exim is bombing out
30785 because it has detected an unrecoverable error), all SMTP commands from the
30786 client are given temporary error responses until QUIT is received or the
30787 connection is closed. In these special cases, the QUIT ACL does not run.
30788
30789
30790 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30791 .vindex &$acl_smtp_notquit$&
30792 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30793 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30794 trouble, such as being unable to write to its log files, this ACL is not run,
30795 because it might try to do things (such as write to log files) that make the
30796 situation even worse.
30797
30798 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30799 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30800 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30801 and &%warn%&.
30802
30803 .vindex &$smtp_notquit_reason$&
30804 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30805 to a string that indicates the reason for the termination of the SMTP
30806 connection. The possible values are:
30807 .table2
30808 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30809 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30810 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30811 .irow &`connection-lost`&          "The SMTP connection has been lost"
30812 .irow &`data-timeout`&             "Timeout while reading message data"
30813 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30814 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30815 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30816 .irow &`synchronization-error`&    "SMTP synchronization error"
30817 .irow &`tls-failed`&               "TLS failed to start"
30818 .endtable
30819 In most cases when an SMTP connection is closed without having received QUIT,
30820 Exim sends an SMTP response message before actually closing the connection.
30821 With the exception of the &`acl-drop`& case, the default message can be
30822 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30823 &%drop%& verb in another ACL, it is the message from the other ACL that is
30824 used.
30825
30826
30827 .section "Finding an ACL to use" "SECID195"
30828 .cindex "&ACL;" "finding which to use"
30829 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30830 you can use different ACLs in different circumstances. For example,
30831 .code
30832 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30833                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30834 .endd
30835 In the default configuration file there are some example settings for
30836 providing an RFC 4409 message &"submission"& service on port 587 and
30837 an RFC 8314 &"submissions"& service on port 465. You can use a string
30838 expansion like this to choose an ACL for MUAs on these ports which is
30839 more appropriate for this purpose than the default ACL on port 25.
30840
30841 The expanded string does not have to be the name of an ACL in the
30842 configuration file; there are other possibilities. Having expanded the
30843 string, Exim searches for an ACL as follows:
30844
30845 .ilist
30846 If the string begins with a slash, Exim uses it as a filename, and reads its
30847 contents as an ACL. The lines are processed in the same way as lines in the
30848 Exim configuration file. In particular, continuation lines are supported, blank
30849 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30850 If the file does not exist or cannot be read, an error occurs (typically
30851 causing a temporary failure of whatever caused the ACL to be run). For example:
30852 .code
30853 acl_smtp_data = /etc/acls/\
30854   ${lookup{$sender_host_address}lsearch\
30855   {/etc/acllist}{$value}{default}}
30856 .endd
30857 This looks up an ACL file to use on the basis of the host's IP address, falling
30858 back to a default if the lookup fails. If an ACL is successfully read from a
30859 file, it is retained in memory for the duration of the Exim process, so that it
30860 can be re-used without having to re-read the file.
30861 .next
30862 If the string does not start with a slash, and does not contain any spaces,
30863 Exim searches the ACL section of the configuration for an ACL whose name
30864 matches the string.
30865 .next
30866 If no named ACL is found, or if the string contains spaces, Exim parses
30867 the string as an inline ACL. This can save typing in cases where you just
30868 want to have something like
30869 .code
30870 acl_smtp_vrfy = accept
30871 .endd
30872 in order to allow free use of the VRFY command. Such a string may contain
30873 newlines; it is processed in the same way as an ACL that is read from a file.
30874 .endlist
30875
30876
30877
30878
30879 .section "ACL return codes" "SECID196"
30880 .cindex "&ACL;" "return codes"
30881 Except for the QUIT ACL, which does not affect the SMTP return code (see
30882 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30883 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30884 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30885 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30886 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30887 This also causes a 4&'xx'& return code.
30888
30889 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30890 &"deny"&, because there is no mechanism for passing temporary errors to the
30891 submitters of non-SMTP messages.
30892
30893
30894 ACLs that are relevant to message reception may also return &"discard"&. This
30895 has the effect of &"accept"&, but causes either the entire message or an
30896 individual recipient address to be discarded. In other words, it is a
30897 blackholing facility. Use it with care.
30898
30899 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30900 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30901 RCPT ACL is to discard just the one recipient address. If there are no
30902 recipients left when the message's data is received, the DATA ACL is not
30903 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30904 remaining recipients. The &"discard"& return is not permitted for the
30905 &%acl_smtp_predata%& ACL.
30906
30907 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30908 is done on the address and the result determines the SMTP response.
30909
30910
30911 .cindex "&[local_scan()]& function" "when all recipients discarded"
30912 The &[local_scan()]& function is always run, even if there are no remaining
30913 recipients; it may create new recipients.
30914
30915
30916
30917 .section "Unset ACL options" "SECID197"
30918 .cindex "&ACL;" "unset options"
30919 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30920 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30921 not defined at all. For any defined ACL, the default action when control
30922 reaches the end of the ACL statements is &"deny"&.
30923
30924 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30925 these two are ACLs that are used only for their side effects. They cannot be
30926 used to accept or reject anything.
30927
30928 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30929 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30930 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30931 when the ACL is not defined is &"accept"&.
30932
30933 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30934 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30935 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30936 messages over an SMTP connection. For an example, see the ACL in the default
30937 configuration file.
30938
30939
30940
30941
30942 .section "Data for message ACLs" "SECID198"
30943 .cindex "&ACL;" "data for message ACL"
30944 .vindex &$domain$&
30945 .vindex &$local_part$&
30946 .vindex &$sender_address$&
30947 .vindex &$sender_host_address$&
30948 .vindex &$smtp_command$&
30949 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30950 that contain information about the host and the message's sender (for example,
30951 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30952 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30953 &$local_part$& are set from the argument address. The entire SMTP command
30954 is available in &$smtp_command$&.
30955
30956 When an ACL for the AUTH parameter of MAIL is running, the variables that
30957 contain information about the host are set, but &$sender_address$& is not yet
30958 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30959 how it is used.
30960
30961 .vindex "&$message_size$&"
30962 The &$message_size$& variable is set to the value of the SIZE parameter on
30963 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30964 that parameter is not given. The value is updated to the true message size by
30965 the time the final DATA ACL is run (after the message data has been
30966 received).
30967
30968 .vindex "&$rcpt_count$&"
30969 .vindex "&$recipients_count$&"
30970 The &$rcpt_count$& variable increases by one for each RCPT command received.
30971 The &$recipients_count$& variable increases by one each time a RCPT command is
30972 accepted, so while an ACL for RCPT is being processed, it contains the number
30973 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30974 &$rcpt_count$& contains the total number of RCPT commands, and
30975 &$recipients_count$& contains the total number of accepted recipients.
30976
30977
30978
30979
30980
30981 .section "Data for non-message ACLs" "SECTdatfornon"
30982 .cindex "&ACL;" "data for non-message ACL"
30983 .vindex &$smtp_command_argument$&
30984 .vindex &$smtp_command$&
30985 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30986 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30987 and the entire SMTP command is available in &$smtp_command$&.
30988 These variables can be tested using a &%condition%& condition. For example,
30989 here is an ACL for use with AUTH, which insists that either the session is
30990 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30991 does not permit authentication methods that use cleartext passwords on
30992 unencrypted connections.
30993 .code
30994 acl_check_auth:
30995   accept encrypted = *
30996   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30997                      {CRAM-MD5}}
30998   deny   message   = TLS encryption or CRAM-MD5 required
30999 .endd
31000 (Another way of applying this restriction is to arrange for the authenticators
31001 that use cleartext passwords not to be advertised when the connection is not
31002 encrypted. You can use the generic &%server_advertise_condition%& authenticator
31003 option to do this.)
31004
31005
31006
31007 .section "Format of an ACL" "SECID199"
31008 .cindex "&ACL;" "format of"
31009 .cindex "&ACL;" "verbs, definition of"
31010 An individual ACL consists of a number of statements. Each statement starts
31011 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31012 Modifiers can change the way the verb operates, define error and log messages,
31013 set variables, insert delays, and vary the processing of accepted messages.
31014
31015 If all the conditions are met, the verb is obeyed. The same condition may be
31016 used (with different arguments) more than once in the same statement. This
31017 provides a means of specifying an &"and"& conjunction between conditions. For
31018 example:
31019 .code
31020 deny  dnslists = list1.example
31021       dnslists = list2.example
31022 .endd
31023 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31024 the conditions and modifiers when it reaches a condition that fails. What
31025 happens then depends on the verb (and in one case, on a special modifier). Not
31026 all the conditions make sense at every testing point. For example, you cannot
31027 test a sender address in the ACL that is run for a VRFY command.
31028
31029
31030 .section "ACL verbs" "SECID200"
31031 The ACL verbs are as follows:
31032
31033 .ilist
31034 .cindex "&%accept%& ACL verb"
31035 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31036 of the conditions are not met, what happens depends on whether &%endpass%&
31037 appears among the conditions (for syntax see below). If the failing condition
31038 is before &%endpass%&, control is passed to the next ACL statement; if it is
31039 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31040 check a RCPT command:
31041 .code
31042 accept domains = +local_domains
31043        endpass
31044        verify = recipient
31045 .endd
31046 If the recipient domain does not match the &%domains%& condition, control
31047 passes to the next statement. If it does match, the recipient is verified, and
31048 the command is accepted if verification succeeds. However, if verification
31049 fails, the ACL yields &"deny"&, because the failing condition is after
31050 &%endpass%&.
31051
31052 The &%endpass%& feature has turned out to be confusing to many people, so its
31053 use is not recommended nowadays. It is always possible to rewrite an ACL so
31054 that &%endpass%& is not needed, and it is no longer used in the default
31055 configuration.
31056
31057 .cindex "&%message%& ACL modifier" "with &%accept%&"
31058 If a &%message%& modifier appears on an &%accept%& statement, its action
31059 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31060 (when an &%accept%& verb either accepts or passes control to the next
31061 statement), &%message%& can be used to vary the message that is sent when an
31062 SMTP command is accepted. For example, in a RCPT ACL you could have:
31063 .display
31064 &`accept  `&<&'some conditions'&>
31065 &`        message = OK, I will allow you through today`&
31066 .endd
31067 You can specify an SMTP response code, optionally followed by an &"extended
31068 response code"& at the start of the message, but the first digit must be the
31069 same as would be sent by default, which is 2 for an &%accept%& verb.
31070
31071 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31072 an error message that is used when access is denied. This behaviour is retained
31073 for backward compatibility, but current &"best practice"& is to avoid the use
31074 of &%endpass%&.
31075
31076
31077 .next
31078 .cindex "&%defer%& ACL verb"
31079 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31080 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31081 &%defer%& is the same as &%deny%&, because there is no way of sending a
31082 temporary error. For a RCPT command, &%defer%& is much the same as using a
31083 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31084 be used in any ACL, and even for a recipient it might be a simpler approach.
31085
31086
31087 .next
31088 .cindex "&%deny%& ACL verb"
31089 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31090 the conditions are not met, control is passed to the next ACL statement. For
31091 example,
31092 .code
31093 deny dnslists = blackholes.mail-abuse.org
31094 .endd
31095 rejects commands from hosts that are on a DNS black list.
31096
31097
31098 .next
31099 .cindex "&%discard%& ACL verb"
31100 &%discard%&: This verb behaves like &%accept%&, except that it returns
31101 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31102 that are concerned with receiving messages. When all the conditions are true,
31103 the sending entity receives a &"success"& response. However, &%discard%& causes
31104 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31105 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31106 message's recipients are discarded. Recipients that are discarded before DATA
31107 do not appear in the log line when the &%received_recipients%& log selector is set.
31108
31109 If the &%log_message%& modifier is set when &%discard%& operates,
31110 its contents are added to the line that is automatically written to the log.
31111 The &%message%& modifier operates exactly as it does for &%accept%&.
31112
31113
31114 .next
31115 .cindex "&%drop%& ACL verb"
31116 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31117 forcibly closed after the 5&'xx'& error message has been sent. For example:
31118 .code
31119 drop   condition = ${if > {$rcpt_count}{20}}
31120        message   = I don't take more than 20 RCPTs
31121 .endd
31122 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31123 The connection is always dropped after sending a 550 response.
31124
31125 .next
31126 .cindex "&%require%& ACL verb"
31127 &%require%&: If all the conditions are met, control is passed to the next ACL
31128 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31129 example, when checking a RCPT command,
31130 .code
31131 require message = Sender did not verify
31132         verify  = sender
31133 .endd
31134 passes control to subsequent statements only if the message's sender can be
31135 verified. Otherwise, it rejects the command. Note the positioning of the
31136 &%message%& modifier, before the &%verify%& condition. The reason for this is
31137 discussed in section &<<SECTcondmodproc>>&.
31138
31139 .next
31140 .cindex "&%warn%& ACL verb"
31141 &%warn%&: If all the conditions are true, a line specified by the
31142 &%log_message%& modifier is written to Exim's main log. Control always passes
31143 to the next ACL statement. If any condition is false, the log line is not
31144 written. If an identical log line is requested several times in the same
31145 message, only one copy is actually written to the log. If you want to force
31146 duplicates to be written, use the &%logwrite%& modifier instead.
31147
31148 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31149 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31150 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31151 first failing condition. There is more about adding header lines in section
31152 &<<SECTaddheadacl>>&.
31153
31154 If any condition on a &%warn%& statement cannot be completed (that is, there is
31155 some sort of defer), the log line specified by &%log_message%& is not written.
31156 This does not include the case of a forced failure from a lookup, which
31157 is considered to be a successful completion. After a defer, no further
31158 conditions or modifiers in the &%warn%& statement are processed. The incident
31159 is logged, and the ACL continues to be processed, from the next statement
31160 onwards.
31161
31162
31163 .vindex "&$acl_verify_message$&"
31164 When one of the &%warn%& conditions is an address verification that fails, the
31165 text of the verification failure message is in &$acl_verify_message$&. If you
31166 want this logged, you must set it up explicitly. For example:
31167 .code
31168 warn   !verify = sender
31169        log_message = sender verify failed: $acl_verify_message
31170 .endd
31171 .endlist
31172
31173 At the end of each ACL there is an implicit unconditional &%deny%&.
31174
31175 As you can see from the examples above, the conditions and modifiers are
31176 written one to a line, with the first one on the same line as the verb, and
31177 subsequent ones on following lines. If you have a very long condition, you can
31178 continue it onto several physical lines by the usual backslash continuation
31179 mechanism. It is conventional to align the conditions vertically.
31180
31181
31182
31183 .section "ACL variables" "SECTaclvariables"
31184 .cindex "&ACL;" "variables"
31185 There are some special variables that can be set during ACL processing. They
31186 can be used to pass information between different ACLs, different invocations
31187 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31188 transports, and filters that are used to deliver a message. The names of these
31189 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31190 an underscore, but the remainder of the name can be any sequence of
31191 alphanumeric characters and underscores that you choose. There is no limit on
31192 the number of ACL variables. The two sets act as follows:
31193 .ilist
31194 The values of those variables whose names begin with &$acl_c$& persist
31195 throughout an SMTP connection. They are never reset. Thus, a value that is set
31196 while receiving one message is still available when receiving the next message
31197 on the same SMTP connection.
31198 .next
31199 The values of those variables whose names begin with &$acl_m$& persist only
31200 while a message is being received. They are reset afterwards. They are also
31201 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31202 .endlist
31203
31204 When a message is accepted, the current values of all the ACL variables are
31205 preserved with the message and are subsequently made available at delivery
31206 time. The ACL variables are set by a modifier called &%set%&. For example:
31207 .code
31208 accept hosts = whatever
31209        set acl_m4 = some value
31210 accept authenticated = *
31211        set acl_c_auth = yes
31212 .endd
31213 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31214 be set. If you want to set a variable without taking any action, you can use a
31215 &%warn%& verb without any other modifiers or conditions.
31216
31217 .oindex &%strict_acl_vars%&
31218 What happens if a syntactically valid but undefined ACL variable is
31219 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31220 false (the default), an empty string is substituted; if it is true, an
31221 error is generated.
31222
31223 Versions of Exim before 4.64 have a limited set of numbered variables, but
31224 their names are compatible, so there is no problem with upgrading.
31225
31226
31227 .section "Condition and modifier processing" "SECTcondmodproc"
31228 .cindex "&ACL;" "conditions; processing"
31229 .cindex "&ACL;" "modifiers; processing"
31230 An exclamation mark preceding a condition negates its result. For example:
31231 .code
31232 deny   domains = *.dom.example
31233       !verify  = recipient
31234 .endd
31235 causes the ACL to return &"deny"& if the recipient domain ends in
31236 &'dom.example'& and the recipient address cannot be verified. Sometimes
31237 negation can be used on the right-hand side of a condition. For example, these
31238 two statements are equivalent:
31239 .code
31240 deny  hosts = !192.168.3.4
31241 deny !hosts =  192.168.3.4
31242 .endd
31243 However, for many conditions (&%verify%& being a good example), only left-hand
31244 side negation of the whole condition is possible.
31245
31246 The arguments of conditions and modifiers are expanded. A forced failure
31247 of an expansion causes a condition to be ignored, that is, it behaves as if the
31248 condition is true. Consider these two statements:
31249 .code
31250 accept  senders = ${lookup{$host_name}lsearch\
31251                   {/some/file}{$value}fail}
31252 accept  senders = ${lookup{$host_name}lsearch\
31253                   {/some/file}{$value}{}}
31254 .endd
31255 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31256 the returned list is searched, but if the lookup fails the behaviour is
31257 different in the two cases. The &%fail%& in the first statement causes the
31258 condition to be ignored, leaving no further conditions. The &%accept%& verb
31259 therefore succeeds. The second statement, however, generates an empty list when
31260 the lookup fails. No sender can match an empty list, so the condition fails,
31261 and therefore the &%accept%& also fails.
31262
31263 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31264 specify actions that are taken as the conditions for a statement are checked;
31265 others specify text for messages that are used when access is denied or a
31266 warning is generated. The &%control%& modifier affects the way an incoming
31267 message is handled.
31268
31269 The positioning of the modifiers in an ACL statement is important, because the
31270 processing of a verb ceases as soon as its outcome is known. Only those
31271 modifiers that have already been encountered will take effect. For example,
31272 consider this use of the &%message%& modifier:
31273 .code
31274 require message = Can't verify sender
31275         verify  = sender
31276         message = Can't verify recipient
31277         verify  = recipient
31278         message = This message cannot be used
31279 .endd
31280 If sender verification fails, Exim knows that the result of the statement is
31281 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31282 so its text is used as the error message. If sender verification succeeds, but
31283 recipient verification fails, the second message is used. If recipient
31284 verification succeeds, the third message becomes &"current"&, but is never used
31285 because there are no more conditions to cause failure.
31286
31287 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31288 modifier that is used, because all the conditions must be true for rejection to
31289 happen. Specifying more than one &%message%& modifier does not make sense, and
31290 the message can even be specified after all the conditions. For example:
31291 .code
31292 deny   hosts = ...
31293       !senders = *@my.domain.example
31294        message = Invalid sender from client host
31295 .endd
31296 The &"deny"& result does not happen until the end of the statement is reached,
31297 by which time Exim has set up the message.
31298
31299
31300
31301 .section "ACL modifiers" "SECTACLmodi"
31302 .cindex "&ACL;" "modifiers; list of"
31303 The ACL modifiers are as follows:
31304
31305 .vlist
31306 .vitem &*add_header*&&~=&~<&'text'&>
31307 This modifier specifies one or more header lines that are to be added to an
31308 incoming message, assuming, of course, that the message is ultimately
31309 accepted. For details, see section &<<SECTaddheadacl>>&.
31310
31311 .vitem &*continue*&&~=&~<&'text'&>
31312 .cindex "&%continue%& ACL modifier"
31313 .cindex "database" "updating in ACL"
31314 This modifier does nothing of itself, and processing of the ACL always
31315 continues with the next condition or modifier. The value of &%continue%& is in
31316 the side effects of expanding its argument. Typically this could be used to
31317 update a database. It is really just a syntactic tidiness, to avoid having to
31318 write rather ugly lines like this:
31319 .display
31320 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31321 .endd
31322 Instead, all you need is
31323 .display
31324 &`continue = `&<&'some expansion'&>
31325 .endd
31326
31327 .vitem &*control*&&~=&~<&'text'&>
31328 .cindex "&%control%& ACL modifier"
31329 This modifier affects the subsequent processing of the SMTP connection or of an
31330 incoming message that is accepted. The effect of the first type of control
31331 lasts for the duration of the connection, whereas the effect of the second type
31332 lasts only until the current message has been received. The message-specific
31333 controls always apply to the whole message, not to individual recipients,
31334 even if the &%control%& modifier appears in a RCPT ACL.
31335
31336 As there are now quite a few controls that can be applied, they are described
31337 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31338 in several different ways. For example:
31339
31340 . ==== As this is a nested list, any displays it contains must be indented
31341 . ==== as otherwise they are too far to the left. That comment applies only
31342 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31343 . ==== way.
31344
31345 .ilist
31346 It can be at the end of an &%accept%& statement:
31347 .code
31348     accept  ...some conditions
31349             control = queue
31350 .endd
31351 In this case, the control is applied when this statement yields &"accept"&, in
31352 other words, when the conditions are all true.
31353
31354 .next
31355 It can be in the middle of an &%accept%& statement:
31356 .code
31357     accept  ...some conditions...
31358             control = queue
31359             ...some more conditions...
31360 .endd
31361 If the first set of conditions are true, the control is applied, even if the
31362 statement does not accept because one of the second set of conditions is false.
31363 In this case, some subsequent statement must yield &"accept"& for the control
31364 to be relevant.
31365
31366 .next
31367 It can be used with &%warn%& to apply the control, leaving the
31368 decision about accepting or denying to a subsequent verb. For
31369 example:
31370 .code
31371     warn    ...some conditions...
31372             control = freeze
31373     accept  ...
31374 .endd
31375 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31376 &%logwrite%&, so it does not add anything to the message and does not write a
31377 log entry.
31378
31379 .next
31380 If you want to apply a control unconditionally, you can use it with a
31381 &%require%& verb. For example:
31382 .code
31383     require  control = no_multiline_responses
31384 .endd
31385 .endlist
31386
31387 .vitem &*delay*&&~=&~<&'time'&>
31388 .cindex "&%delay%& ACL modifier"
31389 .oindex "&%-bh%&"
31390 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31391 the time interval before proceeding. However, when testing Exim using the
31392 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31393 output instead). The time is given in the usual Exim notation, and the delay
31394 happens as soon as the modifier is processed. In an SMTP session, pending
31395 output is flushed before the delay is imposed.
31396
31397 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31398 example:
31399 .code
31400 deny    ...some conditions...
31401         delay = 30s
31402 .endd
31403 The delay happens if all the conditions are true, before the statement returns
31404 &"deny"&. Compare this with:
31405 .code
31406 deny    delay = 30s
31407         ...some conditions...
31408 .endd
31409 which waits for 30s before processing the conditions. The &%delay%& modifier
31410 can also be used with &%warn%& and together with &%control%&:
31411 .code
31412 warn    ...some conditions...
31413         delay = 2m
31414         control = freeze
31415 accept  ...
31416 .endd
31417
31418 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31419 responses to several commands are no longer buffered and sent in one packet (as
31420 they would normally be) because all output is flushed before imposing the
31421 delay. This optimization is disabled so that a number of small delays do not
31422 appear to the client as one large aggregated delay that might provoke an
31423 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31424 using a &%control%& modifier to set &%no_delay_flush%&.
31425
31426
31427 .vitem &*endpass*&
31428 .cindex "&%endpass%& ACL modifier"
31429 This modifier, which has no argument, is recognized only in &%accept%& and
31430 &%discard%& statements. It marks the boundary between the conditions whose
31431 failure causes control to pass to the next statement, and the conditions whose
31432 failure causes the ACL to return &"deny"&. This concept has proved to be
31433 confusing to some people, so the use of &%endpass%& is no longer recommended as
31434 &"best practice"&. See the description of &%accept%& above for more details.
31435
31436
31437 .vitem &*log_message*&&~=&~<&'text'&>
31438 .cindex "&%log_message%& ACL modifier"
31439 This modifier sets up a message that is used as part of the log message if the
31440 ACL denies access or a &%warn%& statement's conditions are true. For example:
31441 .code
31442 require log_message = wrong cipher suite $tls_in_cipher
31443         encrypted   = DES-CBC3-SHA
31444 .endd
31445 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31446 example:
31447 .display
31448 &`discard `&<&'some conditions'&>
31449 &`        log_message = Discarded $local_part@$domain because...`&
31450 .endd
31451 When access is denied, &%log_message%& adds to any underlying error message
31452 that may exist because of a condition failure. For example, while verifying a
31453 recipient address, a &':fail:'& redirection might have already set up a
31454 message.
31455
31456 The message may be defined before the conditions to which it applies, because
31457 the string expansion does not happen until Exim decides that access is to be
31458 denied. This means that any variables that are set by the condition are
31459 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31460 variables are set after a DNS black list lookup succeeds. If the expansion of
31461 &%log_message%& fails, or if the result is an empty string, the modifier is
31462 ignored.
31463
31464 .vindex "&$acl_verify_message$&"
31465 If you want to use a &%warn%& statement to log the result of an address
31466 verification, you can use &$acl_verify_message$& to include the verification
31467 error message.
31468
31469 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31470 the start of the logged message. If the same warning log message is requested
31471 more than once while receiving  a single email message, only one copy is
31472 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31473 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31474 is logged for a successful &%warn%& statement.
31475
31476 If &%log_message%& is not present and there is no underlying error message (for
31477 example, from the failure of address verification), but &%message%& is present,
31478 the &%message%& text is used for logging rejections. However, if any text for
31479 logging contains newlines, only the first line is logged. In the absence of
31480 both &%log_message%& and &%message%&, a default built-in message is used for
31481 logging rejections.
31482
31483
31484 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31485 .cindex "&%log_reject_target%& ACL modifier"
31486 .cindex "logging in ACL" "specifying which log"
31487 This modifier makes it possible to specify which logs are used for messages
31488 about ACL rejections. Its argument is a colon-separated list of words that can
31489 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31490 may be empty, in which case a rejection is not logged at all. For example, this
31491 ACL fragment writes no logging information when access is denied:
31492 .display
31493 &`deny `&<&'some conditions'&>
31494 &`     log_reject_target =`&
31495 .endd
31496 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31497 permanent and temporary rejections. Its effect lasts for the rest of the
31498 current ACL.
31499
31500
31501 .vitem &*logwrite*&&~=&~<&'text'&>
31502 .cindex "&%logwrite%& ACL modifier"
31503 .cindex "logging in ACL" "immediate"
31504 This modifier writes a message to a log file as soon as it is encountered when
31505 processing an ACL. (Compare &%log_message%&, which, except in the case of
31506 &%warn%& and &%discard%&, is used only if the ACL statement denies
31507 access.) The &%logwrite%& modifier can be used to log special incidents in
31508 ACLs. For example:
31509 .display
31510 &`accept `&<&'some special conditions'&>
31511 &`       control  = freeze`&
31512 &`       logwrite = froze message because ...`&
31513 .endd
31514 By default, the message is written to the main log. However, it may begin
31515 with a colon, followed by a comma-separated list of log names, and then
31516 another colon, to specify exactly which logs are to be written. For
31517 example:
31518 .code
31519 logwrite = :main,reject: text for main and reject logs
31520 logwrite = :panic: text for panic log only
31521 .endd
31522
31523
31524 .vitem &*message*&&~=&~<&'text'&>
31525 .cindex "&%message%& ACL modifier"
31526 This modifier sets up a text string that is expanded and used as a response
31527 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31528 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31529 there is some complication if &%endpass%& is involved; see the description of
31530 &%accept%& for details.)
31531
31532 The expansion of the message happens at the time Exim decides that the ACL is
31533 to end, not at the time it processes &%message%&. If the expansion fails, or
31534 generates an empty string, the modifier is ignored. Here is an example where
31535 &%message%& must be specified first, because the ACL ends with a rejection if
31536 the &%hosts%& condition fails:
31537 .code
31538 require  message = Host not recognized
31539          hosts = 10.0.0.0/8
31540 .endd
31541 (Once a condition has failed, no further conditions or modifiers are
31542 processed.)
31543
31544 .cindex "SMTP" "error codes"
31545 .oindex "&%smtp_banner%&
31546 For ACLs that are triggered by SMTP commands, the message is returned as part
31547 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31548 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31549 is accepted. In the case of the connect ACL, accepting with a message modifier
31550 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31551 accept message may not contain more than one line (otherwise it will be
31552 truncated at the first newline and a panic logged), and it cannot affect the
31553 EHLO options.
31554
31555 When SMTP is involved, the message may begin with an overriding response code,
31556 consisting of three digits optionally followed by an &"extended response code"&
31557 of the form &'n.n.n'&, each code being followed by a space. For example:
31558 .code
31559 deny  message = 599 1.2.3 Host not welcome
31560       hosts = 192.168.34.0/24
31561 .endd
31562 The first digit of the supplied response code must be the same as would be sent
31563 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31564 access, but for the predata ACL, note that the default success code is 354, not
31565 2&'xx'&.
31566
31567 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31568 the message modifier cannot override the 221 response code.
31569
31570 The text in a &%message%& modifier is literal; any quotes are taken as
31571 literals, but because the string is expanded, backslash escapes are processed
31572 anyway.
31573 If the message contains newlines, this gives rise to a multi-line SMTP
31574 response.
31575 A long message line will also be split into multi-line SMTP responses,
31576 on word boundaries if possible.
31577
31578 .vindex "&$acl_verify_message$&"
31579 While the text is being expanded, the &$acl_verify_message$& variable
31580 contains any message previously set.
31581 Afterwards, &$acl_verify_message$& is cleared.
31582
31583 If &%message%& is used on a statement that verifies an address, the message
31584 specified overrides any message that is generated by the verification process.
31585 However, the original message is available in the variable
31586 &$acl_verify_message$&, so you can incorporate it into your message if you
31587 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31588 routers to be passed back as part of the SMTP response, you should either not
31589 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31590
31591 For compatibility with previous releases of Exim, a &%message%& modifier that
31592 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31593 modifier, but this usage is now deprecated. However, &%message%& acts only when
31594 all the conditions are true, wherever it appears in an ACL command, whereas
31595 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31596 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31597 effect.
31598
31599
31600 .vitem &*queue*&&~=&~<&'text'&>
31601 .cindex "&%queue%& ACL modifier"
31602 .cindex "named queues" "selecting in ACL"
31603 This modifier specifies the use of a named queue for spool files
31604 for the message.
31605 It can only be used before the message is received (i.e. not in
31606 the DATA ACL).
31607 This could be used, for example, for known high-volume burst sources
31608 of traffic, or for quarantine of messages.
31609 Separate queue-runner processes will be needed for named queues.
31610 If the text after expansion is empty, the default queue is used.
31611
31612
31613 .vitem &*remove_header*&&~=&~<&'text'&>
31614 This modifier specifies one or more header names in a colon-separated list
31615  that are to be removed from an incoming message, assuming, of course, that
31616 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31617
31618
31619 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31620 .cindex "&%set%& ACL modifier"
31621 This modifier puts a value into one of the ACL variables (see section
31622 &<<SECTaclvariables>>&).
31623
31624
31625 .vitem &*udpsend*&&~=&~<&'parameters'&>
31626 .cindex "UDP communications"
31627 This modifier sends a UDP packet, for purposes such as statistics
31628 collection or behaviour monitoring. The parameters are expanded, and
31629 the result of the expansion must be a colon-separated list consisting
31630 of a destination server, port number, and the packet contents. The
31631 server can be specified as a host name or IPv4 or IPv6 address. The
31632 separator can be changed with the usual angle bracket syntax. For
31633 example, you might want to collect information on which hosts connect
31634 when:
31635 .code
31636 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31637              $tod_zulu $sender_host_address
31638 .endd
31639 .endlist
31640
31641
31642
31643
31644 .section "Use of the control modifier" "SECTcontrols"
31645 .cindex "&%control%& ACL modifier"
31646 The &%control%& modifier supports the following settings:
31647
31648 .vlist
31649 .vitem &*control&~=&~allow_auth_unadvertised*&
31650 This modifier allows a client host to use the SMTP AUTH command even when it
31651 has not been advertised in response to EHLO. Furthermore, because there are
31652 apparently some really broken clients that do this, Exim will accept AUTH after
31653 HELO (rather than EHLO) when this control is set. It should be used only if you
31654 really need it, and you should limit its use to those broken clients that do
31655 not work without it. For example:
31656 .code
31657 warn hosts   = 192.168.34.25
31658      control = allow_auth_unadvertised
31659 .endd
31660 Normally, when an Exim server receives an AUTH command, it checks the name of
31661 the authentication mechanism that is given in the command to ensure that it
31662 matches an advertised mechanism. When this control is set, the check that a
31663 mechanism has been advertised is bypassed. Any configured mechanism can be used
31664 by the client. This control is permitted only in the connection and HELO ACLs.
31665
31666
31667 .vitem &*control&~=&~caseful_local_part*& &&&
31668        &*control&~=&~caselower_local_part*&
31669 .cindex "&ACL;" "case of local part in"
31670 .cindex "case of local parts"
31671 .vindex "&$local_part$&"
31672 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31673 (that is, during RCPT processing). By default, the contents of &$local_part$&
31674 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31675 any uppercase letters in the original local part are restored in &$local_part$&
31676 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31677 is encountered.
31678
31679 These controls affect only the current recipient. Moreover, they apply only to
31680 local part handling that takes place directly in the ACL (for example, as a key
31681 in lookups). If a test to verify the recipient is obeyed, the case-related
31682 handling of the local part during the verification is controlled by the router
31683 configuration (see the &%caseful_local_part%& generic router option).
31684
31685 This facility could be used, for example, to add a spam score to local parts
31686 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31687 spam score:
31688 .code
31689 warn  control = caseful_local_part
31690       set acl_m4 = ${eval:\
31691                      $acl_m4 + \
31692                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31693                     }
31694       control = caselower_local_part
31695 .endd
31696 Notice that we put back the lower cased version afterwards, assuming that
31697 is what is wanted for subsequent tests.
31698
31699
31700 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31701 .cindex "&ACL;" "cutthrough routing"
31702 .cindex "cutthrough" "requesting"
31703 This option requests delivery be attempted while the item is being received.
31704
31705 The option is usable in the RCPT ACL.
31706 If enabled for a message received via smtp and routed to an smtp transport,
31707 and only one transport, interface, destination host and port combination
31708 is used for all recipients of the message,
31709 then the delivery connection is made while the receiving connection is open
31710 and data is copied from one to the other.
31711
31712 An attempt to set this option for any recipient but the first
31713 for a mail will be quietly ignored.
31714 If a recipient-verify callout
31715 (with use_sender)
31716 connection is subsequently
31717 requested in the same ACL it is held open and used for
31718 any subsequent recipients and the data,
31719 otherwise one is made after the initial RCPT ACL completes.
31720
31721 Note that routers are used in verify mode,
31722 and cannot depend on content of received headers.
31723 Note also that headers cannot be
31724 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31725 Headers may be modified by routers (subject to the above) and transports.
31726 The &'Received-By:'& header is generated as soon as the body reception starts,
31727 rather than the traditional time after the full message is received;
31728 this will affect the timestamp.
31729
31730 All the usual ACLs are called; if one results in the message being
31731 rejected, all effort spent in delivery (including the costs on
31732 the ultimate destination) will be wasted.
31733 Note that in the case of data-time ACLs this includes the entire
31734 message body.
31735
31736 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31737 of outgoing messages is done, because it sends data to the ultimate destination
31738 before the entire message has been received from the source.
31739 It is not supported for messages received with the SMTP PRDR
31740 or CHUNKING
31741 options in use.
31742
31743 Should the ultimate destination system positively accept or reject the mail,
31744 a corresponding indication is given to the source system and nothing is queued.
31745 If the item is successfully delivered in cutthrough mode
31746 the delivery log lines are tagged with ">>" rather than "=>" and appear
31747 before the acceptance "<=" line.
31748
31749 If there is a temporary error the item is queued for later delivery in the
31750 usual fashion.
31751 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31752 to the control; the default value is &"spool"& and the alternate value
31753 &"pass"& copies an SMTP defer response from the target back to the initiator
31754 and does not queue the message.
31755 Note that this is independent of any recipient verify conditions in the ACL.
31756
31757 Delivery in this mode avoids the generation of a bounce mail to a
31758 (possibly faked)
31759 sender when the destination system is doing content-scan based rejection.
31760
31761
31762 .vitem &*control&~=&~debug/*&<&'options'&>
31763 .cindex "&ACL;" "enabling debug logging"
31764 .cindex "debugging" "enabling from an ACL"
31765 This control turns on debug logging, almost as though Exim had been invoked
31766 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31767 by default called &'debuglog'&.
31768
31769 Logging set up by the control will be maintained across spool residency.
31770
31771 Options are a slash-separated list.
31772 If an option takes an argument, the option name and argument are separated by
31773 an equals character.
31774 Several options are supported:
31775 .display
31776 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31777                      The argument, which may access any variables already defined,
31778                      is appended to the default name.
31779
31780 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31781                      using the same values as the &`-d`& command-line option.
31782
31783 stop                 Logging started with this control may be
31784                      stopped by using this option.
31785
31786 kill                 Logging started with this control may be
31787                      stopped by using this option.
31788                      Additionally the debug file will be removed,
31789                      providing one means for speculative debug tracing.
31790
31791 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31792                      for pre-trigger debug capture.
31793                      Debug lines are recorded in the buffer until
31794                      and if) a trigger occurs; at which time they are
31795                      dumped to the debug file.  Newer lines displace the
31796                      oldest if the buffer is full.  After a trigger,
31797                      immediate writes to file are done as normal.
31798
31799 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31800                      see above) to be copied to file.  A reason of &*now*&
31801                      take effect immediately; one of &*paniclog*& triggers
31802                      on a write to the panic log.
31803 .endd
31804
31805 Some examples (which depend on variables that don't exist in all
31806 contexts):
31807 .code
31808       control = debug
31809       control = debug/tag=.$sender_host_address
31810       control = debug/opts=+expand+acl
31811       control = debug/tag=.$message_exim_id/opts=+expand
31812       control = debug/kill
31813       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31814       control = debug/trigger=now
31815 .endd
31816
31817
31818 .vitem &*control&~=&~dkim_disable_verify*&
31819 .cindex "disable DKIM verify"
31820 .cindex "DKIM" "disable verify"
31821 This control turns off DKIM verification processing entirely.  For details on
31822 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31823
31824
31825 .vitem &*control&~=&~dmarc_disable_verify*&
31826 .cindex "disable DMARC verify"
31827 .cindex "DMARC" "disable verify"
31828 This control turns off DMARC verification processing entirely.  For details on
31829 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31830
31831
31832 .vitem &*control&~=&~dscp/*&<&'value'&>
31833 .cindex "&ACL;" "setting DSCP value"
31834 .cindex "DSCP" "inbound"
31835 This option causes the DSCP value associated with the socket for the inbound
31836 connection to be adjusted to a given value, given as one of a number of fixed
31837 strings or to numeric value.
31838 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31839 Common values include &`throughput`&, &`mincost`&, and on newer systems
31840 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31841
31842 The outbound packets from Exim will be marked with this value in the header
31843 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31844 that these values will have any effect, not be stripped by networking
31845 equipment, or do much of anything without cooperation with your Network
31846 Engineer and those of all network operators between the source and destination.
31847
31848
31849 .vitem &*control&~=&~enforce_sync*& &&&
31850        &*control&~=&~no_enforce_sync*&
31851 .cindex "SMTP" "synchronization checking"
31852 .cindex "synchronization checking in SMTP"
31853 These controls make it possible to be selective about when SMTP synchronization
31854 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31855 state of the switch (it is true by default). See the description of this option
31856 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31857
31858 The effect of these two controls lasts for the remainder of the SMTP
31859 connection. They can appear in any ACL except the one for the non-SMTP
31860 messages. The most straightforward place to put them is in the ACL defined by
31861 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31862 before the first synchronization check. The expected use is to turn off the
31863 synchronization checks for badly-behaved hosts that you nevertheless need to
31864 work with.
31865
31866
31867 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31868 .cindex "fake defer"
31869 .cindex "defer, fake"
31870 .cindex fakedefer
31871 This control works in exactly the same way as &%fakereject%& (described below)
31872 except that it causes an SMTP 450 response after the message data instead of a
31873 550 response. You must take care when using &%fakedefer%& because it causes the
31874 messages to be duplicated when the sender retries. Therefore, you should not
31875 use &%fakedefer%& if the message is to be delivered normally.
31876
31877 .vitem &*control&~=&~fakereject/*&<&'message'&>
31878 .cindex "fake rejection"
31879 .cindex "rejection, fake"
31880 .cindex fakereject
31881 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31882 words, only when an SMTP message is being received. If Exim accepts the
31883 message, instead the final 250 response, a 550 rejection message is sent.
31884 However, Exim proceeds to deliver the message as normal. The control applies
31885 only to the current message, not to any subsequent ones that may be received in
31886 the same SMTP connection.
31887
31888 The text for the 550 response is taken from the &%control%& modifier. If no
31889 message is supplied, the following is used:
31890 .code
31891 550-Your message has been rejected but is being
31892 550-kept for evaluation.
31893 550-If it was a legitimate message, it may still be
31894 550 delivered to the target recipient(s).
31895 .endd
31896 This facility should be used with extreme caution.
31897
31898 .vitem &*control&~=&~freeze*&
31899 .cindex "frozen messages" "forcing in ACL"
31900 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31901 other words, only when a message is being received. If the message is accepted,
31902 it is placed on Exim's queue and frozen. The control applies only to the
31903 current message, not to any subsequent ones that may be received in the same
31904 SMTP connection.
31905
31906 This modifier can optionally be followed by &`/no_tell`&. If the global option
31907 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31908 is told about the freezing), provided all the &*control=freeze*& modifiers that
31909 are obeyed for the current message have the &`/no_tell`& option.
31910
31911 .vitem &*control&~=&~no_delay_flush*&
31912 .cindex "SMTP" "output flushing, disabling for delay"
31913 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31914 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31915 use. This control, as long as it is encountered before the &%delay%& modifier,
31916 disables such output flushing.
31917
31918 .vitem &*control&~=&~no_callout_flush*&
31919 .cindex "SMTP" "output flushing, disabling for callout"
31920 Exim normally flushes SMTP output before performing a callout in an ACL, to
31921 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31922 use. This control, as long as it is encountered before the &%verify%& condition
31923 that causes the callout, disables such output flushing.
31924
31925 .vitem &*control&~=&~no_mbox_unspool*&
31926 This control is available when Exim is compiled with the content scanning
31927 extension. Content scanning may require a copy of the current message, or parts
31928 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31929 or spam scanner. Normally, such copies are deleted when they are no longer
31930 needed. If this control is set, the copies are not deleted. The control applies
31931 only to the current message, not to any subsequent ones that may be received in
31932 the same SMTP connection. It is provided for debugging purposes and is unlikely
31933 to be useful in production.
31934
31935 .vitem &*control&~=&~no_multiline_responses*&
31936 .cindex "multiline responses, suppressing"
31937 This control is permitted for any ACL except the one for non-SMTP messages.
31938 It seems that there are broken clients in use that cannot handle multiline
31939 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31940
31941 If this control is set, multiline SMTP responses from ACL rejections are
31942 suppressed. One way of doing this would have been to put out these responses as
31943 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31944 (&"use multiline responses for more"& it says &-- ha!), and some of the
31945 responses might get close to that. So this facility, which is after all only a
31946 sop to broken clients, is implemented by doing two very easy things:
31947
31948 .ilist
31949 Extra information that is normally output as part of a rejection caused by
31950 sender verification failure is omitted. Only the final line (typically &"sender
31951 verification failed"&) is sent.
31952 .next
31953 If a &%message%& modifier supplies a multiline response, only the first
31954 line is output.
31955 .endlist
31956
31957 The setting of the switch can, of course, be made conditional on the
31958 calling host. Its effect lasts until the end of the SMTP connection.
31959
31960 .vitem &*control&~=&~no_pipelining*&
31961 .cindex "PIPELINING" "suppressing advertising"
31962 .cindex "ESMTP extensions" PIPELINING
31963 This control turns off the advertising of the PIPELINING extension to SMTP in
31964 the current session. To be useful, it must be obeyed before Exim sends its
31965 response to an EHLO command. Therefore, it should normally appear in an ACL
31966 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31967 &%pipelining_advertise_hosts%&.
31968
31969 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31970        &*control&~=&~queue_only*&
31971 .oindex "&%queue%&"
31972 .oindex "&%queue_only%&"
31973 .cindex "queueing incoming messages"
31974 .cindex queueing "forcing in ACL"
31975 .cindex "first pass routing"
31976 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31977 other words, only when a message is being received. If the message is accepted,
31978 it is placed on Exim's queue and left there for delivery by a subsequent queue
31979 runner.
31980 If used with no options set,
31981 no immediate delivery process is started. In other words, it has the
31982 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31983
31984 If the &'first_pass_route'& option is given then
31985 the behaviour is like the command-line &'-oqds'& option;
31986 a delivery process is started which stops short of making
31987 any SMTP delivery.  The benefit is that the hints database will be updated for
31988 the message being waiting for a specific host, and a later queue run will be
31989 able to send all such messages on a single connection.
31990
31991 The control only applies to the current message, not to any subsequent ones that
31992  may be received in the same SMTP connection.
31993
31994 .vitem &*control&~=&~submission/*&<&'options'&>
31995 .cindex "message" "submission"
31996 .cindex "submission mode"
31997 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31998 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31999 the current message is a submission from a local MUA. In this case, Exim
32000 operates in &"submission mode"&, and applies certain fixups to the message if
32001 necessary. For example, it adds a &'Date:'& header line if one is not present.
32002 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
32003 late (the message has already been created).
32004
32005 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32006 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32007 submission mode; the available options for this control are described there.
32008 The control applies only to the current message, not to any subsequent ones
32009 that may be received in the same SMTP connection.
32010
32011 .vitem &*control&~=&~suppress_local_fixups*&
32012 .cindex "submission fixups, suppressing"
32013 This control applies to locally submitted (non TCP/IP) messages, and is the
32014 complement of &`control = submission`&. It disables the fixups that are
32015 normally applied to locally-submitted messages. Specifically:
32016
32017 .ilist
32018 Any &'Sender:'& header line is left alone (in this respect, it is a
32019 dynamic version of &%local_sender_retain%&).
32020 .next
32021 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32022 .next
32023 There is no check that &'From:'& corresponds to the actual sender.
32024 .endlist ilist
32025
32026 This control may be useful when a remotely-originated message is accepted,
32027 passed to some scanning program, and then re-submitted for delivery. It can be
32028 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32029 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32030 data is read.
32031
32032 &*Note:*& This control applies only to the current message, not to any others
32033 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32034
32035 .vitem &*control&~=&~utf8_downconvert*&
32036 This control enables conversion of UTF-8 in message envelope addresses
32037 to a-label form.
32038 For details see section &<<SECTi18nMTA>>&.
32039 .endlist vlist
32040
32041
32042 .section "Summary of message fixup control" "SECTsummesfix"
32043 All four possibilities for message fixups can be specified:
32044
32045 .ilist
32046 Locally submitted, fixups applied: the default.
32047 .next
32048 Locally submitted, no fixups applied: use
32049 &`control = suppress_local_fixups`&.
32050 .next
32051 Remotely submitted, no fixups applied: the default.
32052 .next
32053 Remotely submitted, fixups applied: use &`control = submission`&.
32054 .endlist
32055
32056
32057
32058 .section "Adding header lines in ACLs" "SECTaddheadacl"
32059 .cindex "header lines" "adding in an ACL"
32060 .cindex "header lines" "position of added lines"
32061 .cindex "&%add_header%& ACL modifier"
32062 The &%add_header%& modifier can be used to add one or more extra header lines
32063 to an incoming message, as in this example:
32064 .code
32065 warn dnslists = sbl.spamhaus.org : \
32066                 dialup.mail-abuse.org
32067      add_header = X-blacklisted-at: $dnslist_domain
32068 .endd
32069 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32070 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32071 receiving a message). The message must ultimately be accepted for
32072 &%add_header%& to have any significant effect. You can use &%add_header%& with
32073 any ACL verb, including &%deny%& (though this is potentially useful only in a
32074 RCPT ACL).
32075
32076 Headers will not be added to the message if the modifier is used in
32077 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32078
32079 Leading and trailing newlines are removed from
32080 the data for the &%add_header%& modifier; if it then
32081 contains one or more newlines that
32082 are not followed by a space or a tab, it is assumed to contain multiple header
32083 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32084 front of any line that is not a valid header line.
32085
32086 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32087 They are added to the message before processing the DATA and MIME ACLs.
32088 However, if an identical header line is requested more than once, only one copy
32089 is actually added to the message. Further header lines may be accumulated
32090 during the DATA and MIME ACLs, after which they are added to the message, again
32091 with duplicates suppressed. Thus, it is possible to add two identical header
32092 lines to an SMTP message, but only if one is added before DATA and one after.
32093 In the case of non-SMTP messages, new headers are accumulated during the
32094 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32095 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32096 are included in the entry that is written to the reject log.
32097
32098 .cindex "header lines" "added; visibility of"
32099 Header lines are not visible in string expansions
32100 of message headers
32101 until they are added to the
32102 message. It follows that header lines defined in the MAIL, RCPT, and predata
32103 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32104 header lines that are added by the DATA or MIME ACLs are not visible in those
32105 ACLs. Because of this restriction, you cannot use header lines as a way of
32106 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32107 this, you can use ACL variables, as described in section
32108 &<<SECTaclvariables>>&.
32109
32110 The list of headers yet to be added is given by the &%$headers_added%& variable.
32111
32112 The &%add_header%& modifier acts immediately as it is encountered during the
32113 processing of an ACL. Notice the difference between these two cases:
32114 .display
32115 &`accept add_header = ADDED: some text`&
32116 &`       `&<&'some condition'&>
32117
32118 &`accept `&<&'some condition'&>
32119 &`       add_header = ADDED: some text`&
32120 .endd
32121 In the first case, the header line is always added, whether or not the
32122 condition is true. In the second case, the header line is added only if the
32123 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32124 ACL statement. All those that are encountered before a condition fails are
32125 honoured.
32126
32127 .cindex "&%warn%& ACL verb"
32128 For compatibility with previous versions of Exim, a &%message%& modifier for a
32129 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32130 effect only if all the conditions are true, even if it appears before some of
32131 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32132 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32133 are present on a &%warn%& verb, both are processed according to their
32134 specifications.
32135
32136 By default, new header lines are added to a message at the end of the existing
32137 header lines. However, you can specify that any particular header line should
32138 be added right at the start (before all the &'Received:'& lines), immediately
32139 after the first block of &'Received:'& lines, or immediately before any line
32140 that is not a &'Received:'& or &'Resent-something:'& header.
32141
32142 This is done by specifying &":at_start:"&, &":after_received:"&, or
32143 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32144 header line, respectively. (Header text cannot start with a colon, as there has
32145 to be a header name first.) For example:
32146 .code
32147 warn add_header = \
32148        :after_received:X-My-Header: something or other...
32149 .endd
32150 If more than one header line is supplied in a single &%add_header%& modifier,
32151 each one is treated independently and can therefore be placed differently. If
32152 you add more than one line at the start, or after the Received: block, they end
32153 up in reverse order.
32154
32155 &*Warning*&: This facility currently applies only to header lines that are
32156 added in an ACL. It does NOT work for header lines that are added in a
32157 system filter or in a router or transport.
32158
32159
32160
32161 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32162 .cindex "header lines" "removing in an ACL"
32163 .cindex "header lines" "position of removed lines"
32164 .cindex "&%remove_header%& ACL modifier"
32165 The &%remove_header%& modifier can be used to remove one or more header lines
32166 from an incoming message, as in this example:
32167 .code
32168 warn   message        = Remove internal headers
32169        remove_header  = x-route-mail1 : x-route-mail2
32170 .endd
32171 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32172 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32173 receiving a message). The message must ultimately be accepted for
32174 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32175 with any ACL verb, including &%deny%&, though this is really not useful for
32176 any verb that doesn't result in a delivered message.
32177
32178 Headers will not be removed from the message if the modifier is used in
32179 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32180
32181 More than one header can be removed at the same time by using a colon separated
32182 list of header specifiers.
32183 .new
32184 If a specifier does not start with a circumflex (^)
32185 then it is treated as a header name.
32186 The header name matching is case insensitive.
32187 If it does, then it is treated as a (front-anchored)
32188 regular expression applied to the whole header.
32189
32190 &*Note*&: The colon terminating a header name will need to be doubled
32191 if used in an RE, and there can legitimately be whitepace before it.
32192
32193 Example:
32194 .code
32195 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32196 .endd
32197 .wen
32198
32199 List expansion is not performed, so you cannot use hostlists to
32200 create a list of headers, however both connection and message variable expansion
32201 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32202 .code
32203 warn   hosts           = +internal_hosts
32204        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32205 warn   message         = Remove internal headers
32206        remove_header   = $acl_c_ihdrs
32207 .endd
32208 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32209 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32210 If multiple header lines match, all are removed.
32211 There is no harm in attempting to remove the same header twice nor in removing
32212 a non-existent header. Further header specifiers for removal may be accumulated
32213 during the DATA and MIME ACLs, after which matching headers are removed
32214 if present. In the case of non-SMTP messages, remove speifiers are
32215 accumulated during the non-SMTP ACLs, and are acted on after
32216 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32217 ACL, there really is no effect because there is no logging of what headers
32218 would have been removed.
32219
32220 .cindex "header lines" "removed; visibility of"
32221 Header lines are not visible in string expansions until the DATA phase when it
32222 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32223 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32224 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32225 this restriction, you cannot use header lines as a way of controlling data
32226 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32227 you should instead use ACL variables, as described in section
32228 &<<SECTaclvariables>>&.
32229
32230 The &%remove_header%& modifier acts immediately as it is encountered during the
32231 processing of an ACL. Notice the difference between these two cases:
32232 .display
32233 &`accept remove_header = X-Internal`&
32234 &`       `&<&'some condition'&>
32235
32236 &`accept `&<&'some condition'&>
32237 &`       remove_header = X-Internal`&
32238 .endd
32239 In the first case, the header line is always removed, whether or not the
32240 condition is true. In the second case, the header line is removed only if the
32241 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32242 same ACL statement. All those that are encountered before a condition fails
32243 are honoured.
32244
32245 &*Warning*&: This facility currently applies only to header lines that are
32246 present during ACL processing. It does NOT remove header lines that are added
32247 in a system filter or in a router or transport.
32248
32249
32250
32251
32252 .section "ACL conditions" "SECTaclconditions"
32253 .cindex "&ACL;" "conditions; list of"
32254 Some of the conditions listed in this section are available only when Exim is
32255 compiled with the content-scanning extension. They are included here briefly
32256 for completeness. More detailed descriptions can be found in the discussion on
32257 content scanning in chapter &<<CHAPexiscan>>&.
32258
32259 Not all conditions are relevant in all circumstances. For example, testing
32260 senders and recipients does not make sense in an ACL that is being run as the
32261 result of the arrival of an ETRN command, and checks on message headers can be
32262 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32263 can use the same condition (with different parameters) more than once in the
32264 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32265 The conditions are as follows:
32266
32267
32268 .vlist
32269 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32270 .cindex "&ACL;" "nested"
32271 .cindex "&ACL;" "indirect"
32272 .cindex "&ACL;" "arguments"
32273 .cindex "&%acl%& ACL condition"
32274 The possible values of the argument are the same as for the
32275 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32276 &"accept"& the condition is true; if it returns &"deny"& the condition is
32277 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32278 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32279 condition false. This means that further processing of the &%warn%& verb
32280 ceases, but processing of the ACL continues.
32281
32282 If the argument is a named ACL, up to nine space-separated optional values
32283 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32284 and $acl_narg is set to the count of values.
32285 Previous values of these variables are restored after the call returns.
32286 The name and values are expanded separately.
32287 Note that spaces in complex expansions which are used as arguments
32288 will act as argument separators.
32289
32290 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32291 the connection is dropped. If it returns &"discard"&, the verb must be
32292 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32293 conditions are tested.
32294
32295 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32296 loops. This condition allows you to use different ACLs in different
32297 circumstances. For example, different ACLs can be used to handle RCPT commands
32298 for different local users or different local domains.
32299
32300 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32301 .cindex "&%authenticated%& ACL condition"
32302 .cindex "authentication" "ACL checking"
32303 .cindex "&ACL;" "testing for authentication"
32304 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32305 the name of the authenticator is tested against the list. To test for
32306 authentication by any authenticator, you can set
32307 .code
32308 authenticated = *
32309 .endd
32310
32311 .vitem &*condition&~=&~*&<&'string'&>
32312 .cindex "&%condition%& ACL condition"
32313 .cindex "customizing" "ACL condition"
32314 .cindex "&ACL;" "customized test"
32315 .cindex "&ACL;" "testing, customized"
32316 This feature allows you to make up custom conditions. If the result of
32317 expanding the string is an empty string, the number zero, or one of the strings
32318 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32319 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32320 any other value, some error is assumed to have occurred, and the ACL returns
32321 &"defer"&. However, if the expansion is forced to fail, the condition is
32322 ignored. The effect is to treat it as true, whether it is positive or
32323 negative.
32324
32325 .vitem &*decode&~=&~*&<&'location'&>
32326 .cindex "&%decode%& ACL condition"
32327 This condition is available only when Exim is compiled with the
32328 content-scanning extension, and it is allowed only in the ACL defined by
32329 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32330 If all goes well, the condition is true. It is false only if there are
32331 problems such as a syntax error or a memory shortage. For more details, see
32332 chapter &<<CHAPexiscan>>&.
32333
32334 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32335 .cindex "&%dnslists%& ACL condition"
32336 .cindex "DNS list" "in ACL"
32337 .cindex "black list (DNS)"
32338 .cindex "&ACL;" "testing a DNS list"
32339 This condition checks for entries in DNS black lists. These are also known as
32340 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32341 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32342 different variants of this condition to describe briefly here. See sections
32343 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32344
32345 .vitem &*domains&~=&~*&<&'domain&~list'&>
32346 .cindex "&%domains%& ACL condition"
32347 .cindex "domain" "ACL checking"
32348 .cindex "&ACL;" "testing a recipient domain"
32349 .vindex "&$domain_data$&"
32350 This condition is relevant only in a RCPT ACL. It checks that the domain
32351 of the recipient address is in the domain list. If percent-hack processing is
32352 enabled, it is done before this test is done. If the check succeeds with a
32353 lookup, the result of the lookup is placed in &$domain_data$& until the next
32354 &%domains%& test.
32355
32356 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32357 use &%domains%& in a DATA ACL.
32358
32359
32360 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32361 .cindex "&%encrypted%& ACL condition"
32362 .cindex "encryption" "checking in an ACL"
32363 .cindex "&ACL;" "testing for encryption"
32364 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32365 name of the cipher suite in use is tested against the list. To test for
32366 encryption without testing for any specific cipher suite(s), set
32367 .code
32368 encrypted = *
32369 .endd
32370
32371
32372 .vitem &*hosts&~=&~*&<&'host&~list'&>
32373 .cindex "&%hosts%& ACL condition"
32374 .cindex "host" "ACL checking"
32375 .cindex "&ACL;" "testing the client host"
32376 This condition tests that the calling host matches the host list. If you have
32377 name lookups or wildcarded host names and IP addresses in the same host list,
32378 you should normally put the IP addresses first. For example, you could have:
32379 .code
32380 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32381 .endd
32382 The lookup in this example uses the host name for its key. This is implied by
32383 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32384 and it wouldn't matter which way round you had these two items.)
32385
32386 The reason for the problem with host names lies in the left-to-right way that
32387 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32388 but when it reaches an item that requires a host name, it fails if it cannot
32389 find a host name to compare with the pattern. If the above list is given in the
32390 opposite order, the &%accept%& statement fails for a host whose name cannot be
32391 found, even if its IP address is 10.9.8.7.
32392
32393 If you really do want to do the name check first, and still recognize the IP
32394 address even if the name lookup fails, you can rewrite the ACL like this:
32395 .code
32396 accept hosts = dbm;/etc/friendly/hosts
32397 accept hosts = 10.9.8.7
32398 .endd
32399 The default action on failing to find the host name is to assume that the host
32400 is not in the list, so the first &%accept%& statement fails. The second
32401 statement can then check the IP address.
32402
32403 .vindex "&$host_data$&"
32404 If a &%hosts%& condition is satisfied by means of a lookup, the result
32405 of the lookup is made available in the &$host_data$& variable. This
32406 allows you, for example, to set up a statement like this:
32407 .code
32408 deny  hosts = net-lsearch;/some/file
32409       message = $host_data
32410 .endd
32411 which gives a custom error message for each denied host.
32412
32413 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32414 .cindex "&%local_parts%& ACL condition"
32415 .cindex "local part" "ACL checking"
32416 .cindex "&ACL;" "testing a local part"
32417 .vindex "&$local_part_data$&"
32418 This condition is relevant only in a RCPT ACL. It checks that the local
32419 part of the recipient address is in the list. If percent-hack processing is
32420 enabled, it is done before this test. If the check succeeds with a lookup, the
32421 result of the lookup is placed in &$local_part_data$&, which remains set until
32422 the next &%local_parts%& test.
32423
32424 .vitem &*malware&~=&~*&<&'option'&>
32425 .cindex "&%malware%& ACL condition"
32426 .cindex "&ACL;" "virus scanning"
32427 .cindex "&ACL;" "scanning for viruses"
32428 This condition is available only when Exim is compiled with the
32429 content-scanning extension
32430 and only after a DATA command.
32431 It causes the incoming message to be scanned for
32432 viruses. For details, see chapter &<<CHAPexiscan>>&.
32433
32434 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32435 .cindex "&%mime_regex%& ACL condition"
32436 .cindex "&ACL;" "testing by regex matching"
32437 This condition is available only when Exim is compiled with the
32438 content-scanning extension, and it is allowed only in the ACL defined by
32439 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32440 with any of the regular expressions. For details, see chapter
32441 &<<CHAPexiscan>>&.
32442
32443 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32444 .cindex "rate limiting"
32445 This condition can be used to limit the rate at which a user or host submits
32446 messages. Details are given in section &<<SECTratelimiting>>&.
32447
32448 .vitem &*recipients&~=&~*&<&'address&~list'&>
32449 .cindex "&%recipients%& ACL condition"
32450 .cindex "recipient" "ACL checking"
32451 .cindex "&ACL;" "testing a recipient"
32452 This condition is relevant only in a RCPT ACL. It checks the entire
32453 recipient address against a list of recipients.
32454
32455 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32456 .cindex "&%regex%& ACL condition"
32457 .cindex "&ACL;" "testing by regex matching"
32458 This condition is available only when Exim is compiled with the
32459 content-scanning extension, and is available only in the DATA, MIME, and
32460 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32461 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32462
32463 .vitem &*seen&~=&~*&<&'parameters'&>
32464 .cindex "&%seen%& ACL condition"
32465 This condition can be used to test if a situation has been previously met,
32466 for example for greylisting.
32467 Details are given in section &<<SECTseen>>&.
32468
32469 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32470 .cindex "&%sender_domains%& ACL condition"
32471 .cindex "sender" "ACL checking"
32472 .cindex "&ACL;" "testing a sender domain"
32473 .vindex "&$domain$&"
32474 .vindex "&$sender_address_domain$&"
32475 This condition tests the domain of the sender of the message against the given
32476 domain list. &*Note*&: The domain of the sender address is in
32477 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32478 of this condition. This is an exception to the general rule for testing domain
32479 lists. It is done this way so that, if this condition is used in an ACL for a
32480 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32481 influence the sender checking.
32482
32483 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32484 relaying, because sender addresses are easily, and commonly, forged.
32485
32486 .vitem &*senders&~=&~*&<&'address&~list'&>
32487 .cindex "&%senders%& ACL condition"
32488 .cindex "sender" "ACL checking"
32489 .cindex "&ACL;" "testing a sender"
32490 This condition tests the sender of the message against the given list. To test
32491 for a bounce message, which has an empty sender, set
32492 .code
32493 senders = :
32494 .endd
32495 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32496 relaying, because sender addresses are easily, and commonly, forged.
32497
32498 .vitem &*spam&~=&~*&<&'username'&>
32499 .cindex "&%spam%& ACL condition"
32500 .cindex "&ACL;" "scanning for spam"
32501 This condition is available only when Exim is compiled with the
32502 content-scanning extension. It causes the incoming message to be scanned by
32503 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32504
32505 .vitem &*verify&~=&~certificate*&
32506 .cindex "&%verify%& ACL condition"
32507 .cindex "TLS" "client certificate verification"
32508 .cindex "certificate" "verification of client"
32509 .cindex "&ACL;" "certificate verification"
32510 .cindex "&ACL;" "testing a TLS certificate"
32511 This condition is true in an SMTP session if the session is encrypted, and a
32512 certificate was received from the client, and the certificate was verified. The
32513 server requests a certificate only if the client matches &%tls_verify_hosts%&
32514 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32515
32516 .vitem &*verify&~=&~csa*&
32517 .cindex "CSA verification"
32518 This condition checks whether the sending host (the client) is authorized to
32519 send email. Details of how this works are given in section
32520 &<<SECTverifyCSA>>&.
32521
32522 .vitem &*verify&~=&~header_names_ascii*&
32523 .cindex "&%verify%& ACL condition"
32524 .cindex "&ACL;" "verifying header names only ASCII"
32525 .cindex "header lines" "verifying header names only ASCII"
32526 .cindex "verifying" "header names only ASCII"
32527 This condition is relevant only in an ACL that is run after a message has been
32528 received.
32529 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32530 It checks all header names (not the content) to make sure
32531 there are no non-ASCII characters, also excluding control characters.  The
32532 allowable characters are decimal ASCII values 33 through 126.
32533
32534 Exim itself will handle headers with non-ASCII characters, but it can cause
32535 problems for downstream applications, so this option will allow their
32536 detection and rejection in the DATA ACL's.
32537
32538 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32539 .cindex "&%verify%& ACL condition"
32540 .cindex "&ACL;" "verifying sender in the header"
32541 .cindex "header lines" "verifying the sender in"
32542 .cindex "sender" "verifying in header"
32543 .cindex "verifying" "sender in header"
32544 This condition is relevant only in an ACL that is run after a message has been
32545 received, that is, in an ACL specified by &%acl_smtp_data%& or
32546 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32547 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32548 is loosely thought of as a &"sender"& address (hence the name of the test).
32549 However, an address that appears in one of these headers need not be an address
32550 that accepts bounce messages; only sender addresses in envelopes are required
32551 to accept bounces. Therefore, if you use the callout option on this check, you
32552 might want to arrange for a non-empty address in the MAIL command.
32553
32554 Details of address verification and the options are given later, starting at
32555 section &<<SECTaddressverification>>& (callouts are described in section
32556 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32557 condition to restrict it to bounce messages only:
32558 .code
32559 deny    senders = :
32560        !verify  = header_sender
32561         message = A valid sender header is required for bounces
32562 .endd
32563
32564 .vitem &*verify&~=&~header_syntax*&
32565 .cindex "&%verify%& ACL condition"
32566 .cindex "&ACL;" "verifying header syntax"
32567 .cindex "header lines" "verifying syntax"
32568 .cindex "verifying" "header syntax"
32569 This condition is relevant only in an ACL that is run after a message has been
32570 received, that is, in an ACL specified by &%acl_smtp_data%& or
32571 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32572 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32573 and &'Bcc:'&), returning true if there are no problems.
32574 Unqualified addresses (local parts without domains) are
32575 permitted only in locally generated messages and from hosts that match
32576 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32577 appropriate.
32578
32579 Note that this condition is a syntax check only. However, a common spamming
32580 ploy used to be to send syntactically invalid headers such as
32581 .code
32582 To: @
32583 .endd
32584 and this condition can be used to reject such messages, though they are not as
32585 common as they used to be.
32586
32587 .vitem &*verify&~=&~helo*&
32588 .cindex "&%verify%& ACL condition"
32589 .cindex "&ACL;" "verifying HELO/EHLO"
32590 .cindex "HELO" "verifying"
32591 .cindex "EHLO" "verifying"
32592 .cindex "verifying" "EHLO"
32593 .cindex "verifying" "HELO"
32594 This condition is true if a HELO or EHLO command has been received from the
32595 client host, and its contents have been verified. If there has been no previous
32596 attempt to verify the HELO/EHLO contents, it is carried out when this
32597 condition is encountered. See the description of the &%helo_verify_hosts%& and
32598 &%helo_try_verify_hosts%& options for details of how to request verification
32599 independently of this condition, and for detail of the verification.
32600
32601 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32602 option), this condition is always true.
32603
32604
32605 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32606 .cindex "verifying" "not blind"
32607 .cindex "bcc recipients, verifying none"
32608 This condition checks that there are no blind (bcc) recipients in the message.
32609 Every envelope recipient must appear either in a &'To:'& header line or in a
32610 &'Cc:'& header line for this condition to be true. Local parts are checked
32611 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32612 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32613 used only in a DATA or non-SMTP ACL.
32614
32615 There is one possible option, &`case_insensitive`&.  If this is present then
32616 local parts are checked case-insensitively.
32617
32618 There are, of course, many legitimate messages that make use of blind (bcc)
32619 recipients. This check should not be used on its own for blocking messages.
32620
32621
32622 .vitem &*verify&~=&~recipient/*&<&'options'&>
32623 .cindex "&%verify%& ACL condition"
32624 .cindex "&ACL;" "verifying recipient"
32625 .cindex "recipient" "verifying"
32626 .cindex "verifying" "recipient"
32627 .vindex "&$address_data$&"
32628 This condition is relevant only after a RCPT command. It verifies the current
32629 recipient. Details of address verification are given later, starting at section
32630 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32631 of &$address_data$& is the last value that was set while routing the address.
32632 This applies even if the verification fails. When an address that is being
32633 verified is redirected to a single address, verification continues with the new
32634 address, and in that case, the subsequent value of &$address_data$& is the
32635 value for the child address.
32636
32637 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32638 .cindex "&%verify%& ACL condition"
32639 .cindex "&ACL;" "verifying host reverse lookup"
32640 .cindex "host" "verifying reverse lookup"
32641 This condition ensures that a verified host name has been looked up from the IP
32642 address of the client host. (This may have happened already if the host name
32643 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32644 Verification ensures that the host name obtained from a reverse DNS lookup, or
32645 one of its aliases, does, when it is itself looked up in the DNS, yield the
32646 original IP address.
32647
32648 There is one possible option, &`defer_ok`&.  If this is present and a
32649 DNS operation returns a temporary error, the verify condition succeeds.
32650
32651 If this condition is used for a locally generated message (that is, when there
32652 is no client host involved), it always succeeds.
32653
32654 .vitem &*verify&~=&~sender/*&<&'options'&>
32655 .cindex "&%verify%& ACL condition"
32656 .cindex "&ACL;" "verifying sender"
32657 .cindex "sender" "verifying"
32658 .cindex "verifying" "sender"
32659 This condition is relevant only after a MAIL or RCPT command, or after a
32660 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32661 the message's sender is empty (that is, this is a bounce message), the
32662 condition is true. Otherwise, the sender address is verified.
32663
32664 .vindex "&$address_data$&"
32665 .vindex "&$sender_address_data$&"
32666 If there is data in the &$address_data$& variable at the end of routing, its
32667 value is placed in &$sender_address_data$& at the end of verification. This
32668 value can be used in subsequent conditions and modifiers in the same ACL
32669 statement. It does not persist after the end of the current statement. If you
32670 want to preserve the value for longer, you can save it in an ACL variable.
32671
32672 Details of verification are given later, starting at section
32673 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32674 to avoid doing it more than once per message.
32675
32676 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32677 .cindex "&%verify%& ACL condition"
32678 This is a variation of the previous option, in which a modified address is
32679 verified as a sender.
32680
32681 Note that '/' is legal in local-parts; if the address may have such
32682 (eg. is generated from the received message)
32683 they must be protected from the options parsing by doubling:
32684 .code
32685 verify = sender=${listquote{/}{${address:$h_sender:}}}
32686 .endd
32687 .endlist
32688
32689
32690
32691 .section "Using DNS lists" "SECTmorednslists"
32692 .cindex "DNS list" "in ACL"
32693 .cindex "black list (DNS)"
32694 .cindex "&ACL;" "testing a DNS list"
32695 In its simplest form, the &%dnslists%& condition tests whether the calling host
32696 is on at least one of a number of DNS lists by looking up the inverted IP
32697 address in one or more DNS domains. (Note that DNS list domains are not mail
32698 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32699 special options instead.) For example, if the calling host's IP
32700 address is 192.168.62.43, and the ACL statement is
32701 .code
32702 deny dnslists = blackholes.mail-abuse.org : \
32703                 dialups.mail-abuse.org
32704 .endd
32705 the following records are looked up:
32706 .code
32707 43.62.168.192.blackholes.mail-abuse.org
32708 43.62.168.192.dialups.mail-abuse.org
32709 .endd
32710 As soon as Exim finds an existing DNS record, processing of the list stops.
32711 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32712 to test that a host is on more than one list (an &"and"& conjunction), you can
32713 use two separate conditions:
32714 .code
32715 deny dnslists = blackholes.mail-abuse.org
32716      dnslists = dialups.mail-abuse.org
32717 .endd
32718 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32719 behaves as if the host does not match the list item, that is, as if the DNS
32720 record does not exist. If there are further items in the DNS list, they are
32721 processed.
32722
32723 This is usually the required action when &%dnslists%& is used with &%deny%&
32724 (which is the most common usage), because it prevents a DNS failure from
32725 blocking mail. However, you can change this behaviour by putting one of the
32726 following special items in the list:
32727 .itable none 0 0 2 25* left 75* left
32728 .irow "+include_unknown"   "behave as if the item is on the list"
32729 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32730 .irow "+defer_unknown  "   "give a temporary error"
32731 .endtable
32732 .cindex "&`+include_unknown`&"
32733 .cindex "&`+exclude_unknown`&"
32734 .cindex "&`+defer_unknown`&"
32735 Each of these applies to any subsequent items on the list. For example:
32736 .code
32737 deny dnslists = +defer_unknown : foo.bar.example
32738 .endd
32739 Testing the list of domains stops as soon as a match is found. If you want to
32740 warn for one list and block for another, you can use two different statements:
32741 .code
32742 deny  dnslists = blackholes.mail-abuse.org
32743 warn  dnslists = dialups.mail-abuse.org
32744       message  = X-Warn: sending host is on dialups list
32745 .endd
32746 .cindex caching "of dns lookup"
32747 .cindex DNS TTL
32748 DNS list lookups are cached by Exim for the duration of the SMTP session
32749 (but limited by the DNS return TTL value),
32750 so a lookup based on the IP address is done at most once for any incoming
32751 connection (assuming long-enough TTL).
32752 Exim does not share information between multiple incoming
32753 connections (but your local name server cache should be active).
32754
32755 There are a number of DNS lists to choose from, some commercial, some free,
32756 or free for small deployments.  An overview can be found at
32757 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32758
32759
32760
32761 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32762 .cindex "DNS list" "keyed by explicit IP address"
32763 By default, the IP address that is used in a DNS list lookup is the IP address
32764 of the calling host. However, you can specify another IP address by listing it
32765 after the domain name, introduced by a slash. For example:
32766 .code
32767 deny dnslists = black.list.tld/192.168.1.2
32768 .endd
32769 This feature is not very helpful with explicit IP addresses; it is intended for
32770 use with IP addresses that are looked up, for example, the IP addresses of the
32771 MX hosts or nameservers of an email sender address. For an example, see section
32772 &<<SECTmulkeyfor>>& below.
32773
32774
32775
32776
32777 .subsection "DNS lists keyed on domain names" SECID202
32778 .cindex "DNS list" "keyed by domain name"
32779 There are some lists that are keyed on domain names rather than inverted IP
32780 addresses (see, e.g., the &'domain based zones'& link at
32781 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32782 with these lists. You can change the name that is looked up in a DNS list by
32783 listing it after the domain name, introduced by a slash. For example,
32784 .code
32785 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32786       message  = Sender's domain is listed at $dnslist_domain
32787 .endd
32788 This particular example is useful only in ACLs that are obeyed after the
32789 RCPT or DATA commands, when a sender address is available. If (for
32790 example) the message's sender is &'user@tld.example'& the name that is looked
32791 up by this example is
32792 .code
32793 tld.example.dsn.rfc-ignorant.org
32794 .endd
32795 A single &%dnslists%& condition can contain entries for both names and IP
32796 addresses. For example:
32797 .code
32798 deny dnslists = sbl.spamhaus.org : \
32799                 dsn.rfc-ignorant.org/$sender_address_domain
32800 .endd
32801 The first item checks the sending host's IP address; the second checks a domain
32802 name. The whole condition is true if either of the DNS lookups succeeds.
32803
32804
32805
32806
32807 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32808 .cindex "DNS list" "multiple keys for"
32809 The syntax described above for looking up explicitly-defined values (either
32810 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32811 name for the DNS list, what follows the slash can in fact be a list of items.
32812 As with all lists in Exim, the default separator is a colon. However, because
32813 this is a sublist within the list of DNS blacklist domains, it is necessary
32814 either to double the separators like this:
32815 .code
32816 dnslists = black.list.tld/name.1::name.2
32817 .endd
32818 or to change the separator character, like this:
32819 .code
32820 dnslists = black.list.tld/<;name.1;name.2
32821 .endd
32822 If an item in the list is an IP address, it is inverted before the DNS
32823 blacklist domain is appended. If it is not an IP address, no inversion
32824 occurs. Consider this condition:
32825 .code
32826 dnslists = black.list.tld/<;192.168.1.2;a.domain
32827 .endd
32828 The DNS lookups that occur are:
32829 .code
32830 2.1.168.192.black.list.tld
32831 a.domain.black.list.tld
32832 .endd
32833 Once a DNS record has been found (that matches a specific IP return
32834 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32835 are done. If there is a temporary DNS error, the rest of the sublist of domains
32836 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32837 only if no other DNS lookup in this sublist succeeds. In other words, a
32838 successful lookup for any of the items in the sublist overrides a temporary
32839 error for a previous item.
32840
32841 The ability to supply a list of items after the slash is in some sense just a
32842 syntactic convenience. These two examples have the same effect:
32843 .code
32844 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32845 dnslists = black.list.tld/a.domain::b.domain
32846 .endd
32847 However, when the data for the list is obtained from a lookup, the second form
32848 is usually much more convenient. Consider this example:
32849 .code
32850 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32851                                    ${lookup dnsdb {>|mxh=\
32852                                    $sender_address_domain} }} }
32853      message  = The mail servers for the domain \
32854                 $sender_address_domain \
32855                 are listed at $dnslist_domain ($dnslist_value); \
32856                 see $dnslist_text.
32857 .endd
32858 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32859 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32860 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32861 of expanding the condition might be something like this:
32862 .code
32863 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32864 .endd
32865 Thus, this example checks whether or not the IP addresses of the sender
32866 domain's mail servers are on the Spamhaus black list.
32867
32868 The key that was used for a successful DNS list lookup is put into the variable
32869 &$dnslist_matched$& (see section &<<SECID204>>&).
32870
32871
32872
32873
32874 .subsection "Data returned by DNS lists" SECID203
32875 .cindex "DNS list" "data returned from"
32876 DNS lists are constructed using address records in the DNS. The original RBL
32877 just used the address 127.0.0.1 on the right hand side of each record, but the
32878 RBL+ list and some other lists use a number of values with different meanings.
32879 The values used on the RBL+ list are:
32880 .itable none 0 0 2 20* left 80* left
32881 .irow 127.1.0.1  "RBL"
32882 .irow 127.1.0.2  "DUL"
32883 .irow 127.1.0.3  "DUL and RBL"
32884 .irow 127.1.0.4  "RSS"
32885 .irow 127.1.0.5  "RSS and RBL"
32886 .irow 127.1.0.6  "RSS and DUL"
32887 .irow 127.1.0.7  "RSS and DUL and RBL"
32888 .endtable
32889 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32890 different values. Some DNS lists may return more than one address record;
32891 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32892
32893 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32894 range. If a DNSBL operator loses control of the domain, lookups on it
32895 may start returning other addresses.  Because of this, Exim now ignores
32896 returned values outside the 127/8 region.
32897
32898
32899 .subsection "Variables set from DNS lists" SECID204
32900 .cindex "expansion" "variables, set from DNS list"
32901 .cindex "DNS list" "variables set from"
32902 .vindex "&$dnslist_domain$&"
32903 .vindex "&$dnslist_matched$&"
32904 .vindex "&$dnslist_text$&"
32905 .vindex "&$dnslist_value$&"
32906 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32907 the name of the overall domain that matched (for example,
32908 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32909 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32910 the DNS record. When the key is an IP address, it is not reversed in
32911 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32912 cases, for example:
32913 .code
32914 deny dnslists = spamhaus.example
32915 .endd
32916 the key is also available in another variable (in this case,
32917 &$sender_host_address$&). In more complicated cases, however, this is not true.
32918 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32919 might generate a dnslists lookup like this:
32920 .code
32921 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32922 .endd
32923 If this condition succeeds, the value in &$dnslist_matched$& might be
32924 &`192.168.6.7`& (for example).
32925
32926 If more than one address record is returned by the DNS lookup, all the IP
32927 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32928 The variable &$dnslist_text$& contains the contents of any associated TXT
32929 record. For lists such as RBL+ the TXT record for a merged entry is often not
32930 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32931 information.
32932
32933 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32934 &-- even if these appear before the condition in the ACL, they are not
32935 expanded until after it has failed. For example:
32936 .code
32937 deny    hosts = !+local_networks
32938         message = $sender_host_address is listed \
32939                   at $dnslist_domain
32940         dnslists = rbl-plus.mail-abuse.example
32941 .endd
32942
32943
32944
32945 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32946 .cindex "DNS list" "matching specific returned data"
32947 You can add an equals sign and an IP address after a &%dnslists%& domain name
32948 in order to restrict its action to DNS records with a matching right hand side.
32949 For example,
32950 .code
32951 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32952 .endd
32953 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32954 any address record is considered to be a match. For the moment, we assume
32955 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32956 describes how multiple records are handled.
32957
32958 More than one IP address may be given for checking, using a comma as a
32959 separator. These are alternatives &-- if any one of them matches, the
32960 &%dnslists%& condition is true. For example:
32961 .code
32962 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32963 .endd
32964 If you want to specify a constraining address list and also specify names or IP
32965 addresses to be looked up, the constraining address list must be specified
32966 first. For example:
32967 .code
32968 deny dnslists = dsn.rfc-ignorant.org\
32969                 =127.0.0.2/$sender_address_domain
32970 .endd
32971
32972 If the character &`&&`& is used instead of &`=`&, the comparison for each
32973 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32974 In other words, the listed addresses are used as bit masks. The comparison is
32975 true if all the bits in the mask are present in the address that is being
32976 tested. For example:
32977 .code
32978 dnslists = a.b.c&0.0.0.3
32979 .endd
32980 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32981 want to test whether one bit or another bit is present (as opposed to both
32982 being present), you must use multiple values. For example:
32983 .code
32984 dnslists = a.b.c&0.0.0.1,0.0.0.2
32985 .endd
32986 matches if the final component of the address is an odd number or two times
32987 an odd number.
32988
32989
32990
32991 .subsection "Negated DNS matching conditions" SECID205
32992 You can supply a negative list of IP addresses as part of a &%dnslists%&
32993 condition. Whereas
32994 .code
32995 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32996 .endd
32997 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32998 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32999 .code
33000 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
33001 .endd
33002 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33003 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
33004 words, the result of the test is inverted if an exclamation mark appears before
33005 the &`=`& (or the &`&&`&) sign.
33006
33007 &*Note*&: This kind of negation is not the same as negation in a domain,
33008 host, or address list (which is why the syntax is different).
33009
33010 If you are using just one list, the negation syntax does not gain you much. The
33011 previous example is precisely equivalent to
33012 .code
33013 deny  dnslists = a.b.c
33014      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33015 .endd
33016 However, if you are using multiple lists, the negation syntax is clearer.
33017 Consider this example:
33018 .code
33019 deny  dnslists = sbl.spamhaus.org : \
33020                  list.dsbl.org : \
33021                  dnsbl.njabl.org!=127.0.0.3 : \
33022                  relays.ordb.org
33023 .endd
33024 Using only positive lists, this would have to be:
33025 .code
33026 deny  dnslists = sbl.spamhaus.org : \
33027                  list.dsbl.org
33028 deny  dnslists = dnsbl.njabl.org
33029      !dnslists = dnsbl.njabl.org=127.0.0.3
33030 deny  dnslists = relays.ordb.org
33031 .endd
33032 which is less clear, and harder to maintain.
33033
33034 Negation can also be used with a bitwise-and restriction.
33035 The dnslists condition with only be trus if a result is returned
33036 by the lookup which, anded with the restriction, is all zeroes.
33037 For example:
33038 .code
33039 deny dnslists = zen.spamhaus.org!&0.255.255.0
33040 .endd
33041
33042
33043
33044
33045 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33046 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33047 thereby providing more than one IP address. When an item in a &%dnslists%& list
33048 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33049 the match to specific results from the DNS lookup, there are two ways in which
33050 the checking can be handled. For example, consider the condition:
33051 .code
33052 dnslists = a.b.c=127.0.0.1
33053 .endd
33054 What happens if the DNS lookup for the incoming IP address yields both
33055 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33056 condition true because at least one given value was found, or is it false
33057 because at least one of the found values was not listed? And how does this
33058 affect negated conditions? Both possibilities are provided for with the help of
33059 additional separators &`==`& and &`=&&`&.
33060
33061 .ilist
33062 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33063 IP addresses matches one of the listed addresses. For the example above, the
33064 condition is true because 127.0.0.1 matches.
33065 .next
33066 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33067 looked up IP addresses matches one of the listed addresses. If the condition is
33068 changed to:
33069 .code
33070 dnslists = a.b.c==127.0.0.1
33071 .endd
33072 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33073 false because 127.0.0.2 is not listed. You would need to have:
33074 .code
33075 dnslists = a.b.c==127.0.0.1,127.0.0.2
33076 .endd
33077 for the condition to be true.
33078 .endlist
33079
33080 When &`!`& is used to negate IP address matching, it inverts the result, giving
33081 the precise opposite of the behaviour above. Thus:
33082 .ilist
33083 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33084 addresses matches one of the listed addresses. Consider:
33085 .code
33086 dnslists = a.b.c!&0.0.0.1
33087 .endd
33088 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33089 false because 127.0.0.1 matches.
33090 .next
33091 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33092 looked up IP address that does not match. Consider:
33093 .code
33094 dnslists = a.b.c!=&0.0.0.1
33095 .endd
33096 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33097 true, because 127.0.0.2 does not match. You would need to have:
33098 .code
33099 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33100 .endd
33101 for the condition to be false.
33102 .endlist
33103 When the DNS lookup yields only a single IP address, there is no difference
33104 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33105
33106
33107
33108
33109 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33110 .cindex "DNS list" "information from merged"
33111 When the facility for restricting the matching IP values in a DNS list is used,
33112 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33113 the true reason for rejection. This happens when lists are merged and the IP
33114 address in the A record is used to distinguish them; unfortunately there is
33115 only one TXT record. One way round this is not to use merged lists, but that
33116 can be inefficient because it requires multiple DNS lookups where one would do
33117 in the vast majority of cases when the host of interest is not on any of the
33118 lists.
33119
33120 A less inefficient way of solving this problem is available. If
33121 two domain names, comma-separated, are given, the second is used first to
33122 do an initial check, making use of any IP value restrictions that are set.
33123 If there is a match, the first domain is used, without any IP value
33124 restrictions, to get the TXT record. As a byproduct of this, there is also
33125 a check that the IP being tested is indeed on the first list. The first
33126 domain is the one that is put in &$dnslist_domain$&. For example:
33127 .code
33128 deny   dnslists = \
33129          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33130          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33131        message  = \
33132          rejected because $sender_host_address is blacklisted \
33133          at $dnslist_domain\n$dnslist_text
33134 .endd
33135 For the first blacklist item, this starts by doing a lookup in
33136 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33137 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33138 value, and as long as something is found, it looks for the corresponding TXT
33139 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33140 The second blacklist item is processed similarly.
33141
33142 If you are interested in more than one merged list, the same list must be
33143 given several times, but because the results of the DNS lookups are cached,
33144 the DNS calls themselves are not repeated. For example:
33145 .code
33146 deny dnslists = \
33147          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33148          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33149          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33150          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33151 .endd
33152 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33153 values matches (or if no record is found), this is the only lookup that is
33154 done. Only if there is a match is one of the more specific lists consulted.
33155
33156
33157
33158 .subsection "DNS lists and IPv6" SECTmorednslistslast
33159 .cindex "IPv6" "DNS black lists"
33160 .cindex "DNS list" "IPv6 usage"
33161 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33162 nibble by nibble. For example, if the calling host's IP address is
33163 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33164 .code
33165 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33166   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33167 .endd
33168 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33169 lists contain wildcard records, intended for IPv4, that interact badly with
33170 IPv6. For example, the DNS entry
33171 .code
33172 *.3.some.list.example.    A    127.0.0.1
33173 .endd
33174 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33175 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33176
33177 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33178 &%condition%& condition, as in this example:
33179 .code
33180 deny   condition = ${if isip4{$sender_host_address}}
33181        dnslists  = some.list.example
33182 .endd
33183
33184 If an explicit key is being used for a DNS lookup and it may be an IPv6
33185 address you should specify alternate list separators for both the outer
33186 (DNS list name) list and inner (lookup keys) list:
33187 .code
33188        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33189 .endd
33190
33191
33192 .section "Previously seen user and hosts" "SECTseen"
33193 .cindex "&%seen%& ACL condition"
33194 .cindex greylisting
33195 The &%seen%& ACL condition can be used to test whether a
33196 situation has been previously met.
33197 It uses a hints database to record a timestamp against a key.
33198 The syntax of the condition is:
33199 .display
33200 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33201 .endd
33202
33203 For example,
33204 .code
33205 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33206 .endd
33207 in a RCPT ACL will implement simple greylisting.
33208
33209 The parameters for the condition are
33210 a possible minus sign,
33211 then an interval,
33212 then, slash-separated, a list of options.
33213 The interval is taken as an offset before the current time,
33214 and used for the test.
33215 If the interval is preceded by a minus sign then the condition returns
33216 whether a record is found which is before the test time.
33217 Otherwise, the condition returns whether one is found which is since the
33218 test time.
33219
33220 Options are read in order with later ones overriding earlier ones.
33221
33222 The default key is &$sender_host_address$&.
33223 An explicit key can be set using a &%key=value%& option.
33224
33225 If a &%readonly%& option is given then
33226 no record create or update is done.
33227 If a &%write%& option is given then
33228 a record create or update is always done.
33229 An update is done if the test is for &"since"&.
33230 If none of those hold and there was no existing record,
33231 a record is created.
33232
33233 Creates and updates are marked with the current time.
33234
33235 Finally, a &"before"& test which succeeds, and for which the record
33236 is old enough, will be refreshed with a timestamp of the test time.
33237 This can prevent tidying of the database from removing the entry.
33238 The interval for this is, by default, 10 days.
33239 An explicit interval can be set using a
33240 &%refresh=value%& option.
33241
33242 Note that &"seen"& should be added to the list of hints databases
33243 for maintenance if this ACL condition is used.
33244
33245
33246 .section "Rate limiting incoming messages" "SECTratelimiting"
33247 .cindex "rate limiting" "client sending"
33248 .cindex "limiting client sending rates"
33249 .oindex "&%smtp_ratelimit_*%&"
33250 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33251 which clients can send email. This is more powerful than the
33252 &%smtp_ratelimit_*%& options, because those options control the rate of
33253 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33254 works across all connections (concurrent and sequential) from the same client
33255 host. The syntax of the &%ratelimit%& condition is:
33256 .display
33257 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33258 .endd
33259 If the average client sending rate is less than &'m'& messages per time
33260 period &'p'& then the condition is false; otherwise it is true.
33261
33262 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33263 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33264 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33265 of &'p'&.
33266
33267 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33268 time interval, for example, &`8h`& for eight hours. A larger time constant
33269 means that it takes Exim longer to forget a client's past behaviour. The
33270 parameter &'m'& is the maximum number of messages that a client is permitted to
33271 send in each time interval. It also specifies the number of messages permitted
33272 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33273 constant, you can allow a client to send more messages in a burst without
33274 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33275 both small, messages must be sent at an even rate.
33276
33277 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33278 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33279 when deploying the &%ratelimit%& ACL condition. The script prints usage
33280 instructions when it is run with no arguments.
33281
33282 The key is used to look up the data for calculating the client's average
33283 sending rate. This data is stored in Exim's spool directory, alongside the
33284 retry and other hints databases. The default key is &$sender_host_address$&,
33285 which means Exim computes the sending rate of each client host IP address.
33286 By changing the key you can change how Exim identifies clients for the purpose
33287 of ratelimiting. For example, to limit the sending rate of each authenticated
33288 user, independent of the computer they are sending from, set the key to
33289 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33290 example, &$authenticated_id$& is only meaningful if the client has
33291 authenticated (which you can check with the &%authenticated%& ACL condition).
33292
33293 The lookup key does not have to identify clients: If you want to limit the
33294 rate at which a recipient receives messages, you can use the key
33295 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33296 ACL.
33297
33298 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33299 specifies what Exim measures the rate of, for example, messages or recipients
33300 or bytes. You can adjust the measurement using the &%unique=%& and/or
33301 &%count=%& options. You can also control when Exim updates the recorded rate
33302 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33303 separated by a slash, like the other parameters. They may appear in any order.
33304
33305 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33306 any options that alter the meaning of the stored data. The limit &'m'& is not
33307 stored, so you can alter the configured maximum rate and Exim will still
33308 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33309 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33310 behaviour. The lookup key is not affected by changes to the update mode and
33311 the &%count=%& option.
33312
33313
33314 .subsection "Ratelimit options for what is being measured" ratoptmea
33315 .cindex "rate limiting" "per_* options"
33316 .vlist
33317 .vitem per_conn
33318 .cindex "rate limiting" per_conn
33319 This option limits the client's connection rate. It is not
33320 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33321 &%acl_not_smtp_start%& ACLs.
33322
33323 .vitem per_mail
33324 .cindex "rate limiting" per_conn
33325 This option limits the client's rate of sending messages. This is
33326 the default if none of the &%per_*%& options is specified. It can be used in
33327 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33328 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33329
33330 .vitem per_byte
33331 .cindex "rate limiting" per_conn
33332 This option limits the sender's email bandwidth. It can be used in
33333 the same ACLs as the &%per_mail%& option, though it is best to use this option
33334 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33335 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33336 in its MAIL command, which may be inaccurate or completely missing. You can
33337 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33338 in kilobytes, megabytes, or gigabytes, respectively.
33339
33340 .vitem per_rcpt
33341 .cindex "rate limiting" per_rcpt
33342 This option causes Exim to limit the rate at which recipients are
33343 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33344 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33345 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33346 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33347 in either case the rate limiting engine will see a message with many
33348 recipients as a large high-speed burst.
33349
33350 .vitem per_addr
33351 .cindex "rate limiting" per_addr
33352 This option is like the &%per_rcpt%& option, except it counts the
33353 number of different recipients that the client has sent messages to in the
33354 last time period. That is, if the client repeatedly sends messages to the same
33355 recipient, its measured rate is not increased. This option can only be used in
33356 &%acl_smtp_rcpt%&.
33357
33358 .vitem per_cmd
33359 .cindex "rate limiting" per_cmd
33360 This option causes Exim to recompute the rate every time the
33361 condition is processed. This can be used to limit the rate of any SMTP
33362 command. If it is used in multiple ACLs it can limit the aggregate rate of
33363 multiple different commands.
33364
33365 .vitem count
33366 .cindex "rate limiting" count
33367 This option can be used to alter how much Exim adds to the client's
33368 measured rate.
33369 A value is required, after an equals sign.
33370 For example, the &%per_byte%& option is equivalent to
33371 &`per_mail/count=$message_size`&.
33372 If there is no &%count=%& option, Exim
33373 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33374 other than &%acl_smtp_rcpt%&).
33375 The count does not have to be an integer.
33376
33377 .vitem unique
33378 .cindex "rate limiting" unique
33379 This option is described in section &<<ratoptuniq>>& below.
33380 .endlist
33381
33382
33383 .subsection "Ratelimit update modes" ratoptupd
33384 .cindex "rate limiting" "reading data without updating"
33385 You can specify one of three options with the &%ratelimit%& condition to
33386 control when its database is updated. This section describes the &%readonly%&
33387 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33388
33389 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33390 previously-computed rate to check against the limit.
33391
33392 For example, you can test the client's sending rate and deny it access (when
33393 it is too fast) in the connect ACL. If the client passes this check then it
33394 can go on to send a message, in which case its recorded rate will be updated
33395 in the MAIL ACL. Subsequent connections from the same client will check this
33396 new rate.
33397 .code
33398 acl_check_connect:
33399  deny ratelimit = 100 / 5m / readonly
33400       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33401                   (max $sender_rate_limit)
33402 # ...
33403 acl_check_mail:
33404  warn ratelimit = 100 / 5m / strict
33405       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33406                   (max $sender_rate_limit)
33407 .endd
33408
33409 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33410 processing a message then it may increase the client's measured rate more than
33411 it should. For example, this will happen if you check the &%per_rcpt%& option
33412 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33413 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33414 multiple update problems by using the &%readonly%& option on later ratelimit
33415 checks.
33416
33417 The &%per_*%& options described above do not make sense in some ACLs. If you
33418 use a &%per_*%& option in an ACL where it is not normally permitted then the
33419 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33420 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33421 next section) so you must specify the &%readonly%& option explicitly.
33422
33423
33424 .subsection "Ratelimit options for handling fast clients" ratoptfast
33425 .cindex "rate limiting" "strict and leaky modes"
33426 If a client's average rate is greater than the maximum, the rate limiting
33427 engine can react in two possible ways, depending on the presence of the
33428 &%strict%& or &%leaky%& update modes. This is independent of the other
33429 counter-measures (such as rejecting the message) that may be specified by the
33430 rest of the ACL.
33431
33432 The &%leaky%& (default) option means that the client's recorded rate is not
33433 updated if it is above the limit. The effect of this is that Exim measures the
33434 client's average rate of successfully sent email,
33435 up to the given limit.
33436 This is appropriate if the countermeasure when the condition is true
33437 consists of refusing the message, and
33438 is generally the better choice if you have clients that retry automatically.
33439 If the action when true is anything more complex then this option is
33440 likely not what is wanted.
33441
33442 The &%strict%& option means that the client's recorded rate is always
33443 updated. The effect of this is that Exim measures the client's average rate
33444 of attempts to send email, which can be much higher than the maximum it is
33445 actually allowed. If the client is over the limit it may be subjected to
33446 counter-measures by the ACL. It must slow down and allow sufficient time to
33447 pass that its computed rate falls below the maximum before it can send email
33448 again. The time (the number of smoothing periods) it must wait and not
33449 attempt to send mail can be calculated with this formula:
33450 .code
33451         ln(peakrate/maxrate)
33452 .endd
33453
33454
33455 .subsection "Limiting the rate of different events" ratoptuniq
33456 .cindex "rate limiting" "counting unique events"
33457 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33458 rate of different events. For example, the &%per_addr%& option uses this
33459 mechanism to count the number of different recipients that the client has
33460 sent messages to in the last time period; it is equivalent to
33461 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33462 measure the rate that a client uses different sender addresses with the
33463 options &`per_mail/unique=$sender_address`&.
33464
33465 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33466 has seen for that key. The whole set is thrown away when it is older than the
33467 rate smoothing period &'p'&, so each different event is counted at most once
33468 per period. In the &%leaky%& update mode, an event that causes the client to
33469 go over the limit is not added to the set, in the same way that the client's
33470 recorded rate is not updated in the same situation.
33471
33472 When you combine the &%unique=%& and &%readonly%& options, the specific
33473 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33474 rate.
33475
33476 The &%unique=%& mechanism needs more space in the ratelimit database than the
33477 other &%ratelimit%& options in order to store the event set. The number of
33478 unique values is potentially as large as the rate limit, so the extra space
33479 required increases with larger limits.
33480
33481 The uniqueification is not perfect: there is a small probability that Exim
33482 will think a new event has happened before. If the sender's rate is less than
33483 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33484 the measured rate can go above the limit, in which case Exim may under-count
33485 events by a significant margin. Fortunately, if the rate is high enough (2.7
33486 times the limit) that the false positive rate goes above 9%, then Exim will
33487 throw away the over-full event set before the measured rate falls below the
33488 limit. Therefore the only harm should be that exceptionally high sending rates
33489 are logged incorrectly; any countermeasures you configure will be as effective
33490 as intended.
33491
33492
33493 .subsection "Using rate limiting" useratlim
33494 Exim's other ACL facilities are used to define what counter-measures are taken
33495 when the rate limit is exceeded. This might be anything from logging a warning
33496 (for example, while measuring existing sending rates in order to define
33497 policy), through time delays to slow down fast senders, up to rejecting the
33498 message. For example:
33499 .code
33500 # Log all senders' rates
33501 warn ratelimit = 0 / 1h / strict
33502      log_message = Sender rate $sender_rate / $sender_rate_period
33503
33504 # Slow down fast senders; note the need to truncate $sender_rate
33505 # at the decimal point.
33506 warn ratelimit = 100 / 1h / per_rcpt / strict
33507      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33508                    $sender_rate_limit }s
33509
33510 # Keep authenticated users under control
33511 deny authenticated = *
33512      ratelimit = 100 / 1d / strict / $authenticated_id
33513
33514 # System-wide rate limit
33515 defer ratelimit = 10 / 1s / $primary_hostname
33516       message = Sorry, too busy. Try again later.
33517
33518 # Restrict incoming rate from each host, with a default
33519 # set using a macro and special cases looked up in a table.
33520 defer ratelimit = ${lookup {$sender_host_address} \
33521                    cdb {DB/ratelimits.cdb} \
33522                    {$value} {RATELIMIT} }
33523       message = Sender rate exceeds $sender_rate_limit \
33524                messages per $sender_rate_period
33525 .endd
33526 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33527 especially with the &%per_rcpt%& option, you may suffer from a performance
33528 bottleneck caused by locking on the ratelimit hints database. Apart from
33529 making your ACLs less complicated, you can reduce the problem by using a
33530 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33531 this means that Exim will lose its hints data after a reboot (including retry
33532 hints, the callout cache, and ratelimit data).
33533
33534
33535
33536 .section "Address verification" "SECTaddressverification"
33537 .cindex "verifying address" "options for"
33538 .cindex "policy control" "address verification"
33539 Several of the &%verify%& conditions described in section
33540 &<<SECTaclconditions>>& cause addresses to be verified. Section
33541 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33542 The verification conditions can be followed by options that modify the
33543 verification process. The options are separated from the keyword and from each
33544 other by slashes, and some of them contain parameters. For example:
33545 .code
33546 verify = sender/callout
33547 verify = recipient/defer_ok/callout=10s,defer_ok
33548 .endd
33549 The first stage of address verification, which always happens, is to run the
33550 address through the routers, in &"verify mode"&. Routers can detect the
33551 difference between verification and routing for delivery, and their actions can
33552 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33553 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33554 The available options are as follows:
33555
33556 .ilist
33557 If the &%callout%& option is specified, successful routing to one or more
33558 remote hosts is followed by a &"callout"& to those hosts as an additional
33559 check. Callouts and their sub-options are discussed in the next section.
33560 .next
33561 If there is a defer error while doing verification routing, the ACL
33562 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33563 options, the condition is forced to be true instead. Note that this is a main
33564 verification option as well as a suboption for callouts.
33565 .next
33566 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33567 discusses the reporting of sender address verification failures.
33568 .next
33569 The &%success_on_redirect%& option causes verification always to succeed
33570 immediately after a successful redirection. By default, if a redirection
33571 generates just one address, that address is also verified. See further
33572 discussion in section &<<SECTredirwhilveri>>&.
33573 .next
33574 If the &%quota%& option is specified for recipient verify,
33575 successful routing to an appendfile transport is followed by a call into
33576 the transport to evaluate the quota status for the recipient.
33577 No actual delivery is done, but verification will succeed if the quota
33578 is sufficient for the message (if the sender gave a message size) or
33579 not already exceeded (otherwise).
33580 .endlist
33581
33582 .cindex "verifying address" "differentiating failures"
33583 .vindex "&$recipient_verify_failure$&"
33584 .vindex "&$sender_verify_failure$&"
33585 .vindex "&$acl_verify_message$&"
33586 After an address verification failure, &$acl_verify_message$& contains the
33587 error message that is associated with the failure. It can be preserved by
33588 coding like this:
33589 .code
33590 warn  !verify = sender
33591        set acl_m0 = $acl_verify_message
33592 .endd
33593 If you are writing your own custom rejection message or log message when
33594 denying access, you can use this variable to include information about the
33595 verification failure.
33596 This variable is cleared at the end of processing the ACL verb.
33597
33598 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33599 appropriate) contains one of the following words:
33600
33601 .ilist
33602 &%qualify%&: The address was unqualified (no domain), and the message
33603 was neither local nor came from an exempted host.
33604 .next
33605 &%route%&: Routing failed.
33606 .next
33607 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33608 occurred at or before the MAIL command (that is, on initial
33609 connection, HELO, or MAIL).
33610 .next
33611 &%recipient%&: The RCPT command in a callout was rejected.
33612 .next
33613 &%postmaster%&: The postmaster check in a callout was rejected.
33614 .next
33615 &%quota%&: The quota check for a local recipient did non pass.
33616 .endlist
33617
33618 The main use of these variables is expected to be to distinguish between
33619 rejections of MAIL and rejections of RCPT in callouts.
33620
33621 The above variables may also be set after a &*successful*&
33622 address verification to:
33623
33624 .ilist
33625 &%random%&: A random local-part callout succeeded
33626 .endlist
33627
33628
33629
33630
33631 .section "Callout verification" "SECTcallver"
33632 .cindex "verifying address" "by callout"
33633 .cindex "callout" "verification"
33634 .cindex "SMTP" "callout verification"
33635 For non-local addresses, routing verifies the domain, but is unable to do any
33636 checking of the local part. There are situations where some means of verifying
33637 the local part is desirable. One way this can be done is to make an SMTP
33638 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33639 a subsequent host for a recipient address, to see if the host accepts the
33640 address. We use the term &'callout'& to cover both cases. Note that for a
33641 sender address, the callback is not to the client host that is trying to
33642 deliver the message, but to one of the hosts that accepts incoming mail for the
33643 sender's domain.
33644
33645 Exim does not do callouts by default. If you want them to happen, you must
33646 request them by setting appropriate options on the &%verify%& condition, as
33647 described below. This facility should be used with care, because it can add a
33648 lot of resource usage to the cost of verifying an address. However, Exim does
33649 cache the results of callouts, which helps to reduce the cost. Details of
33650 caching are in section &<<SECTcallvercache>>&.
33651
33652 Recipient callouts are usually used only between hosts that are controlled by
33653 the same administration. For example, a corporate gateway host could use
33654 callouts to check for valid recipients on an internal mailserver. A successful
33655 callout does not guarantee that a real delivery to the address would succeed;
33656 on the other hand, a failing callout does guarantee that a delivery would fail.
33657
33658 If the &%callout%& option is present on a condition that verifies an address, a
33659 second stage of verification occurs if the address is successfully routed to
33660 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33661 &(manualroute)& router, where the router specifies the hosts. However, if a
33662 router that does not set up hosts routes to an &(smtp)& transport with a
33663 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33664 &%hosts_override%& set, its hosts are always used, whether or not the router
33665 supplies a host list.
33666 Callouts are only supported on &(smtp)& transports.
33667
33668 The port that is used is taken from the transport, if it is specified and is a
33669 remote transport. (For routers that do verification only, no transport need be
33670 specified.) Otherwise, the default SMTP port is used. If a remote transport
33671 specifies an outgoing interface, this is used; otherwise the interface is not
33672 specified. Likewise, the text that is used for the HELO command is taken from
33673 the transport's &%helo_data%& option; if there is no transport, the value of
33674 &$smtp_active_hostname$& is used.
33675
33676 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33677 test whether a bounce message could be delivered to the sender address. The
33678 following SMTP commands are sent:
33679 .display
33680 &`HELO `&<&'local host name'&>
33681 &`MAIL FROM:<>`&
33682 &`RCPT TO:`&<&'the address to be tested'&>
33683 &`QUIT`&
33684 .endd
33685 LHLO is used instead of HELO if the transport's &%protocol%& option is
33686 set to &"lmtp"&.
33687
33688 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33689 settings.
33690
33691 A recipient callout check is similar. By default, it also uses an empty address
33692 for the sender. This default is chosen because most hosts do not make use of
33693 the sender address when verifying a recipient. Using the same address means
33694 that a single cache entry can be used for each recipient. Some sites, however,
33695 do make use of the sender address when verifying. These are catered for by the
33696 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33697
33698 If the response to the RCPT command is a 2&'xx'& code, the verification
33699 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33700 Exim tries the next host, if any. If there is a problem with all the remote
33701 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33702 &%callout%& option is given, in which case the condition is forced to succeed.
33703
33704 .cindex "SMTP" "output flushing, disabling for callout"
33705 A callout may take a little time. For this reason, Exim normally flushes SMTP
33706 output before performing a callout in an ACL, to avoid unexpected timeouts in
33707 clients when the SMTP PIPELINING extension is in use. The flushing can be
33708 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33709
33710 .cindex "tainted data" "de-tainting"
33711 .cindex "de-tainting" "using recipient verify"
33712 A recipient callout which gets a 2&'xx'& code
33713 will assign untainted values to the
33714 &$domain_data$& and &$local_part_data$& variables,
33715 corresponding to the domain and local parts of the recipient address.
33716
33717
33718
33719
33720 .subsection "Additional parameters for callouts" CALLaddparcall
33721 .cindex "callout" "additional parameters for"
33722 The &%callout%& option can be followed by an equals sign and a number of
33723 optional parameters, separated by commas. For example:
33724 .code
33725 verify = recipient/callout=10s,defer_ok
33726 .endd
33727 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33728 separate verify options, is retained for backwards compatibility, but is now
33729 deprecated. The additional parameters for &%callout%& are as follows:
33730
33731
33732 .vlist
33733 .vitem <&'a&~time&~interval'&>
33734 .cindex "callout" "timeout, specifying"
33735 This specifies the timeout that applies for the callout attempt to each host.
33736 For example:
33737 .code
33738 verify = sender/callout=5s
33739 .endd
33740 The default is 30 seconds. The timeout is used for each response from the
33741 remote host. It is also used for the initial connection, unless overridden by
33742 the &%connect%& parameter.
33743
33744
33745 .vitem &*connect&~=&~*&<&'time&~interval'&>
33746 .cindex "callout" "connection timeout, specifying"
33747 This parameter makes it possible to set a different (usually smaller) timeout
33748 for making the SMTP connection. For example:
33749 .code
33750 verify = sender/callout=5s,connect=1s
33751 .endd
33752 If not specified, this timeout defaults to the general timeout value.
33753
33754 .vitem &*defer_ok*&
33755 .cindex "callout" "defer, action on"
33756 When this parameter is present, failure to contact any host, or any other kind
33757 of temporary error, is treated as success by the ACL. However, the cache is not
33758 updated in this circumstance.
33759
33760 .vitem &*fullpostmaster*&
33761 .cindex "callout" "full postmaster check"
33762 This operates like the &%postmaster%& option (see below), but if the check for
33763 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33764 accordance with the specification in RFC 2821. The RFC states that the
33765 unqualified address &'postmaster'& should be accepted.
33766
33767
33768 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33769 .cindex "callout" "sender when verifying header"
33770 When verifying addresses in header lines using the &%header_sender%&
33771 verification option, Exim behaves by default as if the addresses are envelope
33772 sender addresses from a message. Callout verification therefore tests to see
33773 whether a bounce message could be delivered, by using an empty address in the
33774 MAIL command. However, it is arguable that these addresses might never be used
33775 as envelope senders, and could therefore justifiably reject bounce messages
33776 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33777 address to use in the MAIL command. For example:
33778 .code
33779 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33780 .endd
33781 This parameter is available only for the &%header_sender%& verification option.
33782
33783
33784 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33785 .cindex "callout" "overall timeout, specifying"
33786 This parameter sets an overall timeout for performing a callout verification.
33787 For example:
33788 .code
33789 verify = sender/callout=5s,maxwait=30s
33790 .endd
33791 This timeout defaults to four times the callout timeout for individual SMTP
33792 commands. The overall timeout applies when there is more than one host that can
33793 be tried. The timeout is checked before trying the next host. This prevents
33794 very long delays if there are a large number of hosts and all are timing out
33795 (for example, when network connections are timing out).
33796
33797
33798 .vitem &*no_cache*&
33799 .cindex "callout" "cache, suppressing"
33800 .cindex "caching callout, suppressing"
33801 When this parameter is given, the callout cache is neither read nor updated.
33802
33803 .vitem &*postmaster*&
33804 .cindex "callout" "postmaster; checking"
33805 When this parameter is set, a successful callout check is followed by a similar
33806 check for the local part &'postmaster'& at the same domain. If this address is
33807 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33808 the postmaster check is recorded in a cache record; if it is a failure, this is
33809 used to fail subsequent callouts for the domain without a connection being
33810 made, until the cache record expires.
33811
33812 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33813 The postmaster check uses an empty sender in the MAIL command by default.
33814 You can use this parameter to do a postmaster check using a different address.
33815 For example:
33816 .code
33817 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33818 .endd
33819 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33820 one overrides. The &%postmaster%& parameter is equivalent to this example:
33821 .code
33822 require  verify = sender/callout=postmaster_mailfrom=
33823 .endd
33824 &*Warning*&: The caching arrangements for postmaster checking do not take
33825 account of the sender address. It is assumed that either the empty address or
33826 a fixed non-empty address will be used. All that Exim remembers is that the
33827 postmaster check for the domain succeeded or failed.
33828
33829
33830 .vitem &*random*&
33831 .cindex "callout" "&""random""& check"
33832 When this parameter is set, before doing the normal callout check, Exim does a
33833 check for a &"random"& local part at the same domain. The local part is not
33834 really random &-- it is defined by the expansion of the option
33835 &%callout_random_local_part%&, which defaults to
33836 .code
33837 $primary_hostname-$tod_epoch-testing
33838 .endd
33839 The idea here is to try to determine whether the remote host accepts all local
33840 parts without checking. If it does, there is no point in doing callouts for
33841 specific local parts. If the &"random"& check succeeds, the result is saved in
33842 a cache record, and used to force the current and subsequent callout checks to
33843 succeed without a connection being made, until the cache record expires.
33844
33845 .vitem &*use_postmaster*&
33846 .cindex "callout" "sender for recipient check"
33847 This parameter applies to recipient callouts only. For example:
33848 .code
33849 deny  !verify = recipient/callout=use_postmaster
33850 .endd
33851 .vindex "&$qualify_domain$&"
33852 It causes a non-empty postmaster address to be used in the MAIL command when
33853 performing the callout for the recipient, and also for a &"random"& check if
33854 that is configured. The local part of the address is &`postmaster`& and the
33855 domain is the contents of &$qualify_domain$&.
33856
33857 .vitem &*use_sender*&
33858 This option applies to recipient callouts only. For example:
33859 .code
33860 require  verify = recipient/callout=use_sender
33861 .endd
33862 It causes the message's actual sender address to be used in the MAIL
33863 command when performing the callout, instead of an empty address. There is no
33864 need to use this option unless you know that the called hosts make use of the
33865 sender when checking recipients. If used indiscriminately, it reduces the
33866 usefulness of callout caching.
33867
33868 .vitem &*hold*&
33869 This option applies to recipient callouts only. For example:
33870 .code
33871 require  verify = recipient/callout=use_sender,hold
33872 .endd
33873 It causes the connection to be held open and used for any further recipients
33874 and for eventual delivery (should that be done quickly).
33875 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33876 when that is used for the connections.
33877 The advantage is only gained if there are no callout cache hits
33878 (which could be enforced by the no_cache option),
33879 if the use_sender option is used,
33880 if neither the random nor the use_postmaster option is used,
33881 and if no other callouts intervene.
33882 .endlist
33883
33884 If you use any of the parameters that set a non-empty sender for the MAIL
33885 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33886 &%use_sender%&), you should think about possible loops. Recipient checking is
33887 usually done between two hosts that are under the same management, and the host
33888 that receives the callouts is not normally configured to do callouts itself.
33889 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33890 these circumstances.
33891
33892 However, if you use a non-empty sender address for a callout to an arbitrary
33893 host, there is the likelihood that the remote host will itself initiate a
33894 callout check back to your host. As it is checking what appears to be a message
33895 sender, it is likely to use an empty address in MAIL, thus avoiding a
33896 callout loop. However, to be on the safe side it would be best to set up your
33897 own ACLs so that they do not do sender verification checks when the recipient
33898 is the address you use for header sender or postmaster callout checking.
33899
33900 Another issue to think about when using non-empty senders for callouts is
33901 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33902 by the sender/recipient combination; thus, for any given recipient, many more
33903 actual callouts are performed than when an empty sender or postmaster is used.
33904
33905
33906
33907
33908 .subsection "Callout caching" SECTcallvercache
33909 .cindex "hints database" "callout cache"
33910 .cindex "callout" "cache, description of"
33911 .cindex "caching" "callout"
33912 Exim caches the results of callouts in order to reduce the amount of resources
33913 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33914 option. A hints database called &"callout"& is used for the cache. Two
33915 different record types are used: one records the result of a callout check for
33916 a specific address, and the other records information that applies to the
33917 entire domain (for example, that it accepts the local part &'postmaster'&).
33918
33919 When an original callout fails, a detailed SMTP error message is given about
33920 the failure. However, for subsequent failures that use the cache data, this message
33921 is not available.
33922
33923 The expiry times for negative and positive address cache records are
33924 independent, and can be set by the global options &%callout_negative_expire%&
33925 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33926
33927 If a host gives a negative response to an SMTP connection, or rejects any
33928 commands up to and including
33929 .code
33930 MAIL FROM:<>
33931 .endd
33932 (but not including the MAIL command with a non-empty address),
33933 any callout attempt is bound to fail. Exim remembers such failures in a
33934 domain cache record, which it uses to fail callouts for the domain without
33935 making new connections, until the domain record times out. There are two
33936 separate expiry times for domain cache records:
33937 &%callout_domain_negative_expire%& (default 3h) and
33938 &%callout_domain_positive_expire%& (default 7d).
33939
33940 Domain records expire when the negative expiry time is reached if callouts
33941 cannot be made for the domain, or if the postmaster check failed.
33942 Otherwise, they expire when the positive expiry time is reached. This
33943 ensures that, for example, a host that stops accepting &"random"& local parts
33944 will eventually be noticed.
33945
33946 The callout caching mechanism is based on the domain of the address that is
33947 being tested. If the domain routes to several hosts, it is assumed that their
33948 behaviour will be the same.
33949
33950
33951
33952 .section "Quota caching" "SECTquotacache"
33953 .cindex "hints database" "quota cache"
33954 .cindex "quota" "cache, description of"
33955 .cindex "caching" "quota"
33956 Exim caches the results of quota verification
33957 in order to reduce the amount of resources used.
33958 The &"callout"& hints database is used.
33959
33960 The default cache periods are five minutes for a positive (good) result
33961 and one hour for a negative result.
33962 To change the periods the &%quota%& option can be followed by an equals sign
33963 and a number of optional paramemters, separated by commas.
33964 For example:
33965 .code
33966 verify = recipient/quota=cachepos=1h,cacheneg=1d
33967 .endd
33968 Possible parameters are:
33969 .vlist
33970 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33971 .cindex "quota cache" "positive entry expiry, specifying"
33972 Set the lifetime for a positive cache entry.
33973 A value of zero seconds is legitimate.
33974
33975 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33976 .cindex "quota cache" "negative entry expiry, specifying"
33977 As above, for a negative entry.
33978
33979 .vitem &*no_cache*&
33980 Set both positive and negative lifetimes to zero.
33981
33982 .section "Sender address verification reporting" "SECTsenaddver"
33983 .cindex "verifying" "suppressing error details"
33984 See section &<<SECTaddressverification>>& for a general discussion of
33985 verification. When sender verification fails in an ACL, the details of the
33986 failure are given as additional output lines before the 550 response to the
33987 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33988 you might see:
33989 .code
33990 MAIL FROM:<xyz@abc.example>
33991 250 OK
33992 RCPT TO:<pqr@def.example>
33993 550-Verification failed for <xyz@abc.example>
33994 550-Called:   192.168.34.43
33995 550-Sent:     RCPT TO:<xyz@abc.example>
33996 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33997 550 Sender verification failed
33998 .endd
33999 If more than one RCPT command fails in the same way, the details are given
34000 only for the first of them. However, some administrators do not want to send
34001 out this much information. You can suppress the details by adding
34002 &`/no_details`& to the ACL statement that requests sender verification. For
34003 example:
34004 .code
34005 verify = sender/no_details
34006 .endd
34007
34008 .section "Redirection while verifying" "SECTredirwhilveri"
34009 .cindex "verifying" "redirection while"
34010 .cindex "address redirection" "while verifying"
34011 A dilemma arises when a local address is redirected by aliasing or forwarding
34012 during verification: should the generated addresses themselves be verified,
34013 or should the successful expansion of the original address be enough to verify
34014 it? By default, Exim takes the following pragmatic approach:
34015
34016 .ilist
34017 When an incoming address is redirected to just one child address, verification
34018 continues with the child address, and if that fails to verify, the original
34019 verification also fails.
34020 .next
34021 When an incoming address is redirected to more than one child address,
34022 verification does not continue. A success result is returned.
34023 .endlist
34024
34025 This seems the most reasonable behaviour for the common use of aliasing as a
34026 way of redirecting different local parts to the same mailbox. It means, for
34027 example, that a pair of alias entries of the form
34028 .code
34029 A.Wol:   aw123
34030 aw123:   :fail: Gone away, no forwarding address
34031 .endd
34032 work as expected, with both local parts causing verification failure. When a
34033 redirection generates more than one address, the behaviour is more like a
34034 mailing list, where the existence of the alias itself is sufficient for
34035 verification to succeed.
34036
34037 It is possible, however, to change the default behaviour so that all successful
34038 redirections count as successful verifications, however many new addresses are
34039 generated. This is specified by the &%success_on_redirect%& verification
34040 option. For example:
34041 .code
34042 require verify = recipient/success_on_redirect/callout=10s
34043 .endd
34044 In this example, verification succeeds if a router generates a new address, and
34045 the callout does not occur, because no address was routed to a remote host.
34046
34047 When verification is being tested via the &%-bv%& option, the treatment of
34048 redirections is as just described, unless the &%-v%& or any debugging option is
34049 also specified. In that case, full verification is done for every generated
34050 address and a report is output for each of them.
34051
34052
34053
34054 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34055 .cindex "CSA" "verifying"
34056 Client SMTP Authorization is a system that allows a site to advertise
34057 which machines are and are not permitted to send email. This is done by placing
34058 special SRV records in the DNS; these are looked up using the client's HELO
34059 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34060 Authorization checks in Exim are performed by the ACL condition:
34061 .code
34062 verify = csa
34063 .endd
34064 This fails if the client is not authorized. If there is a DNS problem, or if no
34065 valid CSA SRV record is found, or if the client is authorized, the condition
34066 succeeds. These three cases can be distinguished using the expansion variable
34067 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34068 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34069 be likely to cause problems for legitimate email.
34070
34071 The error messages produced by the CSA code include slightly more
34072 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34073 looking up the CSA SRV record, or problems looking up the CSA target
34074 address record. There are four reasons for &$csa_status$& being &"fail"&:
34075
34076 .ilist
34077 The client's host name is explicitly not authorized.
34078 .next
34079 The client's IP address does not match any of the CSA target IP addresses.
34080 .next
34081 The client's host name is authorized but it has no valid target IP addresses
34082 (for example, the target's addresses are IPv6 and the client is using IPv4).
34083 .next
34084 The client's host name has no CSA SRV record but a parent domain has asserted
34085 that all subdomains must be explicitly authorized.
34086 .endlist
34087
34088 The &%csa%& verification condition can take an argument which is the domain to
34089 use for the DNS query. The default is:
34090 .code
34091 verify = csa/$sender_helo_name
34092 .endd
34093 This implementation includes an extension to CSA. If the query domain
34094 is an address literal such as [192.0.2.95], or if it is a bare IP
34095 address, Exim searches for CSA SRV records in the reverse DNS as if
34096 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34097 meaningful to say:
34098 .code
34099 verify = csa/$sender_host_address
34100 .endd
34101 In fact, this is the check that Exim performs if the client does not say HELO.
34102 This extension can be turned off by setting the main configuration option
34103 &%dns_csa_use_reverse%& to be false.
34104
34105 If a CSA SRV record is not found for the domain itself, a search
34106 is performed through its parent domains for a record which might be
34107 making assertions about subdomains. The maximum depth of this search is limited
34108 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34109 default. Exim does not look for CSA SRV records in a top level domain, so the
34110 default settings handle HELO domains as long as seven
34111 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34112 of legitimate HELO domains.
34113
34114 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34115 direct SRV lookups, this is not sufficient because of the extra parent domain
34116 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34117 addresses into lookups in the reverse DNS space. The result of a successful
34118 lookup such as:
34119 .code
34120 ${lookup dnsdb {csa=$sender_helo_name}}
34121 .endd
34122 has two space-separated fields: an authorization code and a target host name.
34123 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34124 authorization required but absent, or &"?"& for unknown.
34125
34126
34127
34128
34129 .section "Bounce address tag validation" "SECTverifyPRVS"
34130 .cindex "BATV, verifying"
34131 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34132 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34133 Genuine incoming bounce messages should therefore always be addressed to
34134 recipients that have a valid tag. This scheme is a way of detecting unwanted
34135 bounce messages caused by sender address forgeries (often called &"collateral
34136 spam"&), because the recipients of such messages do not include valid tags.
34137
34138 There are two expansion items to help with the implementation of the BATV
34139 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34140 the original envelope sender address by using a simple key to add a hash of the
34141 address and some time-based randomizing information. The &%prvs%& expansion
34142 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34143 The syntax of these expansion items is described in section
34144 &<<SECTexpansionitems>>&.
34145 The validity period on signed addresses is seven days.
34146
34147 As an example, suppose the secret per-address keys are stored in an MySQL
34148 database. A query to look up the key for an address could be defined as a macro
34149 like this:
34150 .code
34151 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34152                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34153                 }{$value}}
34154 .endd
34155 Suppose also that the senders who make use of BATV are defined by an address
34156 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34157 use this:
34158 .code
34159 # Bounces: drop unsigned addresses for BATV senders
34160 deny senders = :
34161      recipients = +batv_senders
34162      message = This address does not send an unsigned reverse path
34163
34164 # Bounces: In case of prvs-signed address, check signature.
34165 deny senders = :
34166      condition  = ${prvscheck {$local_part@$domain}\
34167                   {PRVSCHECK_SQL}{1}}
34168      !condition = $prvscheck_result
34169      message = Invalid reverse path signature.
34170 .endd
34171 The first statement rejects recipients for bounce messages that are addressed
34172 to plain BATV sender addresses, because it is known that BATV senders do not
34173 send out messages with plain sender addresses. The second statement rejects
34174 recipients that are prvs-signed, but with invalid signatures (either because
34175 the key is wrong, or the signature has timed out).
34176
34177 A non-prvs-signed address is not rejected by the second statement, because the
34178 &%prvscheck%& expansion yields an empty string if its first argument is not a
34179 prvs-signed address, thus causing the &%condition%& condition to be false. If
34180 the first argument is a syntactically valid prvs-signed address, the yield is
34181 the third string (in this case &"1"&), whether or not the cryptographic and
34182 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34183 of the checks (empty for failure, &"1"& for success).
34184
34185 There is one more issue you must consider when implementing prvs-signing:
34186 you have to ensure that the routers accept prvs-signed addresses and
34187 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34188 router to remove the signature with a configuration along these lines:
34189 .code
34190 batv_redirect:
34191   driver = redirect
34192   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34193 .endd
34194 This works because, if the third argument of &%prvscheck%& is empty, the result
34195 of the expansion of a prvs-signed address is the decoded value of the original
34196 address. This router should probably be the first of your routers that handles
34197 local addresses.
34198
34199 To create BATV-signed addresses in the first place, a transport of this form
34200 can be used:
34201 .code
34202 external_smtp_batv:
34203   driver = smtp
34204   return_path = ${prvs {$return_path} \
34205                        {${lookup mysql{SELECT \
34206                        secret FROM batv_prvs WHERE \
34207                        sender='${quote_mysql:$sender_address}'} \
34208                        {$value}fail}}}
34209 .endd
34210 If no key can be found for the existing return path, no signing takes place.
34211
34212
34213
34214 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34215 .cindex "&ACL;" "relay control"
34216 .cindex "relaying" "control by ACL"
34217 .cindex "policy control" "relay control"
34218 An MTA is said to &'relay'& a message if it receives it from some host and
34219 delivers it directly to another host as a result of a remote address contained
34220 within it. Redirecting a local address via an alias or forward file and then
34221 passing the message on to another host is not relaying,
34222 .cindex "&""percent hack""&"
34223 but a redirection as a result of the &"percent hack"& is.
34224
34225 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34226 A host which is acting as a gateway or an MX backup is concerned with incoming
34227 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34228 a host which is acting as a smart host for a number of clients is concerned
34229 with outgoing relaying from those clients to the Internet at large. Often the
34230 same host is fulfilling both functions,
34231 . ///
34232 . as illustrated in the diagram below,
34233 . ///
34234 but in principle these two kinds of relaying are entirely independent. What is
34235 not wanted is the transmission of mail from arbitrary remote hosts through your
34236 system to arbitrary domains.
34237
34238
34239 You can implement relay control by means of suitable statements in the ACL that
34240 runs for each RCPT command. For convenience, it is often easiest to use
34241 Exim's named list facility to define the domains and hosts involved. For
34242 example, suppose you want to do the following:
34243
34244 .ilist
34245 Deliver a number of domains to mailboxes on the local host (or process them
34246 locally in some other way). Let's say these are &'my.dom1.example'& and
34247 &'my.dom2.example'&.
34248 .next
34249 Relay mail for a number of other domains for which you are the secondary MX.
34250 These might be &'friend1.example'& and &'friend2.example'&.
34251 .next
34252 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34253 Suppose your LAN is 192.168.45.0/24.
34254 .endlist
34255
34256
34257 In the main part of the configuration, you put the following definitions:
34258 .code
34259 domainlist local_domains    = my.dom1.example : my.dom2.example
34260 domainlist relay_to_domains = friend1.example : friend2.example
34261 hostlist   relay_from_hosts = 192.168.45.0/24
34262 .endd
34263 Now you can use these definitions in the ACL that is run for every RCPT
34264 command:
34265 .code
34266 acl_check_rcpt:
34267   accept domains = +local_domains : +relay_to_domains
34268   accept hosts   = +relay_from_hosts
34269 .endd
34270 The first statement accepts any RCPT command that contains an address in
34271 the local or relay domains. For any other domain, control passes to the second
34272 statement, which accepts the command only if it comes from one of the relay
34273 hosts. In practice, you will probably want to make your ACL more sophisticated
34274 than this, for example, by including sender and recipient verification. The
34275 default configuration includes a more comprehensive example, which is described
34276 in chapter &<<CHAPdefconfil>>&.
34277
34278
34279
34280 .section "Checking a relay configuration" "SECTcheralcon"
34281 .cindex "relaying" "checking control of"
34282 You can check the relay characteristics of your configuration in the same way
34283 that you can test any ACL behaviour for an incoming SMTP connection, by using
34284 the &%-bh%& option to run a fake SMTP session with which you interact.
34285 .ecindex IIDacl
34286
34287
34288
34289 . ////////////////////////////////////////////////////////////////////////////
34290 . ////////////////////////////////////////////////////////////////////////////
34291
34292 .chapter "Content scanning at ACL time" "CHAPexiscan"
34293 .scindex IIDcosca "content scanning" "at ACL time"
34294 The extension of Exim to include content scanning at ACL time, formerly known
34295 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34296 was integrated into the main source for Exim release 4.50, and Tom continues to
34297 maintain it. Most of the wording of this chapter is taken from Tom's
34298 specification.
34299
34300 It is also possible to scan the content of messages at other times. The
34301 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34302 scanning after all the ACLs have run. A transport filter can be used to scan
34303 messages at delivery time (see the &%transport_filter%& option, described in
34304 chapter &<<CHAPtransportgeneric>>&).
34305
34306 If you want to include the ACL-time content-scanning features when you compile
34307 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34308 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34309
34310 .ilist
34311 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34312 for all MIME parts for SMTP and non-SMTP messages, respectively.
34313 .next
34314 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34315 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34316 run at the end of message reception (the &%acl_smtp_data%& ACL).
34317 .next
34318 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34319 of messages, or parts of messages, for debugging purposes.
34320 .next
34321 Additional expansion variables that are set in the new ACL and by the new
34322 conditions.
34323 .next
34324 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34325 .endlist
34326
34327 Content-scanning is continually evolving, and new features are still being
34328 added. While such features are still unstable and liable to incompatible
34329 changes, they are made available in Exim by setting options whose names begin
34330 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34331 this manual. You can find out about them by reading the file called
34332 &_doc/experimental.txt_&.
34333
34334 All the content-scanning facilities work on a MBOX copy of the message that is
34335 temporarily created in a file called:
34336 .display
34337 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34338 .endd
34339 The &_.eml_& extension is a friendly hint to virus scanners that they can
34340 expect an MBOX-like structure inside that file. The file is created when the
34341 first content scanning facility is called. Subsequent calls to content
34342 scanning conditions open the same file again. The directory is recursively
34343 removed when the &%acl_smtp_data%& ACL has finished running, unless
34344 .code
34345 control = no_mbox_unspool
34346 .endd
34347 has been encountered. When the MIME ACL decodes files, they are put into the
34348 same directory by default.
34349
34350
34351
34352 .section "Scanning for viruses" "SECTscanvirus"
34353 .cindex "virus scanning"
34354 .cindex "content scanning" "for viruses"
34355 .cindex "content scanning" "the &%malware%& condition"
34356 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34357 It supports a &"generic"& interface to scanners called via the shell, and
34358 specialized interfaces for &"daemon"& type virus scanners, which are resident
34359 in memory and thus are much faster.
34360
34361 Since message data needs to have arrived,
34362 the condition may be only called in ACL defined by
34363 &%acl_smtp_data%&,
34364 &%acl_smtp_data_prdr%&,
34365 &%acl_smtp_mime%& or
34366 &%acl_smtp_dkim%&
34367
34368 A timeout of 2 minutes is applied to a scanner call (by default);
34369 if it expires then a defer action is taken.
34370
34371 .oindex "&%av_scanner%&"
34372 You can set the &%av_scanner%& option in the main part of the configuration
34373 to specify which scanner to use, together with any additional options that
34374 are needed. The basic syntax is as follows:
34375 .display
34376 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34377 .endd
34378 If you do not set &%av_scanner%&, it defaults to
34379 .code
34380 av_scanner = sophie:/var/run/sophie
34381 .endd
34382 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34383 before use.
34384 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34385 The following scanner types are supported in this release,
34386 though individual ones can be included or not at build time:
34387
34388 .vlist
34389 .vitem &%avast%&
34390 .cindex "virus scanners" "avast"
34391 This is the scanner daemon of Avast. It has been tested with Avast Core
34392 Security (currently at version 2.2.0).
34393 You can get a trial version at &url(https://www.avast.com) or for Linux
34394 at &url(https://www.avast.com/linux-server-antivirus).
34395 This scanner type takes one option,
34396 which can be either a full path to a UNIX socket,
34397 or host and port specifiers separated by white space.
34398 The host may be a name or an IP address; the port is either a
34399 single number or a pair of numbers with a dash between.
34400 A list of options may follow. These options are interpreted on the
34401 Exim's side of the malware scanner, or are given on separate lines to
34402 the daemon as options before the main scan command.
34403
34404 .cindex &`pass_unscanned`& "avast"
34405 If &`pass_unscanned`&
34406 is set, any files the Avast scanner can't scan (e.g.
34407 decompression bombs, or invalid archives) are considered clean. Use with
34408 care.
34409
34410 For example:
34411 .code
34412 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34413 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34414 av_scanner = avast:192.168.2.22 5036
34415 .endd
34416 If you omit the argument, the default path
34417 &_/var/run/avast/scan.sock_&
34418 is used.
34419 If you use a remote host,
34420 you need to make Exim's spool directory available to it,
34421 as the scanner is passed a file path, not file contents.
34422 For information about available commands and their options you may use
34423 .code
34424 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34425     FLAGS
34426     SENSITIVITY
34427     PACK
34428 .endd
34429
34430 If the scanner returns a temporary failure (e.g. license issues, or
34431 permission problems), the message is deferred and a paniclog entry is
34432 written.  The usual &`defer_ok`& option is available.
34433
34434 .vitem &%aveserver%&
34435 .cindex "virus scanners" "Kaspersky"
34436 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34437 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34438 which is the path to the daemon's UNIX socket. The default is shown in this
34439 example:
34440 .code
34441 av_scanner = aveserver:/var/run/aveserver
34442 .endd
34443
34444
34445 .vitem &%clamd%&
34446 .cindex "virus scanners" "clamd"
34447 This daemon-type scanner is GPL and free. You can get it at
34448 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34449 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34450 in the MIME ACL. This is no longer believed to be necessary.
34451
34452 The options are a list of server specifiers, which may be
34453 a UNIX socket specification,
34454 a TCP socket specification,
34455 or a (global) option.
34456
34457 A socket specification consists of a space-separated list.
34458 For a Unix socket the first element is a full path for the socket,
34459 for a TCP socket the first element is the IP address
34460 and the second a port number,
34461 Any further elements are per-server (non-global) options.
34462 These per-server options are supported:
34463 .code
34464 retry=<timespec>        Retry on connect fail
34465 .endd
34466
34467 The &`retry`& option specifies a time after which a single retry for
34468 a failed connect is made.  The default is to not retry.
34469
34470 If a Unix socket file is specified, only one server is supported.
34471
34472 Examples:
34473 .code
34474 av_scanner = clamd:/opt/clamd/socket
34475 av_scanner = clamd:192.0.2.3 1234
34476 av_scanner = clamd:192.0.2.3 1234:local
34477 av_scanner = clamd:192.0.2.3 1234 retry=10s
34478 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34479 .endd
34480 If the value of av_scanner points to a UNIX socket file or contains the
34481 &`local`&
34482 option, then the ClamAV interface will pass a filename containing the data
34483 to be scanned, which should normally result in less I/O happening and be
34484 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34485 Exim does not assume that there is a common filesystem with the remote host.
34486
34487 The final example shows that multiple TCP targets can be specified.  Exim will
34488 randomly use one for each incoming email (i.e. it load balances them).  Note
34489 that only TCP targets may be used if specifying a list of scanners; a UNIX
34490 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34491 unavailable, Exim will try the remaining one(s) until it finds one that works.
34492 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34493 not keep track of scanner state between multiple messages, and the scanner
34494 selection is random, so the message will get logged in the mainlog for each
34495 email that the down scanner gets chosen first (message wrapped to be readable):
34496 .code
34497 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34498    clamd: connection to localhost, port 3310 failed
34499    (Connection refused)
34500 .endd
34501
34502 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34503 contributing the code for this scanner.
34504
34505 .vitem &%cmdline%&
34506 .cindex "virus scanners" "command line interface"
34507 This is the keyword for the generic command line scanner interface. It can be
34508 used to attach virus scanners that are invoked from the shell. This scanner
34509 type takes 3 mandatory options:
34510
34511 .olist
34512 The full path and name of the scanner binary, with all command line options,
34513 and a placeholder (&`%s`&) for the directory to scan.
34514
34515 .next
34516 A regular expression to match against the STDOUT and STDERR output of the
34517 virus scanner. If the expression matches, a virus was found. You must make
34518 absolutely sure that this expression matches on &"virus found"&. This is called
34519 the &"trigger"& expression.
34520
34521 .next
34522 Another regular expression, containing exactly one pair of parentheses, to
34523 match the name of the virus found in the scanners output. This is called the
34524 &"name"& expression.
34525 .endlist olist
34526
34527 For example, Sophos Sweep reports a virus on a line like this:
34528 .code
34529 Virus 'W32/Magistr-B' found in file ./those.bat
34530 .endd
34531 For the trigger expression, we can match the phrase &"found in file"&. For the
34532 name expression, we want to extract the W32/Magistr-B string, so we can match
34533 for the single quotes left and right of it. Altogether, this makes the
34534 configuration setting:
34535 .code
34536 av_scanner = cmdline:\
34537              /path/to/sweep -ss -all -rec -archive %s:\
34538              found in file:'(.+)'
34539 .endd
34540 .vitem &%drweb%&
34541 .cindex "virus scanners" "DrWeb"
34542 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34543 takes one option,
34544 either a full path to a UNIX socket,
34545 or host and port specifiers separated by white space.
34546 The host may be a name or an IP address; the port is either a
34547 single number or a pair of numbers with a dash between.
34548 For example:
34549 .code
34550 av_scanner = drweb:/var/run/drwebd.sock
34551 av_scanner = drweb:192.168.2.20 31337
34552 .endd
34553 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34554 is used. Thanks to Alex Miller for contributing the code for this scanner.
34555
34556 .vitem &%f-protd%&
34557 .cindex "virus scanners" "f-protd"
34558 The f-protd scanner is accessed via HTTP over TCP.
34559 One argument is taken, being a space-separated hostname and port number
34560 (or port-range).
34561 For example:
34562 .code
34563 av_scanner = f-protd:localhost 10200-10204
34564 .endd
34565 If you omit the argument, the default values shown above are used.
34566
34567 .vitem &%f-prot6d%&
34568 .cindex "virus scanners" "f-prot6d"
34569 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34570 One argument is taken, being a space-separated hostname and port number.
34571 For example:
34572 .code
34573 av_scanner = f-prot6d:localhost 10200
34574 .endd
34575 If you omit the argument, the default values show above are used.
34576
34577 .vitem &%fsecure%&
34578 .cindex "virus scanners" "F-Secure"
34579 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34580 argument which is the path to a UNIX socket. For example:
34581 .code
34582 av_scanner = fsecure:/path/to/.fsav
34583 .endd
34584 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34585 Thelmen for contributing the code for this scanner.
34586
34587 .vitem &%kavdaemon%&
34588 .cindex "virus scanners" "Kaspersky"
34589 This is the scanner daemon of Kaspersky Version 4. This version of the
34590 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34591 scanner type takes one option, which is the path to the daemon's UNIX socket.
34592 For example:
34593 .code
34594 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34595 .endd
34596 The default path is &_/var/run/AvpCtl_&.
34597
34598 .vitem &%mksd%&
34599 .cindex "virus scanners" "mksd"
34600 This was a daemon type scanner that is aimed mainly at Polish users,
34601 though some documentation was available in English.
34602 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34603 and this appears to be a candidate for removal from Exim, unless
34604 we are informed of other virus scanners which use the same protocol
34605 to integrate.
34606 The only option for this scanner type is
34607 the maximum number of processes used simultaneously to scan the attachments,
34608 provided that mksd has
34609 been run with at least the same number of child processes. For example:
34610 .code
34611 av_scanner = mksd:2
34612 .endd
34613 You can safely omit this option (the default value is 1).
34614
34615 .vitem &%sock%&
34616 .cindex "virus scanners" "simple socket-connected"
34617 This is a general-purpose way of talking to simple scanner daemons
34618 running on the local machine.
34619 There are four options:
34620 an address (which may be an IP address and port, or the path of a Unix socket),
34621 a commandline to send (may include a single %s which will be replaced with
34622 the path to the mail file to be scanned),
34623 an RE to trigger on from the returned data,
34624 and an RE to extract malware_name from the returned data.
34625 For example:
34626 .code
34627 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34628 .endd
34629 Note that surrounding whitespace is stripped from each option, meaning
34630 there is no way to specify a trailing newline.
34631 The socket specifier and both regular-expressions are required.
34632 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34633 specify an empty element to get this.
34634
34635 .vitem &%sophie%&
34636 .cindex "virus scanners" "Sophos and Sophie"
34637 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34638 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34639 for this scanner type is the path to the UNIX socket that Sophie uses for
34640 client communication. For example:
34641 .code
34642 av_scanner = sophie:/tmp/sophie
34643 .endd
34644 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34645 the option.
34646 .endlist
34647
34648 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34649 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34650 ACL.
34651
34652 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34653 makes it possible to use different scanners. See further below for an example.
34654 The &%malware%& condition caches its results, so when you use it multiple times
34655 for the same message, the actual scanning process is only carried out once.
34656 However, using expandable items in &%av_scanner%& disables this caching, in
34657 which case each use of the &%malware%& condition causes a new scan of the
34658 message.
34659
34660 The &%malware%& condition takes a right-hand argument that is expanded before
34661 use and taken as a list, slash-separated by default.
34662 The first element can then be one of
34663
34664 .ilist
34665 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34666 The condition succeeds if a virus was found, and fail otherwise. This is the
34667 recommended usage.
34668 .next
34669 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34670 the condition fails immediately.
34671 .next
34672 A regular expression, in which case the message is scanned for viruses. The
34673 condition succeeds if a virus is found and its name matches the regular
34674 expression. This allows you to take special actions on certain types of virus.
34675 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34676 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34677 .endlist
34678
34679 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34680 messages even if there is a problem with the virus scanner.
34681 Otherwise, such a problem causes the ACL to defer.
34682
34683 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34684 specify a non-default timeout.  The default is two minutes.
34685 For example:
34686 .code
34687 malware = * / defer_ok / tmo=10s
34688 .endd
34689 A timeout causes the ACL to defer.
34690
34691 .vindex "&$callout_address$&"
34692 When a connection is made to the scanner the expansion variable &$callout_address$&
34693 is set to record the actual address used.
34694
34695 .vindex "&$malware_name$&"
34696 When a virus is found, the condition sets up an expansion variable called
34697 &$malware_name$& that contains the name of the virus. You can use it in a
34698 &%message%& modifier that specifies the error returned to the sender, and/or in
34699 logging data.
34700
34701 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34702 imposed by your anti-virus scanner.
34703
34704 Here is a very simple scanning example:
34705 .code
34706 deny malware = *
34707      message = This message contains malware ($malware_name)
34708 .endd
34709 The next example accepts messages when there is a problem with the scanner:
34710 .code
34711 deny malware = */defer_ok
34712      message = This message contains malware ($malware_name)
34713 .endd
34714 The next example shows how to use an ACL variable to scan with both sophie and
34715 aveserver. It assumes you have set:
34716 .code
34717 av_scanner = $acl_m0
34718 .endd
34719 in the main Exim configuration.
34720 .code
34721 deny set acl_m0 = sophie
34722      malware = *
34723      message = This message contains malware ($malware_name)
34724
34725 deny set acl_m0 = aveserver
34726      malware = *
34727      message = This message contains malware ($malware_name)
34728 .endd
34729
34730
34731 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34732 .cindex "content scanning" "for spam"
34733 .cindex "spam scanning"
34734 .cindex "SpamAssassin"
34735 .cindex "Rspamd"
34736 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34737 score and a report for the message.
34738 Support is also provided for Rspamd.
34739
34740 For more information about installation and configuration of SpamAssassin or
34741 Rspamd refer to their respective websites at
34742 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34743
34744 SpamAssassin can be installed with CPAN by running:
34745 .code
34746 perl -MCPAN -e 'install Mail::SpamAssassin'
34747 .endd
34748 SpamAssassin has its own set of configuration files. Please review its
34749 documentation to see how you can tweak it. The default installation should work
34750 nicely, however.
34751
34752 .oindex "&%spamd_address%&"
34753 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34754 intend to use an instance running on the local host you do not need to set
34755 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34756 you must set the &%spamd_address%& option in the global part of the Exim
34757 configuration as follows (example):
34758 .code
34759 spamd_address = 192.168.99.45 783
34760 .endd
34761 The SpamAssassin protocol relies on a TCP half-close from the client.
34762 If your SpamAssassin client side is running a Linux system with an
34763 iptables firewall, consider setting
34764 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34765 timeout, Exim uses when waiting for a response from the SpamAssassin
34766 server (currently defaulting to 120s).  With a lower value the Linux
34767 connection tracking may consider your half-closed connection as dead too
34768 soon.
34769
34770
34771 To use Rspamd (which by default listens on all local addresses
34772 on TCP port 11333)
34773 you should add &%variant=rspamd%& after the address/port pair, for example:
34774 .code
34775 spamd_address = 127.0.0.1 11333 variant=rspamd
34776 .endd
34777
34778 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34779 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34780 filename instead of an address/port pair:
34781 .code
34782 spamd_address = /var/run/spamd_socket
34783 .endd
34784 You can have multiple &%spamd%& servers to improve scalability. These can
34785 reside on other hardware reachable over the network. To specify multiple
34786 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34787 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34788 .code
34789 spamd_address = 192.168.2.10 783 : \
34790                 192.168.2.11 783 : \
34791                 192.168.2.12 783
34792 .endd
34793 Up to 32 &%spamd%& servers are supported.
34794 When a server fails to respond to the connection attempt, all other
34795 servers are tried until one succeeds. If no server responds, the &%spam%&
34796 condition defers.
34797
34798 Unix and TCP socket specifications may be mixed in any order.
34799 Each element of the list is a list itself, space-separated by default
34800 and changeable in the usual way (&<<SECTlistsepchange>>&);
34801 take care to not double the separator.
34802
34803 For TCP socket specifications a host name or IP (v4 or v6, but
34804 subject to list-separator quoting rules) address can be used,
34805 and the port can be one or a dash-separated pair.
34806 In the latter case, the range is tried in strict order.
34807
34808 Elements after the first for Unix sockets, or second for TCP socket,
34809 are options.
34810 The supported options are:
34811 .code
34812 pri=<priority>      Selection priority
34813 weight=<value>      Selection bias
34814 time=<start>-<end>  Use only between these times of day
34815 retry=<timespec>    Retry on connect fail
34816 tmo=<timespec>      Connection time limit
34817 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34818 .endd
34819
34820 The &`pri`& option specifies a priority for the server within the list,
34821 higher values being tried first.
34822 The default priority is 1.
34823
34824 The &`weight`& option specifies a selection bias.
34825 Within a priority set
34826 servers are queried in a random fashion, weighted by this value.
34827 The default value for selection bias is 1.
34828
34829 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34830 in the local time zone; each element being one or more digits.
34831 Either the seconds or both minutes and seconds, plus the leading &`.`&
34832 characters, may be omitted and will be taken as zero.
34833
34834 Timeout specifications for the &`retry`& and &`tmo`& options
34835 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34836
34837 The &`tmo`& option specifies an overall timeout for communication.
34838 The default value is two minutes.
34839
34840 The &`retry`& option specifies a time after which a single retry for
34841 a failed connect is made.
34842 The default is to not retry.
34843
34844 The &%spamd_address%& variable is expanded before use if it starts with
34845 a dollar sign. In this case, the expansion may return a string that is
34846 used as the list so that multiple spamd servers can be the result of an
34847 expansion.
34848
34849 .vindex "&$callout_address$&"
34850 When a connection is made to the server the expansion variable &$callout_address$&
34851 is set to record the actual address used.
34852
34853 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34854 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34855 .code
34856 deny spam = joe
34857      message = This message was classified as SPAM
34858 .endd
34859 The right-hand side of the &%spam%& condition specifies a name. This is
34860 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34861 to scan using a specific profile, but rather use the SpamAssassin system-wide
34862 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34863 Rspamd does not use this setting. However, you must put something on the
34864 right-hand side.
34865
34866 The name allows you to use per-domain or per-user antispam profiles in
34867 principle, but this is not straightforward in practice, because a message may
34868 have multiple recipients, not necessarily all in the same domain. Because the
34869 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34870 read the contents of the message, the variables &$local_part$& and &$domain$&
34871 are not set.
34872 Careful enforcement of single-recipient messages
34873 (e.g. by responding with defer in the recipient ACL for all recipients
34874 after the first),
34875 or the use of PRDR,
34876 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34877 are needed to use this feature.
34878
34879 The right-hand side of the &%spam%& condition is expanded before being used, so
34880 you can put lookups or conditions there. When the right-hand side evaluates to
34881 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34882
34883
34884 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34885 large ones may cause significant performance degradation. As most spam messages
34886 are quite small, it is recommended that you do not scan the big ones. For
34887 example:
34888 .code
34889 deny condition = ${if < {$message_size}{10K}}
34890      spam = nobody
34891      message = This message was classified as SPAM
34892 .endd
34893
34894 The &%spam%& condition returns true if the threshold specified in the user's
34895 SpamAssassin profile has been matched or exceeded. If you want to use the
34896 &%spam%& condition for its side effects (see the variables below), you can make
34897 it always return &"true"& by appending &`:true`& to the username.
34898
34899 .cindex "spam scanning" "returned variables"
34900 When the &%spam%& condition is run, it sets up a number of expansion
34901 variables.
34902 Except for &$spam_report$&,
34903 these variables are saved with the received message so are
34904 available for use at delivery time.
34905
34906 .vlist
34907 .vitem &$spam_score$&
34908 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34909 for inclusion in log or reject messages.
34910
34911 .vitem &$spam_score_int$&
34912 The spam score of the message, multiplied by ten, as an integer value. For
34913 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34914 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34915 The integer value is useful for numeric comparisons in conditions.
34916
34917 .vitem &$spam_bar$&
34918 A string consisting of a number of &"+"& or &"-"& characters, representing the
34919 integer part of the spam score value. A spam score of 4.4 would have a
34920 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34921 headers, since MUAs can match on such strings. The maximum length of the
34922 spam bar is 50 characters.
34923
34924 .vitem &$spam_report$&
34925 A multiline text table, containing the full SpamAssassin report for the
34926 message. Useful for inclusion in headers or reject messages.
34927 This variable is only usable in a DATA-time ACL.
34928 Beware that SpamAssassin may return non-ASCII characters, especially
34929 when running in country-specific locales, which are not legal
34930 unencoded in headers.
34931
34932 .vitem &$spam_action$&
34933 For SpamAssassin either 'reject' or 'no action' depending on the
34934 spam score versus threshold.
34935 For Rspamd, the recommended action.
34936
34937 .endlist
34938
34939 The &%spam%& condition caches its results unless expansion in
34940 spamd_address was used. If you call it again with the same user name, it
34941 does not scan again, but rather returns the same values as before.
34942
34943 The &%spam%& condition returns DEFER if there is any error while running
34944 the message through SpamAssassin or if the expansion of spamd_address
34945 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34946 statement block), append &`/defer_ok`& to the right-hand side of the
34947 spam condition, like this:
34948 .code
34949 deny spam    = joe/defer_ok
34950      message = This message was classified as SPAM
34951 .endd
34952 This causes messages to be accepted even if there is a problem with &%spamd%&.
34953
34954 Here is a longer, commented example of the use of the &%spam%&
34955 condition:
34956 .code
34957 # put headers in all messages (no matter if spam or not)
34958 warn  spam = nobody:true
34959       add_header = X-Spam-Score: $spam_score ($spam_bar)
34960       add_header = X-Spam-Report: $spam_report
34961
34962 # add second subject line with *SPAM* marker when message
34963 # is over threshold
34964 warn  spam = nobody
34965       add_header = Subject: *SPAM* $h_Subject:
34966
34967 # reject spam at high scores (> 12)
34968 deny  spam = nobody:true
34969       condition = ${if >{$spam_score_int}{120}{1}{0}}
34970       message = This message scored $spam_score spam points.
34971 .endd
34972
34973
34974
34975 .section "Scanning MIME parts" "SECTscanmimepart"
34976 .cindex "content scanning" "MIME parts"
34977 .cindex "MIME content scanning"
34978 .oindex "&%acl_smtp_mime%&"
34979 .oindex "&%acl_not_smtp_mime%&"
34980 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34981 each MIME part of an SMTP message, including multipart types, in the sequence
34982 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34983 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34984 options may both refer to the same ACL if you want the same processing in both
34985 cases.
34986
34987 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34988 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34989 the case of a non-SMTP message. However, a MIME ACL is called only if the
34990 message contains a &'Content-Type:'& header line. When a call to a MIME
34991 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34992 result code is sent to the client. In the case of an SMTP message, the
34993 &%acl_smtp_data%& ACL is not called when this happens.
34994
34995 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34996 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34997 condition to match against the raw MIME part. You can also use the
34998 &%mime_regex%& condition to match against the decoded MIME part (see section
34999 &<<SECTscanregex>>&).
35000
35001 At the start of a MIME ACL, a number of variables are set from the header
35002 information for the relevant MIME part. These are described below. The contents
35003 of the MIME part are not by default decoded into a disk file except for MIME
35004 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
35005 part into a disk file, you can use the &%decode%& condition. The general
35006 syntax is:
35007 .display
35008 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35009 .endd
35010 The right hand side is expanded before use. After expansion,
35011 the value can be:
35012
35013 .olist
35014 &"0"& or &"false"&, in which case no decoding is done.
35015 .next
35016 The string &"default"&. In that case, the file is put in the temporary
35017 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35018 a sequential filename consisting of the message id and a sequence number. The
35019 full path and name is available in &$mime_decoded_filename$& after decoding.
35020 .next
35021 A full path name starting with a slash. If the full name is an existing
35022 directory, it is used as a replacement for the default directory. The filename
35023 is then sequentially assigned. If the path does not exist, it is used as
35024 the full path and filename.
35025 .next
35026 If the string does not start with a slash, it is used as the
35027 filename, and the default path is then used.
35028 .endlist
35029 The &%decode%& condition normally succeeds. It is only false for syntax
35030 errors or unusual circumstances such as memory shortages. You can easily decode
35031 a file with its original, proposed filename using
35032 .code
35033 decode = $mime_filename
35034 .endd
35035 However, you should keep in mind that &$mime_filename$& might contain
35036 anything. If you place files outside of the default path, they are not
35037 automatically unlinked.
35038
35039 For RFC822 attachments (these are messages attached to messages, with a
35040 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35041 as for the primary message, only that the &$mime_is_rfc822$& expansion
35042 variable is set (see below). Attached messages are always decoded to disk
35043 before being checked, and the files are unlinked once the check is done.
35044
35045 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35046 used to match regular expressions against raw and decoded MIME parts,
35047 respectively. They are described in section &<<SECTscanregex>>&.
35048
35049 .cindex "MIME content scanning" "returned variables"
35050 The following list describes all expansion variables that are
35051 available in the MIME ACL:
35052
35053 .vlist
35054 .vitem &$mime_anomaly_level$& &&&
35055        &$mime_anomaly_text$&
35056 .vindex &$mime_anomaly_level$&
35057 .vindex &$mime_anomaly_text$&
35058 If there are problems decoding, these variables contain information on
35059 the detected issue.
35060
35061 .vitem &$mime_boundary$&
35062 .vindex &$mime_boundary$&
35063 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35064 have a boundary string, which is stored in this variable. If the current part
35065 has no boundary parameter in the &'Content-Type:'& header, this variable
35066 contains the empty string.
35067
35068 .vitem &$mime_charset$&
35069 .vindex &$mime_charset$&
35070 This variable contains the character set identifier, if one was found in the
35071 &'Content-Type:'& header. Examples for charset identifiers are:
35072 .code
35073 us-ascii
35074 gb2312 (Chinese)
35075 iso-8859-1
35076 .endd
35077 Please note that this value is not normalized, so you should do matches
35078 case-insensitively.
35079
35080 .vitem &$mime_content_description$&
35081 .vindex &$mime_content_description$&
35082 This variable contains the normalized content of the &'Content-Description:'&
35083 header. It can contain a human-readable description of the parts content. Some
35084 implementations repeat the filename for attachments here, but they are usually
35085 only used for display purposes.
35086
35087 .vitem &$mime_content_disposition$&
35088 .vindex &$mime_content_disposition$&
35089 This variable contains the normalized content of the &'Content-Disposition:'&
35090 header. You can expect strings like &"attachment"& or &"inline"& here.
35091
35092 .vitem &$mime_content_id$&
35093 .vindex &$mime_content_id$&
35094 This variable contains the normalized content of the &'Content-ID:'& header.
35095 This is a unique ID that can be used to reference a part from another part.
35096
35097 .vitem &$mime_content_size$&
35098 .vindex &$mime_content_size$&
35099 This variable is set only after the &%decode%& modifier (see above) has been
35100 successfully run. It contains the size of the decoded part in kilobytes. The
35101 size is always rounded up to full kilobytes, so only a completely empty part
35102 has a &$mime_content_size$& of zero.
35103
35104 .vitem &$mime_content_transfer_encoding$&
35105 .vindex &$mime_content_transfer_encoding$&
35106 This variable contains the normalized content of the
35107 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35108 type. Typical values are &"base64"& and &"quoted-printable"&.
35109
35110 .vitem &$mime_content_type$&
35111 .vindex &$mime_content_type$&
35112 If the MIME part has a &'Content-Type:'& header, this variable contains its
35113 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35114 are some examples of popular MIME types, as they may appear in this variable:
35115 .code
35116 text/plain
35117 text/html
35118 application/octet-stream
35119 image/jpeg
35120 audio/midi
35121 .endd
35122 If the MIME part has no &'Content-Type:'& header, this variable contains the
35123 empty string.
35124
35125 .vitem &$mime_decoded_filename$&
35126 .vindex &$mime_decoded_filename$&
35127 This variable is set only after the &%decode%& modifier (see above) has been
35128 successfully run. It contains the full path and filename of the file
35129 containing the decoded data.
35130 .endlist
35131
35132 .cindex "RFC 2047"
35133 .vlist
35134 .vitem &$mime_filename$&
35135 .vindex &$mime_filename$&
35136 This is perhaps the most important of the MIME variables. It contains a
35137 proposed filename for an attachment, if one was found in either the
35138 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35139 RFC2047
35140 or RFC2231
35141 decoded, but no additional sanity checks are done.
35142  If no filename was
35143 found, this variable contains the empty string.
35144
35145 .vitem &$mime_is_coverletter$&
35146 .vindex &$mime_is_coverletter$&
35147 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35148 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35149 content in the cover letter, while not restricting attachments at all.
35150
35151 The variable contains 1 (true) for a MIME part believed to be part of the
35152 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35153 follows:
35154
35155 .olist
35156 The outermost MIME part of a message is always a cover letter.
35157
35158 .next
35159 If a multipart/alternative or multipart/related MIME part is a cover letter,
35160 so are all MIME subparts within that multipart.
35161
35162 .next
35163 If any other multipart is a cover letter, the first subpart is a cover letter,
35164 and the rest are attachments.
35165
35166 .next
35167 All parts contained within an attachment multipart are attachments.
35168 .endlist olist
35169
35170 As an example, the following will ban &"HTML mail"& (including that sent with
35171 alternative plain text), while allowing HTML files to be attached. HTML
35172 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35173 .code
35174 deny !condition = $mime_is_rfc822
35175      condition = $mime_is_coverletter
35176      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35177      message = HTML mail is not accepted here
35178 .endd
35179
35180 .vitem &$mime_is_multipart$&
35181 .vindex &$mime_is_multipart$&
35182 This variable has the value 1 (true) when the current part has the main type
35183 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35184 Since multipart entities only serve as containers for other parts, you may not
35185 want to carry out specific actions on them.
35186
35187 .vitem &$mime_is_rfc822$&
35188 .vindex &$mime_is_rfc822$&
35189 This variable has the value 1 (true) if the current part is not a part of the
35190 checked message itself, but part of an attached message. Attached message
35191 decoding is fully recursive.
35192
35193 .vitem &$mime_part_count$&
35194 .vindex &$mime_part_count$&
35195 This variable is a counter that is raised for each processed MIME part. It
35196 starts at zero for the very first part (which is usually a multipart). The
35197 counter is per-message, so it is reset when processing RFC822 attachments (see
35198 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35199 complete, so you can use it in the DATA ACL to determine the number of MIME
35200 parts of a message. For non-MIME messages, this variable contains the value -1.
35201 .endlist
35202
35203
35204
35205 .section "Scanning with regular expressions" "SECTscanregex"
35206 .cindex "content scanning" "with regular expressions"
35207 .cindex "regular expressions" "content scanning with"
35208 You can specify your own custom regular expression matches on the full body of
35209 the message, or on individual MIME parts.
35210
35211 The &%regex%& condition takes one or more regular expressions as arguments and
35212 matches them against the full message (when called in the DATA ACL) or a raw
35213 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35214 linewise, with a maximum line length of 32K characters. That means you cannot
35215 have multiline matches with the &%regex%& condition.
35216
35217 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35218 to 32K of decoded content (the whole content at once, not linewise). If the
35219 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35220 is decoded automatically when &%mime_regex%& is executed (using default path
35221 and filename values). If the decoded data is larger than  32K, only the first
35222 32K characters are checked.
35223
35224 The regular expressions are passed as a colon-separated list. To include a
35225 literal colon, you must double it. Since the whole right-hand side string is
35226 expanded before being used, you must also escape dollar signs and backslashes
35227 with more backslashes, or use the &`\N`& facility to disable expansion.
35228 Here is a simple example that contains two regular expressions:
35229 .code
35230 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35231      message = contains blacklisted regex ($regex_match_string)
35232 .endd
35233 The conditions returns true if any one of the regular expressions matches. The
35234 &$regex_match_string$& expansion variable is then set up and contains the
35235 matching regular expression.
35236 The expansion variables &$regex1$& &$regex2$& etc
35237 are set to any substrings captured by the regular expression.
35238
35239 &*Warning*&: With large messages, these conditions can be fairly
35240 CPU-intensive.
35241
35242 .ecindex IIDcosca
35243
35244
35245
35246
35247 . ////////////////////////////////////////////////////////////////////////////
35248 . ////////////////////////////////////////////////////////////////////////////
35249
35250 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35251          "Local scan function"
35252 .scindex IIDlosca "&[local_scan()]& function" "description of"
35253 .cindex "customizing" "input scan using C function"
35254 .cindex "policy control" "by local scan function"
35255 In these days of email worms, viruses, and ever-increasing spam, some sites
35256 want to apply a lot of checking to messages before accepting them.
35257
35258 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35259 passing messages to external virus and spam scanning software. You can also do
35260 a certain amount in Exim itself through string expansions and the &%condition%&
35261 condition in the ACL that runs after the SMTP DATA command or the ACL for
35262 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35263
35264 To allow for further customization to a site's own requirements, there is the
35265 possibility of linking Exim with a private message scanning function, written
35266 in C. If you want to run code that is written in something other than C, you
35267 can of course use a little C stub to call it.
35268
35269 The local scan function is run once for every incoming message, at the point
35270 when Exim is just about to accept the message.
35271 It can therefore be used to control non-SMTP messages from local processes as
35272 well as messages arriving via SMTP.
35273
35274 Exim applies a timeout to calls of the local scan function, and there is an
35275 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35276 Zero means &"no timeout"&.
35277 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35278 before calling the local scan function, so that the most common types of crash
35279 are caught. If the timeout is exceeded or one of those signals is caught, the
35280 incoming message is rejected with a temporary error if it is an SMTP message.
35281 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35282 code. The incident is logged on the main and reject logs.
35283
35284
35285
35286 .section "Building Exim to use a local scan function" "SECID207"
35287 .cindex "&[local_scan()]& function" "building Exim to use"
35288 To make use of the local scan function feature, you must tell Exim where your
35289 function is before building Exim, by setting
35290 both HAVE_LOCAL_SCAN and
35291 LOCAL_SCAN_SOURCE in your
35292 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35293 directory, so you might set
35294 .code
35295 HAVE_LOCAL_SCAN=yes
35296 LOCAL_SCAN_SOURCE=Local/local_scan.c
35297 .endd
35298 for example. The function must be called &[local_scan()]&;
35299 the source file(s) for it should first #define LOCAL_SCAN
35300 and then #include "local_scan.h".
35301 It is called by
35302 Exim after it has received a message, when the success return code is about to
35303 be sent. This is after all the ACLs have been run. The return code from your
35304 function controls whether the message is actually accepted or not. There is a
35305 commented template function (that just accepts the message) in the file
35306 _src/local_scan.c_.
35307
35308 If you want to make use of Exim's runtime configuration file to set options
35309 for your &[local_scan()]& function, you must also set
35310 .code
35311 LOCAL_SCAN_HAS_OPTIONS=yes
35312 .endd
35313 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35314
35315
35316
35317
35318 .section "API for local_scan()" "SECTapiforloc"
35319 .cindex "&[local_scan()]& function" "API description"
35320 .cindex &%dlfunc%& "API description"
35321 You must include this line near the start of your code:
35322 .code
35323 #define LOCAL_SCAN
35324 #include "local_scan.h"
35325 .endd
35326 This header file defines a number of variables and other values, and the
35327 prototype for the function itself. Exim is coded to use unsigned char values
35328 almost exclusively, and one of the things this header defines is a shorthand
35329 for &`unsigned char`& called &`uschar`&.
35330 It also makes available the following macro definitions, to simplify casting character
35331 strings and pointers to character strings:
35332 .code
35333 #define CS   (char *)
35334 #define CCS  (const char *)
35335 #define CSS  (char **)
35336 #define US   (unsigned char *)
35337 #define CUS  (const unsigned char *)
35338 #define USS  (unsigned char **)
35339 .endd
35340 The function prototype for &[local_scan()]& is:
35341 .code
35342 extern int local_scan(int fd, uschar **return_text);
35343 .endd
35344 The arguments are as follows:
35345
35346 .ilist
35347 &%fd%& is a file descriptor for the file that contains the body of the message
35348 (the -D file). The file is open for reading and writing, but updating it is not
35349 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35350
35351 The descriptor is positioned at character 19 of the file, which is the first
35352 character of the body itself, because the first 19 characters are the message
35353 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35354 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35355 case this changes in some future version.
35356 .next
35357 &%return_text%& is an address which you can use to return a pointer to a text
35358 string at the end of the function. The value it points to on entry is NULL.
35359 .endlist
35360
35361 The function must return an &%int%& value which is one of the following macros:
35362
35363 .vlist
35364 .vitem &`LOCAL_SCAN_ACCEPT`&
35365 .vindex "&$local_scan_data$&"
35366 The message is accepted. If you pass back a string of text, it is saved with
35367 the message, and made available in the variable &$local_scan_data$&. No
35368 newlines are permitted (if there are any, they are turned into spaces) and the
35369 maximum length of text is 1000 characters.
35370
35371 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35372 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35373 queued without immediate delivery, and is frozen.
35374
35375 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35376 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35377 queued without immediate delivery.
35378
35379 .vitem &`LOCAL_SCAN_REJECT`&
35380 The message is rejected; the returned text is used as an error message which is
35381 passed back to the sender and which is also logged. Newlines are permitted &--
35382 they cause a multiline response for SMTP rejections, but are converted to
35383 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35384 used.
35385
35386 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35387 The message is temporarily rejected; the returned text is used as an error
35388 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35389 problem"& is used.
35390
35391 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35392 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35393 message is not written to the reject log. It has the effect of unsetting the
35394 &%rejected_header%& log selector for just this rejection. If
35395 &%rejected_header%& is already unset (see the discussion of the
35396 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35397 same as LOCAL_SCAN_REJECT.
35398
35399 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35400 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35401 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35402 .endlist
35403
35404 If the message is not being received by interactive SMTP, rejections are
35405 reported by writing to &%stderr%& or by sending an email, as configured by the
35406 &%-oe%& command line options.
35407
35408
35409
35410 .section "Configuration options for local_scan()" "SECTconoptloc"
35411 .cindex "&[local_scan()]& function" "configuration options"
35412 It is possible to have option settings in the main configuration file
35413 that set values in static variables in the &[local_scan()]& module. If you
35414 want to do this, you must have the line
35415 .code
35416 LOCAL_SCAN_HAS_OPTIONS=yes
35417 .endd
35418 in your &_Local/Makefile_& when you build Exim. (This line is in
35419 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35420 file, you must define static variables to hold the option values, and a table
35421 to define them.
35422
35423 The table must be a vector called &%local_scan_options%&, of type
35424 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35425 and a pointer to the variable that holds the value. The entries must appear in
35426 alphabetical order. Following &%local_scan_options%& you must also define a
35427 variable called &%local_scan_options_count%& that contains the number of
35428 entries in the table. Here is a short example, showing two kinds of option:
35429 .code
35430 static int my_integer_option = 42;
35431 static uschar *my_string_option = US"a default string";
35432
35433 optionlist local_scan_options[] = {
35434   { "my_integer", opt_int,       &my_integer_option },
35435   { "my_string",  opt_stringptr, &my_string_option }
35436 };
35437
35438 int local_scan_options_count =
35439   sizeof(local_scan_options)/sizeof(optionlist);
35440 .endd
35441 The values of the variables can now be changed from Exim's runtime
35442 configuration file by including a local scan section as in this example:
35443 .code
35444 begin local_scan
35445 my_integer = 99
35446 my_string = some string of text...
35447 .endd
35448 The available types of option data are as follows:
35449
35450 .vlist
35451 .vitem &*opt_bool*&
35452 This specifies a boolean (true/false) option. The address should point to a
35453 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35454 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35455 whether such a variable has been set at all, you can initialize it to
35456 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35457 values.)
35458
35459 .vitem &*opt_fixed*&
35460 This specifies a fixed point number, such as is used for load averages.
35461 The address should point to a variable of type &`int`&. The value is stored
35462 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35463
35464 .vitem &*opt_int*&
35465 This specifies an integer; the address should point to a variable of type
35466 &`int`&. The value may be specified in any of the integer formats accepted by
35467 Exim.
35468
35469 .vitem &*opt_mkint*&
35470 This is the same as &%opt_int%&, except that when such a value is output in a
35471 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35472 printed with the suffix K or M.
35473
35474 .vitem &*opt_octint*&
35475 This also specifies an integer, but the value is always interpreted as an
35476 octal integer, whether or not it starts with the digit zero, and it is
35477 always output in octal.
35478
35479 .vitem &*opt_stringptr*&
35480 This specifies a string value; the address must be a pointer to a
35481 variable that points to a string (for example, of type &`uschar *`&).
35482
35483 .vitem &*opt_time*&
35484 This specifies a time interval value. The address must point to a variable of
35485 type &`int`&. The value that is placed there is a number of seconds.
35486 .endlist
35487
35488 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35489 out the values of all the &[local_scan()]& options.
35490
35491
35492
35493 .section "Available Exim variables" "SECID208"
35494 .cindex "&[local_scan()]& function" "available Exim variables"
35495 The header &_local_scan.h_& gives you access to a number of C variables. These
35496 are the only ones that are guaranteed to be maintained from release to release.
35497 Note, however, that you can obtain the value of any Exim expansion variable,
35498 including &$recipients$&, by calling &'expand_string()'&. The exported
35499 C variables are as follows:
35500
35501 .vlist
35502 .vitem &*int&~body_linecount*&
35503 This variable contains the number of lines in the message's body.
35504 It is not valid if the &%spool_wireformat%& option is used.
35505
35506 .vitem &*int&~body_zerocount*&
35507 This variable contains the number of binary zero bytes in the message's body.
35508 It is not valid if the &%spool_wireformat%& option is used.
35509
35510 .vitem &*unsigned&~int&~debug_selector*&
35511 This variable is set to zero when no debugging is taking place. Otherwise, it
35512 is a bitmap of debugging selectors. Two bits are identified for use in
35513 &[local_scan()]&; they are defined as macros:
35514
35515 .ilist
35516 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35517 testing option that is not privileged &-- any caller may set it. All the
35518 other selector bits can be set only by admin users.
35519
35520 .next
35521 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35522 by the &`+local_scan`& debug selector. It is not included in the default set
35523 of debugging bits.
35524 .endlist ilist
35525
35526 Thus, to write to the debugging output only when &`+local_scan`& has been
35527 selected, you should use code like this:
35528 .code
35529 if ((debug_selector & D_local_scan) != 0)
35530   debug_printf("xxx", ...);
35531 .endd
35532 .vitem &*uschar&~*expand_string_message*&
35533 After a failing call to &'expand_string()'& (returned value NULL), the
35534 variable &%expand_string_message%& contains the error message, zero-terminated.
35535
35536 .vitem &*header_line&~*header_list*&
35537 A pointer to a chain of header lines. The &%header_line%& structure is
35538 discussed below.
35539
35540 .vitem &*header_line&~*header_last*&
35541 A pointer to the last of the header lines.
35542
35543 .vitem &*const&~uschar&~*headers_charset*&
35544 The value of the &%headers_charset%& configuration option.
35545
35546 .vitem &*BOOL&~host_checking*&
35547 This variable is TRUE during a host checking session that is initiated by the
35548 &%-bh%& command line option.
35549
35550 .vitem &*uschar&~*interface_address*&
35551 The IP address of the interface that received the message, as a string. This
35552 is NULL for locally submitted messages.
35553
35554 .vitem &*int&~interface_port*&
35555 The port on which this message was received. When testing with the &%-bh%&
35556 command line option, the value of this variable is -1 unless a port has been
35557 specified via the &%-oMi%& option.
35558
35559 .vitem &*uschar&~*message_id*&
35560 This variable contains Exim's message id for the incoming message (the value of
35561 &$message_exim_id$&) as a zero-terminated string.
35562
35563 .vitem &*uschar&~*received_protocol*&
35564 The name of the protocol by which the message was received.
35565
35566 .vitem &*int&~recipients_count*&
35567 The number of accepted recipients.
35568
35569 .vitem &*recipient_item&~*recipients_list*&
35570 .cindex "recipient" "adding in local scan"
35571 .cindex "recipient" "removing in local scan"
35572 The list of accepted recipients, held in a vector of length
35573 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35574 can add additional recipients by calling &'receive_add_recipient()'& (see
35575 below). You can delete recipients by removing them from the vector and
35576 adjusting the value in &%recipients_count%&. In particular, by setting
35577 &%recipients_count%& to zero you remove all recipients. If you then return the
35578 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35579 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35580 and then call &'receive_add_recipient()'& as often as needed.
35581
35582 .vitem &*uschar&~*sender_address*&
35583 The envelope sender address. For bounce messages this is the empty string.
35584
35585 .vitem &*uschar&~*sender_host_address*&
35586 The IP address of the sending host, as a string. This is NULL for
35587 locally-submitted messages.
35588
35589 .vitem &*uschar&~*sender_host_authenticated*&
35590 The name of the authentication mechanism that was used, or NULL if the message
35591 was not received over an authenticated SMTP connection.
35592
35593 .vitem &*uschar&~*sender_host_name*&
35594 The name of the sending host, if known.
35595
35596 .vitem &*int&~sender_host_port*&
35597 The port on the sending host.
35598
35599 .vitem &*BOOL&~smtp_input*&
35600 This variable is TRUE for all SMTP input, including BSMTP.
35601
35602 .vitem &*BOOL&~smtp_batched_input*&
35603 This variable is TRUE for BSMTP input.
35604
35605 .vitem &*int&~store_pool*&
35606 The contents of this variable control which pool of memory is used for new
35607 requests. See section &<<SECTmemhanloc>>& for details.
35608 .endlist
35609
35610
35611 .section "Structure of header lines" "SECID209"
35612 The &%header_line%& structure contains the members listed below.
35613 You can add additional header lines by calling the &'header_add()'& function
35614 (see below). You can cause header lines to be ignored (deleted) by setting
35615 their type to *.
35616
35617
35618 .vlist
35619 .vitem &*struct&~header_line&~*next*&
35620 A pointer to the next header line, or NULL for the last line.
35621
35622 .vitem &*int&~type*&
35623 A code identifying certain headers that Exim recognizes. The codes are printing
35624 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35625 Notice in particular that any header line whose type is * is not transmitted
35626 with the message. This flagging is used for header lines that have been
35627 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35628 lines.) Effectively, * means &"deleted"&.
35629
35630 .vitem &*int&~slen*&
35631 The number of characters in the header line, including the terminating and any
35632 internal newlines.
35633
35634 .vitem &*uschar&~*text*&
35635 A pointer to the text of the header. It always ends with a newline, followed by
35636 a zero byte. Internal newlines are preserved.
35637 .endlist
35638
35639
35640
35641 .section "Structure of recipient items" "SECID210"
35642 The &%recipient_item%& structure contains these members:
35643
35644 .vlist
35645 .vitem &*uschar&~*address*&
35646 This is a pointer to the recipient address as it was received.
35647
35648 .vitem &*int&~pno*&
35649 This is used in later Exim processing when top level addresses are created by
35650 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35651 and must always contain -1 at this stage.
35652
35653 .vitem &*uschar&~*errors_to*&
35654 If this value is not NULL, bounce messages caused by failing to deliver to the
35655 recipient are sent to the address it contains. In other words, it overrides the
35656 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35657 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35658 an unqualified address, Exim qualifies it using the domain from
35659 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35660 is NULL for all recipients.
35661 .endlist
35662
35663
35664
35665 .section "Available Exim functions" "SECID211"
35666 .cindex "&[local_scan()]& function" "available Exim functions"
35667 The header &_local_scan.h_& gives you access to a number of Exim functions.
35668 These are the only ones that are guaranteed to be maintained from release to
35669 release:
35670
35671 .vlist
35672 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35673        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35674
35675 This function creates a child process that runs the command specified by
35676 &%argv%&. The environment for the process is specified by &%envp%&, which can
35677 be NULL if no environment variables are to be passed. A new umask is supplied
35678 for the process in &%newumask%&.
35679
35680 Pipes to the standard input and output of the new process are set up
35681 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35682 standard error is cloned to the standard output. If there are any file
35683 descriptors &"in the way"& in the new process, they are closed. If the final
35684 argument is TRUE, the new process is made into a process group leader.
35685
35686 The function returns the pid of the new process, or -1 if things go wrong.
35687
35688 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35689 This function waits for a child process to terminate, or for a timeout (in
35690 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35691 return value is as follows:
35692
35693 .ilist
35694 >= 0
35695
35696 The process terminated by a normal exit and the value is the process
35697 ending status.
35698
35699 .next
35700 < 0 and > &--256
35701
35702 The process was terminated by a signal and the value is the negation of the
35703 signal number.
35704
35705 .next
35706 &--256
35707
35708 The process timed out.
35709 .next
35710 &--257
35711
35712 The was some other error in wait(); &%errno%& is still set.
35713 .endlist
35714
35715 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35716 This function provide you with a means of submitting a new message to
35717 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35718 want, but this packages it all up for you.) The function creates a pipe,
35719 forks a subprocess that is running
35720 .code
35721 exim -t -oem -oi -f <>
35722 .endd
35723 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35724 that is connected to the standard input. The yield of the function is the PID
35725 of the subprocess. You can then write a message to the file descriptor, with
35726 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35727
35728 When you have finished, call &'child_close()'& to wait for the process to
35729 finish and to collect its ending status. A timeout value of zero is usually
35730 fine in this circumstance. Unless you have made a mistake with the recipient
35731 addresses, you should get a return code of zero.
35732
35733
35734 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35735        *sender_authentication)*&
35736 This function is a more sophisticated version of &'child_open()'&. The command
35737 that it runs is:
35738 .display
35739 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35740 .endd
35741 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35742
35743
35744 .vitem &*void&~debug_printf(char&~*,&~...)*&
35745 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35746 output is written to the standard error stream. If no debugging is selected,
35747 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35748 conditional on the &`local_scan`& debug selector by coding like this:
35749 .code
35750 if ((debug_selector & D_local_scan) != 0)
35751   debug_printf("xxx", ...);
35752 .endd
35753
35754 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35755 This is an interface to Exim's string expansion code. The return value is the
35756 expanded string, or NULL if there was an expansion failure.
35757 The C variable &%expand_string_message%& contains an error message after an
35758 expansion failure. If expansion does not change the string, the return value is
35759 the pointer to the input string. Otherwise, the return value points to a new
35760 block of memory that was obtained by a call to &'store_get()'&. See section
35761 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35762
35763 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35764 This function allows you to an add additional header line at the end of the
35765 existing ones. The first argument is the type, and should normally be a space
35766 character. The second argument is a format string and any number of
35767 substitution arguments as for &[sprintf()]&. You may include internal newlines
35768 if you want, and you must ensure that the string ends with a newline.
35769
35770 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35771         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35772 This function adds a new header line at a specified point in the header
35773 chain. The header itself is specified as for &'header_add()'&.
35774
35775 If &%name%& is NULL, the new header is added at the end of the chain if
35776 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35777 NULL, the header lines are searched for the first non-deleted header that
35778 matches the name. If one is found, the new header is added before it if
35779 &%after%& is false. If &%after%& is true, the new header is added after the
35780 found header and any adjacent subsequent ones with the same name (even if
35781 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35782 option controls where the header is added. If it is true, addition is at the
35783 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35784 headers, or at the top if there are no &'Received:'& headers, you could use
35785 .code
35786 header_add_at_position(TRUE, US"Received", TRUE,
35787   ' ', "X-xxx: ...");
35788 .endd
35789 Normally, there is always at least one non-deleted &'Received:'& header, but
35790 there may not be if &%received_header_text%& expands to an empty string.
35791
35792
35793 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35794 This function removes header lines. If &%occurrence%& is zero or negative, all
35795 occurrences of the header are removed. If occurrence is greater than zero, that
35796 particular instance of the header is removed. If no header(s) can be found that
35797 match the specification, the function does nothing.
35798
35799
35800 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35801         int&~length,&~BOOL&~notdel)*&"
35802 This function tests whether the given header has the given name. It is not just
35803 a string comparison, because white space is permitted between the name and the
35804 colon. If the &%notdel%& argument is true, a false return is forced for all
35805 &"deleted"& headers; otherwise they are not treated specially. For example:
35806 .code
35807 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35808 .endd
35809 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35810 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35811 This function base64-encodes a string, which is passed by address and length.
35812 The text may contain bytes of any value, including zero. The result is passed
35813 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35814 zero-terminated.
35815
35816 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35817 This function decodes a base64-encoded string. Its arguments are a
35818 zero-terminated base64-encoded string and the address of a variable that is set
35819 to point to the result, which is in dynamic memory. The length of the decoded
35820 string is the yield of the function. If the input is invalid base64 data, the
35821 yield is -1. A zero byte is added to the end of the output string to make it
35822 easy to interpret as a C string (assuming it contains no zeros of its own). The
35823 added zero byte is not included in the returned count.
35824
35825 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35826 This function checks for a match in a domain list. Domains are always
35827 matched caselessly. The return value is one of the following:
35828 .itable none 0 0 2 15* left 85* left
35829 .irow &`OK`&    "match succeeded"
35830 .irow &`FAIL`&  "match failed"
35831 .irow &`DEFER`& "match deferred"
35832 .endtable
35833 DEFER is usually caused by some kind of lookup defer, such as the
35834 inability to contact a database.
35835
35836 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35837         BOOL&~caseless)*&"
35838 This function checks for a match in a local part list. The third argument
35839 controls case-sensitivity. The return values are as for
35840 &'lss_match_domain()'&.
35841
35842 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35843         BOOL&~caseless)*&"
35844 This function checks for a match in an address list. The third argument
35845 controls the case-sensitivity of the local part match. The domain is always
35846 matched caselessly. The return values are as for &'lss_match_domain()'&.
35847
35848 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35849         uschar&~*list)*&"
35850 This function checks for a match in a host list. The most common usage is
35851 expected to be
35852 .code
35853 lss_match_host(sender_host_name, sender_host_address, ...)
35854 .endd
35855 .vindex "&$sender_host_address$&"
35856 An empty address field matches an empty item in the host list. If the host name
35857 is NULL, the name corresponding to &$sender_host_address$& is automatically
35858 looked up if a host name is required to match an item in the list. The return
35859 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35860 returns ERROR in the case when it had to look up a host name, but the lookup
35861 failed.
35862
35863 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35864         *format,&~...)*&"
35865 This function writes to Exim's log files. The first argument should be zero (it
35866 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35867 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35868 them. It specifies to which log or logs the message is written. The remaining
35869 arguments are a format and relevant insertion arguments. The string should not
35870 contain any newlines, not even at the end.
35871
35872
35873 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35874 This function adds an additional recipient to the message. The first argument
35875 is the recipient address. If it is unqualified (has no domain), it is qualified
35876 with the &%qualify_recipient%& domain. The second argument must always be -1.
35877
35878 This function does not allow you to specify a private &%errors_to%& address (as
35879 described with the structure of &%recipient_item%& above), because it pre-dates
35880 the addition of that field to the structure. However, it is easy to add such a
35881 value afterwards. For example:
35882 .code
35883  receive_add_recipient(US"monitor@mydom.example", -1);
35884  recipients_list[recipients_count-1].errors_to =
35885    US"postmaster@mydom.example";
35886 .endd
35887
35888 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35889 This is a convenience function to remove a named recipient from the list of
35890 recipients. It returns true if a recipient was removed, and false if no
35891 matching recipient could be found. The argument must be a complete email
35892 address.
35893 .endlist
35894
35895
35896 .cindex "RFC 2047"
35897 .vlist
35898 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35899   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35900 This function decodes strings that are encoded according to RFC 2047. Typically
35901 these are the contents of header lines. First, each &"encoded word"& is decoded
35902 from the Q or B encoding into a byte-string. Then, if provided with the name of
35903 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35904 made  to translate the result to the named character set. If this fails, the
35905 binary string is returned with an error message.
35906
35907 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35908 maximum MIME word length is enforced. The third argument is the target
35909 encoding, or NULL if no translation is wanted.
35910
35911 .cindex "binary zero" "in RFC 2047 decoding"
35912 .cindex "RFC 2047" "binary zero in"
35913 If a binary zero is encountered in the decoded string, it is replaced by the
35914 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35915 not be 0 because header lines are handled as zero-terminated strings.
35916
35917 The function returns the result of processing the string, zero-terminated; if
35918 &%lenptr%& is not NULL, the length of the result is set in the variable to
35919 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35920
35921 If an error is encountered, the function returns NULL and uses the &%error%&
35922 argument to return an error message. The variable pointed to by &%error%& is
35923 set to NULL if there is no error; it may be set non-NULL even when the function
35924 returns a non-NULL value if decoding was successful, but there was a problem
35925 with translation.
35926
35927
35928 .vitem &*int&~smtp_fflush(void)*&
35929 This function is used in conjunction with &'smtp_printf()'&, as described
35930 below.
35931
35932 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35933 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35934 output stream. You should use this function only when there is an SMTP output
35935 stream, that is, when the incoming message is being received via interactive
35936 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35937 is FALSE. If you want to test for an incoming message from another host (as
35938 opposed to a local process that used the &%-bs%& command line option), you can
35939 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35940 is involved.
35941
35942 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35943 output function, so it can be used for all forms of SMTP connection.
35944
35945 The second argument is used to request that the data be buffered
35946 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35947 This is advisory only, but likely to save on system-calls and packets
35948 sent when a sequence of calls to the function are made.
35949
35950 The argument was added in Exim version 4.90 - changing the API/ABI.
35951 Nobody noticed until 4.93 was imminent, at which point the
35952 ABI version number was incremented.
35953
35954 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35955 must start with an appropriate response code: 550 if you are going to return
35956 LOCAL_SCAN_REJECT, 451 if you are going to return
35957 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35958 initial lines of a multi-line response, the code must be followed by a hyphen
35959 to indicate that the line is not the final response line. You must also ensure
35960 that the lines you write terminate with CRLF. For example:
35961 .code
35962 smtp_printf("550-this is some extra info\r\n");
35963 return LOCAL_SCAN_REJECT;
35964 .endd
35965 Note that you can also create multi-line responses by including newlines in
35966 the data returned via the &%return_text%& argument. The added value of using
35967 &'smtp_printf()'& is that, for instance, you could introduce delays between
35968 multiple output lines.
35969
35970 The &'smtp_printf()'& function does not return any error indication, because it
35971 does not
35972 guarantee a flush of
35973 pending output, and therefore does not test
35974 the state of the stream. (In the main code of Exim, flushing and error
35975 detection is done when Exim is ready for the next SMTP input command.) If
35976 you want to flush the output and check for an error (for example, the
35977 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35978 arguments. It flushes the output stream, and returns a non-zero value if there
35979 is an error.
35980
35981 .vitem &*void&~*store_get(int,BOOL)*&
35982 This function accesses Exim's internal store (memory) manager. It gets a new
35983 chunk of memory whose size is given by the first argument.
35984 The second argument should be given as TRUE if the memory will be used for
35985 data possibly coming from an attacker (eg. the message content),
35986 FALSE if it is locally-sourced.
35987 Exim bombs out if it ever
35988 runs out of memory. See the next section for a discussion of memory handling.
35989
35990 .vitem &*void&~*store_get_perm(int,BOOL)*&
35991 This function is like &'store_get()'&, but it always gets memory from the
35992 permanent pool. See the next section for a discussion of memory handling.
35993
35994 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35995 See below.
35996
35997 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35998 See below.
35999
36000 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
36001 These three functions create strings using Exim's dynamic memory facilities.
36002 The first makes a copy of an entire string. The second copies up to a maximum
36003 number of characters, indicated by the second argument. The third uses a format
36004 and insertion arguments to create a new string. In each case, the result is a
36005 pointer to a new string in the current memory pool. See the next section for
36006 more discussion.
36007 .endlist
36008
36009
36010
36011 .section "More about Exim's memory handling" "SECTmemhanloc"
36012 .cindex "&[local_scan()]& function" "memory handling"
36013 No function is provided for freeing memory, because that is never needed.
36014 The dynamic memory that Exim uses when receiving a message is automatically
36015 recycled if another message is received by the same process (this applies only
36016 to incoming SMTP connections &-- other input methods can supply only one
36017 message at a time). After receiving the last message, a reception process
36018 terminates.
36019
36020 Because it is recycled, the normal dynamic memory cannot be used for holding
36021 data that must be preserved over a number of incoming messages on the same SMTP
36022 connection. However, Exim in fact uses two pools of dynamic memory; the second
36023 one is not recycled, and can be used for this purpose.
36024
36025 If you want to allocate memory that remains available for subsequent messages
36026 in the same SMTP connection, you should set
36027 .code
36028 store_pool = POOL_PERM
36029 .endd
36030 before calling the function that does the allocation. There is no need to
36031 restore the value if you do not need to; however, if you do want to revert to
36032 the normal pool, you can either restore the previous value of &%store_pool%& or
36033 set it explicitly to POOL_MAIN.
36034
36035 The pool setting applies to all functions that get dynamic memory, including
36036 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36037 There is also a convenience function called &'store_get_perm()'& that gets a
36038 block of memory from the permanent pool while preserving the value of
36039 &%store_pool%&.
36040 .ecindex IIDlosca
36041
36042
36043
36044
36045 . ////////////////////////////////////////////////////////////////////////////
36046 . ////////////////////////////////////////////////////////////////////////////
36047
36048 .chapter "System-wide message filtering" "CHAPsystemfilter"
36049 .scindex IIDsysfil1 "filter" "system filter"
36050 .scindex IIDsysfil2 "filtering all mail"
36051 .scindex IIDsysfil3 "system filter"
36052 The previous chapters (on ACLs and the local scan function) describe checks
36053 that can be applied to messages before they are accepted by a host. There is
36054 also a mechanism for checking messages once they have been received, but before
36055 they are delivered. This is called the &'system filter'&.
36056
36057 The system filter operates in a similar manner to users' filter files, but it
36058 is run just once per message (however many recipients the message has).
36059 It should not normally be used as a substitute for routing, because &%deliver%&
36060 commands in a system router provide new envelope recipient addresses.
36061 The system filter must be an Exim filter. It cannot be a Sieve filter.
36062
36063 The system filter is run at the start of a delivery attempt, before any routing
36064 is done. If a message fails to be completely delivered at the first attempt,
36065 the system filter is run again at the start of every retry.
36066 If you want your filter to do something only once per message, you can make use
36067 .cindex retry condition
36068 of the &%first_delivery%& condition in an &%if%& command in the filter to
36069 prevent it happening on retries.
36070
36071 .vindex "&$domain$&"
36072 .vindex "&$local_part$&"
36073 &*Warning*&: Because the system filter runs just once, variables that are
36074 specific to individual recipient addresses, such as &$local_part$& and
36075 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36076 you want to run a centrally-specified filter for each recipient address
36077 independently, you can do so by setting up a suitable &(redirect)& router, as
36078 described in section &<<SECTperaddfil>>& below.
36079
36080
36081 .section "Specifying a system filter" "SECID212"
36082 .cindex "uid (user id)" "system filter"
36083 .cindex "gid (group id)" "system filter"
36084 The name of the file that contains the system filter must be specified by
36085 setting &%system_filter%&. If you want the filter to run under a uid and gid
36086 other than root, you must also set &%system_filter_user%& and
36087 &%system_filter_group%& as appropriate. For example:
36088 .code
36089 system_filter = /etc/mail/exim.filter
36090 system_filter_user = exim
36091 .endd
36092 If a system filter generates any deliveries directly to files or pipes (via the
36093 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36094 specified by setting &%system_filter_file_transport%& and
36095 &%system_filter_pipe_transport%&, respectively. Similarly,
36096 &%system_filter_reply_transport%& must be set to handle any messages generated
36097 by the &%reply%& command.
36098
36099
36100 .section "Testing a system filter" "SECID213"
36101 You can run simple tests of a system filter in the same way as for a user
36102 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36103 are permitted only in system filters are recognized.
36104
36105 If you want to test the combined effect of a system filter and a user filter,
36106 you can use both &%-bF%& and &%-bf%& on the same command line.
36107
36108
36109
36110 .section "Contents of a system filter" "SECID214"
36111 The language used to specify system filters is the same as for users' filter
36112 files. It is described in the separate end-user document &'Exim's interface to
36113 mail filtering'&. However, there are some additional features that are
36114 available only in system filters; these are described in subsequent sections.
36115 If they are encountered in a user's filter file or when testing with &%-bf%&,
36116 they cause errors.
36117
36118 .cindex "frozen messages" "manual thaw; testing in filter"
36119 There are two special conditions which, though available in users' filter
36120 files, are designed for use in system filters. The condition &%first_delivery%&
36121 is true only for the first attempt at delivering a message, and
36122 &%manually_thawed%& is true only if the message has been frozen, and
36123 subsequently thawed by an admin user. An explicit forced delivery counts as a
36124 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36125
36126 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36127 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36128 succeed, it will not be tried again.
36129 If you want Exim to retry an unseen delivery until it succeeds, you should
36130 arrange to set it up every time the filter runs.
36131
36132 When a system filter finishes running, the values of the variables &$n0$& &--
36133 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36134 users' filter files. Thus a system filter can, for example, set up &"scores"&
36135 to which users' filter files can refer.
36136
36137
36138
36139 .section "Additional variable for system filters" "SECID215"
36140 .vindex "&$recipients$&"
36141 The expansion variable &$recipients$&, containing a list of all the recipients
36142 of the message (separated by commas and white space), is available in system
36143 filters. It is not available in users' filters for privacy reasons.
36144
36145
36146
36147 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36148 .cindex "freezing messages"
36149 .cindex "message" "freezing"
36150 .cindex "message" "forced failure"
36151 .cindex "&%fail%&" "in system filter"
36152 .cindex "&%freeze%& in system filter"
36153 .cindex "&%defer%& in system filter"
36154 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36155 always available in system filters, but are not normally enabled in users'
36156 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36157 for the &(redirect)& router.) These commands can optionally be followed by the
36158 word &%text%& and a string containing an error message, for example:
36159 .code
36160 fail text "this message looks like spam to me"
36161 .endd
36162 The keyword &%text%& is optional if the next character is a double quote.
36163
36164 The &%defer%& command defers delivery of the original recipients of the
36165 message. The &%fail%& command causes all the original recipients to be failed,
36166 and a bounce message to be created. The &%freeze%& command suspends all
36167 delivery attempts for the original recipients. In all cases, any new deliveries
36168 that are specified by the filter are attempted as normal after the filter has
36169 run.
36170
36171 The &%freeze%& command is ignored if the message has been manually unfrozen and
36172 not manually frozen since. This means that automatic freezing by a system
36173 filter can be used as a way of checking out suspicious messages. If a message
36174 is found to be all right, manually unfreezing it allows it to be delivered.
36175
36176 .cindex "log" "&%fail%& command log line"
36177 .cindex "&%fail%&" "log line; reducing"
36178 The text given with a fail command is used as part of the bounce message as
36179 well as being written to the log. If the message is quite long, this can fill
36180 up a lot of log space when such failures are common. To reduce the size of the
36181 log message, Exim interprets the text in a special way if it starts with the
36182 two characters &`<<`& and contains &`>>`& later. The text between these two
36183 strings is written to the log, and the rest of the text is used in the bounce
36184 message. For example:
36185 .code
36186 fail "<<filter test 1>>Your message is rejected \
36187      because it contains attachments that we are \
36188      not prepared to receive."
36189 .endd
36190
36191 .cindex "loop" "caused by &%fail%&"
36192 Take great care with the &%fail%& command when basing the decision to fail on
36193 the contents of the message, because the bounce message will of course include
36194 the contents of the original message and will therefore trigger the &%fail%&
36195 command again (causing a mail loop) unless steps are taken to prevent this.
36196 Testing the &%error_message%& condition is one way to prevent this. You could
36197 use, for example
36198 .code
36199 if $message_body contains "this is spam" and not error_message
36200 then fail text "spam is not wanted here" endif
36201 .endd
36202 though of course that might let through unwanted bounce messages. The
36203 alternative is clever checking of the body and/or headers to detect bounces
36204 generated by the filter.
36205
36206 The interpretation of a system filter file ceases after a
36207 &%defer%&,
36208 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36209 set up earlier in the filter file are honoured, so you can use a sequence such
36210 as
36211 .code
36212 mail ...
36213 freeze
36214 .endd
36215 to send a specified message when the system filter is freezing (or deferring or
36216 failing) a message. The normal deliveries for the message do not, of course,
36217 take place.
36218
36219
36220
36221 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36222 .cindex "header lines" "adding; in system filter"
36223 .cindex "header lines" "removing; in system filter"
36224 .cindex "filter" "header lines; adding/removing"
36225 Two filter commands that are available only in system filters are:
36226 .code
36227 headers add <string>
36228 headers remove <string>
36229 .endd
36230 The argument for the &%headers add%& is a string that is expanded and then
36231 added to the end of the message's headers. It is the responsibility of the
36232 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36233 space is ignored, and if the string is otherwise empty, or if the expansion is
36234 forced to fail, the command has no effect.
36235
36236 You can use &"\n"& within the string, followed by white space, to specify
36237 continued header lines. More than one header may be added in one command by
36238 including &"\n"& within the string without any following white space. For
36239 example:
36240 .code
36241 headers add "X-header-1: ....\n  \
36242              continuation of X-header-1 ...\n\
36243              X-header-2: ...."
36244 .endd
36245 Note that the header line continuation white space after the first newline must
36246 be placed before the backslash that continues the input string, because white
36247 space after input continuations is ignored.
36248
36249 The argument for &%headers remove%& is a colon-separated list of header names.
36250 This command applies only to those headers that are stored with the message;
36251 those that are added at delivery time (such as &'Envelope-To:'& and
36252 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36253 header with the same name, they are all removed.
36254
36255 The &%headers%& command in a system filter makes an immediate change to the set
36256 of header lines that was received with the message (with possible additions
36257 from ACL processing). Subsequent commands in the system filter operate on the
36258 modified set, which also forms the basis for subsequent message delivery.
36259 Unless further modified during routing or transporting, this set of headers is
36260 used for all recipients of the message.
36261
36262 During routing and transporting, the variables that refer to the contents of
36263 header lines refer only to those lines that are in this set. Thus, header lines
36264 that are added by a system filter are visible to users' filter files and to all
36265 routers and transports. This contrasts with the manipulation of header lines by
36266 routers and transports, which is not immediate, but which instead is saved up
36267 until the message is actually being written (see section
36268 &<<SECTheadersaddrem>>&).
36269
36270 If the message is not delivered at the first attempt, header lines that were
36271 added by the system filter are stored with the message, and so are still
36272 present at the next delivery attempt. Header lines that were removed are still
36273 present, but marked &"deleted"& so that they are not transported with the
36274 message. For this reason, it is usual to make the &%headers%& command
36275 conditional on &%first_delivery%& so that the set of header lines is not
36276 modified more than once.
36277
36278 Because header modification in a system filter acts immediately, you have to
36279 use an indirect approach if you want to modify the contents of a header line.
36280 For example:
36281 .code
36282 headers add "Old-Subject: $h_subject:"
36283 headers remove "Subject"
36284 headers add "Subject: new subject (was: $h_old-subject:)"
36285 headers remove "Old-Subject"
36286 .endd
36287
36288
36289
36290 .section "Setting an errors address in a system filter" "SECID217"
36291 .cindex "envelope from"
36292 .cindex "envelope sender"
36293 In a system filter, if a &%deliver%& command is followed by
36294 .code
36295 errors_to <some address>
36296 .endd
36297 in order to change the envelope sender (and hence the error reporting) for that
36298 delivery, any address may be specified. (In a user filter, only the current
36299 user's address can be set.) For example, if some mail is being monitored, you
36300 might use
36301 .code
36302 unseen deliver monitor@spying.example errors_to root@local.example
36303 .endd
36304 to take a copy which would not be sent back to the normal error reporting
36305 address if its delivery failed.
36306
36307
36308
36309 .section "Per-address filtering" "SECTperaddfil"
36310 .vindex "&$domain_data$&"
36311 .vindex "&$local_part_data$&"
36312 In contrast to the system filter, which is run just once per message for each
36313 delivery attempt, it is also possible to set up a system-wide filtering
36314 operation that runs once for each recipient address. In this case, variables
36315 such as &$local_part_data$& and &$domain_data$& can be used,
36316 and indeed, the choice of filter file could be made dependent on them.
36317 This is an example of a router which implements such a filter:
36318 .code
36319 central_filter:
36320   check_local_user
36321   driver = redirect
36322   domains = +local_domains
36323   file = /central/filters/$local_part_data
36324   no_verify
36325   allow_filter
36326   allow_freeze
36327 .endd
36328 The filter is run in a separate process under its own uid. Therefore, either
36329 &%check_local_user%& must be set (as above), in which case the filter is run as
36330 the local user, or the &%user%& option must be used to specify which user to
36331 use. If both are set, &%user%& overrides.
36332
36333 Care should be taken to ensure that none of the commands in the filter file
36334 specify a significant delivery if the message is to go on to be delivered to
36335 its intended recipient. The router will not then claim to have dealt with the
36336 address, so it will be passed on to subsequent routers to be delivered in the
36337 normal way.
36338 .ecindex IIDsysfil1
36339 .ecindex IIDsysfil2
36340 .ecindex IIDsysfil3
36341
36342
36343
36344
36345
36346
36347 . ////////////////////////////////////////////////////////////////////////////
36348 . ////////////////////////////////////////////////////////////////////////////
36349
36350 .chapter "Message processing" "CHAPmsgproc"
36351 .scindex IIDmesproc "message" "general processing"
36352 Exim performs various transformations on the sender and recipient addresses of
36353 all messages that it handles, and also on the messages' header lines. Some of
36354 these are optional and configurable, while others always take place. All of
36355 this processing, except rewriting as a result of routing, and the addition or
36356 removal of header lines while delivering, happens when a message is received,
36357 before it is placed on Exim's queue.
36358
36359 Some of the automatic processing takes place by default only for
36360 &"locally-originated"& messages. This adjective is used to describe messages
36361 that are not received over TCP/IP, but instead are passed to an Exim process on
36362 its standard input. This includes the interactive &"local SMTP"& case that is
36363 set up by the &%-bs%& command line option.
36364
36365 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36366 or ::1) are not considered to be locally-originated. Exim does not treat the
36367 loopback interface specially in any way.
36368
36369 If you want the loopback interface to be treated specially, you must ensure
36370 that there are appropriate entries in your ACLs.
36371
36372
36373
36374
36375 .section "Submission mode for non-local messages" "SECTsubmodnon"
36376 .cindex "message" "submission"
36377 .cindex "submission mode"
36378 Processing that happens automatically for locally-originated messages (unless
36379 &%suppress_local_fixups%& is set) can also be requested for messages that are
36380 received over TCP/IP. The term &"submission mode"& is used to describe this
36381 state. Submission mode is set by the modifier
36382 .code
36383 control = submission
36384 .endd
36385 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36386 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36387 a local submission, and is normally used when the source of the message is
36388 known to be an MUA running on a client host (as opposed to an MTA). For
36389 example, to set submission mode for messages originating on the IPv4 loopback
36390 interface, you could include the following in the MAIL ACL:
36391 .code
36392 warn  hosts = 127.0.0.1
36393       control = submission
36394 .endd
36395 .cindex "&%sender_retain%& submission option"
36396 There are some options that can be used when setting submission mode. A slash
36397 is used to separate options. For example:
36398 .code
36399 control = submission/sender_retain
36400 .endd
36401 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36402 true and &%local_from_check%& false for the current incoming message. The first
36403 of these allows an existing &'Sender:'& header in the message to remain, and
36404 the second suppresses the check to ensure that &'From:'& matches the
36405 authenticated sender. With this setting, Exim still fixes up messages by adding
36406 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36407 attempt to check sender authenticity in header lines.
36408
36409 When &%sender_retain%& is not set, a submission mode setting may specify a
36410 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36411 example:
36412 .code
36413 control = submission/domain=some.domain
36414 .endd
36415 The domain may be empty. How this value is used is described in sections
36416 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36417 that allows you to specify the user's full name for inclusion in a created
36418 &'Sender:'& or &'From:'& header line. For example:
36419 .code
36420 accept authenticated = *
36421        control = submission/domain=wonderland.example/\
36422                             name=${lookup {$authenticated_id} \
36423                                    lsearch {/etc/exim/namelist}}
36424 .endd
36425 Because the name may contain any characters, including slashes, the &%name%&
36426 option must be given last. The remainder of the string is used as the name. For
36427 the example above, if &_/etc/exim/namelist_& contains:
36428 .code
36429 bigegg:  Humpty Dumpty
36430 .endd
36431 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36432 line would be:
36433 .code
36434 Sender: Humpty Dumpty <bigegg@wonderland.example>
36435 .endd
36436 .cindex "return path" "in submission mode"
36437 By default, submission mode forces the return path to the same address as is
36438 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36439 specified, the return path is also left unchanged.
36440
36441 &*Note*&: The changes caused by submission mode take effect after the predata
36442 ACL. This means that any sender checks performed before the fix-ups use the
36443 untrusted sender address specified by the user, not the trusted sender address
36444 specified by submission mode. Although this might be slightly unexpected, it
36445 does mean that you can configure ACL checks to spot that a user is trying to
36446 spoof another's address.
36447
36448 .section "Line endings" "SECTlineendings"
36449 .cindex "line endings"
36450 .cindex "carriage return"
36451 .cindex "linefeed"
36452 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36453 linefeed) is the line ending for messages transmitted over the Internet using
36454 SMTP over TCP/IP. However, within individual operating systems, different
36455 conventions are used. For example, Unix-like systems use just LF, but others
36456 use CRLF or just CR.
36457
36458 Exim was designed for Unix-like systems, and internally, it stores messages
36459 using the system's convention of a single LF as a line terminator. When
36460 receiving a message, all line endings are translated to this standard format.
36461 Originally, it was thought that programs that passed messages directly to an
36462 MTA within an operating system would use that system's convention. Experience
36463 has shown that this is not the case; for example, there are Unix applications
36464 that use CRLF in this circumstance. For this reason, and for compatibility with
36465 other MTAs, the way Exim handles line endings for all messages is now as
36466 follows:
36467
36468 .ilist
36469 LF not preceded by CR is treated as a line ending.
36470 .next
36471 CR is treated as a line ending; if it is immediately followed by LF, the LF
36472 is ignored.
36473 .next
36474 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36475 nor a local message in the state where a line containing only a dot is a
36476 terminator.
36477 .next
36478 If a bare CR is encountered within a header line, an extra space is added after
36479 the line terminator so as not to end the header line. The reasoning behind this
36480 is that bare CRs in header lines are most likely either to be mistakes, or
36481 people trying to play silly games.
36482 .next
36483 If the first header line received in a message ends with CRLF, a subsequent
36484 bare LF in a header line is treated in the same way as a bare CR in a header
36485 line.
36486 .endlist
36487
36488
36489
36490
36491
36492 .section "Unqualified addresses" "SECID218"
36493 .cindex "unqualified addresses"
36494 .cindex "address" "qualification"
36495 By default, Exim expects every envelope address it receives from an external
36496 host to be fully qualified. Unqualified addresses cause negative responses to
36497 SMTP commands. However, because SMTP is used as a means of transporting
36498 messages from MUAs running on personal workstations, there is sometimes a
36499 requirement to accept unqualified addresses from specific hosts or IP networks.
36500
36501 Exim has two options that separately control which hosts may send unqualified
36502 sender or recipient addresses in SMTP commands, namely
36503 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36504 cases, if an unqualified address is accepted, it is qualified by adding the
36505 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36506
36507 .oindex "&%qualify_domain%&"
36508 .oindex "&%qualify_recipient%&"
36509 Unqualified addresses in header lines are automatically qualified for messages
36510 that are locally originated, unless the &%-bnq%& option is given on the command
36511 line. For messages received over SMTP, unqualified addresses in header lines
36512 are qualified only if unqualified addresses are permitted in SMTP commands. In
36513 other words, such qualification is also controlled by
36514 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36515
36516
36517
36518
36519 .section "The UUCP From line" "SECID219"
36520 .cindex "&""From""& line"
36521 .cindex "UUCP" "&""From""& line"
36522 .cindex "sender" "address"
36523 .oindex "&%uucp_from_pattern%&"
36524 .oindex "&%uucp_from_sender%&"
36525 .cindex "envelope from"
36526 .cindex "envelope sender"
36527 .cindex "Sendmail compatibility" "&""From""& line"
36528 Messages that have come from UUCP (and some other applications) often begin
36529 with a line containing the envelope sender and a timestamp, following the word
36530 &"From"&. Examples of two common formats are:
36531 .code
36532 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36533 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36534 .endd
36535 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36536 Exim recognizes such lines at the start of messages that are submitted to it
36537 via the command line (that is, on the standard input). It does not recognize
36538 such lines in incoming SMTP messages, unless the sending host matches
36539 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36540 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36541 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36542 default value matches the two common cases shown above and puts the address
36543 that follows &"From"& into &$1$&.
36544
36545 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36546 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36547 a trusted user, the message's sender address is constructed by expanding the
36548 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36549 then parsed as an RFC 2822 address. If there is no domain, the local part is
36550 qualified with &%qualify_domain%& unless it is the empty string. However, if
36551 the command line &%-f%& option is used, it overrides the &"From"& line.
36552
36553 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36554 sender address is not changed. This is also the case for incoming SMTP messages
36555 that are permitted to contain &"From"& lines.
36556
36557 Only one &"From"& line is recognized. If there is more than one, the second is
36558 treated as a data line that starts the body of the message, as it is not valid
36559 as a header line. This also happens if a &"From"& line is present in an
36560 incoming SMTP message from a source that is not permitted to send them.
36561
36562
36563
36564 .section "Header lines"
36565 .subsection "Resent- header lines" SECID220
36566 .chindex Resent-
36567 RFC 2822 makes provision for sets of header lines starting with the string
36568 &`Resent-`& to be added to a message when it is resent by the original
36569 recipient to somebody else. These headers are &'Resent-Date:'&,
36570 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36571 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36572
36573 .blockquote
36574 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36575 processing of replies or other such automatic actions on messages.'&
36576 .endblockquote
36577
36578 This leaves things a bit vague as far as other processing actions such as
36579 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36580 follows:
36581
36582 .ilist
36583 A &'Resent-From:'& line that just contains the login id of the submitting user
36584 is automatically rewritten in the same way as &'From:'& (see below).
36585 .next
36586 If there's a rewriting rule for a particular header line, it is also applied to
36587 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36588 &'From:'& also rewrites &'Resent-From:'&.
36589 .next
36590 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36591 also removed.
36592 .next
36593 For a locally-submitted message,
36594 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36595 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36596 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36597 included in log lines in this case.
36598 .next
36599 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36600 &%Resent-%& header lines are present.
36601 .endlist
36602
36603
36604
36605
36606 .subsection Auto-Submitted: SECID221
36607 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36608 includes the header line:
36609 .code
36610 Auto-Submitted: auto-replied
36611 .endd
36612
36613 .subsection Bcc: SECID222
36614 .cindex "&'Bcc:'& header line"
36615 If Exim is called with the &%-t%& option, to take recipient addresses from a
36616 message's header, it removes any &'Bcc:'& header line that may exist (after
36617 extracting its addresses). If &%-t%& is not present on the command line, any
36618 existing &'Bcc:'& is not removed.
36619
36620
36621 .subsection Date: SECID223
36622 .cindex Date:
36623 If a locally-generated or submission-mode message has no &'Date:'& header line,
36624 Exim adds one, using the current date and time, unless the
36625 &%suppress_local_fixups%& control has been specified.
36626
36627 .subsection Delivery-date: SECID224
36628 .cindex "&'Delivery-date:'& header line"
36629 .oindex "&%delivery_date_remove%&"
36630 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36631 set. Exim can be configured to add them to the final delivery of messages. (See
36632 the generic &%delivery_date_add%& transport option.) They should not be present
36633 in messages in transit. If the &%delivery_date_remove%& configuration option is
36634 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36635 messages.
36636
36637
36638 .subsection Envelope-to: SECID225
36639 .chindex Envelope-to:
36640 .oindex "&%envelope_to_remove%&"
36641 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36642 Exim can be configured to add them to the final delivery of messages. (See the
36643 generic &%envelope_to_add%& transport option.) They should not be present in
36644 messages in transit. If the &%envelope_to_remove%& configuration option is set
36645 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36646 messages.
36647
36648
36649 .subsection From: SECTthefrohea
36650 .chindex From:
36651 .cindex "Sendmail compatibility" "&""From""& line"
36652 .cindex "message" "submission"
36653 .cindex "submission mode"
36654 If a submission-mode message does not contain a &'From:'& header line, Exim
36655 adds one if either of the following conditions is true:
36656
36657 .ilist
36658 The envelope sender address is not empty (that is, this is not a bounce
36659 message). The added header line copies the envelope sender address.
36660 .next
36661 .vindex "&$authenticated_id$&"
36662 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36663 .olist
36664 .vindex "&$qualify_domain$&"
36665 If no domain is specified by the submission control, the local part is
36666 &$authenticated_id$& and the domain is &$qualify_domain$&.
36667 .next
36668 If a non-empty domain is specified by the submission control, the local
36669 part is &$authenticated_id$&, and the domain is the specified domain.
36670 .next
36671 If an empty domain is specified by the submission control,
36672 &$authenticated_id$& is assumed to be the complete address.
36673 .endlist
36674 .endlist
36675
36676 A non-empty envelope sender takes precedence.
36677
36678 If a locally-generated incoming message does not contain a &'From:'& header
36679 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36680 containing the sender's address. The calling user's login name and full name
36681 are used to construct the address, as described in section &<<SECTconstr>>&.
36682 They are obtained from the password data by calling &[getpwuid()]& (but see the
36683 &%unknown_login%& configuration option). The address is qualified with
36684 &%qualify_domain%&.
36685
36686 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36687 &'From:'& header line containing just the unqualified login name of the calling
36688 user, this is replaced by an address containing the user's login name and full
36689 name as described in section &<<SECTconstr>>&.
36690
36691
36692 .subsection Message-ID: SECID226
36693 .chindex Message-ID:
36694 .cindex "message" "submission"
36695 .oindex "&%message_id_header_text%&"
36696 If a locally-generated or submission-mode incoming message does not contain a
36697 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36698 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36699 to the message. If there are any &'Resent-:'& headers in the message, it
36700 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36701 message id, preceded by the letter E to ensure it starts with a letter, and
36702 followed by @ and the primary host name. Additional information can be included
36703 in this header line by setting the &%message_id_header_text%& and/or
36704 &%message_id_header_domain%& options.
36705
36706
36707 .subsection Received: SECID227
36708 .chindex Received:
36709 A &'Received:'& header line is added at the start of every message. The
36710 contents are defined by the &%received_header_text%& configuration option, and
36711 Exim automatically adds a semicolon and a timestamp to the configured string.
36712
36713 The &'Received:'& header is generated as soon as the message's header lines
36714 have been received. At this stage, the timestamp in the &'Received:'& header
36715 line is the time that the message started to be received. This is the value
36716 that is seen by the DATA ACL and by the &[local_scan()]& function.
36717
36718 Once a message is accepted, the timestamp in the &'Received:'& header line is
36719 changed to the time of acceptance, which is (apart from a small delay while the
36720 -H spool file is written) the earliest time at which delivery could start.
36721
36722
36723 .subsection References: SECID228
36724 .chindex References:
36725 Messages created by the &(autoreply)& transport include a &'References:'&
36726 header line. This is constructed according to the rules that are described in
36727 section 3.64 of RFC 2822 (which states that replies should contain such a
36728 header line), and section 3.14 of RFC 3834 (which states that automatic
36729 responses are not different in this respect). However, because some mail
36730 processing software does not cope well with very long header lines, no more
36731 than 12 message IDs are copied from the &'References:'& header line in the
36732 incoming message. If there are more than 12, the first one and then the final
36733 11 are copied, before adding the message ID of the incoming message.
36734
36735
36736
36737 .subsection Return-path: SECID229
36738 .chindex Return-path:
36739 .oindex "&%return_path_remove%&"
36740 &'Return-path:'& header lines are defined as something an MTA may insert when
36741 it does the final delivery of messages. (See the generic &%return_path_add%&
36742 transport option.) Therefore, they should not be present in messages in
36743 transit. If the &%return_path_remove%& configuration option is set (the
36744 default), Exim removes &'Return-path:'& header lines from incoming messages.
36745
36746
36747
36748 .subsection Sender: SECTthesenhea
36749 .cindex "&'Sender:'& header line"
36750 .cindex "message" "submission"
36751 .chindex Sender:
36752 For a locally-originated message from an untrusted user, Exim may remove an
36753 existing &'Sender:'& header line, and it may add a new one. You can modify
36754 these actions by setting the &%local_sender_retain%& option true, the
36755 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36756 control setting.
36757
36758 When a local message is received from an untrusted user and
36759 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36760 control has not been set, a check is made to see if the address given in the
36761 &'From:'& header line is the correct (local) sender of the message. The address
36762 that is expected has the login name as the local part and the value of
36763 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36764 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36765 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36766 line is added to the message.
36767
36768 If you set &%local_from_check%& false, this checking does not occur. However,
36769 the removal of an existing &'Sender:'& line still happens, unless you also set
36770 &%local_sender_retain%& to be true. It is not possible to set both of these
36771 options true at the same time.
36772
36773 .cindex "submission mode"
36774 By default, no processing of &'Sender:'& header lines is done for messages
36775 received over TCP/IP or for messages submitted by trusted users. However, when
36776 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36777 not specified on the submission control, the following processing takes place:
36778
36779 .vindex "&$authenticated_id$&"
36780 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36781 authenticated, and &$authenticated_id$& is not empty, a sender address is
36782 created as follows:
36783
36784 .ilist
36785 .vindex "&$qualify_domain$&"
36786 If no domain is specified by the submission control, the local part is
36787 &$authenticated_id$& and the domain is &$qualify_domain$&.
36788 .next
36789 If a non-empty domain is specified by the submission control, the local part
36790 is &$authenticated_id$&, and the domain is the specified domain.
36791 .next
36792 If an empty domain is specified by the submission control,
36793 &$authenticated_id$& is assumed to be the complete address.
36794 .endlist
36795
36796 This address is compared with the address in the &'From:'& header line. If they
36797 are different, a &'Sender:'& header line containing the created address is
36798 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36799 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36800
36801 .cindex "return path" "created from &'Sender:'&"
36802 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36803 the message (the envelope sender address) is changed to be the same address,
36804 except in the case of submission mode when &%sender_retain%& is specified.
36805
36806
36807
36808 .section "Adding and removing header lines in routers and transports" &&&
36809          "SECTheadersaddrem"
36810 .cindex "header lines" "adding; in router or transport"
36811 .cindex "header lines" "removing; in router or transport"
36812 When a message is delivered, the addition and removal of header lines can be
36813 specified in a system filter, or on any of the routers and transports that
36814 process the message. Section &<<SECTaddremheasys>>& contains details about
36815 modifying headers in a system filter. Header lines can also be added in an ACL
36816 as a message is received (see section &<<SECTaddheadacl>>&).
36817
36818 In contrast to what happens in a system filter, header modifications that are
36819 specified on routers and transports apply only to the particular recipient
36820 addresses that are being processed by those routers and transports. These
36821 changes do not actually take place until a copy of the message is being
36822 transported. Therefore, they do not affect the basic set of header lines, and
36823 they do not affect the values of the variables that refer to header lines.
36824
36825 &*Note*&: In particular, this means that any expansions in the configuration of
36826 the transport cannot refer to the modified header lines, because such
36827 expansions all occur before the message is actually transported.
36828
36829 For both routers and transports, the argument of a &%headers_add%&
36830 option must be in the form of one or more RFC 2822 header lines, separated by
36831 newlines (coded as &"\n"&). For example:
36832 .code
36833 headers_add = X-added-header: added by $primary_hostname\n\
36834               X-added-second: another added header line
36835 .endd
36836 Exim does not check the syntax of these added header lines.
36837
36838 Multiple &%headers_add%& options for a single router or transport can be
36839 specified; the values will append to a single list of header lines.
36840 Each header-line is separately expanded.
36841
36842 The argument of a &%headers_remove%& option must consist of a colon-separated
36843 list of header names. This is confusing, because header names themselves are
36844 often terminated by colons. In this case, the colons are the list separators,
36845 not part of the names. For example:
36846 .code
36847 headers_remove = return-receipt-to:acknowledge-to
36848 .endd
36849
36850 Multiple &%headers_remove%& options for a single router or transport can be
36851 specified; the arguments will append to a single header-names list.
36852 Each item is separately expanded.
36853 Note that colons in complex expansions which are used to
36854 form all or part of a &%headers_remove%& list
36855 will act as list separators.
36856
36857 When &%headers_add%& or &%headers_remove%& is specified on a router,
36858 items are expanded at routing time,
36859 and then associated with all addresses that are
36860 accepted by that router, and also with any new addresses that it generates. If
36861 an address passes through several routers as a result of aliasing or
36862 forwarding, the changes are cumulative.
36863
36864 .oindex "&%unseen%&"
36865 However, this does not apply to multiple routers that result from the use of
36866 the &%unseen%& option. Any header modifications that were specified by the
36867 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36868
36869 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36870 settings cannot be delivered together in a batch, so a transport is always
36871 dealing with a set of addresses that have the same header-processing
36872 requirements.
36873
36874 The transport starts by writing the original set of header lines that arrived
36875 with the message, possibly modified by the system filter. As it writes out
36876 these lines, it consults the list of header names that were attached to the
36877 recipient address(es) by &%headers_remove%& options in routers, and it also
36878 consults the transport's own &%headers_remove%& option. Header lines whose
36879 names are on either of these lists are not written out. If there are multiple
36880 instances of any listed header, they are all skipped.
36881
36882 After the remaining original header lines have been written, new header
36883 lines that were specified by routers' &%headers_add%& options are written, in
36884 the order in which they were attached to the address. These are followed by any
36885 header lines specified by the transport's &%headers_add%& option.
36886
36887 This way of handling header line modifications in routers and transports has
36888 the following consequences:
36889
36890 .ilist
36891 The original set of header lines, possibly modified by the system filter,
36892 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36893 to it, at all times.
36894 .next
36895 Header lines that are added by a router's
36896 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36897 expansion syntax in subsequent routers or the transport.
36898 .next
36899 Conversely, header lines that are specified for removal by &%headers_remove%&
36900 in a router remain visible to subsequent routers and the transport.
36901 .next
36902 Headers added to an address by &%headers_add%& in a router cannot be removed by
36903 a later router or by a transport.
36904 .next
36905 An added header can refer to the contents of an original header that is to be
36906 removed, even it has the same name as the added header. For example:
36907 .code
36908 headers_remove = subject
36909 headers_add = Subject: new subject (was: $h_subject:)
36910 .endd
36911 .endlist
36912
36913 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36914 for a &(redirect)& router that has the &%one_time%& option set.
36915
36916
36917
36918
36919
36920 .section "Constructed addresses" "SECTconstr"
36921 .cindex "address" "constructed"
36922 .cindex "constructed address"
36923 When Exim constructs a sender address for a locally-generated message, it uses
36924 the form
36925 .display
36926 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36927 .endd
36928 For example:
36929 .code
36930 Zaphod Beeblebrox <zaphod@end.univ.example>
36931 .endd
36932 The user name is obtained from the &%-F%& command line option if set, or
36933 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36934 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36935 ampersand character, this is replaced by the login name with the first letter
36936 upper cased, as is conventional in a number of operating systems. See the
36937 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36938 The &%unknown_username%& option can be used to specify user names in cases when
36939 there is no password file entry.
36940
36941 .cindex "RFC 2047"
36942 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36943 parts of it if necessary. In addition, if it contains any non-printing
36944 characters, it is encoded as described in RFC 2047, which defines a way of
36945 including non-ASCII characters in header lines. The value of the
36946 &%headers_charset%& option specifies the name of the encoding that is used (the
36947 characters are assumed to be in this encoding). The setting of
36948 &%print_topbitchars%& controls whether characters with the top bit set (that
36949 is, with codes greater than 127) count as printing characters or not.
36950
36951
36952
36953 .section "Case of local parts" "SECID230"
36954 .cindex "case of local parts"
36955 .cindex "local part" "case of"
36956 RFC 2822 states that the case of letters in the local parts of addresses cannot
36957 be assumed to be non-significant. Exim preserves the case of local parts of
36958 addresses, but by default it uses a lower-cased form when it is routing,
36959 because on most Unix systems, usernames are in lower case and case-insensitive
36960 routing is required. However, any particular router can be made to use the
36961 original case for local parts by setting the &%caseful_local_part%& generic
36962 router option.
36963
36964 .cindex "mixed-case login names"
36965 If you must have mixed-case user names on your system, the best way to proceed,
36966 assuming you want case-independent handling of incoming email, is to set up
36967 your first router to convert incoming local parts in your domains to the
36968 correct case by means of a file lookup. For example:
36969 .code
36970 correct_case:
36971   driver = redirect
36972   domains = +local_domains
36973   data = ${lookup{$local_part}cdb\
36974               {/etc/usercased.cdb}{$value}fail}\
36975               @$domain
36976 .endd
36977 For this router, the local part is forced to lower case by the default action
36978 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36979 up a new local part in the correct case. If you then set &%caseful_local_part%&
36980 on any subsequent routers which process your domains, they will operate on
36981 local parts with the correct case in a case-sensitive manner.
36982
36983
36984
36985 .section "Dots in local parts" "SECID231"
36986 .cindex "dot" "in local part"
36987 .cindex "local part" "dots in"
36988 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36989 part may not begin or end with a dot, nor have two consecutive dots in the
36990 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36991 empty components for compatibility.
36992
36993
36994
36995 .section "Rewriting addresses" "SECID232"
36996 .cindex "rewriting" "addresses"
36997 Rewriting of sender and recipient addresses, and addresses in headers, can
36998 happen automatically, or as the result of configuration options, as described
36999 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
37000 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
37001
37002 Automatic rewriting includes qualification, as mentioned above. The other case
37003 in which it can happen is when an incomplete non-local domain is given. The
37004 routing process may cause this to be expanded into the full domain name. For
37005 example, a header such as
37006 .code
37007 To: hare@teaparty
37008 .endd
37009 might get rewritten as
37010 .code
37011 To: hare@teaparty.wonderland.fict.example
37012 .endd
37013 Rewriting as a result of routing is the one kind of message processing that
37014 does not happen at input time, as it cannot be done until the address has
37015 been routed.
37016
37017 Strictly, one should not do &'any'& deliveries of a message until all its
37018 addresses have been routed, in case any of the headers get changed as a
37019 result of routing. However, doing this in practice would hold up many
37020 deliveries for unreasonable amounts of time, just because one address could not
37021 immediately be routed. Exim therefore does not delay other deliveries when
37022 routing of one or more addresses is deferred.
37023 .ecindex IIDmesproc
37024
37025
37026
37027 . ////////////////////////////////////////////////////////////////////////////
37028 . ////////////////////////////////////////////////////////////////////////////
37029
37030 .chapter "SMTP processing" "CHAPSMTP"
37031 .scindex IIDsmtpproc1 "SMTP" "processing details"
37032 .scindex IIDsmtpproc2 "LMTP" "processing details"
37033 Exim supports a number of different ways of using the SMTP protocol, and its
37034 LMTP variant, which is an interactive protocol for transferring messages into a
37035 closed mail store application. This chapter contains details of how SMTP is
37036 processed. For incoming mail, the following are available:
37037
37038 .ilist
37039 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37040 .next
37041 SMTP over the standard input and output (the &%-bs%& option);
37042 .next
37043 Batched SMTP on the standard input (the &%-bS%& option).
37044 .endlist
37045
37046 For mail delivery, the following are available:
37047
37048 .ilist
37049 SMTP over TCP/IP (the &(smtp)& transport);
37050 .next
37051 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37052 &"lmtp"&);
37053 .next
37054 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37055 transport);
37056 .next
37057 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37058 the &%use_bsmtp%& option set).
37059 .endlist
37060
37061 &'Batched SMTP'& is the name for a process in which batches of messages are
37062 stored in or read from files (or pipes), in a format in which SMTP commands are
37063 used to contain the envelope information.
37064
37065
37066
37067 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37068 .cindex "SMTP" "outgoing over TCP/IP"
37069 .cindex "outgoing SMTP over TCP/IP"
37070 .cindex "LMTP" "over TCP/IP"
37071 .cindex "outgoing LMTP over TCP/IP"
37072 .cindex "EHLO"
37073 .cindex "HELO"
37074 .cindex "SIZE" "option on MAIL command"
37075 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37076 The &%protocol%& option selects which protocol is to be used, but the actual
37077 processing is the same in both cases.
37078
37079 .cindex "ESMTP extensions" SIZE
37080 If, in response to its EHLO command, Exim is told that the SIZE
37081 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37082 command. The value of <&'n'&> is the message size plus the value of the
37083 &%size_addition%& option (default 1024) to allow for additions to the message
37084 such as per-transport header lines, or changes made in a
37085 .cindex "transport" "filter"
37086 .cindex "filter" "transport filter"
37087 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37088 suppressed.
37089
37090 If the remote server advertises support for PIPELINING, Exim uses the
37091 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37092 required for the transaction.
37093
37094 If the remote server advertises support for the STARTTLS command, and Exim
37095 was built to support TLS encryption, it tries to start a TLS session unless the
37096 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37097 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37098 is called for verification.
37099
37100 If the remote server advertises support for the AUTH command, Exim scans
37101 the authenticators configuration for any suitable client settings, as described
37102 in chapter &<<CHAPSMTPAUTH>>&.
37103
37104 .cindex "carriage return"
37105 .cindex "linefeed"
37106 Responses from the remote host are supposed to be terminated by CR followed by
37107 LF. However, there are known to be hosts that do not send CR characters, so in
37108 order to be able to interwork with such hosts, Exim treats LF on its own as a
37109 line terminator.
37110
37111 If a message contains a number of different addresses, all those with the same
37112 characteristics (for example, the same envelope sender) that resolve to the
37113 same set of hosts, in the same order, are sent in a single SMTP transaction,
37114 even if they are for different domains, unless there are more than the setting
37115 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37116 they are split into groups containing no more than &%max_rcpt%&s addresses
37117 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37118 in parallel sessions. The order of hosts with identical MX values is not
37119 significant when checking whether addresses can be batched in this way.
37120
37121 When the &(smtp)& transport suffers a temporary failure that is not
37122 message-related, Exim updates its transport-specific database, which contains
37123 records indexed by host name that remember which messages are waiting for each
37124 particular host. It also updates the retry database with new retry times.
37125
37126 .cindex "hints database" "retry keys"
37127 Exim's retry hints are based on host name plus IP address, so if one address of
37128 a multi-homed host is broken, it will soon be skipped most of the time.
37129 See the next section for more detail about error handling.
37130
37131 .cindex "SMTP" "passed connection"
37132 .cindex "SMTP" "batching over TCP/IP"
37133 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37134 looks in the hints database for the transport to see if there are any queued
37135 messages waiting for the host to which it is connected. If it finds one, it
37136 creates a new Exim process using the &%-MC%& option (which can only be used by
37137 a process running as root or the Exim user) and passes the TCP/IP socket to it
37138 so that it can deliver another message using the same socket. The new process
37139 does only those deliveries that are routed to the connected host, and may in
37140 turn pass the socket on to a third process, and so on.
37141
37142 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37143 limit the number of messages sent down a single TCP/IP connection.
37144
37145 .cindex "asterisk" "after IP address"
37146 The second and subsequent messages delivered down an existing connection are
37147 identified in the main log by the addition of an asterisk after the closing
37148 square bracket of the IP address.
37149
37150
37151
37152
37153 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37154 .cindex "error" "in outgoing SMTP"
37155 .cindex "SMTP" "errors in outgoing"
37156 .cindex "host" "error"
37157 Three different kinds of error are recognized for outgoing SMTP: host errors,
37158 message errors, and recipient errors.
37159
37160 .vlist
37161 .vitem "&*Host errors*&"
37162 A host error is not associated with a particular message or with a
37163 particular recipient of a message. The host errors are:
37164
37165 .ilist
37166 Connection refused or timed out,
37167 .next
37168 Any error response code on connection,
37169 .next
37170 Any error response code to EHLO or HELO,
37171 .next
37172 Loss of connection at any time, except after &"."&,
37173 .next
37174 I/O errors at any time,
37175 .next
37176 Timeouts during the session, other than in response to MAIL, RCPT or
37177 the &"."& at the end of the data.
37178 .endlist ilist
37179
37180 For a host error, a permanent error response on connection, or in response to
37181 EHLO, causes all addresses routed to the host to be failed. Any other host
37182 error causes all addresses to be deferred, and retry data to be created for the
37183 host. It is not tried again, for any message, until its retry time arrives. If
37184 the current set of addresses are not all delivered in this run (to some
37185 alternative host), the message is added to the list of those waiting for this
37186 host, so if it is still undelivered when a subsequent successful delivery is
37187 made to the host, it will be sent down the same SMTP connection.
37188
37189 .vitem "&*Message errors*&"
37190 .cindex "message" "error"
37191 A message error is associated with a particular message when sent to a
37192 particular host, but not with a particular recipient of the message. The
37193 message errors are:
37194
37195 .ilist
37196 Any error response code to MAIL, DATA, or the &"."& that terminates
37197 the data,
37198 .next
37199 Timeout after MAIL,
37200 .next
37201 Timeout or loss of connection after the &"."& that terminates the data. A
37202 timeout after the DATA command itself is treated as a host error, as is loss of
37203 connection at any other time.
37204 .endlist ilist
37205
37206 For a message error, a permanent error response (5&'xx'&) causes all addresses
37207 to be failed, and a delivery error report to be returned to the sender. A
37208 temporary error response (4&'xx'&), or one of the timeouts, causes all
37209 addresses to be deferred. Retry data is not created for the host, but instead,
37210 a retry record for the combination of host plus message id is created. The
37211 message is not added to the list of those waiting for this host. This ensures
37212 that the failing message will not be sent to this host again until the retry
37213 time arrives. However, other messages that are routed to the host are not
37214 affected, so if it is some property of the message that is causing the error,
37215 it will not stop the delivery of other mail.
37216
37217 If the remote host specified support for the SIZE parameter in its response
37218 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37219 over-large message will cause a message error because the error arrives as a
37220 response to MAIL.
37221
37222 .vitem "&*Recipient errors*&"
37223 .cindex "recipient" "error"
37224 A recipient error is associated with a particular recipient of a message. The
37225 recipient errors are:
37226
37227 .ilist
37228 Any error response to RCPT,
37229 .next
37230 Timeout after RCPT.
37231 .endlist
37232
37233 For a recipient error, a permanent error response (5&'xx'&) causes the
37234 recipient address to be failed, and a bounce message to be returned to the
37235 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37236 address to be deferred, and routing retry data to be created for it. This is
37237 used to delay processing of the address in subsequent queue runs, until its
37238 routing retry time arrives. This applies to all messages, but because it
37239 operates only in queue runs, one attempt will be made to deliver a new message
37240 to the failing address before the delay starts to operate. This ensures that,
37241 if the failure is really related to the message rather than the recipient
37242 (&"message too big for this recipient"& is a possible example), other messages
37243 have a chance of getting delivered. If a delivery to the address does succeed,
37244 the retry information gets cleared, so all stuck messages get tried again, and
37245 the retry clock is reset.
37246
37247 The message is not added to the list of those waiting for this host. Use of the
37248 host for other messages is unaffected, and except in the case of a timeout,
37249 other recipients are processed independently, and may be successfully delivered
37250 in the current SMTP session. After a timeout it is of course impossible to
37251 proceed with the session, so all addresses get deferred. However, those other
37252 than the one that failed do not suffer any subsequent retry delays. Therefore,
37253 if one recipient is causing trouble, the others have a chance of getting
37254 through when a subsequent delivery attempt occurs before the failing
37255 recipient's retry time.
37256 .endlist
37257
37258 In all cases, if there are other hosts (or IP addresses) available for the
37259 current set of addresses (for example, from multiple MX records), they are
37260 tried in this run for any undelivered addresses, subject of course to their
37261 own retry data. In other words, recipient error retry data does not take effect
37262 until the next delivery attempt.
37263
37264 Some hosts have been observed to give temporary error responses to every
37265 MAIL command at certain times (&"insufficient space"& has been seen). It
37266 would be nice if such circumstances could be recognized, and defer data for the
37267 host itself created, but this is not possible within the current Exim design.
37268 What actually happens is that retry data for every (host, message) combination
37269 is created.
37270
37271 The reason that timeouts after MAIL and RCPT are treated specially is that
37272 these can sometimes arise as a result of the remote host's verification
37273 procedures. Exim makes this assumption, and treats them as if a temporary error
37274 response had been received. A timeout after &"."& is treated specially because
37275 it is known that some broken implementations fail to recognize the end of the
37276 message if the last character of the last line is a binary zero. Thus, it is
37277 helpful to treat this case as a message error.
37278
37279 Timeouts at other times are treated as host errors, assuming a problem with the
37280 host, or the connection to it. If a timeout after MAIL, RCPT,
37281 or &"."& is really a connection problem, the assumption is that at the next try
37282 the timeout is likely to occur at some other point in the dialogue, causing it
37283 then to be treated as a host error.
37284
37285 There is experimental evidence that some MTAs drop the connection after the
37286 terminating &"."& if they do not like the contents of the message for some
37287 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37288 should be given. That is why Exim treats this case as a message rather than a
37289 host error, in order not to delay other messages to the same host.
37290
37291
37292
37293
37294 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37295 .cindex "SMTP" "incoming over TCP/IP"
37296 .cindex "incoming SMTP over TCP/IP"
37297 .cindex "inetd"
37298 .cindex "daemon"
37299 Incoming SMTP messages can be accepted in one of two ways: by running a
37300 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37301 &_/etc/inetd.conf_& should be like this:
37302 .code
37303 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37304 .endd
37305 Exim distinguishes between this case and the case of a locally running user
37306 agent using the &%-bs%& option by checking whether or not the standard input is
37307 a socket. When it is, either the port must be privileged (less than 1024), or
37308 the caller must be root or the Exim user. If any other user passes a socket
37309 with an unprivileged port number, Exim prints a message on the standard error
37310 stream and exits with an error code.
37311
37312 By default, Exim does not make a log entry when a remote host connects or
37313 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37314 unexpected. It can be made to write such log entries by setting the
37315 &%smtp_connection%& log selector.
37316
37317 .cindex "carriage return"
37318 .cindex "linefeed"
37319 Commands from the remote host are supposed to be terminated by CR followed by
37320 LF. However, there are known to be hosts that do not send CR characters. In
37321 order to be able to interwork with such hosts, Exim treats LF on its own as a
37322 line terminator.
37323 Furthermore, because common code is used for receiving messages from all
37324 sources, a CR on its own is also interpreted as a line terminator. However, the
37325 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37326
37327 .cindex "EHLO" "invalid data"
37328 .cindex "HELO" "invalid data"
37329 One area that sometimes gives rise to problems concerns the EHLO or
37330 HELO commands. Some clients send syntactically invalid versions of these
37331 commands, which Exim rejects by default. (This is nothing to do with verifying
37332 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37333 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37334 match the broken hosts that send invalid commands.
37335
37336 .cindex "SIZE option on MAIL command"
37337 .cindex "MAIL" "SIZE option"
37338 The amount of disk space available is checked whenever SIZE is received on
37339 a MAIL command, independently of whether &%message_size_limit%& or
37340 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37341 false. A temporary error is given if there is not enough space. If
37342 &%check_spool_space%& is set, the check is for that amount of space plus the
37343 value given with SIZE, that is, it checks that the addition of the incoming
37344 message will not reduce the space below the threshold.
37345
37346 When a message is successfully received, Exim includes the local message id in
37347 its response to the final &"."& that terminates the data. If the remote host
37348 logs this text it can help with tracing what has happened to a message.
37349
37350 The Exim daemon can limit the number of simultaneous incoming connections it is
37351 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37352 number of simultaneous incoming connections from a single remote host (see the
37353 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37354 rejected using the SMTP temporary error code 421.
37355
37356 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37357 subprocess has finished, as this can get lost at busy times. Instead, it looks
37358 for completed subprocesses every time it wakes up. Provided there are other
37359 things happening (new incoming calls, starts of queue runs), completed
37360 processes will be noticed and tidied away. On very quiet systems you may
37361 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37362 it will be noticed when the daemon next wakes up.
37363
37364 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37365 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37366 high system load &-- for details see the &%smtp_accept_reserve%&,
37367 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37368 applies in both the daemon and &'inetd'& cases.
37369
37370 Exim normally starts a delivery process for each message received, though this
37371 can be varied by means of the &%-odq%& command line option and the
37372 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37373 number of simultaneously running delivery processes started in this way from
37374 SMTP input can be limited by the &%smtp_accept_queue%& and
37375 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37376 subsequently received messages are just put on the input queue without starting
37377 a delivery process.
37378
37379 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37380 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37381 started up from the &'inetd'& daemon, because in that case each connection is
37382 handled by an entirely independent Exim process. Control by load average is,
37383 however, available with &'inetd'&.
37384
37385 Exim can be configured to verify addresses in incoming SMTP commands as they
37386 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37387 to rewrite addresses at this time &-- before any syntax checking is done. See
37388 section &<<SSECTrewriteS>>&.
37389
37390 Exim can also be configured to limit the rate at which a client host submits
37391 MAIL and RCPT commands in a single SMTP session. See the
37392 &%smtp_ratelimit_hosts%& option.
37393
37394
37395
37396 .subsection "Unrecognized SMTP commands" SECID234
37397 .cindex "SMTP" "unrecognized commands"
37398 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37399 commands during a single SMTP connection, it drops the connection after sending
37400 the error response to the last command. The default value for
37401 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37402 abuse that subvert web servers into making connections to SMTP ports; in these
37403 circumstances, a number of non-SMTP lines are sent first.
37404
37405
37406 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37407 .cindex "SMTP" "syntax errors"
37408 .cindex "SMTP" "protocol errors"
37409 A syntax error is detected if an SMTP command is recognized, but there is
37410 something syntactically wrong with its data, for example, a malformed email
37411 address in a RCPT command. Protocol errors include invalid command
37412 sequencing such as RCPT before MAIL. If Exim receives more than
37413 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37414 drops the connection after sending the error response to the last command. The
37415 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37416 broken clients that loop sending bad commands (yes, it has been seen).
37417
37418
37419
37420 .subsection "Use of non-mail SMTP commands" SECID236
37421 .cindex "SMTP" "non-mail commands"
37422 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37423 DATA. Exim counts such commands, and drops the connection if there are too
37424 many of them in a single SMTP session. This action catches some
37425 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37426 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37427 defines what &"too many"& means. Its default value is 10.
37428
37429 When a new message is expected, one occurrence of RSET is not counted. This
37430 allows a client to send one RSET between messages (this is not necessary,
37431 but some clients do it). Exim also allows one uncounted occurrence of HELO
37432 or EHLO, and one occurrence of STARTTLS between messages. After
37433 starting up a TLS session, another EHLO is expected, and so it too is not
37434 counted.
37435
37436 The first occurrence of AUTH in a connection, or immediately following
37437 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37438 RCPT, DATA, and QUIT are counted.
37439
37440 You can control which hosts are subject to the limit set by
37441 &%smtp_accept_max_nonmail%& by setting
37442 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37443 the limit apply to all hosts. This option means that you can exclude any
37444 specific badly-behaved hosts that you have to live with.
37445
37446
37447
37448
37449 .subsection "The VRFY and EXPN commands" SECID237
37450 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37451 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37452 appropriate) in order to decide whether the command should be accepted or not.
37453
37454 .cindex "VRFY" "processing"
37455 When no ACL is defined for VRFY, or if it rejects without
37456 setting an explicit response code, the command is accepted
37457 (with a 252 SMTP response code)
37458 in order to support awkward clients that do a VRFY before every RCPT.
37459 When VRFY is accepted, it runs exactly the same code as when Exim is
37460 called with the &%-bv%& option, and returns 250/451/550
37461 SMTP response codes.
37462
37463 .cindex "EXPN" "processing"
37464 If no ACL for EXPN is defined, the command is rejected.
37465 When EXPN is accepted, a single-level expansion of the address is done.
37466 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37467 than a verification (the &%-bv%& option). If an unqualified local part is given
37468 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37469 of VRFY and EXPN commands are logged on the main and reject logs, and
37470 VRFY verification failures are logged in the main log for consistency with
37471 RCPT failures.
37472
37473
37474
37475 .subsection "The ETRN command" SECTETRN
37476 .cindex "ETRN" "processing"
37477 .cindex "ESMTP extensions" ETRN
37478 RFC 1985 describes an ESMTP command called ETRN that is designed to
37479 overcome the security problems of the TURN command (which has fallen into
37480 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37481 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37482 should be accepted or not. If no ACL is defined, the command is rejected.
37483
37484 The ETRN command is concerned with &"releasing"& messages that are awaiting
37485 delivery to certain hosts. As Exim does not organize its message queue by host,
37486 the only form of ETRN that is supported by default is the one where the
37487 text starts with the &"#"& prefix, in which case the remainder of the text is
37488 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37489 the &%-R%& option to happen, with the remainder of the ETRN text as its
37490 argument. For example,
37491 .code
37492 ETRN #brigadoon
37493 .endd
37494 runs the command
37495 .code
37496 exim -R brigadoon
37497 .endd
37498 which causes a delivery attempt on all messages with undelivered addresses
37499 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37500 default), Exim prevents the simultaneous execution of more than one queue run
37501 for the same argument string as a result of an ETRN command. This stops
37502 a misbehaving client from starting more than one queue runner at once.
37503
37504 .cindex "hints database" "ETRN serialization"
37505 Exim implements the serialization by means of a hints database in which a
37506 record is written whenever a process is started by ETRN, and deleted when
37507 the process completes. However, Exim does not keep the SMTP session waiting for
37508 the ETRN process to complete. Once ETRN is accepted, the client is sent
37509 a &"success"& return code. Obviously there is scope for hints records to get
37510 left lying around if there is a system or program crash. To guard against this,
37511 Exim ignores any records that are more than six hours old.
37512
37513 .oindex "&%smtp_etrn_command%&"
37514 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37515 used. This specifies a command that is run whenever ETRN is received,
37516 whatever the form of its argument. For
37517 example:
37518 .code
37519 smtp_etrn_command = /etc/etrn_command $domain \
37520                     $sender_host_address
37521 .endd
37522 .vindex "&$domain$&"
37523 The string is split up into arguments which are independently expanded. The
37524 expansion variable &$domain$& is set to the argument of the ETRN command,
37525 and no syntax checking is done on the contents of this argument. Exim does not
37526 wait for the command to complete, so its status code is not checked. Exim runs
37527 under its own uid and gid when receiving incoming SMTP, so it is not possible
37528 for it to change them before running the command.
37529
37530
37531
37532 .section "Incoming local SMTP" "SECID238"
37533 .cindex "SMTP" "local incoming"
37534 Some user agents use SMTP to pass messages to their local MTA using the
37535 standard input and output, as opposed to passing the envelope on the command
37536 line and writing the message to the standard input. This is supported by the
37537 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37538 messages over TCP/IP (including the use of ACLs), except that the envelope
37539 sender given in a MAIL command is ignored unless the caller is trusted. In
37540 an ACL you can detect this form of SMTP input by testing for an empty host
37541 identification. It is common to have this as the first line in the ACL that
37542 runs for RCPT commands:
37543 .code
37544 accept hosts = :
37545 .endd
37546 This accepts SMTP messages from local processes without doing any other tests.
37547
37548
37549
37550 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37551 .cindex "SMTP" "batched outgoing"
37552 .cindex "batched SMTP output"
37553 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37554 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37555 be output in BSMTP format. No SMTP responses are possible for this form of
37556 delivery. All it is doing is using SMTP commands as a way of transmitting the
37557 envelope along with the message.
37558
37559 The message is written to the file or pipe preceded by the SMTP commands
37560 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37561 the message that start with a dot have an extra dot added. The SMTP command
37562 HELO is not normally used. If it is required, the &%message_prefix%& option
37563 can be used to specify it.
37564
37565 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37566 one recipient address at a time by default. However, you can arrange for them
37567 to handle several addresses at once by setting the &%batch_max%& option. When
37568 this is done for BSMTP, messages may contain multiple RCPT commands. See
37569 chapter &<<CHAPbatching>>& for more details.
37570
37571 .vindex "&$host$&"
37572 When one or more addresses are routed to a BSMTP transport by a router that
37573 sets up a host list, the name of the first host on the list is available to the
37574 transport in the variable &$host$&. Here is an example of such a transport and
37575 router:
37576 .code
37577 begin routers
37578 route_append:
37579   driver = manualroute
37580   transport = smtp_appendfile
37581   route_list = domain.example  batch.host.example
37582
37583 begin transports
37584 smtp_appendfile:
37585   driver = appendfile
37586   directory = /var/bsmtp/$host
37587   batch_max = 1000
37588   use_bsmtp
37589   user = exim
37590 .endd
37591 This causes messages addressed to &'domain.example'& to be written in BSMTP
37592 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37593 message (unless there are more than 1000 recipients).
37594
37595
37596
37597 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37598 .cindex "SMTP" "batched incoming"
37599 .cindex "batched SMTP input"
37600 The &%-bS%& command line option causes Exim to accept one or more messages by
37601 reading SMTP on the standard input, but to generate no responses. If the caller
37602 is trusted, the senders in the MAIL commands are believed; otherwise the
37603 sender is always the caller of Exim. Unqualified senders and receivers are not
37604 rejected (there seems little point) but instead just get qualified. HELO
37605 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37606 as NOOP; QUIT quits.
37607
37608 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37609 ACL is run in the same way as for non-SMTP local input.
37610
37611 If an error is detected while reading a message, including a missing &"."& at
37612 the end, Exim gives up immediately. It writes details of the error to the
37613 standard output in a stylized way that the calling program should be able to
37614 make some use of automatically, for example:
37615 .code
37616 554 Unexpected end of file
37617 Transaction started in line 10
37618 Error detected in line 14
37619 .endd
37620 It writes a more verbose version, for human consumption, to the standard error
37621 file, for example:
37622 .code
37623 An error was detected while processing a file of BSMTP input.
37624 The error message was:
37625
37626 501 '>' missing at end of address
37627
37628 The SMTP transaction started in line 10.
37629 The error was detected in line 12.
37630 The SMTP command at fault was:
37631
37632 rcpt to:<malformed@in.com.plete
37633
37634 1 previous message was successfully processed.
37635 The rest of the batch was abandoned.
37636 .endd
37637 The return code from Exim is zero only if there were no errors. It is 1 if some
37638 messages were accepted before an error was detected, and 2 if no messages were
37639 accepted.
37640 .ecindex IIDsmtpproc1
37641 .ecindex IIDsmtpproc2
37642
37643
37644
37645 . ////////////////////////////////////////////////////////////////////////////
37646 . ////////////////////////////////////////////////////////////////////////////
37647
37648 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37649          "Customizing messages"
37650 When a message fails to be delivered, or remains in the queue for more than a
37651 configured amount of time, Exim sends a message to the original sender, or
37652 to an alternative configured address. The text of these messages is built into
37653 the code of Exim, but it is possible to change it, either by adding a single
37654 string, or by replacing each of the paragraphs by text supplied in a file.
37655
37656 The &'From:'& and &'To:'& header lines are automatically generated; you can
37657 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37658 option. Exim also adds the line
37659 .code
37660 Auto-Submitted: auto-generated
37661 .endd
37662 to all warning and bounce messages,
37663
37664
37665 .section "Customizing bounce messages" "SECID239"
37666 .cindex "customizing" "bounce message"
37667 .cindex "bounce message" "customizing"
37668 If &%bounce_message_text%& is set, its contents are included in the default
37669 message immediately after &"This message was created automatically by mail
37670 delivery software."& The string is not expanded. It is not used if
37671 &%bounce_message_file%& is set.
37672
37673 When &%bounce_message_file%& is set, it must point to a template file for
37674 constructing error messages. The file consists of a series of text items,
37675 separated by lines consisting of exactly four asterisks. If the file cannot be
37676 opened, default text is used and a message is written to the main and panic
37677 logs. If any text item in the file is empty, default text is used for that
37678 item.
37679
37680 .vindex "&$bounce_recipient$&"
37681 .vindex "&$bounce_return_size_limit$&"
37682 Each item of text that is read from the file is expanded, and there are two
37683 expansion variables which can be of use here: &$bounce_recipient$& is set to
37684 the recipient of an error message while it is being created, and
37685 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37686 option, rounded to a whole number.
37687
37688 The items must appear in the file in the following order:
37689
37690 .ilist
37691 The first item is included in the headers, and should include at least a
37692 &'Subject:'& header. Exim does not check the syntax of these headers.
37693 .next
37694 The second item forms the start of the error message. After it, Exim lists the
37695 failing addresses with their error messages.
37696 .next
37697 The third item is used to introduce any text from pipe transports that is to be
37698 returned to the sender. It is omitted if there is no such text.
37699 .next
37700 The fourth, fifth and sixth items will be ignored and may be empty.
37701 The fields exist for back-compatibility
37702 .endlist
37703
37704 The default state (&%bounce_message_file%& unset) is equivalent to the
37705 following file, in which the sixth item is empty. The &'Subject:'& and some
37706 other lines have been split in order to fit them on the page:
37707 .code
37708 Subject: Mail delivery failed
37709   ${if eq{$sender_address}{$bounce_recipient}
37710   {: returning message to sender}}
37711 ****
37712 This message was created automatically by mail delivery software.
37713
37714 A message ${if eq{$sender_address}{$bounce_recipient}
37715   {that you sent }{sent by
37716
37717 <$sender_address>
37718
37719 }}could not be delivered to all of its recipients.
37720 This is a permanent error. The following address(es) failed:
37721 ****
37722 The following text was generated during the delivery attempt(s):
37723 ****
37724 ------ This is a copy of the message, including all the headers.
37725   ------
37726 ****
37727 ------ The body of the message is $message_size characters long;
37728   only the first
37729 ------ $bounce_return_size_limit or so are included here.
37730 ****
37731 .endd
37732 .section "Customizing warning messages" "SECTcustwarn"
37733 .cindex "customizing" "warning message"
37734 .cindex "warning of delay" "customizing the message"
37735 The option &%warn_message_file%& can be pointed at a template file for use when
37736 warnings about message delays are created. In this case there are only three
37737 text sections:
37738
37739 .ilist
37740 The first item is included in the headers, and should include at least a
37741 &'Subject:'& header. Exim does not check the syntax of these headers.
37742 .next
37743 The second item forms the start of the warning message. After it, Exim lists
37744 the delayed addresses.
37745 .next
37746 The third item then ends the message.
37747 .endlist
37748
37749 The default state is equivalent to the following file, except that some lines
37750 have been split here, in order to fit them on the page:
37751 .code
37752 Subject: Warning: message $message_exim_id delayed
37753   $warn_message_delay
37754 ****
37755 This message was created automatically by mail delivery software.
37756
37757 A message ${if eq{$sender_address}{$warn_message_recipients}
37758 {that you sent }{sent by
37759
37760 <$sender_address>
37761
37762 }}has not been delivered to all of its recipients after
37763 more than $warn_message_delay in the queue on $primary_hostname.
37764
37765 The message identifier is:     $message_exim_id
37766 The subject of the message is: $h_subject
37767 The date of the message is:    $h_date
37768
37769 The following address(es) have not yet been delivered:
37770 ****
37771 No action is required on your part. Delivery attempts will
37772 continue for some time, and this warning may be repeated at
37773 intervals if the message remains undelivered. Eventually the
37774 mail delivery software will give up, and when that happens,
37775 the message will be returned to you.
37776 .endd
37777 .vindex "&$warn_message_delay$&"
37778 .vindex "&$warn_message_recipients$&"
37779 However, in the default state the subject and date lines are omitted if no
37780 appropriate headers exist. During the expansion of this file,
37781 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37782 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37783 of recipients for the warning message. There may be more than one if there are
37784 multiple addresses with different &%errors_to%& settings on the routers that
37785 handled them.
37786
37787
37788
37789
37790 . ////////////////////////////////////////////////////////////////////////////
37791 . ////////////////////////////////////////////////////////////////////////////
37792
37793 .chapter "Some common configuration settings" "CHAPcomconreq"
37794 This chapter discusses some configuration settings that seem to be fairly
37795 common. More examples and discussion can be found in the Exim book.
37796
37797
37798
37799 .section "Sending mail to a smart host" "SECID240"
37800 .cindex "smart host" "example router"
37801 If you want to send all mail for non-local domains to a &"smart host"&, you
37802 should replace the default &(dnslookup)& router with a router which does the
37803 routing explicitly:
37804 .code
37805 send_to_smart_host:
37806   driver = manualroute
37807   route_list = !+local_domains smart.host.name
37808   transport = remote_smtp
37809 .endd
37810 You can use the smart host's IP address instead of the name if you wish.
37811 If you are using Exim only to submit messages to a smart host, and not for
37812 receiving incoming messages, you can arrange for it to do the submission
37813 synchronously by setting the &%mua_wrapper%& option (see chapter
37814 &<<CHAPnonqueueing>>&).
37815
37816
37817
37818
37819 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37820 .cindex "mailing lists"
37821 Exim can be used to run simple mailing lists, but for large and/or complicated
37822 requirements, the use of additional specialized mailing list software such as
37823 Majordomo or Mailman is recommended.
37824
37825 The &(redirect)& router can be used to handle mailing lists where each list
37826 is maintained in a separate file, which can therefore be managed by an
37827 independent manager. The &%domains%& router option can be used to run these
37828 lists in a separate domain from normal mail. For example:
37829 .code
37830 lists:
37831   driver = redirect
37832   domains = lists.example
37833   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37834   forbid_pipe
37835   forbid_file
37836   errors_to = ${quote_local_part:$local_part-request}@lists.example
37837   no_more
37838 .endd
37839 This router is skipped for domains other than &'lists.example'&. For addresses
37840 in that domain, it looks for a file that matches the local part. If there is no
37841 such file, the router declines, but because &%no_more%& is set, no subsequent
37842 routers are tried, and so the whole delivery fails.
37843
37844 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37845 expanded into a filename or a pipe delivery, which is usually inappropriate in
37846 a mailing list.
37847
37848 .oindex "&%errors_to%&"
37849 The &%errors_to%& option specifies that any delivery errors caused by addresses
37850 taken from a mailing list are to be sent to the given address rather than the
37851 original sender of the message. However, before acting on this, Exim verifies
37852 the error address, and ignores it if verification fails.
37853
37854 For example, using the configuration above, mail sent to
37855 &'dicts@lists.example'& is passed on to those addresses contained in
37856 &_/usr/lists/dicts_&, with error reports directed to
37857 &'dicts-request@lists.example'&, provided that this address can be verified.
37858 There could be a file called &_/usr/lists/dicts-request_& containing
37859 the address(es) of this particular list's manager(s), but other approaches,
37860 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37861 or &%local_part_suffix%& options) to handle addresses of the form
37862 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37863
37864
37865
37866 .section "Syntax errors in mailing lists" "SECID241"
37867 .cindex "mailing lists" "syntax errors in"
37868 If an entry in redirection data contains a syntax error, Exim normally defers
37869 delivery of the original address. That means that a syntax error in a mailing
37870 list holds up all deliveries to the list. This may not be appropriate when a
37871 list is being maintained automatically from data supplied by users, and the
37872 addresses are not rigorously checked.
37873
37874 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37875 entries that fail to parse, noting the incident in the log. If in addition
37876 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37877 whenever a broken address is skipped. It is usually appropriate to set
37878 &%syntax_errors_to%& to the same address as &%errors_to%&.
37879
37880
37881
37882 .section "Re-expansion of mailing lists" "SECID242"
37883 .cindex "mailing lists" "re-expansion of"
37884 Exim remembers every individual address to which a message has been delivered,
37885 in order to avoid duplication, but it normally stores only the original
37886 recipient addresses with a message. If all the deliveries to a mailing list
37887 cannot be done at the first attempt, the mailing list is re-expanded when the
37888 delivery is next tried. This means that alterations to the list are taken into
37889 account at each delivery attempt, so addresses that have been added to
37890 the list since the message arrived will therefore receive a copy of the
37891 message, even though it pre-dates their subscription.
37892
37893 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37894 on the &(redirect)& router. If this is done, any addresses generated by the
37895 router that fail to deliver at the first attempt are added to the message as
37896 &"top level"& addresses, and the parent address that generated them is marked
37897 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37898 subsequent delivery attempts. The disadvantage of this is that if any of the
37899 failing addresses are incorrect, correcting them in the file has no effect on
37900 pre-existing messages.
37901
37902 The original top-level address is remembered with each of the generated
37903 addresses, and is output in any log messages. However, any intermediate parent
37904 addresses are not recorded. This makes a difference to the log only if the
37905 &%all_parents%& selector is set, but for mailing lists there is normally only
37906 one level of expansion anyway.
37907
37908
37909
37910 .section "Closed mailing lists" "SECID243"
37911 .cindex "mailing lists" "closed"
37912 The examples so far have assumed open mailing lists, to which anybody may
37913 send mail. It is also possible to set up closed lists, where mail is accepted
37914 from specified senders only. This is done by making use of the generic
37915 &%senders%& option to restrict the router that handles the list.
37916
37917 The following example uses the same file as a list of recipients and as a list
37918 of permitted senders. It requires three routers:
37919 .code
37920 lists_request:
37921   driver = redirect
37922   domains = lists.example
37923   local_part_suffix = -request
37924   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37925   file = /usr/lists/${local_part_data}-request
37926   no_more
37927
37928 lists_post:
37929   driver = redirect
37930   domains = lists.example
37931   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37932   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37933   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37934   forbid_pipe
37935   forbid_file
37936   errors_to = ${quote_local_part:$local_part-request}@lists.example
37937   no_more
37938
37939 lists_closed:
37940   driver = redirect
37941   domains = lists.example
37942   allow_fail
37943   data = :fail: $local_part@lists.example is a closed mailing list
37944 .endd
37945 All three routers have the same &%domains%& setting, so for any other domains,
37946 they are all skipped. The first router runs only if the local part ends in
37947 &%-request%&. It handles messages to the list manager(s) by means of an open
37948 mailing list.
37949
37950 The second router runs only if the &%senders%& precondition is satisfied. It
37951 checks for the existence of a list that corresponds to the local part, and then
37952 checks that the sender is on the list by means of a linear search. It is
37953 necessary to check for the existence of the file before trying to search it,
37954 because otherwise Exim thinks there is a configuration error. If the file does
37955 not exist, the expansion of &%senders%& is *, which matches all senders. This
37956 means that the router runs, but because there is no list, declines, and
37957 &%no_more%& ensures that no further routers are run. The address fails with an
37958 &"unrouteable address"& error.
37959
37960 The third router runs only if the second router is skipped, which happens when
37961 a mailing list exists, but the sender is not on it. This router forcibly fails
37962 the address, giving a suitable error message.
37963
37964
37965
37966
37967 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37968 .cindex "VERP"
37969 .cindex "Variable Envelope Return Paths"
37970 .cindex "envelope from"
37971 .cindex "envelope sender"
37972 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37973 are a way of helping mailing list administrators discover which subscription
37974 address is the cause of a particular delivery failure. The idea is to encode
37975 the original recipient address in the outgoing envelope sender address, so that
37976 if the message is forwarded by another host and then subsequently bounces, the
37977 original recipient can be extracted from the recipient address of the bounce.
37978
37979 .oindex &%errors_to%&
37980 .oindex &%return_path%&
37981 Envelope sender addresses can be modified by Exim using two different
37982 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37983 list examples), or the &%return_path%& option on a transport. The second of
37984 these is effective only if the message is successfully delivered to another
37985 host; it is not used for errors detected on the local host (see the description
37986 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37987 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37988 .code
37989 verp_smtp:
37990   driver = smtp
37991   max_rcpt = 1
37992   return_path = \
37993     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37994       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37995 .endd
37996 This has the effect of rewriting the return path (envelope sender) on outgoing
37997 SMTP messages, if the local part of the original return path ends in
37998 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37999 local part and domain of the recipient into the return path. Suppose, for
38000 example, that a message whose return path has been set to
38001 &'somelist-request@your.dom.example'& is sent to
38002 &'subscriber@other.dom.example'&. In the transport, the return path is
38003 rewritten as
38004 .code
38005 somelist-request+subscriber=other.dom.example@your.dom.example
38006 .endd
38007 .vindex "&$local_part$&"
38008 For this to work, you must tell Exim to send multiple copies of messages that
38009 have more than one recipient, so that each copy has just one recipient. This is
38010 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38011 might be sent to several different recipients in the same domain, in which case
38012 &$local_part$& is not available in the transport, because it is not unique.
38013
38014 Unless your host is doing nothing but mailing list deliveries, you should
38015 probably use a separate transport for the VERP deliveries, so as not to use
38016 extra resources in making one-per-recipient copies for other deliveries. This
38017 can easily be done by expanding the &%transport%& option in the router:
38018 .code
38019 dnslookup:
38020   driver = dnslookup
38021   domains = ! +local_domains
38022   transport = \
38023     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38024       {verp_smtp}{remote_smtp}}
38025   no_more
38026 .endd
38027 If you want to change the return path using &%errors_to%& in a router instead
38028 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38029 routers that handle mailing list addresses. This will ensure that all delivery
38030 errors, including those detected on the local host, are sent to the VERP
38031 address.
38032
38033 On a host that does no local deliveries and has no manual routing, only the
38034 &(dnslookup)& router needs to be changed. A special transport is not needed for
38035 SMTP deliveries. Every mailing list recipient has its own return path value,
38036 and so Exim must hand them to the transport one at a time. Here is an example
38037 of a &(dnslookup)& router that implements VERP:
38038 .code
38039 verp_dnslookup:
38040   driver = dnslookup
38041   domains = ! +local_domains
38042   transport = remote_smtp
38043   errors_to = \
38044     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38045      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38046   no_more
38047 .endd
38048 Before you start sending out messages with VERPed return paths, you must also
38049 configure Exim to accept the bounce messages that come back to those paths.
38050 Typically this is done by setting a &%local_part_suffix%& option for a
38051 router, and using this to route the messages to wherever you want to handle
38052 them.
38053
38054 The overhead incurred in using VERP depends very much on the size of the
38055 message, the number of recipient addresses that resolve to the same remote
38056 host, and the speed of the connection over which the message is being sent. If
38057 a lot of addresses resolve to the same host and the connection is slow, sending
38058 a separate copy of the message for each address may take substantially longer
38059 than sending a single copy with many recipients (for which VERP cannot be
38060 used).
38061
38062
38063
38064
38065
38066
38067 .section "Virtual domains" "SECTvirtualdomains"
38068 .cindex "virtual domains"
38069 .cindex "domain" "virtual"
38070 The phrase &'virtual domain'& is unfortunately used with two rather different
38071 meanings:
38072
38073 .ilist
38074 A domain for which there are no real mailboxes; all valid local parts are
38075 aliases for other email addresses. Common examples are organizational
38076 top-level domains and &"vanity"& domains.
38077 .next
38078 One of a number of independent domains that are all handled by the same host,
38079 with mailboxes on that host, but where the mailbox owners do not necessarily
38080 have login accounts on that host.
38081 .endlist
38082
38083 The first usage is probably more common, and does seem more &"virtual"& than
38084 the second. This kind of domain can be handled in Exim with a straightforward
38085 aliasing router. One approach is to create a separate alias file for each
38086 virtual domain. Exim can test for the existence of the alias file to determine
38087 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38088 to a router of this form:
38089 .code
38090 virtual:
38091   driver = redirect
38092   domains = dsearch;/etc/mail/virtual
38093   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38094   no_more
38095 .endd
38096 The &%domains%& option specifies that the router is to be skipped, unless there
38097 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38098 domain that is being processed.
38099 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38100 being placed into the &$domain_data$& variable.
38101
38102 When the router runs, it looks up the local
38103 part in the file to find a new address (or list of addresses). The &%no_more%&
38104 setting ensures that if the lookup fails (leading to &%data%& being an empty
38105 string), Exim gives up on the address without trying any subsequent routers.
38106
38107 This one router can handle all the virtual domains because the alias filenames
38108 follow a fixed pattern. Permissions can be arranged so that appropriate people
38109 can edit the different alias files. A successful aliasing operation results in
38110 a new envelope recipient address, which is then routed from scratch.
38111
38112 The other kind of &"virtual"& domain can also be handled in a straightforward
38113 way. One approach is to create a file for each domain containing a list of
38114 valid local parts, and use it in a router like this:
38115 .code
38116 my_domains:
38117   driver = accept
38118   domains = dsearch;/etc/mail/domains
38119   local_parts = lsearch;/etc/mail/domains/$domain
38120   transport = my_mailboxes
38121 .endd
38122 The address is accepted if there is a file for the domain, and the local part
38123 can be found in the file. The &%domains%& option is used to check for the
38124 file's existence because &%domains%& is tested before the &%local_parts%&
38125 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38126 because that option is tested after &%local_parts%&. The transport is as
38127 follows:
38128 .code
38129 my_mailboxes:
38130   driver = appendfile
38131   file = /var/mail/$domain_data/$local_part_data
38132   user = mail
38133 .endd
38134 This uses a directory of mailboxes for each domain. The &%user%& setting is
38135 required, to specify which uid is to be used for writing to the mailboxes.
38136
38137 The configuration shown here is just one example of how you might support this
38138 requirement. There are many other ways this kind of configuration can be set
38139 up, for example, by using a database instead of separate files to hold all the
38140 information about the domains.
38141
38142
38143
38144 .section "Multiple user mailboxes" "SECTmulbox"
38145 .cindex "multiple mailboxes"
38146 .cindex "mailbox" "multiple"
38147 .cindex "local part" "prefix"
38148 .cindex "local part" "suffix"
38149 Heavy email users often want to operate with multiple mailboxes, into which
38150 incoming mail is automatically sorted. A popular way of handling this is to
38151 allow users to use multiple sender addresses, so that replies can easily be
38152 identified. Users are permitted to add prefixes or suffixes to their local
38153 parts for this purpose. The wildcard facility of the generic router options
38154 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38155 example, consider this router:
38156 .code
38157 userforward:
38158   driver = redirect
38159   check_local_user
38160   file = $home/.forward
38161   local_part_suffix = -*
38162   local_part_suffix_optional
38163   allow_filter
38164 .endd
38165 .vindex "&$local_part_suffix$&"
38166 It runs a user's &_.forward_& file for all local parts of the form
38167 &'username-*'&. Within the filter file the user can distinguish different
38168 cases by testing the variable &$local_part_suffix$&. For example:
38169 .code
38170 if $local_part_suffix contains -special then
38171 save /home/$local_part_data/Mail/special
38172 endif
38173 .endd
38174 If the filter file does not exist, or does not deal with such addresses, they
38175 fall through to subsequent routers, and, assuming no subsequent use of the
38176 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38177 control over which suffixes are valid.
38178
38179 Alternatively, a suffix can be used to trigger the use of a different
38180 &_.forward_& file &-- which is the way a similar facility is implemented in
38181 another MTA:
38182 .code
38183 userforward:
38184   driver = redirect
38185   check_local_user
38186   local_part_suffix = -*
38187   local_part_suffix_optional
38188   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38189   allow_filter
38190 .endd
38191 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38192 example, &_.forward-special_& is used. Once again, if the appropriate file
38193 does not exist, or does not deal with the address, it is passed on to
38194 subsequent routers, which could, if required, look for an unqualified
38195 &_.forward_& file to use as a default.
38196
38197
38198
38199 .section "Simplified vacation processing" "SECID244"
38200 .cindex "vacation processing"
38201 The traditional way of running the &'vacation'& program is for a user to set up
38202 a pipe command in a &_.forward_& file
38203 (see section &<<SECTspecitredli>>& for syntax details).
38204 This is prone to error by inexperienced users. There are two features of Exim
38205 that can be used to make this process simpler for users:
38206
38207 .ilist
38208 A local part prefix such as &"vacation-"& can be specified on a router which
38209 can cause the message to be delivered directly to the &'vacation'& program, or
38210 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38211 &_.forward_& file are then much simpler. For example:
38212 .code
38213 spqr, vacation-spqr
38214 .endd
38215 .next
38216 The &%require_files%& generic router option can be used to trigger a
38217 vacation delivery by checking for the existence of a certain file in the
38218 user's home directory. The &%unseen%& generic option should also be used, to
38219 ensure that the original delivery also proceeds. In this case, all the user has
38220 to do is to create a file called, say, &_.vacation_&, containing a vacation
38221 message.
38222 .endlist
38223
38224 Another advantage of both these methods is that they both work even when the
38225 use of arbitrary pipes by users is locked out.
38226
38227
38228
38229 .section "Taking copies of mail" "SECID245"
38230 .cindex "message" "copying every"
38231 Some installations have policies that require archive copies of all messages to
38232 be made. A single copy of each message can easily be taken by an appropriate
38233 command in a system filter, which could, for example, use a different file for
38234 each day's messages.
38235
38236 There is also a shadow transport mechanism that can be used to take copies of
38237 messages that are successfully delivered by local transports, one copy per
38238 delivery. This could be used, &'inter alia'&, to implement automatic
38239 notification of delivery by sites that insist on doing such things.
38240
38241
38242
38243 .section "Intermittently connected hosts" "SECID246"
38244 .cindex "intermittently connected hosts"
38245 It has become quite common (because it is cheaper) for hosts to connect to the
38246 Internet periodically rather than remain connected all the time. The normal
38247 arrangement is that mail for such hosts accumulates on a system that is
38248 permanently connected.
38249
38250 Exim was designed for use on permanently connected hosts, and so it is not
38251 particularly well-suited to use in an intermittently connected environment.
38252 Nevertheless there are some features that can be used.
38253
38254
38255 .section "Exim on the upstream server host" "SECID247"
38256 It is tempting to arrange for incoming mail for the intermittently connected
38257 host to remain in Exim's queue until the client connects. However, this
38258 approach does not scale very well. Two different kinds of waiting message are
38259 being mixed up in the same queue &-- those that cannot be delivered because of
38260 some temporary problem, and those that are waiting for their destination host
38261 to connect. This makes it hard to manage the queue, as well as wasting
38262 resources, because each queue runner scans the entire queue.
38263
38264 A better approach is to separate off those messages that are waiting for an
38265 intermittently connected host. This can be done by delivering these messages
38266 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38267 format, from where they are transmitted by other software when their
38268 destination connects. This makes it easy to collect all the mail for one host
38269 in a single directory, and to apply local timeout rules on a per-message basis
38270 if required.
38271
38272 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38273 you are doing this, you should configure Exim with a long retry period for the
38274 intermittent host. For example:
38275 .code
38276 cheshire.wonderland.fict.example    *   F,5d,24h
38277 .endd
38278 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38279 which messages it has queued up for that host. Once the intermittent host comes
38280 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38281 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38282 causes all the queued up messages to be delivered, often down a single SMTP
38283 connection. While the host remains connected, any new messages get delivered
38284 immediately.
38285
38286 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38287 issued with a different IP address each time it connects, Exim's retry
38288 mechanisms on the holding host get confused, because the IP address is normally
38289 used as part of the key string for holding retry information. This can be
38290 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38291 Since this has disadvantages for permanently connected hosts, it is best to
38292 arrange a separate transport for the intermittently connected ones.
38293
38294
38295
38296 .section "Exim on the intermittently connected client host" "SECID248"
38297 The value of &%smtp_accept_queue_per_connection%& should probably be
38298 increased, or even set to zero (that is, disabled) on the intermittently
38299 connected host, so that all incoming messages down a single connection get
38300 delivered immediately.
38301
38302 .cindex "SMTP" "passed connection"
38303 .cindex "SMTP" "multiple deliveries"
38304 .cindex "multiple SMTP deliveries"
38305 .cindex "first pass routing"
38306 Mail waiting to be sent from an intermittently connected host will probably
38307 not have been routed, because without a connection DNS lookups are not
38308 possible. This means that if a normal queue run is done at connection time,
38309 each message is likely to be sent in a separate SMTP session. This can be
38310 avoided by starting the queue run with a command line option beginning with
38311 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38312 first pass, routing is done but no deliveries take place. The second pass is a
38313 normal queue run; since all the messages have been previously routed, those
38314 destined for the same host are likely to get sent as multiple deliveries in a
38315 single SMTP connection.
38316
38317
38318
38319 . ////////////////////////////////////////////////////////////////////////////
38320 . ////////////////////////////////////////////////////////////////////////////
38321
38322 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38323          "Exim as a non-queueing client"
38324 .cindex "client, non-queueing"
38325 .cindex "smart host" "suppressing queueing"
38326 On a personal computer, it is a common requirement for all
38327 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38328 configured to operate that way, for all the popular operating systems.
38329 However, there are some MUAs for Unix-like systems that cannot be so
38330 configured: they submit messages using the command line interface of
38331 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38332 messages this way.
38333
38334 If the personal computer runs continuously, there is no problem, because it can
38335 run a conventional MTA that handles delivery to the smart host, and deal with
38336 any delays via its queueing mechanism. However, if the computer does not run
38337 continuously or runs different operating systems at different times, queueing
38338 email is not desirable.
38339
38340 There is therefore a requirement for something that can provide the
38341 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38342 any queueing or retrying facilities. Furthermore, the delivery to the smart
38343 host should be synchronous, so that if it fails, the sending MUA is immediately
38344 informed. In other words, we want something that extends an MUA that submits
38345 to a local MTA via the command line so that it behaves like one that submits
38346 to a remote smart host using TCP/SMTP.
38347
38348 There are a number of applications (for example, there is one called &'ssmtp'&)
38349 that do this job. However, people have found them to be lacking in various
38350 ways. For instance, you might want to allow aliasing and forwarding to be done
38351 before sending a message to the smart host.
38352
38353 Exim already had the necessary infrastructure for doing this job. Just a few
38354 tweaks were needed to make it behave as required, though it is somewhat of an
38355 overkill to use a fully-featured MTA for this purpose.
38356
38357 .oindex "&%mua_wrapper%&"
38358 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38359 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38360 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38361 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38362 compatible router and transport configuration. Typically there will be just one
38363 router and one transport, sending everything to a smart host.
38364
38365 When run in MUA wrapping mode, the behaviour of Exim changes in the
38366 following ways:
38367
38368 .ilist
38369 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38370 In other words, the only way to submit messages is via the command line.
38371 .next
38372 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38373 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38374 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38375 does not finish until the delivery attempt is complete. If the delivery is
38376 successful, a zero return code is given.
38377 .next
38378 Address redirection is permitted, but the final routing for all addresses must
38379 be to the same remote transport, and to the same list of hosts. Furthermore,
38380 the return address (envelope sender) must be the same for all recipients, as
38381 must any added or deleted header lines. In other words, it must be possible to
38382 deliver the message in a single SMTP transaction, however many recipients there
38383 are.
38384 .next
38385 If these conditions are not met, or if routing any address results in a
38386 failure or defer status, or if Exim is unable to deliver all the recipients
38387 successfully to one of the smart hosts, delivery of the entire message fails.
38388 .next
38389 Because no queueing is allowed, all failures are treated as permanent; there
38390 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38391 smart host. Furthermore, because only a single yes/no response can be given to
38392 the caller, it is not possible to deliver to some recipients and not others. If
38393 there is an error (temporary or permanent) for any recipient, all are failed.
38394 .next
38395 If more than one smart host is listed, Exim will try another host after a
38396 connection failure or a timeout, in the normal way. However, if this kind of
38397 failure happens for all the hosts, the delivery fails.
38398 .next
38399 When delivery fails, an error message is written to the standard error stream
38400 (as well as to Exim's log), and Exim exits to the caller with a return code
38401 value 1. The message is expunged from Exim's spool files. No bounce messages
38402 are ever generated.
38403 .next
38404 No retry data is maintained, and any retry rules are ignored.
38405 .next
38406 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38407 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38408 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38409 .endlist
38410
38411 The overall effect is that Exim makes a single synchronous attempt to deliver
38412 the message, failing if there is any kind of problem. Because no local
38413 deliveries are done and no daemon can be run, Exim does not need root
38414 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38415 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38416 the advantages and disadvantages of running without root privilege.
38417
38418
38419
38420
38421 . ////////////////////////////////////////////////////////////////////////////
38422 . ////////////////////////////////////////////////////////////////////////////
38423
38424 .chapter "Log files" "CHAPlog"
38425 .scindex IIDloggen "log" "general description"
38426 .cindex "log" "types of"
38427 Exim writes three different logs, referred to as the main log, the reject log,
38428 and the panic log:
38429
38430 .ilist
38431 .cindex "main log"
38432 The main log records the arrival of each message and each delivery in a single
38433 line in each case. The format is as compact as possible, in an attempt to keep
38434 down the size of log files. Two-character flag sequences make it easy to pick
38435 out these lines. A number of other events are recorded in the main log. Some of
38436 them are optional, in which case the &%log_selector%& option controls whether
38437 they are included or not. A Perl script called &'eximstats'&, which does simple
38438 analysis of main log files, is provided in the Exim distribution (see section
38439 &<<SECTmailstat>>&).
38440 .next
38441 .cindex "reject log"
38442 The reject log records information from messages that are rejected as a result
38443 of a configuration option (that is, for policy reasons).
38444 The first line of each rejection is a copy of the line that is also written to
38445 the main log. Then, if the message's header has been read at the time the log
38446 is written, its contents are written to this log. Only the original header
38447 lines are available; header lines added by ACLs are not logged. You can use the
38448 reject log to check that your policy controls are working correctly; on a busy
38449 host this may be easier than scanning the main log for rejection messages. You
38450 can suppress the writing of the reject log by setting &%write_rejectlog%&
38451 false.
38452 .next
38453 .cindex "panic log"
38454 .cindex "system log"
38455 When certain serious errors occur, Exim writes entries to its panic log. If the
38456 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38457 are usually written to the main log as well, but can get lost amid the mass of
38458 other entries. The panic log should be empty under normal circumstances. It is
38459 therefore a good idea to check it (or to have a &'cron'& script check it)
38460 regularly, in order to become aware of any problems. When Exim cannot open its
38461 panic log, it tries as a last resort to write to the system log (syslog). This
38462 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38463 message itself is written at priority LOG_CRIT.
38464 .endlist
38465
38466 Every log line starts with a timestamp, in the format shown in the following
38467 example. Note that many of the examples shown in this chapter are line-wrapped.
38468 In the log file, this would be all on one line:
38469 .code
38470 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38471   by QUIT
38472 .endd
38473 By default, the timestamps are in the local timezone. There are two
38474 ways of changing this:
38475
38476 .ilist
38477 You can set the &%timezone%& option to a different time zone; in particular, if
38478 you set
38479 .code
38480 timezone = UTC
38481 .endd
38482 the timestamps will be in UTC (aka GMT).
38483 .next
38484 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38485 example:
38486 .code
38487 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38488 .endd
38489 .endlist
38490
38491 .cindex "log" "process ids in"
38492 .cindex "pid (process id)" "in log lines"
38493 Exim does not include its process id in log lines by default, but you can
38494 request that it does so by specifying the &`pid`& log selector (see section
38495 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38496 brackets, immediately after the time and date.
38497
38498
38499
38500
38501 .section "Where the logs are written" "SECTwhelogwri"
38502 .cindex "log" "destination"
38503 .cindex "log" "to file"
38504 .cindex "log" "to syslog"
38505 .cindex "syslog"
38506 The logs may be written to local files, or to syslog, or both. However, it
38507 should be noted that many syslog implementations use UDP as a transport, and
38508 are therefore unreliable in the sense that messages are not guaranteed to
38509 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38510 It has also been reported that on large log files (tens of megabytes) you may
38511 need to tweak syslog to prevent it syncing the file with each write &-- on
38512 Linux this has been seen to make syslog take 90% plus of CPU time.
38513
38514 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38515 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38516 configuration. This latter string is expanded, so it can contain, for example,
38517 references to the host name:
38518 .code
38519 log_file_path = /var/log/$primary_hostname/exim_%slog
38520 .endd
38521 It is generally advisable, however, to set the string in &_Local/Makefile_&
38522 rather than at runtime, because then the setting is available right from the
38523 start of Exim's execution. Otherwise, if there's something it wants to log
38524 before it has read the configuration file (for example, an error in the
38525 configuration file) it will not use the path you want, and may not be able to
38526 log at all.
38527
38528 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38529 list, currently limited to at most two items. This is one option where the
38530 facility for changing a list separator may not be used. The list must always be
38531 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38532 otherwise the item must either be an absolute path, containing &`%s`& at the
38533 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38534 implying the use of a default path.
38535
38536 When Exim encounters an empty item in the list, it searches the list defined by
38537 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38538 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38539 mean &"use the path specified at build time"&. If no such item exists, log
38540 files are written in the &_log_& subdirectory of the spool directory. This is
38541 equivalent to the configuration file setting:
38542 .code
38543 log_file_path = $spool_directory/log/%slog
38544 .endd
38545 If you do not specify anything at build time or runtime,
38546 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38547 that is where the logs are written.
38548
38549 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38550 are in use &-- see section &<<SECTdatlogfil>>& below.
38551
38552 Here are some examples of possible Makefile settings:
38553 .display
38554 &`LOG_FILE_PATH=syslog                    `& syslog only
38555 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38556 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38557 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38558 .endd
38559 If there are more than two paths in the list, the first is used and a panic
38560 error is logged.
38561
38562
38563
38564 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38565 .cindex "log" "cycling local files"
38566 .cindex "cycling logs"
38567 .cindex "&'exicyclog'&"
38568 .cindex "log" "local files; writing to"
38569 Some operating systems provide centralized and standardized methods for cycling
38570 log files. For those that do not, a utility script called &'exicyclog'& is
38571 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38572 main and reject logs each time it is called. The maximum number of old logs to
38573 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38574
38575 An Exim delivery process opens the main log when it first needs to write to it,
38576 and it keeps the file open in case subsequent entries are required &-- for
38577 example, if a number of different deliveries are being done for the same
38578 message. However, remote SMTP deliveries can take a long time, and this means
38579 that the file may be kept open long after it is renamed if &'exicyclog'& or
38580 something similar is being used to rename log files on a regular basis. To
38581 ensure that a switch of log files is noticed as soon as possible, Exim calls
38582 &[stat()]& on the main log's name before reusing an open file, and if the file
38583 does not exist, or its inode has changed, the old file is closed and Exim
38584 tries to open the main log from scratch. Thus, an old log file may remain open
38585 for quite some time, but no Exim processes should write to it once it has been
38586 renamed.
38587
38588
38589
38590 .section "Datestamped log files" "SECTdatlogfil"
38591 .cindex "log" "datestamped files"
38592 Instead of cycling the main and reject log files by renaming them
38593 periodically, some sites like to use files whose names contain a datestamp,
38594 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38595 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38596 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38597 point where the datestamp is required. For example:
38598 .code
38599 log_file_path = /var/spool/exim/log/%slog-%D
38600 log_file_path = /var/log/exim-%s-%D.log
38601 log_file_path = /var/spool/exim/log/%D-%slog
38602 log_file_path = /var/log/exim/%s.%M
38603 .endd
38604 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38605 examples of names generated by the above examples:
38606 .code
38607 /var/spool/exim/log/mainlog-20021225
38608 /var/log/exim-reject-20021225.log
38609 /var/spool/exim/log/20021225-mainlog
38610 /var/log/exim/main.200212
38611 .endd
38612 When this form of log file is specified, Exim automatically switches to new
38613 files at midnight. It does not make any attempt to compress old logs; you
38614 will need to write your own script if you require this. You should not
38615 run &'exicyclog'& with this form of logging.
38616
38617 The location of the panic log is also determined by &%log_file_path%&, but it
38618 is not datestamped, because rotation of the panic log does not make sense.
38619 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38620 the string. In addition, if it immediately follows a slash, a following
38621 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38622 character is removed. Thus, the four examples above would give these panic
38623 log names:
38624 .code
38625 /var/spool/exim/log/paniclog
38626 /var/log/exim-panic.log
38627 /var/spool/exim/log/paniclog
38628 /var/log/exim/panic
38629 .endd
38630
38631
38632 .section "Logging to syslog" "SECID249"
38633 .cindex "log" "syslog; writing to"
38634 The use of syslog does not change what Exim logs or the format of its messages,
38635 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38636 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38637 that, the same strings are written to syslog as to log files. The syslog
38638 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38639 by default, but you can change these by setting the &%syslog_facility%& and
38640 &%syslog_processname%& options, respectively. If Exim was compiled with
38641 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38642 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38643 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38644 the time and host name to each line.
38645 The three log streams are mapped onto syslog priorities as follows:
38646
38647 .ilist
38648 &'mainlog'& is mapped to LOG_INFO
38649 .next
38650 &'rejectlog'& is mapped to LOG_NOTICE
38651 .next
38652 &'paniclog'& is mapped to LOG_ALERT
38653 .endlist
38654
38655 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38656 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38657 these are routed by syslog to the same place. You can suppress this duplication
38658 by setting &%syslog_duplication%& false.
38659
38660 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38661 entries contain multiple lines when headers are included. To cope with both
38662 these cases, entries written to syslog are split into separate &[syslog()]&
38663 calls at each internal newline, and also after a maximum of
38664 870 data characters. (This allows for a total syslog line length of 1024, when
38665 additions such as timestamps are added.) If you are running a syslog
38666 replacement that can handle lines longer than the 1024 characters allowed by
38667 RFC 3164, you should set
38668 .code
38669 SYSLOG_LONG_LINES=yes
38670 .endd
38671 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38672 lines, but it still splits at internal newlines in &'reject'& log entries.
38673
38674 To make it easy to re-assemble split lines later, each component of a split
38675 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38676 where <&'n'&> is the component number and <&'m'&> is the total number of
38677 components in the entry. The / delimiter is used when the line was split
38678 because it was too long; if it was split because of an internal newline, the \
38679 delimiter is used. For example, supposing the length limit to be 50 instead of
38680 870, the following would be the result of a typical rejection message to
38681 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38682 name, and pid as added by syslog:
38683 .code
38684 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38685 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38686 [3/5]  when scanning for sender: missing or malformed lo
38687 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38688 [5/5] mple>)
38689 .endd
38690 The same error might cause the following lines to be written to &"rejectlog"&
38691 (LOG_NOTICE):
38692 .code
38693 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38694 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38695 [3/18] er when scanning for sender: missing or malformed
38696 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38697 [5\18] .example>)
38698 [6\18] Recipients: ph10@some.domain.cam.example
38699 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38700 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38701 [9\18]        id 16RdAL-0006pc-00
38702 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38703 [11\18] 09:43 +0100
38704 [12\18] F From: <>
38705 [13\18]   Subject: this is a test header
38706 [18\18]   X-something: this is another header
38707 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38708 [16\18] le>
38709 [17\18] B Bcc:
38710 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38711 .endd
38712 Log lines that are neither too long nor contain newlines are written to syslog
38713 without modification.
38714
38715 If only syslog is being used, the Exim monitor is unable to provide a log tail
38716 display, unless syslog is routing &'mainlog'& to a file on the local host and
38717 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38718 where it is.
38719
38720
38721
38722 .section "Log line flags" "SECID250"
38723 One line is written to the main log for each message received, and for each
38724 successful, unsuccessful, and delayed delivery. These lines can readily be
38725 picked out by the distinctive two-character flags that immediately follow the
38726 timestamp. The flags are:
38727 .itable none 0 0 2 10* left 90* left
38728 .irow &%<=%&     "message arrival"
38729 .irow &%(=%&     "message fakereject"
38730 .irow &%=>%&     "normal message delivery"
38731 .irow &%->%&     "additional address in same delivery"
38732 .irow &%>>%&     "cutthrough message delivery"
38733 .irow &%*>%&     "delivery suppressed by &%-N%&"
38734 .irow &%**%&     "delivery failed; address bounced"
38735 .irow &%==%&     "delivery deferred; temporary problem"
38736 .endtable
38737
38738
38739 .section "Logging message reception" "SECID251"
38740 .cindex "log" "reception line"
38741 The format of the single-line entry in the main log that is written for every
38742 message received is shown in the basic example below, which is split over
38743 several lines in order to fit it on the page:
38744 .code
38745 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38746   H=mailer.fict.example [192.168.123.123] U=exim
38747   P=smtp S=5678 id=<incoming message id>
38748 .endd
38749 The address immediately following &"<="& is the envelope sender address. A
38750 bounce message is shown with the sender address &"<>"&, and if it is locally
38751 generated, this is followed by an item of the form
38752 .code
38753 R=<message id>
38754 .endd
38755 which is a reference to the message that caused the bounce to be sent.
38756
38757 .cindex "HELO"
38758 .cindex "EHLO"
38759 For messages from other hosts, the H and U fields identify the remote host and
38760 record the RFC 1413 identity of the user that sent the message, if one was
38761 received. The number given in square brackets is the IP address of the sending
38762 host. If there is a single, unparenthesized  host name in the H field, as
38763 above, it has been verified to correspond to the IP address (see the
38764 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38765 by the remote host in the SMTP HELO or EHLO command, and has not been
38766 verified. If verification yields a different name to that given for HELO or
38767 EHLO, the verified name appears first, followed by the HELO or EHLO
38768 name in parentheses.
38769
38770 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38771 without brackets, in the HELO or EHLO command, leading to entries in
38772 the log containing text like these examples:
38773 .code
38774 H=(10.21.32.43) [192.168.8.34]
38775 H=([10.21.32.43]) [192.168.8.34]
38776 .endd
38777 This can be confusing. Only the final address in square brackets can be relied
38778 on.
38779
38780 For locally generated messages (that is, messages not received over TCP/IP),
38781 the H field is omitted, and the U field contains the login name of the caller
38782 of Exim.
38783
38784 .cindex "authentication" "logging"
38785 .cindex "AUTH" "logging"
38786 For all messages, the P field specifies the protocol used to receive the
38787 message. This is the value that is stored in &$received_protocol$&. In the case
38788 of incoming SMTP messages, the value indicates whether or not any SMTP
38789 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38790 session was encrypted, there is an additional X field that records the cipher
38791 suite that was used.
38792
38793 .cindex log protocol
38794 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38795 hosts that have authenticated themselves using the SMTP AUTH command. The first
38796 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38797 there is an additional item A= followed by the name of the authenticator that
38798 was used. If an authenticated identification was set up by the authenticator's
38799 &%server_set_id%& option, this is logged too, separated by a colon from the
38800 authenticator name.
38801
38802 .cindex "size" "of message"
38803 The id field records the existing message id, if present. The size of the
38804 received message is given by the S field. When the message is delivered,
38805 headers may be removed or added, so that the size of delivered copies of the
38806 message may not correspond with this value (and indeed may be different to each
38807 other).
38808
38809 The &%log_selector%& option can be used to request the logging of additional
38810 data when a message is received. See section &<<SECTlogselector>>& below.
38811
38812
38813
38814 .section "Logging deliveries" "SECID252"
38815 .cindex "log" "delivery line"
38816 The format of the single-line entry in the main log that is written for every
38817 delivery is shown in one of the examples below, for local and remote
38818 deliveries, respectively. Each example has been split into multiple lines in order
38819 to fit it on the page:
38820 .code
38821 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38822   <marv@hitch.fict.example> R=localuser T=local_delivery
38823 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38824   monk@holistic.fict.example R=dnslookup T=remote_smtp
38825   H=holistic.fict.example [192.168.234.234]
38826 .endd
38827 For ordinary local deliveries, the original address is given in angle brackets
38828 after the final delivery address, which might be a pipe or a file. If
38829 intermediate address(es) exist between the original and the final address, the
38830 last of these is given in parentheses after the final address. The R and T
38831 fields record the router and transport that were used to process the address.
38832
38833 If SMTP AUTH was used for the delivery there is an additional item A=
38834 followed by the name of the authenticator that was used.
38835 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38836 option, this is logged too, as a second colon-separated list item.
38837 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38838
38839 If a shadow transport was run after a successful local delivery, the log line
38840 for the successful delivery has an item added on the end, of the form
38841 .display
38842 &`ST=<`&&'shadow transport name'&&`>`&
38843 .endd
38844 If the shadow transport did not succeed, the error message is put in
38845 parentheses afterwards.
38846
38847 .cindex "asterisk" "after IP address"
38848 When more than one address is included in a single delivery (for example, two
38849 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38850 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38851 down a single SMTP connection, an asterisk follows the
38852 remote IP address (and port if enabled)
38853 in the log lines for the second and subsequent messages.
38854 When two or more messages are delivered down a single TLS connection, the
38855 DNS and some TLS-related information logged for the first message delivered
38856 will not be present in the log lines for the second and subsequent messages.
38857 TLS cipher information is still available.
38858
38859 .cindex "delivery" "cutthrough; logging"
38860 .cindex "cutthrough" "logging"
38861 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38862 line precedes the reception line, since cutthrough waits for a possible
38863 rejection from the destination in case it can reject the sourced item.
38864
38865 The generation of a reply message by a filter file gets logged as a
38866 &"delivery"& to the addressee, preceded by &">"&.
38867
38868 The &%log_selector%& option can be used to request the logging of additional
38869 data when a message is delivered. See section &<<SECTlogselector>>& below.
38870
38871
38872 .section "Discarded deliveries" "SECID253"
38873 .cindex "discarded messages"
38874 .cindex "message" "discarded"
38875 .cindex "delivery" "discarded; logging"
38876 When a message is discarded as a result of the command &"seen finish"& being
38877 obeyed in a filter file which generates no deliveries, a log entry of the form
38878 .code
38879 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38880   <low.club@bridge.example> R=userforward
38881 .endd
38882 is written, to record why no deliveries are logged. When a message is discarded
38883 because it is aliased to &":blackhole:"& the log line is like this:
38884 .code
38885 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38886   <hole@nowhere.example> R=blackhole_router
38887 .endd
38888
38889
38890 .section "Deferred deliveries" "SECID254"
38891 When a delivery is deferred, a line of the following form is logged:
38892 .code
38893 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38894   R=dnslookup T=smtp defer (146): Connection refused
38895 .endd
38896 In the case of remote deliveries, the error is the one that was given for the
38897 last IP address that was tried. Details of individual SMTP failures are also
38898 written to the log, so the above line would be preceded by something like
38899 .code
38900 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38901   mail1.endrest.example [192.168.239.239]: Connection refused
38902 .endd
38903 When a deferred address is skipped because its retry time has not been reached,
38904 a message is written to the log, but this can be suppressed by setting an
38905 appropriate value in &%log_selector%&.
38906
38907
38908
38909 .section "Delivery failures" "SECID255"
38910 .cindex "delivery" "failure; logging"
38911 If a delivery fails because an address cannot be routed, a line of the
38912 following form is logged:
38913 .code
38914 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38915   <jim@trek99.example>: unknown mail domain
38916 .endd
38917 If a delivery fails at transport time, the router and transport are shown, and
38918 the response from the remote host is included, as in this example:
38919 .code
38920 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38921   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38922   after pipelined RCPT TO:<ace400@pb.example>: host
38923   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38924   <ace400@pb.example>...Addressee unknown
38925 .endd
38926 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38927 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38928 disabling PIPELINING. The log lines for all forms of delivery failure are
38929 flagged with &`**`&.
38930
38931
38932
38933 .section "Fake deliveries" "SECID256"
38934 .cindex "delivery" "fake; logging"
38935 If a delivery does not actually take place because the &%-N%& option has been
38936 used to suppress it, a normal delivery line is written to the log, except that
38937 &"=>"& is replaced by &"*>"&.
38938
38939
38940
38941 .section "Completion" "SECID257"
38942 A line of the form
38943 .code
38944 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38945 .endd
38946 is written to the main log when a message is about to be removed from the spool
38947 at the end of its processing.
38948
38949
38950
38951
38952 .section "Summary of Fields in Log Lines" "SECID258"
38953 .cindex "log" "summary of fields"
38954 A summary of the field identifiers that are used in log lines is shown in
38955 the following table:
38956 .display
38957 &`A   `&        authenticator name (and optional id and sender)
38958 &`C   `&        SMTP confirmation on delivery
38959 &`    `&        command list for &"no mail in SMTP session"&
38960 &`CV  `&        certificate verification status
38961 &`D   `&        duration of &"no mail in SMTP session"&
38962 &`DKIM`&        domain verified in incoming message
38963 &`DN  `&        distinguished name from peer certificate
38964 &`DS  `&        DNSSEC secured lookups
38965 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38966 &`F   `&        sender address (on delivery lines)
38967 &`H   `&        host name and IP address
38968 &`I   `&        local interface used
38969 &`id  `&        message id (from header) for incoming message
38970 &`K   `&        CHUNKING extension used
38971 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38972 &`M8S `&        8BITMIME status for incoming message
38973 &`P   `&        on &`<=`& lines: protocol used
38974 &`    `&        on &`=>`& and &`**`& lines: return path
38975 &`PRDR`&        PRDR extension used
38976 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38977 &`Q   `&        alternate queue name
38978 &`QT  `&        on &`=>`& lines: time spent on queue so far
38979 &`    `&        on &"Completed"& lines: time spent on queue
38980 &`R   `&        on &`<=`& lines: reference for local bounce
38981 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38982 &`RT  `&        on &`<=`& lines: time taken for reception
38983 &`S   `&        size of message in bytes
38984 &`SNI `&        server name indication from TLS client hello
38985 &`ST  `&        shadow transport name
38986 &`T   `&        on &`<=`& lines: message subject (topic)
38987 &`TFO `&        connection took advantage of TCP Fast Open
38988 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38989 &`U   `&        local user or RFC 1413 identity
38990 &`X   `&        TLS cipher suite
38991 .endd
38992
38993
38994 .section "Other log entries" "SECID259"
38995 Various other types of log entry are written from time to time. Most should be
38996 self-explanatory. Among the more common are:
38997
38998 .ilist
38999 .cindex "retry" "time not reached"
39000 &'retry time not reached'&&~&~An address previously suffered a temporary error
39001 during routing or local delivery, and the time to retry has not yet arrived.
39002 This message is not written to an individual message log file unless it happens
39003 during the first delivery attempt.
39004 .next
39005 &'retry time not reached for any host'&&~&~An address previously suffered
39006 temporary errors during remote delivery, and the retry time has not yet arrived
39007 for any of the hosts to which it is routed.
39008 .next
39009 .cindex "spool directory" "file locked"
39010 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39011 some other Exim process is already working on the message. This can be quite
39012 common if queue running processes are started at frequent intervals. The
39013 &'exiwhat'& utility script can be used to find out what Exim processes are
39014 doing.
39015 .next
39016 .cindex "error" "ignored"
39017 &'error ignored'&&~&~There are several circumstances that give rise to this
39018 message:
39019 .olist
39020 Exim failed to deliver a bounce message whose age was greater than
39021 &%ignore_bounce_errors_after%&. The bounce was discarded.
39022 .next
39023 A filter file set up a delivery using the &"noerror"& option, and the delivery
39024 failed. The delivery was discarded.
39025 .next
39026 A delivery set up by a router configured with
39027 . ==== As this is a nested list, any displays it contains must be indented
39028 . ==== as otherwise they are too far to the left.
39029 .code
39030     errors_to = <>
39031 .endd
39032 failed. The delivery was discarded.
39033 .endlist olist
39034 .next
39035 .cindex DKIM "log line"
39036 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39037 logging and the message has a DKIM signature header.
39038 .endlist ilist
39039
39040
39041
39042
39043
39044 .section "Reducing or increasing what is logged" "SECTlogselector"
39045 .cindex "log" "selectors"
39046 By setting the &%log_selector%& global option, you can disable some of Exim's
39047 default logging to the main log, or you can request additional logging. The value of
39048 &%log_selector%& is made up of names preceded by plus or minus characters. For
39049 example:
39050 .code
39051 log_selector = +arguments -retry_defer
39052 .endd
39053 The list of optional log items is in the following table, with the default
39054 selection marked by asterisks:
39055 .itable none 0 0 3 2.8in left 10pt center 3in left
39056 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39057 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39058 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39059 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39060 .irow &`arguments`&                     &nbsp; "command line arguments"
39061 .irow &`connection_reject`&             *       "connection rejections"
39062 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39063 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39064 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39065 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39066 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
39067 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39068 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39069 .irow &`etrn`&                          *       "ETRN commands"
39070 .irow &`host_lookup_failed`&            *       "as it says"
39071 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39072 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39073 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39074 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39075 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39076 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39077 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39078 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39079 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39080 .irow &`queue_run`&                     *       "start and end queue runs"
39081 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39082 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39083 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39084 .irow &`pid`&                           &nbsp; "Exim process id"
39085 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39086 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39087 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39088 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39089 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39090 .irow &`rejected_header`&               *       "header contents on reject log"
39091 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39092 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39093 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39094 .irow &`sender_verify_fail`&            *       "sender verification failures"
39095 .irow &`size_reject`&                   *       "rejection because too big"
39096 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39097 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39098 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39099 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39100 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39101 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39102 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39103 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39104 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39105 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39106 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39107 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39108 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39109 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39110 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39111 .irow &`all`&                           &nbsp; "&*all of the above*&"
39112 .endtable
39113 See also the &%slow_lookup_log%& main configuration option,
39114 section &<<SECID99>>&
39115
39116 More details on each of these items follows:
39117
39118 .ilist
39119 .cindex "8BITMIME"
39120 .cindex "log" "8BITMIME"
39121 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39122 which may help in tracking down interoperability issues with ancient MTAs
39123 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39124 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39125 &`7BIT`& and &`8BITMIME`& respectively.
39126 .next
39127 .cindex "&%warn%& ACL verb" "log when skipping"
39128 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39129 its conditions cannot be evaluated, a log line to this effect is written if
39130 this log selector is set.
39131 .next
39132 .cindex "log" "rewriting"
39133 .cindex "rewriting" "logging"
39134 &%address_rewrite%&: This applies both to global rewrites and per-transport
39135 rewrites, but not to rewrites in filters run as an unprivileged user (because
39136 such users cannot access the log).
39137 .next
39138 .cindex "log" "full parentage"
39139 &%all_parents%&: Normally only the original and final addresses are logged on
39140 delivery lines; with this selector, intermediate parents are given in
39141 parentheses between them.
39142 .next
39143 .cindex "log" "Exim arguments"
39144 .cindex "Exim arguments, logging"
39145 &%arguments%&: This causes Exim to write the arguments with which it was called
39146 to the main log, preceded by the current working directory. This is a debugging
39147 feature, added to make it easier to find out how certain MUAs call
39148 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39149 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39150 that are empty or that contain white space are quoted. Non-printing characters
39151 are shown as escape sequences. This facility cannot log unrecognized arguments,
39152 because the arguments are checked before the configuration file is read. The
39153 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39154 between the caller and Exim.
39155 .next
39156 .cindex "log" "connection rejections"
39157 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39158 connection is rejected, for whatever reason.
39159 .next
39160 .cindex "log" "delayed delivery"
39161 .cindex "delayed delivery, logging"
39162 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39163 started for an incoming message because the load is too high or too many
39164 messages were received on one connection. Logging does not occur if no delivery
39165 process is started because &%queue_only%& is set or &%-odq%& was used.
39166 .next
39167 .cindex "log" "delivery duration"
39168 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39169 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39170 If millisecond logging is enabled, short times will be shown with greater
39171 precision, eg. &`DT=0.304s`&.
39172 .next
39173 .cindex "log" "message size on delivery"
39174 .cindex "size" "of message"
39175 &%delivery_size%&: For each delivery, the size of message delivered is added to
39176 the &"=>"& line, tagged with S=.
39177 .next
39178 .cindex log "DKIM verification"
39179 .cindex DKIM "verification logging"
39180 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39181 verifies successfully a tag of DKIM is added, with one of the verified domains.
39182 .next
39183 .cindex log "DKIM verification"
39184 .cindex DKIM "verification logging"
39185 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39186 .next
39187 .cindex "log" "dnslist defer"
39188 .cindex "DNS list" "logging defer"
39189 .cindex "black list (DNS)"
39190 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39191 DNS black list suffers a temporary error.
39192 .next
39193 .cindex log dnssec
39194 .cindex dnssec logging
39195 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39196 dns lookups gave secure results a tag of DS is added.
39197 For acceptance this covers the reverse and forward lookups for host name verification.
39198 It does not cover helo-name verification.
39199 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39200 .next
39201 .cindex "log" "ETRN commands"
39202 .cindex "ETRN" "logging"
39203 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39204 is run to determine whether or not it is actually accepted. An invalid ETRN
39205 command, or one received within a message transaction is not logged by this
39206 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39207 .next
39208 .cindex "log" "host lookup failure"
39209 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39210 any addresses, or when a lookup of an IP address fails to find a host name, a
39211 log line is written. This logging does not apply to direct DNS lookups when
39212 routing email addresses, but it does apply to &"byname"& lookups.
39213 .next
39214 .cindex "log" "ident timeout"
39215 .cindex "RFC 1413" "logging timeout"
39216 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39217 client's ident port times out.
39218 .next
39219 .cindex "log" "incoming interface"
39220 .cindex "log" "outgoing interface"
39221 .cindex "log" "local interface"
39222 .cindex "log" "local address and port"
39223 .cindex "TCP/IP" "logging local address and port"
39224 .cindex "interface" "logging"
39225 &%incoming_interface%&: The interface on which a message was received is added
39226 to the &"<="& line as an IP address in square brackets, tagged by I= and
39227 followed by a colon and the port number. The local interface and port are also
39228 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39229 rejection lines, and (despite the name) to outgoing
39230 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39231 The latter can be disabled by turning off the &%outgoing_interface%& option.
39232 .next
39233 .cindex log "incoming proxy address"
39234 .cindex proxy "logging proxy address"
39235 .cindex "TCP/IP" "logging proxy address"
39236 &%proxy%&: The internal (closest to the system running Exim) IP address
39237 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39238 on a proxied connection
39239 or the &"=>"& line for a message delivered on a proxied connection.
39240 See &<<SECTproxyInbound>>& for more information.
39241 .next
39242 .cindex "log" "incoming remote port"
39243 .cindex "port" "logging remote"
39244 .cindex "TCP/IP" "logging incoming remote port"
39245 .vindex "&$sender_fullhost$&"
39246 .vindex "&$sender_rcvhost$&"
39247 &%incoming_port%&: The remote port number from which a message was received is
39248 added to log entries and &'Received:'& header lines, following the IP address
39249 in square brackets, and separated from it by a colon. This is implemented by
39250 changing the value that is put in the &$sender_fullhost$& and
39251 &$sender_rcvhost$& variables. Recording the remote port number has become more
39252 important with the widening use of NAT (see RFC 2505).
39253 .next
39254 .cindex "log" "dropped connection"
39255 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39256 connection is unexpectedly dropped.
39257 .next
39258 .cindex "log" "millisecond timestamps"
39259 .cindex millisecond logging
39260 .cindex timestamps "millisecond, in logs"
39261 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39262 appended to the seconds value.
39263 .next
39264 .cindex "log" "message id"
39265 &%msg_id%&: The value of the Message-ID: header.
39266 .next
39267 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39268 This will be either because the message is a bounce, or was submitted locally
39269 (submission mode) without one.
39270 The field identifier will have an asterix appended: &"id*="&.
39271 .next
39272 .cindex "log" "outgoing interface"
39273 .cindex "log" "local interface"
39274 .cindex "log" "local address and port"
39275 .cindex "TCP/IP" "logging local address and port"
39276 .cindex "interface" "logging"
39277 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39278 interface on which a message was sent is added to delivery lines as an I= tag
39279 followed by IP address in square brackets. You can disable this by turning
39280 off the &%outgoing_interface%& option.
39281 .next
39282 .cindex "log" "outgoing remote port"
39283 .cindex "port" "logging outgoing remote"
39284 .cindex "TCP/IP" "logging outgoing remote port"
39285 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39286 containing => tags) following the IP address.
39287 The local port is also added if &%incoming_interface%& and
39288 &%outgoing_interface%& are both enabled.
39289 This option is not included in the default setting, because for most ordinary
39290 configurations, the remote port number is always 25 (the SMTP port), and the
39291 local port is a random ephemeral port.
39292 .next
39293 .cindex "log" "process ids in"
39294 .cindex "pid (process id)" "in log lines"
39295 &%pid%&: The current process id is added to every log line, in square brackets,
39296 immediately after the time and date.
39297 .next
39298 .cindex log pipelining
39299 .cindex pipelining "logging outgoing"
39300 &%pipelining%&: A field is added to delivery and accept
39301 log lines when the ESMTP PIPELINING extension was used.
39302 The field is a single "L".
39303
39304 On accept lines, where PIPELINING was offered but not used by the client,
39305 the field has a minus appended.
39306
39307 .cindex "pipelining" "early connection"
39308 If Exim is built without the DISABLE_PIPE_CONNECT build option
39309 accept "L" fields have a period appended if the feature was
39310 offered but not used, or an asterisk appended if used.
39311 Delivery "L" fields have an asterisk appended if used.
39312
39313 .next
39314 .cindex "log" "queue run"
39315 .cindex "queue runner" "logging"
39316 &%queue_run%&: The start and end of every queue run are logged.
39317 .next
39318 .cindex "log" "queue time"
39319 &%queue_time%&: The amount of time the message has been in the queue on the
39320 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39321 &`QT=3m45s`&.
39322 If millisecond logging is enabled, short times will be shown with greater
39323 precision, eg. &`QT=1.578s`&.
39324 .next
39325 &%queue_time_overall%&: The amount of time the message has been in the queue on
39326 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39327 example, &`QT=3m45s`&.
39328 .next
39329 .cindex "log" "receive duration"
39330 &%receive_time%&: For each message, the amount of real time it has taken to
39331 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39332 If millisecond logging is enabled, short times will be shown with greater
39333 precision, eg. &`RT=0.204s`&.
39334 .next
39335 .cindex "log" "recipients"
39336 &%received_recipients%&: The recipients of a message are listed in the main log
39337 as soon as the message is received. The list appears at the end of the log line
39338 that is written when a message is received, preceded by the word &"for"&. The
39339 addresses are listed after they have been qualified, but before any rewriting
39340 has taken place.
39341 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39342 in the list.
39343 .next
39344 .cindex "log" "sender reception"
39345 &%received_sender%&: The unrewritten original sender of a message is added to
39346 the end of the log line that records the message's arrival, after the word
39347 &"from"& (before the recipients if &%received_recipients%& is also set).
39348 .next
39349 .cindex "log" "header lines for rejection"
39350 &%rejected_header%&: If a message's header has been received at the time a
39351 rejection is written to the reject log, the complete header is added to the
39352 log. Header logging can be turned off individually for messages that are
39353 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39354 .next
39355 .cindex "log" "retry defer"
39356 &%retry_defer%&: A log line is written if a delivery is deferred because a
39357 retry time has not yet been reached. However, this &"retry time not reached"&
39358 message is always omitted from individual message logs after the first delivery
39359 attempt.
39360 .next
39361 .cindex "log" "return path"
39362 &%return_path_on_delivery%&: The return path that is being transmitted with
39363 the message is included in delivery and bounce lines, using the tag P=.
39364 This is omitted if no delivery actually happens, for example, if routing fails,
39365 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39366 .next
39367 .cindex "log" "sender on delivery"
39368 &%sender_on_delivery%&: The message's sender address is added to every delivery
39369 and bounce line, tagged by F= (for &"from"&).
39370 This is the original sender that was received with the message; it is not
39371 necessarily the same as the outgoing return path.
39372 .next
39373 .cindex "log" "sender verify failure"
39374 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39375 gives details of a sender verification failure is not written. Log lines for
39376 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39377 detail is lost.
39378 .next
39379 .cindex "log" "size rejection"
39380 &%size_reject%&: A log line is written whenever a message is rejected because
39381 it is too big.
39382 .next
39383 .cindex "log" "frozen messages; skipped"
39384 .cindex "frozen messages" "logging skipping"
39385 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39386 queue run because it another process is already delivering it or because
39387 it is frozen.
39388 .cindex "&""spool file is locked""&"
39389 .cindex "&""message is frozen""&"
39390 The message that is written is either &"spool file is locked"& or
39391 &"message is frozen"&.
39392 .next
39393 .cindex "log" "smtp confirmation"
39394 .cindex "SMTP" "logging confirmation"
39395 .cindex "LMTP" "logging confirmation"
39396 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39397 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39398 A number of MTAs (including Exim) return an identifying string in this
39399 response.
39400 .next
39401 .cindex "log" "SMTP connections"
39402 .cindex "SMTP" "logging connections"
39403 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39404 established or closed, unless the connection is from a host that matches
39405 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39406 only when the closure is unexpected.) This applies to connections from local
39407 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39408 dropped in the middle of a message, a log line is always written, whether or
39409 not this selector is set, but otherwise nothing is written at the start and end
39410 of connections unless this selector is enabled.
39411
39412 For TCP/IP connections to an Exim daemon, the current number of connections is
39413 included in the log message for each new connection, but note that the count is
39414 reset if the daemon is restarted.
39415 Also, because connections are closed (and the closure is logged) in
39416 subprocesses, the count may not include connections that have been closed but
39417 whose termination the daemon has not yet noticed. Thus, while it is possible to
39418 match up the opening and closing of connections in the log, the value of the
39419 logged counts may not be entirely accurate.
39420 .next
39421 .cindex "log" "SMTP transaction; incomplete"
39422 .cindex "SMTP" "logging incomplete transactions"
39423 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39424 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39425 and the message sender plus any accepted recipients are included in the log
39426 line. This can provide evidence of dictionary attacks.
39427 .next
39428 .cindex "log" "non-MAIL SMTP sessions"
39429 .cindex "MAIL" "logging session without"
39430 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39431 connection terminates without having issued a MAIL command. This includes both
39432 the case when the connection is dropped, and the case when QUIT is used. It
39433 does not include cases where the connection is rejected right at the start (by
39434 an ACL, or because there are too many connections, or whatever). These cases
39435 already have their own log lines.
39436
39437 The log line that is written contains the identity of the client in the usual
39438 way, followed by D= and a time, which records the duration of the connection.
39439 If the connection was authenticated, this fact is logged exactly as it is for
39440 an incoming message, with an A= item. If the connection was encrypted, CV=,
39441 DN=, and X= items may appear as they do for an incoming message, controlled by
39442 the same logging options.
39443
39444 Finally, if any SMTP commands were issued during the connection, a C= item
39445 is added to the line, listing the commands that were used. For example,
39446 .code
39447 C=EHLO,QUIT
39448 .endd
39449 shows that the client issued QUIT straight after EHLO. If there were fewer
39450 than 20 commands, they are all listed. If there were more than 20 commands,
39451 the last 20 are listed, preceded by &"..."&. However, with the default
39452 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39453 have been aborted before 20 non-mail commands are processed.
39454 .next
39455 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39456 colon-separated, is appended to the A= item for a message arrival or delivery
39457 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39458 was accepted or used.
39459 .next
39460 .cindex "log" "SMTP protocol error"
39461 .cindex "SMTP" "logging protocol error"
39462 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39463 encountered. Exim does not have perfect detection of all protocol errors
39464 because of transmission delays and the use of pipelining. If PIPELINING has
39465 been advertised to a client, an Exim server assumes that the client will use
39466 it, and therefore it does not count &"expected"& errors (for example, RCPT
39467 received after rejecting MAIL) as protocol errors.
39468 .next
39469 .cindex "SMTP" "logging syntax errors"
39470 .cindex "SMTP" "syntax errors; logging"
39471 .cindex "SMTP" "unknown command; logging"
39472 .cindex "log" "unknown SMTP command"
39473 .cindex "log" "SMTP syntax error"
39474 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39475 encountered. An unrecognized command is treated as a syntax error. For an
39476 external connection, the host identity is given; for an internal connection
39477 using &%-bs%& the sender identification (normally the calling user) is given.
39478 .next
39479 .cindex "log" "subject"
39480 .cindex "subject, logging"
39481 &%subject%&: The subject of the message is added to the arrival log line,
39482 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39483 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39484 specifies whether characters with values greater than 127 should be logged
39485 unchanged, or whether they should be rendered as escape sequences.
39486 .next
39487 .cindex "log" "certificate verification"
39488 .cindex log DANE
39489 .cindex DANE logging
39490 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39491 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39492 verified
39493 using a CA trust anchor,
39494 &`CV=dane`& if using a DNS trust anchor,
39495 and &`CV=no`& if not.
39496 .next
39497 .cindex "log" "TLS cipher"
39498 .cindex "TLS" "logging cipher"
39499 &%tls_cipher%&: When a message is sent or received over an encrypted
39500 connection, the cipher suite used is added to the log line, preceded by X=.
39501 .next
39502 .cindex "log" "TLS peer DN"
39503 .cindex "TLS" "logging peer DN"
39504 &%tls_peerdn%&: When a message is sent or received over an encrypted
39505 connection, and a certificate is supplied by the remote host, the peer DN is
39506 added to the log line, preceded by DN=.
39507 .next
39508 .cindex "log" "TLS resumption"
39509 .cindex "TLS" "logging session resumption"
39510 &%tls_resumption%&: When a message is sent or received over an encrypted
39511 connection and the TLS session resumed one used on a previous TCP connection,
39512 an asterisk is appended to the X= cipher field in the log line.
39513 .next
39514 .cindex "log" "TLS SNI"
39515 .cindex "TLS" "logging SNI"
39516 .cindex SNI logging
39517 &%tls_sni%&: When a message is received over an encrypted connection, and
39518 the remote host provided the Server Name Indication extension, the SNI is
39519 added to the log line, preceded by SNI=.
39520 .next
39521 .cindex "log" "DNS failure in list"
39522 &%unknown_in_list%&: This setting causes a log entry to be written when the
39523 result of a list match is failure because a DNS lookup failed.
39524 .endlist
39525
39526
39527 .section "Message log" "SECID260"
39528 .cindex "message" "log file for"
39529 .cindex "log" "message log; description of"
39530 .cindex "&_msglog_& directory"
39531 .oindex "&%preserve_message_logs%&"
39532 In addition to the general log files, Exim writes a log file for each message
39533 that it handles. The names of these per-message logs are the message ids, and
39534 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39535 message log contains copies of the log lines that apply to the message. This
39536 makes it easier to inspect the status of an individual message without having
39537 to search the main log. A message log is deleted when processing of the message
39538 is complete, unless &%preserve_message_logs%& is set, but this should be used
39539 only with great care because they can fill up your disk very quickly.
39540
39541 On a heavily loaded system, it may be desirable to disable the use of
39542 per-message logs, in order to reduce disk I/O. This can be done by setting the
39543 &%message_logs%& option false.
39544 .ecindex IIDloggen
39545
39546
39547
39548
39549 . ////////////////////////////////////////////////////////////////////////////
39550 . ////////////////////////////////////////////////////////////////////////////
39551
39552 .chapter "Exim utilities" "CHAPutils"
39553 .scindex IIDutils "utilities"
39554 A number of utility scripts and programs are supplied with Exim and are
39555 described in this chapter. There is also the Exim Monitor, which is covered in
39556 the next chapter. The utilities described here are:
39557
39558 .itable none 0 0 3  7* left  15* left  40* left
39559 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39560   "list what Exim processes are doing"
39561 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39562 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39563 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39564 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39565                                                 various criteria"
39566 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39567 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39568   "extract statistics from the log"
39569 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39570   "check address acceptance from given IP"
39571 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39572 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39573 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39574 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39575 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39576 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39577 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39578 .endtable
39579
39580 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39581 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39582 &url(https://duncanthrax.net/exilog/) for details.
39583
39584
39585
39586
39587 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39588 .cindex "&'exiwhat'&"
39589 .cindex "process, querying"
39590 .cindex "SIGUSR1"
39591 On operating systems that can restart a system call after receiving a signal
39592 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39593 a line describing what it is doing to the file &_exim-process.info_& in the
39594 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39595 processes it can find, having first emptied the file. It then waits for one
39596 second to allow the Exim processes to react before displaying the results. In
39597 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39598 send the signal to the Exim processes, so it is normally run as root.
39599
39600 &*Warning*&: This is not an efficient process. It is intended for occasional
39601 use by system administrators. It is not sensible, for example, to set up a
39602 script that sends SIGUSR1 signals to Exim processes at short intervals.
39603
39604
39605 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39606 varies in different operating systems. Not only are different options used,
39607 but the format of the output is different. For this reason, there are some
39608 system configuration options that configure exactly how &'exiwhat'& works. If
39609 it doesn't seem to be working for you, check the following compile-time
39610 options:
39611 .itable none 0 0 2 30* left 70* left
39612 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39613 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39614 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39615 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39616 .endtable
39617 An example of typical output from &'exiwhat'& is
39618 .code
39619 164 daemon: -q1h, listening on port 25
39620 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39621 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39622   [10.19.42.42] (editor@ref.example)
39623 10592 handling incoming call from [192.168.243.242]
39624 10628 accepting a local non-SMTP message
39625 .endd
39626 The first number in the output line is the process number. The third line has
39627 been split here, in order to fit it on the page.
39628
39629
39630
39631 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39632 .cindex "&'exiqgrep'&"
39633 .cindex "queue" "grepping"
39634 This utility is a Perl script contributed by Matt Hubbard. It runs
39635 .code
39636 exim -bpu
39637 .endd
39638 or (in case &*-a*& switch is specified)
39639 .code
39640 exim -bp
39641 .endd
39642 to obtain a queue listing, and then greps the output to select messages
39643 that match given criteria. The following selection options are available:
39644
39645 .vlist
39646 .vitem &*-f*&&~<&'regex'&>
39647 Match the sender address using a case-insensitive search. The field that is
39648 tested is enclosed in angle brackets, so you can test for bounce messages with
39649 .code
39650 exiqgrep -f '^<>$'
39651 .endd
39652 .vitem &*-r*&&~<&'regex'&>
39653 Match a recipient address using a case-insensitive search. The field that is
39654 tested is not enclosed in angle brackets.
39655
39656 .vitem &*-s*&&~<&'regex'&>
39657 Match against the size field.
39658
39659 .vitem &*-y*&&~<&'seconds'&>
39660 Match messages that are younger than the given time.
39661
39662 .vitem &*-o*&&~<&'seconds'&>
39663 Match messages that are older than the given time.
39664
39665 .vitem &*-z*&
39666 Match only frozen messages.
39667
39668 .vitem &*-x*&
39669 Match only non-frozen messages.
39670
39671 .vitem &*-G*&&~<&'queuename'&>
39672 Match only messages in the given queue.  Without this, the default queue is searched.
39673 .endlist
39674
39675 The following options control the format of the output:
39676
39677 .vlist
39678 .vitem &*-c*&
39679 Display only the count of matching messages.
39680
39681 .vitem &*-l*&
39682 Long format &-- display the full message information as output by Exim. This is
39683 the default.
39684
39685 .vitem &*-i*&
39686 Display message ids only.
39687
39688 .vitem &*-b*&
39689 Brief format &-- one line per message.
39690
39691 .vitem &*-R*&
39692 Display messages in reverse order.
39693
39694 .vitem &*-a*&
39695 Include delivered recipients in queue listing.
39696 .endlist
39697
39698 The following options give alternates for configuration:
39699
39700 .vlist
39701 .vitem &*-C*&&~<&'config&~file'&>
39702 is used to specify an alternate &_exim.conf_& which might
39703 contain alternate exim configuration the queue management might be using.
39704
39705 .vitem &*-E*&&~<&'path'&>
39706 can be used to specify a path for the exim binary,
39707 overriding the built-in one.
39708 .endlist
39709
39710 There is one more option, &%-h%&, which outputs a list of options.
39711 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39712
39713
39714
39715 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39716 .cindex "&'exiqsumm'&"
39717 .cindex "queue" "summary"
39718 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39719 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39720 running a command such as
39721 .code
39722 exim -bp | exiqsumm
39723 .endd
39724 The output consists of one line for each domain that has messages waiting for
39725 it, as in the following example:
39726 .code
39727 3   2322   74m   66m  msn.com.example
39728 .endd
39729 Each line lists the number of pending deliveries for a domain, their total
39730 volume, and the length of time that the oldest and the newest messages have
39731 been waiting. Note that the number of pending deliveries is greater than the
39732 number of messages when messages have more than one recipient.
39733
39734 A summary line is output at the end. By default the output is sorted on the
39735 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39736 the output to be sorted by oldest message and by count of messages,
39737 respectively. There are also three options that split the messages for each
39738 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39739 separates frozen messages, and &%-s%& separates messages according to their
39740 sender.
39741
39742 The output of &'exim -bp'& contains the original addresses in the message, so
39743 this also applies to the output from &'exiqsumm'&. No domains from addresses
39744 generated by aliasing or forwarding are included (unless the &%one_time%&
39745 option of the &(redirect)& router has been used to convert them into &"top
39746 level"& addresses).
39747
39748
39749
39750
39751 .section "Extracting specific information from the log (exigrep)" &&&
39752          "SECTextspeinf"
39753 .cindex "&'exigrep'&"
39754 .cindex "log" "extracts; grepping for"
39755 The &'exigrep'& utility is a Perl script that searches one or more main log
39756 files for entries that match a given pattern. When it finds a match, it
39757 extracts all the log entries for the relevant message, not just those that
39758 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39759 given message, or all mail for a given user, or for a given host, for example.
39760 The input files can be in Exim log format or syslog format.
39761 If a matching log line is not associated with a specific message, it is
39762 included in &'exigrep'&'s output without any additional lines. The usage is:
39763 .display
39764 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39765 .endd
39766 If no log filenames are given on the command line, the standard input is read.
39767
39768 The &%-t%& argument specifies a number of seconds. It adds an additional
39769 condition for message selection. Messages that are complete are shown only if
39770 they spent more than <&'n'&> seconds in the queue.
39771
39772 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39773 makes it case-sensitive. This may give a performance improvement when searching
39774 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39775 option; with &%-I%& they do not. In both cases it is possible to change the
39776 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39777
39778 The &%-l%& option means &"literal"&, that is, treat all characters in the
39779 pattern as standing for themselves. Otherwise the pattern must be a Perl
39780 regular expression.
39781
39782 The &%-v%& option inverts the matching condition. That is, a line is selected
39783 if it does &'not'& match the pattern.
39784
39785 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39786 that are generated as a result/response to a message that &'exigrep'& matched
39787 normally.
39788
39789 Example of &%-M%&:
39790 user_a sends a message to user_b, which generates a bounce back to user_b. If
39791 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39792 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39793 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39794 when searching for &"user_a"& will show both messages since the bounce is
39795 &"related"& to or a &"result"& of the first message that was found by the
39796 search term.
39797
39798 If the location of a &'zcat'& command is known from the definition of
39799 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39800 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39801 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39802 autodetection of some well known compression extensions.
39803
39804
39805 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39806 .cindex "&'exipick'&"
39807 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39808 lists messages from the queue according to a variety of criteria. For details
39809 of &'exipick'&'s facilities, run &'exipick'& with
39810 the &%--help%& option.
39811
39812
39813 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39814 .cindex "log" "cycling local files"
39815 .cindex "cycling logs"
39816 .cindex "&'exicyclog'&"
39817 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39818 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39819 you are using log files with datestamps in their names (see section
39820 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39821 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39822 There are two command line options for &'exicyclog'&:
39823 .ilist
39824 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39825 default that is set when Exim is built. The default default is 10.
39826 .next
39827 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39828 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39829 overriding the script's default, which is to find the setting from Exim's
39830 configuration.
39831 .endlist
39832
39833 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39834 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39835 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39836 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39837 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39838 logs are handled similarly.
39839
39840 If the limit is greater than 99, the script uses 3-digit numbers such as
39841 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39842 to one that is greater, or &'vice versa'&, you will have to fix the names of
39843 any existing log files.
39844
39845 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39846 the end are deleted. All files with numbers greater than 01 are compressed,
39847 using a compression command which is configured by the COMPRESS_COMMAND
39848 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39849 root &%crontab%& entry of the form
39850 .code
39851 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39852 .endd
39853 assuming you have used the name &"exim"& for the Exim user. You can run
39854 &'exicyclog'& as root if you wish, but there is no need.
39855
39856
39857
39858 .section "Mail statistics (eximstats)" "SECTmailstat"
39859 .cindex "statistics"
39860 .cindex "&'eximstats'&"
39861 A Perl script called &'eximstats'& is provided for extracting statistical
39862 information from log files. The output is either plain text, or HTML.
39863 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39864 . --- 404 error and everything else points to that.
39865
39866 The &'eximstats'& script has been hacked about quite a bit over time. The
39867 latest version is the result of some extensive revision by Steve Campbell. A
39868 lot of information is given by default, but there are options for suppressing
39869 various parts of it. Following any options, the arguments to the script are a
39870 list of files, which should be main log files. For example:
39871 .code
39872 eximstats -nr /var/spool/exim/log/mainlog.01
39873 .endd
39874 By default, &'eximstats'& extracts information about the number and volume of
39875 messages received from or delivered to various hosts. The information is sorted
39876 both by message count and by volume, and the top fifty hosts in each category
39877 are listed on the standard output. Similar information, based on email
39878 addresses or domains instead of hosts can be requested by means of various
39879 options. For messages delivered and received locally, similar statistics are
39880 also produced per user.
39881
39882 The output also includes total counts and statistics about delivery errors, and
39883 histograms showing the number of messages received and deliveries made in each
39884 hour of the day. A delivery with more than one address in its envelope (for
39885 example, an SMTP transaction with more than one RCPT command) is counted
39886 as a single delivery by &'eximstats'&.
39887
39888 Though normally more deliveries than receipts are reported (as messages may
39889 have multiple recipients), it is possible for &'eximstats'& to report more
39890 messages received than delivered, even though the queue is empty at the start
39891 and end of the period in question. If an incoming message contains no valid
39892 recipients, no deliveries are recorded for it. A bounce message is handled as
39893 an entirely separate message.
39894
39895 &'eximstats'& always outputs a grand total summary giving the volume and number
39896 of messages received and deliveries made, and the number of hosts involved in
39897 each case. It also outputs the number of messages that were delayed (that is,
39898 not completely delivered at the first attempt), and the number that had at
39899 least one address that failed.
39900
39901 The remainder of the output is in sections that can be independently disabled
39902 or modified by various options. It consists of a summary of deliveries by
39903 transport, histograms of messages received and delivered per time interval
39904 (default per hour), information about the time messages spent in the queue,
39905 a list of relayed messages, lists of the top fifty sending hosts, local
39906 senders, destination hosts, and destination local users by count and by volume,
39907 and a list of delivery errors that occurred.
39908
39909 The relay information lists messages that were actually relayed, that is, they
39910 came from a remote host and were directly delivered to some other remote host,
39911 without being processed (for example, for aliasing or forwarding) locally.
39912
39913 There are quite a few options for &'eximstats'& to control exactly what it
39914 outputs. These are documented in the Perl script itself, and can be extracted
39915 by running the command &(perldoc)& on the script. For example:
39916 .code
39917 perldoc /usr/exim/bin/eximstats
39918 .endd
39919
39920 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39921 .cindex "&'exim_checkaccess'&"
39922 .cindex "policy control" "checking access"
39923 .cindex "checking access"
39924 The &%-bh%& command line argument allows you to run a fake SMTP session with
39925 debugging output, in order to check what Exim is doing when it is applying
39926 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39927 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39928 sometimes you just want to answer the question &"Does this address have
39929 access?"& without bothering with any further details.
39930
39931 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39932 two arguments, an IP address and an email address:
39933 .code
39934 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39935 .endd
39936 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39937 given email address would be accepted in a RCPT command in a TCP/IP
39938 connection from the host with the given IP address. The output of the utility
39939 is either the word &"accepted"&, or the SMTP error response, for example:
39940 .code
39941 Rejected:
39942 550 Relay not permitted
39943 .endd
39944 When running this test, the utility uses &`<>`& as the envelope sender address
39945 for the MAIL command, but you can change this by providing additional
39946 options. These are passed directly to the Exim command. For example, to specify
39947 that the test is to be run with the sender address &'himself@there.example'&
39948 you can use:
39949 .code
39950 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39951                  -f himself@there.example
39952 .endd
39953 Note that these additional Exim command line items must be given after the two
39954 mandatory arguments.
39955
39956 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39957 while running its checks. You can run checks that include callouts by using
39958 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39959
39960
39961
39962 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39963 .cindex "DBM" "building dbm files"
39964 .cindex "building DBM files"
39965 .cindex "&'exim_dbmbuild'&"
39966 .cindex "lower casing"
39967 .cindex "binary zero" "in lookup key"
39968 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39969 the format used by the &(lsearch)& lookup (see section
39970 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39971 names as keys and the remainder of the information as data. The lower-casing
39972 can be prevented by calling the program with the &%-nolc%& option.
39973
39974 A terminating zero is included as part of the key string. This is expected by
39975 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39976 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39977 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39978 files.
39979
39980 The program requires two arguments: the name of the input file (which can be a
39981 single hyphen to indicate the standard input), and the name of the output file.
39982 It creates the output under a temporary name, and then renames it if all went
39983 well.
39984
39985 .cindex "USE_DB"
39986 If the native DB interface is in use (USE_DB is set in a compile-time
39987 configuration file &-- this is common in free versions of Unix) the two
39988 filenames must be different, because in this mode the Berkeley DB functions
39989 create a single output file using exactly the name given. For example,
39990 .code
39991 exim_dbmbuild /etc/aliases /etc/aliases.db
39992 .endd
39993 reads the system alias file and creates a DBM version of it in
39994 &_/etc/aliases.db_&.
39995
39996 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39997 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39998 environment, the suffixes are added to the second argument of
39999 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40000 when the Berkeley functions are used in compatibility mode (though this is not
40001 recommended), because in that case it adds a &_.db_& suffix to the filename.
40002
40003 If a duplicate key is encountered, the program outputs a warning, and when it
40004 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40005 option is used. By default, only the first of a set of duplicates is used &--
40006 this makes it compatible with &(lsearch)& lookups. There is an option
40007 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40008 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40009 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40010 return code is 2.
40011
40012
40013
40014
40015 .section "Finding individual retry times (exinext)" "SECTfinindret"
40016 .cindex "retry" "times"
40017 .cindex "&'exinext'&"
40018 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40019 fish specific information out of the retry database. Given a mail domain (or a
40020 complete address), it looks up the hosts for that domain, and outputs any retry
40021 information for the hosts or for the domain. At present, the retry information
40022 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40023 output. For example:
40024 .code
40025 $ exinext piglet@milne.fict.example
40026 kanga.milne.example:192.168.8.1 error 146: Connection refused
40027   first failed: 21-Feb-1996 14:57:34
40028   last tried:   21-Feb-1996 14:57:34
40029   next try at:  21-Feb-1996 15:02:34
40030 roo.milne.example:192.168.8.3 error 146: Connection refused
40031   first failed: 20-Jan-1996 13:12:08
40032   last tried:   21-Feb-1996 11:42:03
40033   next try at:  21-Feb-1996 19:42:03
40034   past final cutoff time
40035 .endd
40036 You can also give &'exinext'& a local part, without a domain, and it
40037 will give any retry information for that local part in your default domain.
40038 A message id can be used to obtain retry information pertaining to a specific
40039 message. This exists only when an attempt to deliver a message to a remote host
40040 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40041 &'exinext'& is not particularly efficient, but then it is not expected to be
40042 run very often.
40043
40044 The &'exinext'& utility calls Exim to find out information such as the location
40045 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40046 passed on to the &'exim'& commands. The first specifies an alternate Exim
40047 configuration file, and the second sets macros for use within the configuration
40048 file. These features are mainly to help in testing, but might also be useful in
40049 environments where more than one configuration file is in use.
40050
40051
40052
40053 .section "Hints database maintenance" "SECThindatmai"
40054 .cindex "hints database" "maintenance"
40055 .cindex "maintaining Exim's hints database"
40056 Three utility programs are provided for maintaining the DBM files that Exim
40057 uses to contain its delivery hint information. Each program requires two
40058 arguments. The first specifies the name of Exim's spool directory, and the
40059 second is the name of the database it is to operate on. These are as follows:
40060
40061 .ilist
40062 &'retry'&: the database of retry information
40063 .next
40064 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40065 for remote hosts
40066 .next
40067 &'callout'&: the callout cache
40068 .next
40069 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40070 .next
40071 &'tls'&: TLS session resumption data
40072 .next
40073 &'misc'&: other hints data
40074 .endlist
40075
40076 The &'misc'& database is used for
40077
40078 .ilist
40079 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40080 .next
40081 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40082 &(smtp)& transport)
40083 .next
40084 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40085 in a transport)
40086 .endlist
40087
40088
40089
40090 .section "exim_dumpdb" "SECTdumpdb"
40091 .cindex "&'exim_dumpdb'&"
40092 The entire contents of a database are written to the standard output by the
40093 &'exim_dumpdb'& program,
40094 taking as arguments the spool and database names.
40095 An option &'-z'& may be given to request times in UTC;
40096 otherwise times are in the local timezone.
40097 An option &'-k'& may be given to dump only the record keys.
40098 For example, to dump the retry database:
40099 .code
40100 exim_dumpdb /var/spool/exim retry
40101 .endd
40102 For the retry database
40103 two lines of output are produced for each entry:
40104 .code
40105 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40106 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40107 .endd
40108 The first item on the first line is the key of the record. It starts with one
40109 of the letters R, or T, depending on whether it refers to a routing or
40110 transport retry. For a local delivery, the next part is the local address; for
40111 a remote delivery it is the name of the remote host, followed by its failing IP
40112 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40113 transport). If the remote port is not the standard one (port 25), it is added
40114 to the IP address. Then there follows an error code, an additional error code,
40115 and a textual description of the error.
40116
40117 The three times on the second line are the time of first failure, the time of
40118 the last delivery attempt, and the computed time for the next attempt. The line
40119 ends with an asterisk if the cutoff time for the last retry rule has been
40120 exceeded.
40121
40122 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40123 consists of a host name followed by a list of ids for messages that are or were
40124 waiting to be delivered to that host. If there are a very large number for any
40125 one host, continuation records, with a sequence number added to the host name,
40126 may be seen. The data in these records is often out of date, because a message
40127 may be routed to several alternative hosts, and Exim makes no effort to keep
40128 cross-references.
40129
40130
40131
40132 .section "exim_tidydb" "SECTtidydb"
40133 .cindex "&'exim_tidydb'&"
40134 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40135 database. If run with no options, it removes all records that are more than 30
40136 days old. The age is calculated from the date and time that the record was last
40137 updated. Note that, in the case of the retry database, it is &'not'& the time
40138 since the first delivery failure. Information about a host that has been down
40139 for more than 30 days will remain in the database, provided that the record is
40140 updated sufficiently often.
40141
40142 The cutoff date can be altered by means of the &%-t%& option, which must be
40143 followed by a time. For example, to remove all records older than a week from
40144 the retry database:
40145 .code
40146 exim_tidydb -t 7d /var/spool/exim retry
40147 .endd
40148 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40149 message ids. In the former these appear as data in records keyed by host &--
40150 they were messages that were waiting for that host &-- and in the latter they
40151 are the keys for retry information for messages that have suffered certain
40152 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40153 message ids in database records are those of messages that are still on the
40154 queue. Message ids for messages that no longer exist are removed from
40155 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40156 For the &'retry'& database, records whose keys are non-existent message ids are
40157 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40158 whenever it removes information from the database.
40159
40160 Certain records are automatically removed by Exim when they are no longer
40161 needed, but others are not. For example, if all the MX hosts for a domain are
40162 down, a retry record is created for each one. If the primary MX host comes back
40163 first, its record is removed when Exim successfully delivers to it, but the
40164 records for the others remain because Exim has not tried to use those hosts.
40165
40166 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40167 hints databases. You should do this at a quiet time of day, because it requires
40168 a database to be locked (and therefore inaccessible to Exim) while it does its
40169 work. Removing records from a DBM file does not normally make the file smaller,
40170 but all the common DBM libraries are able to re-use the space that is released.
40171 After an initial phase of increasing in size, the databases normally reach a
40172 point at which they no longer get any bigger, as long as they are regularly
40173 tidied.
40174
40175 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40176 databases is likely to keep on increasing.
40177
40178
40179
40180
40181 .section "exim_fixdb" "SECTfixdb"
40182 .cindex "&'exim_fixdb'&"
40183 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40184 Its main use is for testing Exim, but it might also be occasionally useful for
40185 getting round problems in a live system. Its interface
40186 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40187 key of a database record can then be entered, and the data for that record is
40188 displayed.
40189
40190 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40191 except the &'retry'& database, that is the only operation that can be carried
40192 out. For the &'retry'& database, each field is output preceded by a number, and
40193 data for individual fields can be changed by typing the field number followed
40194 by new data, for example:
40195 .code
40196 > 4 951102:1000
40197 .endd
40198 resets the time of the next delivery attempt. Time values are given as a
40199 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40200 used as optional separators.
40201
40202 Both displayed and input times are in the local timezone by default.
40203 If an option &'-z'& is used on the command line, displayed times
40204 are in UTC.
40205
40206
40207
40208
40209 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40210 .cindex "mailbox" "maintenance"
40211 .cindex "&'exim_lock'&"
40212 .cindex "locking mailboxes"
40213 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40214 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40215 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40216 a user agent while investigating a problem. The utility requires the name of
40217 the file as its first argument. If the locking is successful, the second
40218 argument is run as a command (using C's &[system()]& function); if there is no
40219 second argument, the value of the SHELL environment variable is used; if this
40220 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40221 is unlocked and the utility ends. The following options are available:
40222
40223 .vlist
40224 .vitem &%-fcntl%&
40225 Use &[fcntl()]& locking on the open mailbox.
40226
40227 .vitem &%-flock%&
40228 Use &[flock()]& locking on the open mailbox, provided the operating system
40229 supports it.
40230
40231 .vitem &%-interval%&
40232 This must be followed by a number, which is a number of seconds; it sets the
40233 interval to sleep between retries (default 3).
40234
40235 .vitem &%-lockfile%&
40236 Create a lock file before opening the mailbox.
40237
40238 .vitem &%-mbx%&
40239 Lock the mailbox using MBX rules.
40240
40241 .vitem &%-q%&
40242 Suppress verification output.
40243
40244 .vitem &%-retries%&
40245 This must be followed by a number; it sets the number of times to try to get
40246 the lock (default 10).
40247
40248 .vitem &%-restore_time%&
40249 This option causes &%exim_lock%& to restore the modified and read times to the
40250 locked file before exiting. This allows you to access a locked mailbox (for
40251 example, to take a backup copy) without disturbing the times that the user
40252 subsequently sees.
40253
40254 .vitem &%-timeout%&
40255 This must be followed by a number, which is a number of seconds; it sets a
40256 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40257 default), a non-blocking call is used.
40258
40259 .vitem &%-v%&
40260 Generate verbose output.
40261 .endlist
40262
40263 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40264 default is to create a lock file and also to use &[fcntl()]& locking on the
40265 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40266 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40267 requires that the directory containing the file be writeable. Locking by lock
40268 file does not last forever; Exim assumes that a lock file is expired if it is
40269 more than 30 minutes old.
40270
40271 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40272 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40273 to be taken out on the open mailbox, and an exclusive lock on the file
40274 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40275 number of the mailbox file. When the locking is released, if an exclusive lock
40276 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40277
40278 The default output contains verification of the locking that takes place. The
40279 &%-v%& option causes some additional information to be given. The &%-q%& option
40280 suppresses all output except error messages.
40281
40282 A command such as
40283 .code
40284 exim_lock /var/spool/mail/spqr
40285 .endd
40286 runs an interactive shell while the file is locked, whereas
40287 .display
40288 &`exim_lock -q /var/spool/mail/spqr <<End`&
40289 <&'some commands'&>
40290 &`End`&
40291 .endd
40292 runs a specific non-interactive sequence of commands while the file is locked,
40293 suppressing all verification output. A single command can be run by a command
40294 such as
40295 .code
40296 exim_lock -q /var/spool/mail/spqr \
40297   "cp /var/spool/mail/spqr /some/where"
40298 .endd
40299 Note that if a command is supplied, it must be entirely contained within the
40300 second argument &-- hence the quotes.
40301
40302
40303 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40304 .cindex "exim_msgdate"
40305 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40306 This Perl script converts an Exim Mesage ID back into a human readable form.
40307 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40308
40309 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40310 .ecindex IIDutils
40311 . ////////////////////////////////////////////////////////////////////////////
40312 . ////////////////////////////////////////////////////////////////////////////
40313
40314 .chapter "The Exim monitor" "CHAPeximon"
40315 .scindex IIDeximon "Exim monitor" "description"
40316 .cindex "X-windows"
40317 .cindex "&'eximon'&"
40318 .cindex "Local/eximon.conf"
40319 .cindex "&_exim_monitor/EDITME_&"
40320 The Exim monitor is an application which displays in an X window information
40321 about the state of Exim's queue and what Exim is doing. An admin user can
40322 perform certain operations on messages from this GUI interface; however all
40323 such facilities are also available from the command line, and indeed, the
40324 monitor itself makes use of the command line to perform any actions requested.
40325
40326
40327
40328 .section "Running the monitor" "SECID264"
40329 The monitor is started by running the script called &'eximon'&. This is a shell
40330 script that sets up a number of environment variables, and then runs the
40331 binary called &_eximon.bin_&. The default appearance of the monitor window can
40332 be changed by editing the &_Local/eximon.conf_& file created by editing
40333 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40334 parameters are for.
40335
40336 The parameters that get built into the &'eximon'& script can be overridden for
40337 a particular invocation by setting up environment variables of the same names,
40338 preceded by &`EXIMON_`&. For example, a shell command such as
40339 .code
40340 EXIMON_LOG_DEPTH=400 eximon
40341 .endd
40342 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40343 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40344 overrides the Exim log file configuration. This makes it possible to have
40345 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40346 syslog messages are routed to a file on the local host.
40347
40348 X resources can be used to change the appearance of the window in the normal
40349 way. For example, a resource setting of the form
40350 .code
40351 Eximon*background: gray94
40352 .endd
40353 changes the colour of the background to light grey rather than white. The
40354 stripcharts are drawn with both the data lines and the reference lines in
40355 black. This means that the reference lines are not visible when on top of the
40356 data. However, their colour can be changed by setting a resource called
40357 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40358 For example, if your X server is running Unix, you could set up lighter
40359 reference lines in the stripcharts by obeying
40360 .code
40361 xrdb -merge <<End
40362 Eximon*highlight: gray
40363 End
40364 .endd
40365 .cindex "admin user"
40366 In order to see the contents of messages in the queue, and to operate on them,
40367 &'eximon'& must either be run as root or by an admin user.
40368
40369 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40370 contain X11 resource parameters interpreted by the X11 library.  In addition,
40371 if the first parameter starts with the string "gdb" then it is removed and the
40372 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40373 versioned variants of gdb can be invoked).
40374
40375 The monitor's window is divided into three parts. The first contains one or
40376 more stripcharts and two action buttons, the second contains a &"tail"& of the
40377 main log file, and the third is a display of the queue of messages awaiting
40378 delivery, with two more action buttons. The following sections describe these
40379 different parts of the display.
40380
40381
40382
40383
40384 .section "The stripcharts" "SECID265"
40385 .cindex "stripchart"
40386 The first stripchart is always a count of messages in the queue. Its name can
40387 be configured by setting QUEUE_STRIPCHART_NAME in the
40388 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40389 configuration script by regular expression matches on log file entries, making
40390 it possible to display, for example, counts of messages delivered to certain
40391 hosts or using certain transports. The supplied defaults display counts of
40392 received and delivered messages, and of local and SMTP deliveries. The default
40393 period between stripchart updates is one minute; this can be adjusted by a
40394 parameter in the &_Local/eximon.conf_& file.
40395
40396 The stripchart displays rescale themselves automatically as the value they are
40397 displaying changes. There are always 10 horizontal lines in each chart; the
40398 title string indicates the value of each division when it is greater than one.
40399 For example, &"x2"& means that each division represents a value of 2.
40400
40401 It is also possible to have a stripchart which shows the percentage fullness of
40402 a particular disk partition, which is useful when local deliveries are confined
40403 to a single partition.
40404
40405 .cindex "&%statvfs%& function"
40406 This relies on the availability of the &[statvfs()]& function or equivalent in
40407 the operating system. Most, but not all versions of Unix that support Exim have
40408 this. For this particular stripchart, the top of the chart always represents
40409 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40410 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40411 &_Local/eximon.conf_& file.
40412
40413
40414
40415
40416 .section "Main action buttons" "SECID266"
40417 .cindex "size" "of monitor window"
40418 .cindex "Exim monitor" "window size"
40419 .cindex "window size"
40420 Below the stripcharts there is an action button for quitting the monitor. Next
40421 to this is another button marked &"Size"&. They are placed here so that
40422 shrinking the window to its default minimum size leaves just the queue count
40423 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40424 the window to expand to its maximum size, unless it is already at the maximum,
40425 in which case it is reduced to its minimum.
40426
40427 When expanding to the maximum, if the window cannot be fully seen where it
40428 currently is, it is moved back to where it was the last time it was at full
40429 size. When it is expanding from its minimum size, the old position is
40430 remembered, and next time it is reduced to the minimum it is moved back there.
40431
40432 The idea is that you can keep a reduced window just showing one or two
40433 stripcharts at a convenient place on your screen, easily expand it to show
40434 the full window when required, and just as easily put it back to what it was.
40435 The idea is copied from what the &'twm'& window manager does for its
40436 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40437 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40438
40439 Normally, the monitor starts up with the window at its full size, but it can be
40440 built so that it starts up with the window at its smallest size, by setting
40441 START_SMALL=yes in &_Local/eximon.conf_&.
40442
40443
40444
40445 .section "The log display" "SECID267"
40446 .cindex "log" "tail of; in monitor"
40447 The second section of the window is an area in which a display of the tail of
40448 the main log is maintained.
40449 To save space on the screen, the timestamp on each log line is shortened by
40450 removing the date and, if &%log_timezone%& is set, the timezone.
40451 The log tail is not available when the only destination for logging data is
40452 syslog, unless the syslog lines are routed to a local file whose name is passed
40453 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40454
40455 The log sub-window has a scroll bar at its lefthand side which can be used to
40456 move back to look at earlier text, and the up and down arrow keys also have a
40457 scrolling effect. The amount of log that is kept depends on the setting of
40458 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40459 to use. When this is full, the earlier 50% of data is discarded &-- this is
40460 much more efficient than throwing it away line by line. The sub-window also has
40461 a horizontal scroll bar for accessing the ends of long log lines. This is the
40462 only means of horizontal scrolling; the right and left arrow keys are not
40463 available. Text can be cut from this part of the window using the mouse in the
40464 normal way. The size of this subwindow is controlled by parameters in the
40465 configuration file &_Local/eximon.conf_&.
40466
40467 Searches of the text in the log window can be carried out by means of the ^R
40468 and ^S keystrokes, which default to a reverse and a forward search,
40469 respectively. The search covers only the text that is displayed in the window.
40470 It cannot go further back up the log.
40471
40472 The point from which the search starts is indicated by a caret marker. This is
40473 normally at the end of the text in the window, but can be positioned explicitly
40474 by pointing and clicking with the left mouse button, and is moved automatically
40475 by a successful search. If new text arrives in the window when it is scrolled
40476 back, the caret remains where it is, but if the window is not scrolled back,
40477 the caret is moved to the end of the new text.
40478
40479 Pressing ^R or ^S pops up a window into which the search text can be typed.
40480 There are buttons for selecting forward or reverse searching, for carrying out
40481 the search, and for cancelling. If the &"Search"& button is pressed, the search
40482 happens and the window remains so that further searches can be done. If the
40483 &"Return"& key is pressed, a single search is done and the window is closed. If
40484 ^C is typed the search is cancelled.
40485
40486 The searching facility is implemented using the facilities of the Athena text
40487 widget. By default this pops up a window containing both &"search"& and
40488 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40489 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40490 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40491 provided version of &%TextPop%& when the remaining parts of the text widget
40492 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40493 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40494 on these systems, at the expense of having unwanted items in the search popup
40495 window.
40496
40497
40498
40499 .section "The queue display" "SECID268"
40500 .cindex "queue" "display in monitor"
40501 The bottom section of the monitor window contains a list of all messages that
40502 are in the queue, which includes those currently being received or delivered,
40503 as well as those awaiting delivery. The size of this subwindow is controlled by
40504 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40505 at which it is updated is controlled by another parameter in the same file &--
40506 the default is 5 minutes, since queue scans can be quite expensive. However,
40507 there is an &"Update"& action button just above the display which can be used
40508 to force an update of the queue display at any time.
40509
40510 When a host is down for some time, a lot of pending mail can build up for it,
40511 and this can make it hard to deal with other messages in the queue. To help
40512 with this situation there is a button next to &"Update"& called &"Hide"&. If
40513 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40514 type anything in here and press &"Return"&, the text is added to a chain of
40515 such texts, and if every undelivered address in a message matches at least one
40516 of the texts, the message is not displayed.
40517
40518 If there is an address that does not match any of the texts, all the addresses
40519 are displayed as normal. The matching happens on the ends of addresses so, for
40520 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40521 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40522 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40523 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40524 a hide request is automatically cancelled after one hour.
40525
40526 While the dialogue box is displayed, you can't press any buttons or do anything
40527 else to the monitor window. For this reason, if you want to cut text from the
40528 queue display to use in the dialogue box, you have to do the cutting before
40529 pressing the &"Hide"& button.
40530
40531 The queue display contains, for each unhidden queued message, the length of
40532 time it has been in the queue, the size of the message, the message id, the
40533 message sender, and the first undelivered recipient, all on one line. If it is
40534 a bounce message, the sender is shown as &"<>"&. If there is more than one
40535 recipient to which the message has not yet been delivered, subsequent ones are
40536 listed on additional lines, up to a maximum configured number, following which
40537 an ellipsis is displayed. Recipients that have already received the message are
40538 not shown.
40539
40540 .cindex "frozen messages" "display"
40541 If a message is frozen, an asterisk is displayed at the left-hand side.
40542
40543 The queue display has a vertical scroll bar, and can also be scrolled by means
40544 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40545 The text searching facilities, as described above for the log window, are also
40546 available, but the caret is always moved to the end of the text when the queue
40547 display is updated.
40548
40549
40550
40551 .section "The queue menu" "SECID269"
40552 .cindex "queue" "menu in monitor"
40553 If the &%shift%& key is held down and the left button is clicked when the mouse
40554 pointer is over the text for any message, an action menu pops up, and the first
40555 line of the queue display for the message is highlighted. This does not affect
40556 any selected text.
40557
40558 If you want to use some other event for popping up the menu, you can set the
40559 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40560 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40561 value set in this parameter is a standard X event description. For example, to
40562 run eximon using &%ctrl%& rather than &%shift%& you could use
40563 .code
40564 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40565 .endd
40566 The title of the menu is the message id, and it contains entries which act as
40567 follows:
40568
40569 .ilist
40570 &'message log'&: The contents of the message log for the message are displayed
40571 in a new text window.
40572 .next
40573 &'headers'&: Information from the spool file that contains the envelope
40574 information and headers is displayed in a new text window. See chapter
40575 &<<CHAPspool>>& for a description of the format of spool files.
40576 .next
40577 &'body'&: The contents of the spool file containing the body of the message are
40578 displayed in a new text window. There is a default limit of 20,000 bytes to the
40579 amount of data displayed. This can be changed by setting the BODY_MAX
40580 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40581 .next
40582 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40583 delivery of the message. This causes an automatic thaw if the message is
40584 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40585 a new text window. The delivery is run in a separate process, to avoid holding
40586 up the monitor while the delivery proceeds.
40587 .next
40588 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40589 that the message be frozen.
40590 .next
40591 .cindex "thawing messages"
40592 .cindex "unfreezing messages"
40593 .cindex "frozen messages" "thawing"
40594 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40595 that the message be thawed.
40596 .next
40597 .cindex "delivery" "forcing failure"
40598 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40599 that Exim gives up trying to deliver the message. A bounce message is generated
40600 for any remaining undelivered addresses.
40601 .next
40602 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40603 that the message be deleted from the system without generating a bounce
40604 message.
40605 .next
40606 &'add recipient'&: A dialog box is displayed into which a recipient address can
40607 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40608 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40609 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40610 causes a call to Exim to be made using the &%-Mar%& option to request that an
40611 additional recipient be added to the message, unless the entry box is empty, in
40612 which case no action is taken.
40613 .next
40614 &'mark delivered'&: A dialog box is displayed into which a recipient address
40615 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40616 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40617 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40618 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40619 recipient address as already delivered, unless the entry box is empty, in which
40620 case no action is taken.
40621 .next
40622 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40623 mark all recipient addresses as already delivered.
40624 .next
40625 &'edit sender'&: A dialog box is displayed initialized with the current
40626 sender's address. Pressing RETURN causes a call to Exim to be made using the
40627 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40628 in which case no action is taken. If you want to set an empty sender (as in
40629 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40630 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40631 the address is qualified with that domain.
40632 .endlist
40633
40634 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40635 other cases when a call to Exim is made, if there is any output from Exim (in
40636 particular, if the command fails) a window containing the command and the
40637 output is displayed. Otherwise, the results of the action are normally apparent
40638 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40639 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40640 if no output is generated.
40641
40642 The queue display is automatically updated for actions such as freezing and
40643 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40644 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40645 force an update of the display after one of these actions.
40646
40647 In any text window that is displayed as result of a menu action, the normal
40648 cut-and-paste facility is available, and searching can be carried out using ^R
40649 and ^S, as described above for the log tail window.
40650 .ecindex IIDeximon
40651
40652
40653
40654
40655
40656 . ////////////////////////////////////////////////////////////////////////////
40657 . ////////////////////////////////////////////////////////////////////////////
40658
40659 .chapter "Security considerations" "CHAPsecurity"
40660 .scindex IIDsecurcon "security" "discussion of"
40661 This chapter discusses a number of issues concerned with security, some of
40662 which are also covered in other parts of this manual.
40663
40664 For reasons that this author does not understand, some people have promoted
40665 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40666 existence of this chapter in the documentation. However, the intent of the
40667 chapter is simply to describe the way Exim works in relation to certain
40668 security concerns, not to make any specific claims about the effectiveness of
40669 its security as compared with other MTAs.
40670
40671 What follows is a description of the way Exim is supposed to be. Best efforts
40672 have been made to try to ensure that the code agrees with the theory, but an
40673 absence of bugs can never be guaranteed. Any that are reported will get fixed
40674 as soon as possible.
40675
40676
40677 .section "Building a more &""hardened""& Exim" "SECID286"
40678 .cindex "security" "build-time features"
40679 There are a number of build-time options that can be set in &_Local/Makefile_&
40680 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40681 Exim administrator who does not have the root password, or by someone who has
40682 penetrated the Exim (but not the root) account. These options are as follows:
40683
40684 .ilist
40685 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40686 start of any filenames used with the &%-C%& option. When it is set, these
40687 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40688 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40689 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40690 default setting for &%ALT_CONFIG_PREFIX%&.
40691
40692 If the permitted configuration files are confined to a directory to
40693 which only root has access, this guards against someone who has broken
40694 into the Exim account from running a privileged Exim with an arbitrary
40695 configuration file, and using it to break into other accounts.
40696 .next
40697
40698 If a non-trusted configuration file (i.e. not the default configuration file
40699 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40700 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40701 the next item), then root privilege is retained only if the caller of Exim is
40702 root. This locks out the possibility of testing a configuration using &%-C%&
40703 right through message reception and delivery, even if the caller is root. The
40704 reception works, but by that time, Exim is running as the Exim user, so when
40705 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40706 privilege to be lost. However, root can test reception and delivery using two
40707 separate commands.
40708
40709 .next
40710 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40711 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40712 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40713 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40714 the restrictive side.  Requiring build-time selection of safe macros is onerous
40715 but this option is intended solely as a transition mechanism to permit
40716 previously-working configurations to continue to work after release 4.73.
40717 .next
40718 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40719 is disabled.
40720 .next
40721 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40722 never to be used for any deliveries. This is like the &%never_users%& runtime
40723 option, but it cannot be overridden; the runtime option adds additional users
40724 to the list. The default setting is &"root"&; this prevents a non-root user who
40725 is permitted to modify the runtime file from using Exim as a way to get root.
40726 .endlist
40727
40728
40729
40730 .section "Root privilege" "SECID270"
40731 .cindex "setuid"
40732 .cindex "root privilege"
40733 The Exim binary is normally setuid to root, which means that it gains root
40734 privilege (runs as root) when it starts execution. In some special cases (for
40735 example, when the daemon is not in use and there are no local deliveries), it
40736 may be possible to run Exim setuid to some user other than root. This is
40737 discussed in the next section. However, in most installations, root privilege
40738 is required for two things:
40739
40740 .ilist
40741 To set up a socket connected to the standard SMTP port (25) when initialising
40742 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40743 not required.
40744 .next
40745 To be able to change uid and gid in order to read users' &_.forward_& files and
40746 perform local deliveries as the receiving user or as specified in the
40747 configuration.
40748 .endlist
40749
40750 It is not necessary to be root to do any of the other things Exim does, such as
40751 receiving messages and delivering them externally over SMTP, and it is
40752 obviously more secure if Exim does not run as root except when necessary.
40753 For this reason, a user and group for Exim to use must be defined in
40754 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40755 group"&. Their values can be changed by the runtime configuration, though this
40756 is not recommended. Often a user called &'exim'& is used, but some sites use
40757 &'mail'& or another user name altogether.
40758
40759 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40760 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40761 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40762
40763 After a new Exim process has interpreted its command line options, it changes
40764 uid and gid in the following cases:
40765
40766 .ilist
40767 .oindex "&%-C%&"
40768 .oindex "&%-D%&"
40769 If the &%-C%& option is used to specify an alternate configuration file, or if
40770 the &%-D%& option is used to define macro values for the configuration, and the
40771 calling process is not running as root, the uid and gid are changed to those of
40772 the calling process.
40773 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40774 option may not be used at all.
40775 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40776 can be supplied if the calling process is running as root, the Exim run-time
40777 user or CONFIGURE_OWNER, if defined.
40778 .next
40779 .oindex "&%-be%&"
40780 .oindex "&%-bf%&"
40781 .oindex "&%-bF%&"
40782 If the expansion test option (&%-be%&) or one of the filter testing options
40783 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40784 calling process.
40785 .next
40786 If the process is not a daemon process or a queue runner process or a delivery
40787 process or a process for testing address routing (started with &%-bt%&), the
40788 uid and gid are changed to the Exim user and group. This means that Exim always
40789 runs under its own uid and gid when receiving messages. This also applies when
40790 testing address verification
40791 .oindex "&%-bv%&"
40792 .oindex "&%-bh%&"
40793 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40794 option).
40795 .next
40796 For a daemon, queue runner, delivery, or address testing process, the uid
40797 remains as root at this stage, but the gid is changed to the Exim group.
40798 .endlist
40799
40800 The processes that initially retain root privilege behave as follows:
40801
40802 .ilist
40803 A daemon process changes the gid to the Exim group and the uid to the Exim
40804 user after setting up one or more listening sockets. The &[initgroups()]&
40805 function is called, so that if the Exim user is in any additional groups, they
40806 will be used during message reception.
40807 .next
40808 A queue runner process retains root privilege throughout its execution. Its
40809 job is to fork a controlled sequence of delivery processes.
40810 .next
40811 A delivery process retains root privilege throughout most of its execution,
40812 but any actual deliveries (that is, the transports themselves) are run in
40813 subprocesses which always change to a non-root uid and gid. For local
40814 deliveries this is typically the uid and gid of the owner of the mailbox; for
40815 remote deliveries, the Exim uid and gid are used. Once all the delivery
40816 subprocesses have been run, a delivery process changes to the Exim uid and gid
40817 while doing post-delivery tidying up such as updating the retry database and
40818 generating bounce and warning messages.
40819
40820 While the recipient addresses in a message are being routed, the delivery
40821 process runs as root. However, if a user's filter file has to be processed,
40822 this is done in a subprocess that runs under the individual user's uid and
40823 gid. A system filter is run as root unless &%system_filter_user%& is set.
40824 .next
40825 A process that is testing addresses (the &%-bt%& option) runs as root so that
40826 the routing is done in the same environment as a message delivery.
40827 .endlist
40828
40829
40830
40831
40832 .section "Running Exim without privilege" "SECTrunexiwitpri"
40833 .cindex "privilege, running without"
40834 .cindex "unprivileged running"
40835 .cindex "root privilege" "running without"
40836 Some installations like to run Exim in an unprivileged state for more of its
40837 operation, for added security. Support for this mode of operation is provided
40838 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40839 gid are changed to the Exim user and group at the start of a delivery process
40840 (and also queue runner and address testing processes). This means that address
40841 routing is no longer run as root, and the deliveries themselves cannot change
40842 to any other uid.
40843
40844 .cindex SIGHUP
40845 .cindex "daemon" "restarting"
40846 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40847 that the daemon can still be started in the usual way, and it can respond
40848 correctly to SIGHUP because the re-invocation regains root privilege.
40849
40850 An alternative approach is to make Exim setuid to the Exim user and also setgid
40851 to the Exim group. If you do this, the daemon must be started from a root
40852 process. (Calling Exim from a root process makes it behave in the way it does
40853 when it is setuid root.) However, the daemon cannot restart itself after a
40854 SIGHUP signal because it cannot regain privilege.
40855
40856 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40857 stops Exim from trying to re-invoke itself to do a delivery after a message has
40858 been received. Such a re-invocation is a waste of resources because it has no
40859 effect.
40860
40861 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40862 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40863 to the Exim user seems a clean approach, but there is one complication:
40864
40865 In this style of operation, Exim is running with the real uid and gid set to
40866 those of the calling process, and the effective uid/gid set to Exim's values.
40867 Ideally, any association with the calling process' uid/gid should be dropped,
40868 that is, the real uid/gid should be reset to the effective values so as to
40869 discard any privileges that the caller may have. While some operating systems
40870 have a function that permits this action for a non-root effective uid, quite a
40871 number of them do not. Because of this lack of standardization, Exim does not
40872 address this problem at this time.
40873
40874 For this reason, the recommended approach for &"mostly unprivileged"& running
40875 is to keep the Exim binary setuid to root, and to set
40876 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40877 be used in the most straightforward way.
40878
40879 If you configure Exim not to run delivery processes as root, there are a
40880 number of restrictions on what you can do:
40881
40882 .ilist
40883 You can deliver only as the Exim user/group. You should  explicitly use the
40884 &%user%& and &%group%& options to override routers or local transports that
40885 normally deliver as the recipient. This makes sure that configurations that
40886 work in this mode function the same way in normal mode. Any implicit or
40887 explicit specification of another user causes an error.
40888 .next
40889 Use of &_.forward_& files is severely restricted, such that it is usually
40890 not worthwhile to include them in the configuration.
40891 .next
40892 Users who wish to use &_.forward_& would have to make their home directory and
40893 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40894 and their equivalents in Exim filters, cannot be used. While they could be
40895 enabled in the Exim user's name, that would be insecure and not very useful.
40896 .next
40897 Unless the local user mailboxes are all owned by the Exim user (possible in
40898 some POP3 or IMAP-only environments):
40899
40900 .olist
40901 They must be owned by the Exim group and be writeable by that group. This
40902 implies you must set &%mode%& in the appendfile configuration, as well as the
40903 mode of the mailbox files themselves.
40904 .next
40905 You must set &%no_check_owner%&, since most or all of the files will not be
40906 owned by the Exim user.
40907 .next
40908 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40909 on a newly created mailbox when unprivileged. This also implies that new
40910 mailboxes need to be created manually.
40911 .endlist olist
40912 .endlist ilist
40913
40914
40915 These restrictions severely restrict what can be done in local deliveries.
40916 However, there are no restrictions on remote deliveries. If you are running a
40917 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40918 gives more security at essentially no cost.
40919
40920 If you are using the &%mua_wrapper%& facility (see chapter
40921 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40922
40923
40924
40925
40926 .section "Delivering to local files" "SECID271"
40927 Full details of the checks applied by &(appendfile)& before it writes to a file
40928 are given in chapter &<<CHAPappendfile>>&.
40929
40930
40931
40932 .section "Running local commands" "SECTsecconslocalcmds"
40933 .cindex "security" "local commands"
40934 .cindex "security" "command injection attacks"
40935 There are a number of ways in which an administrator can configure Exim to run
40936 commands based upon received, untrustworthy, data. Further, in some
40937 configurations a user who can control a &_.forward_& file can also arrange to
40938 run commands. Configuration to check includes, but is not limited to:
40939
40940 .ilist
40941 Use of &%use_shell%& in the pipe transport: various forms of shell command
40942 injection may be possible with this option present. It is dangerous and should
40943 be used only with considerable caution. Consider constraints which whitelist
40944 allowed characters in a variable which is to be used in a pipe transport that
40945 has &%use_shell%& enabled.
40946 .next
40947 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40948 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40949 &_.forward_& files in a redirect router. If Exim is running on a central mail
40950 hub to which ordinary users do not have shell access, but home directories are
40951 NFS mounted (for instance) then administrators should review the list of these
40952 forbid options available, and should bear in mind that the options that may
40953 need forbidding can change as new features are added between releases.
40954 .next
40955 The &%${run...}%& expansion item does not use a shell by default, but
40956 administrators can configure use of &_/bin/sh_& as part of the command.
40957 Such invocations should be viewed with prejudicial suspicion.
40958 .next
40959 Administrators who use embedded Perl are advised to explore how Perl's
40960 taint checking might apply to their usage.
40961 .next
40962 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40963 administrators are well advised to view its use with suspicion, in case (for
40964 instance) it allows a local-part to contain embedded Exim directives.
40965 .next
40966 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40967 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40968 each can reference arbitrary lists and files, rather than just being a list
40969 of opaque strings.
40970 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40971 real-world security vulnerabilities caused by its use with untrustworthy data
40972 injected in, for SQL injection attacks.
40973 Consider the use of the &%inlisti%& expansion condition instead.
40974 .endlist
40975
40976
40977
40978
40979 .section "Trust in configuration data" "SECTsecconfdata"
40980 .cindex "security" "data sources"
40981 .cindex "security" "regular expressions"
40982 .cindex "regular expressions" "security"
40983 .cindex "PCRE2" "security"
40984 If configuration data for Exim can come from untrustworthy sources, there
40985 are some issues to be aware of:
40986
40987 .ilist
40988 Use of &%${expand...}%& may provide a path for shell injection attacks.
40989 .next
40990 Letting untrusted data provide a regular expression is unwise.
40991 .next
40992 Using &%${match...}%& to apply a fixed regular expression against untrusted
40993 data may result in pathological behaviour within PCRE2.  Be aware of what
40994 "backtracking" means and consider options for being more strict with a regular
40995 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40996 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40997 possessive quantifiers or just not using regular expressions against untrusted
40998 data.
40999 .next
41000 It can be important to correctly use &%${quote:...}%&,
41001 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41002 items to ensure that data is correctly constructed.
41003 .next
41004 Some lookups might return multiple results, even though normal usage is only
41005 expected to yield one result.
41006 .endlist
41007
41008
41009
41010
41011 .section "IPv4 source routing" "SECID272"
41012 .cindex "source routing" "in IP packets"
41013 .cindex "IP source routing"
41014 Many operating systems suppress IP source-routed packets in the kernel, but
41015 some cannot be made to do this, so Exim does its own check. It logs incoming
41016 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41017 IPv6. No special checking is currently done.
41018
41019
41020
41021 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41022 Support for these SMTP commands is disabled by default. If required, they can
41023 be enabled by defining suitable ACLs.
41024
41025
41026
41027
41028 .section "Privileged users" "SECID274"
41029 .cindex "trusted users"
41030 .cindex "admin user"
41031 .cindex "privileged user"
41032 .cindex "user" "trusted"
41033 .cindex "user" "admin"
41034 Exim recognizes two sets of users with special privileges. Trusted users are
41035 able to submit new messages to Exim locally, but supply their own sender
41036 addresses and information about a sending host. For other users submitting
41037 local messages, Exim sets up the sender address from the uid, and doesn't
41038 permit a remote host to be specified.
41039
41040 .oindex "&%-f%&"
41041 However, an untrusted user is permitted to use the &%-f%& command line option
41042 in the special form &%-f <>%& to indicate that a delivery failure for the
41043 message should not cause an error report. This affects the message's envelope,
41044 but it does not affect the &'Sender:'& header. Untrusted users may also be
41045 permitted to use specific forms of address with the &%-f%& option by setting
41046 the &%untrusted_set_sender%& option.
41047
41048 Trusted users are used to run processes that receive mail messages from some
41049 other mail domain and pass them on to Exim for delivery either locally, or over
41050 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41051 as any user listed in the &%trusted_users%& configuration option, or under any
41052 group listed in the &%trusted_groups%& option.
41053
41054 Admin users are permitted to do things to the messages on Exim's queue. They
41055 can freeze or thaw messages, cause them to be returned to their senders, remove
41056 them entirely, or modify them in various ways. In addition, admin users can run
41057 the Exim monitor and see all the information it is capable of providing, which
41058 includes the contents of files on the spool.
41059
41060 .oindex "&%-M%&"
41061 .oindex "&%-q%&"
41062 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41063 delivery of messages on its queue is restricted to admin users. This
41064 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41065 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41066 queue is also restricted to admin users. This restriction can be relaxed by
41067 setting &%no_queue_list_requires_admin%&.
41068
41069 Exim recognizes an admin user if the calling process is running as root or as
41070 the Exim user or if any of the groups associated with the calling process is
41071 the Exim group. It is not necessary actually to be running under the Exim
41072 group. However, if admin users who are not root or the Exim user are to access
41073 the contents of files on the spool via the Exim monitor (which runs
41074 unprivileged), Exim must be built to allow group read access to its spool
41075 files.
41076
41077 By default, regular users are trusted to perform basic testing and
41078 introspection commands, as themselves.  This setting can be tightened by
41079 setting the &%commandline_checks_require_admin%& option.
41080 This affects most of the checking options,
41081 such as &%-be%& and anything else &%-b*%&.
41082
41083
41084 .section "Spool files" "SECID275"
41085 .cindex "spool directory" "files"
41086 Exim's spool directory and everything it contains is owned by the Exim user and
41087 set to the Exim group. The mode for spool files is defined in the
41088 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41089 any user who is a member of the Exim group can access these files.
41090
41091
41092
41093 .section "Use of argv[0]" "SECID276"
41094 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41095 of specific strings, Exim assumes certain options. For example, calling Exim
41096 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41097 to calling it with the option &%-bS%&. There are no security implications in
41098 this.
41099
41100
41101
41102 .section "Use of %f formatting" "SECID277"
41103 The only use made of &"%f"& by Exim is in formatting load average values. These
41104 are actually stored in integer variables as 1000 times the load average.
41105 Consequently, their range is limited and so therefore is the length of the
41106 converted output.
41107
41108
41109
41110 .section "Embedded Exim path" "SECID278"
41111 Exim uses its own path name, which is embedded in the code, only when it needs
41112 to re-exec in order to regain root privilege. Therefore, it is not root when it
41113 does so. If some bug allowed the path to get overwritten, it would lead to an
41114 arbitrary program's being run as exim, not as root.
41115
41116
41117
41118 .section "Dynamic module directory" "SECTdynmoddir"
41119 Any dynamically loadable modules must be installed into the directory
41120 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41121 loading it.
41122
41123
41124 .section "Use of sprintf()" "SECID279"
41125 .cindex "&[sprintf()]&"
41126 A large number of occurrences of &"sprintf"& in the code are actually calls to
41127 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41128 The intermediate formatting is done into a large fixed buffer by a function
41129 that runs through the format string itself, and checks the length of each
41130 conversion before performing it, thus preventing buffer overruns.
41131
41132 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41133 the output buffer is known to be sufficiently long to contain the converted
41134 string.
41135
41136
41137
41138 .section "Use of debug_printf() and log_write()" "SECID280"
41139 Arbitrary strings are passed to both these functions, but they do their
41140 formatting by calling the function &'string_vformat()'&, which runs through
41141 the format string itself, and checks the length of each conversion.
41142
41143
41144
41145 .section "Use of strcat() and strcpy()" "SECID281"
41146 These are used only in cases where the output buffer is known to be large
41147 enough to hold the result.
41148 .ecindex IIDsecurcon
41149
41150
41151
41152
41153 . ////////////////////////////////////////////////////////////////////////////
41154 . ////////////////////////////////////////////////////////////////////////////
41155
41156 .chapter "Format of spool files" "CHAPspool"
41157 .scindex IIDforspo1 "format" "spool files"
41158 .scindex IIDforspo2 "spool directory" "format of files"
41159 .scindex IIDforspo3 "spool files" "format of"
41160 .cindex "spool files" "editing"
41161 A message on Exim's queue consists of two files, whose names are the message id
41162 followed by -D and -H, respectively. The data portion of the message is kept in
41163 the -D file on its own. The message's envelope, status, and headers are all
41164 kept in the -H file, whose format is described in this chapter. Each of these
41165 two files contains the final component of its own name as its first line. This
41166 is insurance against disk crashes where the directory is lost but the files
41167 themselves are recoverable.
41168
41169 The file formats may be changed, or new formats added, at any release.
41170 Spool files are not intended as an interface to other programs
41171 and should not be used as such.
41172
41173 Some people are tempted into editing -D files in order to modify messages. You
41174 need to be extremely careful if you do this; it is not recommended and you are
41175 on your own if you do it. Here are some of the pitfalls:
41176
41177 .ilist
41178 You must ensure that Exim does not try to deliver the message while you are
41179 fiddling with it. The safest way is to take out a write lock on the -D file,
41180 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41181 place, the lock will be retained. If you write a new file and rename it, the
41182 lock will be lost at the instant of rename.
41183 .next
41184 .vindex "&$body_linecount$&"
41185 If you change the number of lines in the file, the value of
41186 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41187 cause incomplete transmission of messages or undeliverable messages.
41188 .next
41189 If the message is in MIME format, you must take care not to break it.
41190 .next
41191 If the message is cryptographically signed, any change will invalidate the
41192 signature.
41193 .endlist
41194 All in all, modifying -D files is fraught with danger.
41195
41196 Files whose names end with -J may also be seen in the &_input_& directory (or
41197 its subdirectories when &%split_spool_directory%& is set). These are journal
41198 files, used to record addresses to which the message has been delivered during
41199 the course of a delivery attempt. If there are still undelivered recipients at
41200 the end, the -H file is updated, and the -J file is deleted. If, however, there
41201 is some kind of crash (for example, a power outage) before this happens, the -J
41202 file remains in existence. When Exim next processes the message, it notices the
41203 -J file and uses it to update the -H file before starting the next delivery
41204 attempt.
41205
41206 Files whose names end with -K or .eml may also be seen in the spool.
41207 These are temporaries used for DKIM or malware processing, when that is used.
41208 They should be tidied up by normal operations; any old ones are probably
41209 relics of crashes and can be removed.
41210
41211 .section "Format of the -H file" "SECID282"
41212 .cindex "uid (user id)" "in spool file"
41213 .cindex "gid (group id)" "in spool file"
41214 The second line of the -H file contains the login name for the uid of the
41215 process that called Exim to read the message, followed by the numerical uid and
41216 gid. For a locally generated message, this is normally the user who sent the
41217 message. For a message received over TCP/IP via the daemon, it is
41218 normally the Exim user.
41219
41220 The third line of the file contains the address of the message's sender as
41221 transmitted in the envelope, contained in angle brackets. The sender address is
41222 empty for bounce messages. For incoming SMTP mail, the sender address is given
41223 in the MAIL command. For locally generated mail, the sender address is
41224 created by Exim from the login name of the current user and the configured
41225 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41226 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41227 &"<>"& or an address that matches &%untrusted_set_senders%&.
41228
41229 The fourth line contains two numbers. The first is the time that the message
41230 was received, in the conventional Unix form &-- the number of seconds since the
41231 start of the epoch. The second number is a count of the number of messages
41232 warning of delayed delivery that have been sent to the sender.
41233
41234 There follow a number of lines starting with a hyphen.
41235 These contain variables, can appear in any
41236 order, and are omitted when not relevant.
41237
41238 If there is a second hyphen after the first,
41239 the corresponding data is tainted.
41240 If there is a value in parentheses, the data is quoted for a lookup.
41241
41242 The following word specifies a variable,
41243 and the remainder of the item depends on the variable.
41244
41245 .vlist
41246 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41247 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41248 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41249 recognized, to provide backward compatibility. In the old format, a line of
41250 this form is present for every ACL variable that is not empty. The number
41251 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41252 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41253 the data string for the variable. The string itself starts at the beginning of
41254 the next line, and is followed by a newline character. It may contain internal
41255 newlines.
41256
41257 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41258 A line of this form is present for every ACL connection variable that is
41259 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41260 The length is the length of the data string for the variable. The string itself
41261 starts at the beginning of the next line, and is followed by a newline
41262 character. It may contain internal newlines.
41263
41264 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41265 A line of this form is present for every ACL message variable that is defined.
41266 Note that there is a space between &%-aclm%& and the rest of the name. The
41267 length is the length of the data string for the variable. The string itself
41268 starts at the beginning of the next line, and is followed by a newline
41269 character. It may contain internal newlines.
41270
41271 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41272 This is present if, when the message was received over SMTP, the value of
41273 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41274
41275 .vitem &%-allow_unqualified_recipient%&
41276 This is present if unqualified recipient addresses are permitted in header
41277 lines (to stop such addresses from being qualified if rewriting occurs at
41278 transport time). Local messages that were input using &%-bnq%& and remote
41279 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41280
41281 .vitem &%-allow_unqualified_sender%&
41282 This is present if unqualified sender addresses are permitted in header lines
41283 (to stop such addresses from being qualified if rewriting occurs at transport
41284 time). Local messages that were input using &%-bnq%& and remote messages from
41285 hosts that match &%sender_unqualified_hosts%& set this flag.
41286
41287 .vitem "&%-auth_id%&&~<&'text'&>"
41288 The id information for a message received on an authenticated SMTP connection
41289 &-- the value of the &$authenticated_id$& variable.
41290
41291 .vitem "&%-auth_sender%&&~<&'address'&>"
41292 The address of an authenticated sender &-- the value of the
41293 &$authenticated_sender$& variable.
41294
41295 .vitem "&%-body_linecount%&&~<&'number'&>"
41296 This records the number of lines in the body of the message, and is
41297 present unless &%-spool_file_wireformat%& is.
41298
41299 .vitem "&%-body_zerocount%&&~<&'number'&>"
41300 This records the number of binary zero bytes in the body of the message, and is
41301 present if the number is greater than zero.
41302
41303 .vitem &%-deliver_firsttime%&
41304 This is written when a new message is first added to the spool. When the spool
41305 file is updated after a deferral, it is omitted.
41306
41307 .vitem "&%-frozen%&&~<&'time'&>"
41308 .cindex "frozen messages" "spool data"
41309 The message is frozen, and the freezing happened at <&'time'&>.
41310
41311 .vitem "&%-helo_name%&&~<&'text'&>"
41312 This records the host name as specified by a remote host in a HELO or EHLO
41313 command.
41314
41315 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41316 This records the IP address of the host from which the message was received and
41317 the remote port number that was used. It is omitted for locally generated
41318 messages.
41319
41320 .vitem "&%-host_auth%&&~<&'text'&>"
41321 If the message was received on an authenticated SMTP connection, this records
41322 the name of the authenticator &-- the value of the
41323 &$sender_host_authenticated$& variable.
41324
41325 .vitem &%-host_lookup_failed%&
41326 This is present if an attempt to look up the sending host's name from its IP
41327 address failed. It corresponds to the &$host_lookup_failed$& variable.
41328
41329 .vitem "&%-host_name%&&~<&'text'&>"
41330 .cindex "reverse DNS lookup"
41331 .cindex "DNS" "reverse lookup"
41332 This records the name of the remote host from which the message was received,
41333 if the host name was looked up from the IP address when the message was being
41334 received. It is not present if no reverse lookup was done.
41335
41336 .vitem "&%-ident%&&~<&'text'&>"
41337 For locally submitted messages, this records the login of the originating user,
41338 unless it was a trusted user and the &%-oMt%& option was used to specify an
41339 ident value. For messages received over TCP/IP, this records the ident string
41340 supplied by the remote host, if any.
41341
41342 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41343 This records the IP address of the local interface and the port number through
41344 which a message was received from a remote host. It is omitted for locally
41345 generated messages.
41346
41347 .vitem &%-local%&
41348 The message is from a local sender.
41349
41350 .vitem &%-localerror%&
41351 The message is a locally-generated bounce message.
41352
41353 .vitem "&%-local_scan%&&~<&'string'&>"
41354 This records the data string that was returned by the &[local_scan()]& function
41355 when the message was received &-- the value of the &$local_scan_data$&
41356 variable. It is omitted if no data was returned.
41357
41358 .vitem &%-manual_thaw%&
41359 The message was frozen but has been thawed manually, that is, by an explicit
41360 Exim command rather than via the auto-thaw process.
41361
41362 .vitem &%-N%&
41363 A testing delivery process was started using the &%-N%& option to suppress any
41364 actual deliveries, but delivery was deferred. At any further delivery attempts,
41365 &%-N%& is assumed.
41366
41367 .vitem &%-received_protocol%&
41368 This records the value of the &$received_protocol$& variable, which contains
41369 the name of the protocol by which the message was received.
41370
41371 .vitem &%-sender_set_untrusted%&
41372 The envelope sender of this message was set by an untrusted local caller (used
41373 to ensure that the caller is displayed in queue listings).
41374
41375 .vitem "&%-spam_score_int%&&~<&'number'&>"
41376 If a message was scanned by SpamAssassin, this is present. It records the value
41377 of &$spam_score_int$&.
41378
41379 .vitem &%-spool_file_wireformat%&
41380 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41381 rather than Unix-format.
41382 The line-ending is CRLF rather than newline.
41383 There is still, however, no leading-dot-stuffing.
41384
41385 .vitem &%-tls_certificate_verified%&
41386 A TLS certificate was received from the client that sent this message, and the
41387 certificate was verified by the server.
41388
41389 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41390 When the message was received over an encrypted connection, this records the
41391 name of the cipher suite that was used.
41392
41393 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41394 When the message was received over an encrypted connection, and a certificate
41395 was received from the client, this records the Distinguished Name from that
41396 certificate.
41397 .endlist
41398
41399 Following the options there is a list of those addresses to which the message
41400 is not to be delivered. This set of addresses is initialized from the command
41401 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41402 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41403 the address is added to this set. The addresses are kept internally as a
41404 balanced binary tree, and it is a representation of that tree which is written
41405 to the spool file. If an address is expanded via an alias or forward file, the
41406 original address is added to the tree when deliveries to all its child
41407 addresses are complete.
41408
41409 If the tree is empty, there is a single line in the spool file containing just
41410 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41411 Y or N, followed by an address. The address is the value for the node of the
41412 tree, and the letters indicate whether the node has a left branch and/or a
41413 right branch attached to it, respectively. If branches exist, they immediately
41414 follow. Here is an example of a three-node tree:
41415 .code
41416 YY darcy@austen.fict.example
41417 NN alice@wonderland.fict.example
41418 NN editor@thesaurus.ref.example
41419 .endd
41420 After the non-recipients tree, there is a list of the message's recipients.
41421 This is a simple list, preceded by a count. It includes all the original
41422 recipients of the message, including those to whom the message has already been
41423 delivered. In the simplest case, the list contains one address per line. For
41424 example:
41425 .code
41426 4
41427 editor@thesaurus.ref.example
41428 darcy@austen.fict.example
41429 rdo@foundation
41430 alice@wonderland.fict.example
41431 .endd
41432 However, when a child address has been added to the top-level addresses as a
41433 result of the use of the &%one_time%& option on a &(redirect)& router, each
41434 line is of the following form:
41435 .display
41436 <&'top-level address'&> <&'errors_to address'&> &&&
41437   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41438 .endd
41439 The 01 flag bit indicates the presence of the three other fields that follow
41440 the top-level address. Other bits may be used in future to support additional
41441 fields. The <&'parent number'&> is the offset in the recipients list of the
41442 original parent of the &"one time"& address. The first two fields are the
41443 envelope sender that is associated with this address and its length. If the
41444 length is zero, there is no special envelope sender (there are then two space
41445 characters in the line). A non-empty field can arise from a &(redirect)& router
41446 that has an &%errors_to%& setting.
41447
41448
41449 A blank line separates the envelope and status information from the headers
41450 which follow. A header may occupy several lines of the file, and to save effort
41451 when reading it in, each header is preceded by a number and an identifying
41452 character. The number is the number of characters in the header, including any
41453 embedded newlines and the terminating newline. The character is one of the
41454 following:
41455
41456 .table2 50pt
41457 .row <&'blank'&>         "header in which Exim has no special interest"
41458 .row &`B`&               "&'Bcc:'& header"
41459 .row &`C`&               "&'Cc:'& header"
41460 .row &`F`&               "&'From:'& header"
41461 .row &`I`&               "&'Message-id:'& header"
41462 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41463 .row &`R`&               "&'Reply-To:'& header"
41464 .row &`S`&               "&'Sender:'& header"
41465 .row &`T`&               "&'To:'& header"
41466 .row &`*`&               "replaced or deleted header"
41467 .endtable
41468
41469 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41470 purposes. They are not transmitted when the message is delivered. Here is a
41471 typical set of headers:
41472 .code
41473 111P Received: by hobbit.fict.example with local (Exim 4.00)
41474 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41475 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41476 038* X-rewrote-sender: bb@hobbit.fict.example
41477 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41478 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41479 099* To: alice@wonderland.fict.example, rdo@foundation,
41480 darcy@austen.fict.example, editor@thesaurus.ref.example
41481 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41482 darcy@austen.fict.example, editor@thesaurus.ref.example
41483 038  Date: Fri, 11 May 2001 10:28:59 +0100
41484 .endd
41485 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41486 &'To:'& header have been rewritten, the last one because routing expanded the
41487 unqualified domain &'foundation'&.
41488 .ecindex IIDforspo1
41489 .ecindex IIDforspo2
41490 .ecindex IIDforspo3
41491
41492 .section "Format of the -D file" "SECID282a"
41493 The data file is traditionally in Unix-standard format: lines are ended with
41494 an ASCII newline character.
41495 However, when the &%spool_wireformat%& main option is used some -D files
41496 can have an alternate format.
41497 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41498 The -D file lines (not including the first name-component line) are
41499 suitable for direct copying to the wire when transmitting using the
41500 ESMTP CHUNKING option, meaning lower processing overhead.
41501 Lines are terminated with an ASCII CRLF pair.
41502 There is no dot-stuffing (and no dot-termination).
41503
41504 . ////////////////////////////////////////////////////////////////////////////
41505 . ////////////////////////////////////////////////////////////////////////////
41506
41507 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41508          "DKIM, SPF, SRS and DMARC Support"
41509
41510 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41511 .cindex "DKIM"
41512
41513 DKIM is a mechanism by which messages sent by some entity can be provably
41514 linked to a domain which that entity controls.  It permits reputation to
41515 be tracked on a per-domain basis, rather than merely upon source IP address.
41516 DKIM is documented in RFC 6376.
41517
41518 As DKIM relies on the message being unchanged in transit, messages handled
41519 by a mailing-list (which traditionally adds to the message) will not match
41520 any original DKIM signature.
41521
41522 DKIM support is compiled into Exim by default if TLS support is present.
41523 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41524
41525 Exim's DKIM implementation allows for
41526 .olist
41527 Signing outgoing messages: This function is implemented in the SMTP transport.
41528 It can co-exist with all other Exim features
41529 (including transport filters)
41530 except cutthrough delivery.
41531 .next
41532 Verifying signatures in incoming messages: This is implemented by an additional
41533 ACL (acl_smtp_dkim), which can be called several times per message, with
41534 different signature contexts.
41535 .endlist
41536
41537 In typical Exim style, the verification implementation does not include any
41538 default "policy". Instead it enables you to build your own policy using
41539 Exim's standard controls.
41540
41541 Please note that verification of DKIM signatures in incoming mail is turned
41542 on by default for logging (in the <= line) purposes.
41543
41544 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41545 When set, for each signature in incoming email,
41546 exim will log a line displaying the most important signature details, and the
41547 signature status. Here is an example (with line-breaks added for clarity):
41548 .code
41549 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41550     d=facebookmail.com s=q1-2009b
41551     c=relaxed/relaxed a=rsa-sha1
41552     i=@facebookmail.com t=1252484542 [verification succeeded]
41553 .endd
41554
41555 You might want to turn off DKIM verification processing entirely for internal
41556 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41557 control modifier. This should typically be done in the RCPT ACL, at points
41558 where you accept mail from relay sources (internal hosts or authenticated
41559 senders).
41560
41561
41562 .subsection "Signing outgoing messages" SECDKIMSIGN
41563 .cindex DKIM signing
41564
41565 For signing to be usable you must have published a DKIM record in DNS.
41566 Note that RFC 8301 (which does not cover EC keys) says:
41567 .code
41568 rsa-sha1 MUST NOT be used for signing or verifying.
41569
41570 Signers MUST use RSA keys of at least 1024 bits for all keys.
41571 Signers SHOULD use RSA keys of at least 2048 bits.
41572 .endd
41573
41574 Note also that the key content (the 'p=' field)
41575 in the DNS record is different between RSA and EC keys;
41576 for the former it is the base64 of the ASN.1 for the RSA public key
41577 (equivalent to the private-key .pem with the header/trailer stripped)
41578 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41579
41580 Signing is enabled by setting private options on the SMTP transport.
41581 These options take (expandable) strings as arguments.
41582
41583 .option dkim_domain smtp "string list&!!" unset
41584 The domain(s) you want to sign with.
41585 After expansion, this can be a list.
41586 Each element in turn,
41587 lowercased,
41588 .vindex "&$dkim_domain$&"
41589 is put into the &%$dkim_domain%& expansion variable
41590 while expanding the remaining signing options.
41591 If it is empty after expansion, DKIM signing is not done,
41592 and no error will result even if &%dkim_strict%& is set.
41593
41594 .option dkim_selector smtp "string list&!!" unset
41595 This sets the key selector string.
41596 After expansion, which can use &$dkim_domain$&, this can be a list.
41597 Each element in turn is put in the expansion
41598 .vindex "&$dkim_selector$&"
41599 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41600 option along with &%$dkim_domain%&.
41601 If the option is empty after expansion, DKIM signing is not done for this domain,
41602 and no error will result even if &%dkim_strict%& is set.
41603
41604 To do, for example, dual-signing with RSA and EC keys
41605 this could be be used:
41606 .code
41607 dkim_selector = ec_sel : rsa_sel
41608 dkim_private_key = KEYS_DIR/$dkim_selector
41609 .endd
41610
41611 .option dkim_private_key smtp string&!! unset
41612 This sets the private key to use.
41613 You can use the &%$dkim_domain%& and
41614 &%$dkim_selector%& expansion variables to determine the private key to use.
41615 The result can either
41616 .ilist
41617 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41618 .next
41619 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41620 be a valid Ed25519 private key (same format as above)
41621 .next
41622 start with a slash, in which case it is treated as a file that contains
41623 the private key
41624 .next
41625 be "0", "false" or the empty string, in which case the message will not
41626 be signed. This case will not result in an error, even if &%dkim_strict%&
41627 is set.
41628 .endlist
41629
41630 To generate keys under OpenSSL:
41631 .code
41632 openssl genrsa -out dkim_rsa.private 2048
41633 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41634 .endd
41635 The result file from the first command should be retained, and
41636 this option set to use it.
41637 Take the base-64 lines from the output of the second command, concatenated,
41638 for the DNS TXT record.
41639 See section 3.6 of RFC6376 for the record specification.
41640
41641 Under GnuTLS:
41642 .code
41643 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41644 certtool --load-privkey=dkim_rsa.private --pubkey-info
41645 .endd
41646
41647 Note that RFC 8301 says:
41648 .code
41649 Signers MUST use RSA keys of at least 1024 bits for all keys.
41650 Signers SHOULD use RSA keys of at least 2048 bits.
41651 .endd
41652
41653 EC keys for DKIM are defined by RFC 8463.
41654 They are considerably smaller than RSA keys for equivalent protection.
41655 As they are a recent development, users should consider dual-signing
41656 (by setting a list of selectors, and an expansion for this option)
41657 for some transition period.
41658 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41659 for EC keys.
41660
41661 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41662 .code
41663 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41664 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41665 .endd
41666
41667 To produce the required public key value for a DNS record:
41668 .code
41669 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41670 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41671 .endd
41672
41673 Exim also supports an alternate format
41674 of Ed25519 keys in DNS which was a candidate during development
41675 of the standard, but not adopted.
41676 A future release will probably drop that support.
41677
41678 .option dkim_hash smtp string&!! sha256
41679 Can be set to any one of the supported hash methods, which are:
41680 .ilist
41681 &`sha1`& &-- should not be used, is old and insecure
41682 .next
41683 &`sha256`& &-- the default
41684 .next
41685 &`sha512`& &-- possibly more secure but less well supported
41686 .endlist
41687
41688 Note that RFC 8301 says:
41689 .code
41690 rsa-sha1 MUST NOT be used for signing or verifying.
41691 .endd
41692
41693 .option dkim_identity smtp string&!! unset
41694 If set after expansion, the value is used to set an "i=" tag in
41695 the signing header.  The DKIM standards restrict the permissible
41696 syntax of this optional tag to a mail address, with possibly-empty
41697 local part, an @, and a domain identical to or subdomain of the "d="
41698 tag value.  Note that Exim does not check the value.
41699
41700 .option dkim_canon smtp string&!! unset
41701 This option sets the canonicalization method used when signing a message.
41702 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41703 The option defaults to "relaxed" when unset. Note: the current implementation
41704 only supports signing with the same canonicalization method for both headers and body.
41705
41706 .option dkim_strict smtp string&!! unset
41707 This  option  defines  how  Exim  behaves  when  signing a message that
41708 should be signed fails for some reason.  When the expansion evaluates to
41709 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41710 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41711 variables here.
41712
41713 .option dkim_sign_headers smtp string&!! "see below"
41714 If set, this option must expand to a colon-separated
41715 list of header names.
41716 Headers with these names, or the absence or such a header, will be included
41717 in the message signature.
41718 When unspecified, the header names listed in RFC4871 will be used,
41719 whether or not each header is present in the message.
41720 The default list is available for the expansion in the macro
41721 &"_DKIM_SIGN_HEADERS"&
41722 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41723
41724 If a name is repeated, multiple headers by that name (or the absence thereof)
41725 will be signed.  The textually later headers in the headers part of the
41726 message are signed first, if there are multiples.
41727
41728 A name can be prefixed with either an &"="& or a &"+"& character.
41729 If an &"="& prefix is used, all headers that are present with this name
41730 will be signed.
41731 If a &"+"& prefix if used, all headers that are present with this name
41732 will be signed, and one signature added for a missing header with the
41733 name will be appended.
41734
41735 .option dkim_timestamps smtp integer&!! unset
41736 This option controls the inclusion of timestamp information in the signature.
41737 If not set, no such information will be included.
41738 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41739 for the expiry tag
41740 (eg. 1209600 for two weeks);
41741 both creation (t=) and expiry (x=) tags will be included.
41742
41743 RFC 6376 lists these tags as RECOMMENDED.
41744
41745
41746 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41747 .cindex DKIM verification
41748
41749 Verification of DKIM signatures in SMTP incoming email is done for all
41750 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41751 .cindex DKIM "selecting signature algorithms"
41752 Individual classes of signature algorithm can be ignored by changing
41753 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41754 The &%dkim_verify_minimal%& option can be set to cease verification
41755 processing for a message once the first passing signature is found.
41756
41757 .cindex authentication "expansion item"
41758 Performing verification sets up information used by the
41759 &%authresults%& expansion item.
41760
41761 For most purposes the default option settings suffice and the remainder
41762 of this section can be ignored.
41763
41764 The results of verification are made available to the
41765 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41766 A missing ACL definition defaults to accept.
41767 By default, the ACL is called once for each
41768 syntactically(!) correct signature in the incoming message.
41769 If any ACL call does not accept, the message is not accepted.
41770 If a cutthrough delivery was in progress for the message, that is
41771 summarily dropped (having wasted the transmission effort).
41772
41773 To evaluate the verification result in the ACL
41774 a large number of expansion variables
41775 containing the signature status and its details are set up during the
41776 runtime of the ACL.
41777
41778 Calling the ACL only for existing signatures is not sufficient to build
41779 more advanced policies. For that reason, the main option
41780 &%dkim_verify_signers%&, and an expansion variable
41781 &%$dkim_signers%& exist.
41782
41783 The main option &%dkim_verify_signers%& can be set to a colon-separated
41784 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41785 called. It is expanded when the message has been received. At this point,
41786 the expansion variable &%$dkim_signers%& already contains a colon-separated
41787 list of signer domains and identities for the message. When
41788 &%dkim_verify_signers%& is not specified in the main configuration,
41789 it defaults as:
41790 .code
41791 dkim_verify_signers = $dkim_signers
41792 .endd
41793 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41794 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41795 call the ACL for known domains or identities. This would be achieved as follows:
41796 .code
41797 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41798 .endd
41799 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41800 and "ebay.com", plus all domains and identities that have signatures in the message.
41801 You can also be more creative in constructing your policy. For example:
41802 .code
41803 dkim_verify_signers = $sender_address_domain:$dkim_signers
41804 .endd
41805
41806 If a domain or identity is listed several times in the (expanded) value of
41807 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41808
41809 Note that if the option is set using untrustworthy data
41810 (such as the From: header)
41811 care should be taken to force lowercase for domains
41812 and for the domain part if identities.
41813 The default setting can be regarded as trustworthy in this respect.
41814
41815 If multiple signatures match a domain (or identity), the ACL is called once
41816 for each matching signature.
41817
41818
41819 Inside the DKIM ACL, the following expansion variables are
41820 available (from most to least important):
41821
41822
41823 .vlist
41824 .vitem &%$dkim_cur_signer%&
41825 The signer that is being evaluated in this ACL run. This can be a domain or
41826 an identity. This is one of the list items from the expanded main option
41827 &%dkim_verify_signers%& (see above).
41828
41829 .vitem &%$dkim_verify_status%&
41830 Within the DKIM ACL,
41831 a string describing the general status of the signature. One of
41832 .ilist
41833 &%none%&: There is no signature in the message for the current domain or
41834 identity (as reflected by &%$dkim_cur_signer%&).
41835 .next
41836 &%invalid%&: The signature could not be verified due to a processing error.
41837 More detail is available in &%$dkim_verify_reason%&.
41838 .next
41839 &%fail%&: Verification of the signature failed.  More detail is
41840 available in &%$dkim_verify_reason%&.
41841 .next
41842 &%pass%&: The signature passed verification. It is valid.
41843 .endlist
41844
41845 This variable can be overwritten using an ACL 'set' modifier.
41846 This might, for instance, be done to enforce a policy restriction on
41847 hash-method or key-size:
41848 .code
41849   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41850        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41851        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41852                                   {< {$dkim_key_length}{1024}}}}
41853        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41854        set dkim_verify_status = fail
41855        set dkim_verify_reason = hash too weak or key too short
41856 .endd
41857
41858 So long as a DKIM ACL is defined (it need do no more than accept),
41859 after all the DKIM ACL runs have completed, the value becomes a
41860 colon-separated list of the values after each run.
41861 This is maintained for the mime, prdr and data ACLs.
41862
41863 .vitem &%$dkim_verify_reason%&
41864 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41865 "fail" or "invalid". One of
41866 .ilist
41867 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41868 key for the domain could not be retrieved. This may be a temporary problem.
41869 .next
41870 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41871 record for the domain is syntactically invalid.
41872 .next
41873 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41874 body hash does not match the one specified in the signature header. This
41875 means that the message body was modified in transit.
41876 .next
41877 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41878 could not be verified. This may mean that headers were modified,
41879 re-written or otherwise changed in a way which is incompatible with
41880 DKIM verification. It may of course also mean that the signature is forged.
41881 .endlist
41882
41883 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41884
41885 .vitem &%$dkim_domain%&
41886 The signing domain. IMPORTANT: This variable is only populated if there is
41887 an actual signature in the message for the current domain or identity (as
41888 reflected by &%$dkim_cur_signer%&).
41889
41890 .vitem &%$dkim_identity%&
41891 The signing identity, if present. IMPORTANT: This variable is only populated
41892 if there is an actual signature in the message for the current domain or
41893 identity (as reflected by &%$dkim_cur_signer%&).
41894
41895 .vitem &%$dkim_selector%&
41896 The key record selector string.
41897
41898 .vitem &%$dkim_algo%&
41899 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41900 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41901 may also be 'ed25519-sha256'.
41902 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41903 for EC keys.
41904
41905 Note that RFC 8301 says:
41906 .code
41907 rsa-sha1 MUST NOT be used for signing or verifying.
41908
41909 DKIM signatures identified as having been signed with historic
41910 algorithms (currently, rsa-sha1) have permanently failed evaluation
41911 .endd
41912
41913 To enforce this you must either have a DKIM ACL which checks this variable
41914 and overwrites the &$dkim_verify_status$& variable as discussed above,
41915 or have set the main option &%dkim_verify_hashes%& to exclude
41916 processing of such signatures.
41917
41918 .vitem &%$dkim_canon_body%&
41919 The body canonicalization method. One of 'relaxed' or 'simple'.
41920
41921 .vitem &%$dkim_canon_headers%&
41922 The header canonicalization method. One of 'relaxed' or 'simple'.
41923
41924 .vitem &%$dkim_copiedheaders%&
41925 A transcript of headers and their values which are included in the signature
41926 (copied from the 'z=' tag of the signature).
41927 Note that RFC6376 requires that verification fail if the From: header is
41928 not included in the signature.  Exim does not enforce this; sites wishing
41929 strict enforcement should code the check explicitly.
41930
41931 .vitem &%$dkim_bodylength%&
41932 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41933 limit was set by the signer, "9999999999999" is returned. This makes sure
41934 that this variable always expands to an integer value.
41935 &*Note:*& The presence of the signature tag specifying a signing body length
41936 is one possible route to spoofing of valid DKIM signatures.
41937 A paranoid implementation might wish to regard signature where this variable
41938 shows less than the "no limit" return as being invalid.
41939
41940 .vitem &%$dkim_created%&
41941 UNIX timestamp reflecting the date and time when the signature was created.
41942 When this was not specified by the signer, "0" is returned.
41943
41944 .vitem &%$dkim_expires%&
41945 UNIX timestamp reflecting the date and time when the signer wants the
41946 signature to be treated as "expired". When this was not specified by the
41947 signer, "9999999999999" is returned. This makes it possible to do useful
41948 integer size comparisons against this value.
41949 Note that Exim does not check this value.
41950
41951 .vitem &%$dkim_headernames%&
41952 A colon-separated list of names of headers included in the signature.
41953
41954 .vitem &%$dkim_key_testing%&
41955 "1" if the key record has the "testing" flag set, "0" if not.
41956
41957 .vitem &%$dkim_key_nosubdomains%&
41958 "1" if the key record forbids subdomaining, "0" otherwise.
41959
41960 .vitem &%$dkim_key_srvtype%&
41961 Service type (tag s=) from the key record. Defaults to "*" if not specified
41962 in the key record.
41963
41964 .vitem &%$dkim_key_granularity%&
41965 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41966 in the key record.
41967
41968 .vitem &%$dkim_key_notes%&
41969 Notes from the key record (tag n=).
41970
41971 .vitem &%$dkim_key_length%&
41972 Number of bits in the key.
41973 Valid only once the key is loaded, which is at the time the header signature
41974 is verified, which is after the body hash is.
41975
41976 Note that RFC 8301 says:
41977 .code
41978 Verifiers MUST NOT consider signatures using RSA keys of
41979 less than 1024 bits as valid signatures.
41980 .endd
41981
41982 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41983 option.
41984
41985 .endlist
41986
41987 In addition, two ACL conditions are provided:
41988
41989 .vlist
41990 .vitem &%dkim_signers%&
41991 ACL condition that checks a colon-separated list of domains or identities
41992 for a match against the domain or identity that the ACL is currently verifying
41993 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41994 verb to a group of domains or identities. For example:
41995
41996 .code
41997 # Warn when Mail purportedly from GMail has no gmail signature
41998 warn sender_domains = gmail.com
41999      dkim_signers = gmail.com
42000      dkim_status = none
42001      log_message = GMail sender without gmail.com DKIM signature
42002 .endd
42003
42004 Note that the above does not check for a total lack of DKIM signing;
42005 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42006
42007 .vitem &%dkim_status%&
42008 ACL condition that checks a colon-separated list of possible DKIM verification
42009 results against the actual result of verification. This is typically used
42010 to restrict an ACL verb to a list of verification outcomes, for example:
42011
42012 .code
42013 deny sender_domains = paypal.com:paypal.de
42014      dkim_signers = paypal.com:paypal.de
42015      dkim_status = none:invalid:fail
42016      message = Mail from Paypal with invalid/missing signature
42017 .endd
42018
42019 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42020 see the documentation of the &%$dkim_verify_status%& expansion variable above
42021 for more information of what they mean.
42022 .endlist
42023
42024
42025
42026
42027 .section "SPF (Sender Policy Framework)" SECSPF
42028 .cindex SPF verification
42029
42030 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42031 messages with its domain in the envelope from, documented by RFC 7208.
42032 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42033 the &url(http://openspf.org).
42034 . --- 2019-10-28: still not https, open-spf.org is told to be a
42035 . --- web-archive copy of the now dead openspf.org site
42036 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42037 . --- discussion.
42038
42039 Messages sent by a system not authorised will fail checking of such assertions.
42040 This includes retransmissions done by traditional forwarders.
42041
42042 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42043 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42044 &url(https://www.libspf2.org/).
42045 There is no Exim involvement in the transmission of messages;
42046 publishing certain DNS records is all that is required.
42047
42048 For verification, an ACL condition and an expansion lookup are provided.
42049 .cindex authentication "expansion item"
42050 Performing verification sets up information used by the
42051 &%authresults%& expansion item.
42052
42053
42054 .cindex SPF "ACL condition"
42055 .cindex ACL "spf condition"
42056 The ACL condition "spf" can be used at or after the MAIL ACL.
42057 It takes as an argument a list of strings giving the outcome of the SPF check,
42058 and will succeed for any matching outcome.
42059 Valid strings are:
42060 .vlist
42061 .vitem &%pass%&
42062 The SPF check passed, the sending host is positively verified by SPF.
42063
42064 .vitem &%fail%&
42065 The SPF check failed, the sending host is NOT allowed to send mail for the
42066 domain in the envelope-from address.
42067
42068 .vitem &%softfail%&
42069 The SPF check failed, but the queried domain can't absolutely confirm that this
42070 is a forgery.
42071
42072 .vitem &%none%&
42073 The queried domain does not publish SPF records.
42074
42075 .vitem &%neutral%&
42076 The SPF check returned a "neutral" state.  This means the queried domain has
42077 published a SPF record, but wants to allow outside servers to send mail under
42078 its domain as well.  This should be treated like "none".
42079
42080 .vitem &%permerror%&
42081 This indicates a syntax error in the SPF record of the queried domain.
42082 You may deny messages when this occurs.
42083
42084 .vitem &%temperror%&
42085 This indicates a temporary error during all processing, including Exim's
42086 SPF processing.  You may defer messages when this occurs.
42087
42088 .vitem &%invalid%&
42089 There was an error during processing of the SPF lookup
42090 .endlist
42091
42092 You can prefix each string with an exclamation mark to  invert
42093 its meaning,  for example  "!fail" will  match all  results but
42094 "fail".  The  string  list is  evaluated  left-to-right,  in a
42095 short-circuit fashion.
42096
42097 Example:
42098 .code
42099 deny spf = fail
42100      message = $sender_host_address is not allowed to send mail from \
42101                ${if def:sender_address_domain \
42102                     {$sender_address_domain}{$sender_helo_name}}.  \
42103                Please see http://www.open-spf.org/Why;\
42104                identity=${if def:sender_address_domain \
42105                              {$sender_address}{$sender_helo_name}};\
42106                ip=$sender_host_address
42107 .endd
42108
42109 Note: The above mentioned URL may not be as helpful as expected. You are
42110 encouraged to replace the link with a link to a site with more
42111 explanations.
42112
42113 When the spf condition has run, it sets up several expansion
42114 variables:
42115
42116 .cindex SPF "verification variables"
42117 .vlist
42118 .vitem &$spf_header_comment$&
42119 .vindex &$spf_header_comment$&
42120   This contains a human-readable string describing the outcome
42121   of the SPF check. You can add it to a custom header or use
42122   it for logging purposes.
42123
42124 .vitem &$spf_received$&
42125 .vindex &$spf_received$&
42126   This contains a complete Received-SPF: header (name and
42127   content) that can be added to the message. Please note that
42128   according to the SPF draft, this header must be added at the
42129   top of the header list, i.e. with
42130 .code
42131 add_header = :at_start:$spf_received
42132 .endd
42133   See section &<<SECTaddheadacl>>& for further details.
42134
42135   Note: in case of "Best-guess" (see below), the convention is
42136   to put this string in a header called X-SPF-Guess: instead.
42137
42138 .vitem &$spf_result$&
42139 .vindex &$spf_result$&
42140   This contains the outcome of the SPF check in string form,
42141   currently one of pass, fail, softfail, none, neutral, permerror,
42142   temperror, or &"(invalid)"&.
42143
42144 .vitem &$spf_result_guessed$&
42145 .vindex &$spf_result_guessed$&
42146   This boolean is true only if a best-guess operation was used
42147   and required in order to obtain a result.
42148
42149 .vitem &$spf_smtp_comment$&
42150 .vindex &$spf_smtp_comment$&
42151 .vindex &%spf_smtp_comment_template%&
42152   This contains a string that can be used in a SMTP response
42153   to the calling party. Useful for "fail".
42154   The string is generated by the SPF library from the template configured in the main config
42155   option &%spf_smtp_comment_template%&.
42156 .endlist
42157
42158
42159 .cindex SPF "ACL condition"
42160 .cindex ACL "spf_guess condition"
42161 .cindex SPF "best guess"
42162 In addition to SPF, you can also perform checks for so-called
42163 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42164 SPF, but it is supported by the same framework that enables SPF
42165 capability.
42166 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42167 for a description of what it means.
42168 . --- 2019-10-28: still not https:
42169
42170 To access this feature, simply use the spf_guess condition in place
42171 of the spf one.  For example:
42172
42173 .code
42174 deny spf_guess = fail
42175      message = $sender_host_address doesn't look trustworthy to me
42176 .endd
42177
42178 In case you decide to reject messages based on this check, you
42179 should note that although it uses the same framework, "Best-guess"
42180 is not SPF, and therefore you should not mention SPF at all in your
42181 reject message.
42182
42183 When the spf_guess condition has run, it sets up the same expansion
42184 variables as when spf condition is run, described above.
42185
42186 Additionally, since Best-guess is not standardized, you may redefine
42187 what "Best-guess" means to you by redefining the main configuration
42188 &%spf_guess%& option.
42189 For example, the following:
42190
42191 .code
42192 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42193 .endd
42194
42195 would relax host matching rules to a broader network range.
42196
42197
42198 .cindex SPF "lookup expansion"
42199 .cindex lookup spf
42200 A lookup expansion is also available. It takes an email
42201 address as the key and an IP address
42202 (v4 or v6)
42203 as the database:
42204
42205 .code
42206   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42207 .endd
42208
42209 The lookup will return the same result strings as can appear in
42210 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42211
42212
42213
42214
42215
42216 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42217 .cindex SRS "sender rewriting scheme"
42218
42219 SRS can be used to modify sender addresses when forwarding so that
42220 SPF verification does not object to them.
42221 It operates by encoding the original envelope sender in a new
42222 sender local part and using a domain run by the forwarding site
42223 as the new domain for the sender.  Any DSN message should be returned
42224 to this new sender at the forwarding site, which can extract the
42225 original sender from the coded local part and forward the DSN to
42226 the originator.
42227
42228 This is a way of avoiding the breakage that SPF does to forwarding.
42229 The constructed local-part will be longer than the original,
42230 leading to possible problems with very long addresses.
42231 The changing of the sender address also hinders the tracing of mail
42232 problems.
42233
42234 Exim can be built to include native SRS support.  To do this
42235 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42236 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42237 will be defined.
42238 The support is limited to SRS0-encoding; SRS1 is not supported.
42239
42240 .cindex SRS excoding
42241 To encode an address use this expansion item:
42242 .vlist
42243 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42244 .cindex "&%srs_encode%& expansion item"
42245 .cindex SRS "expansion item"
42246 The first argument should be a secret known and used by all systems
42247 handling the recipient domain for the original message.
42248 There is no need to periodically change this key; a timestamp is also
42249 encoded.
42250 The second argument should be given as the envelope sender address before this
42251 encoding operation.
42252 If this value is empty the the expansion result will be empty.
42253 The third argument should be the recipient domain of the message when
42254 it arrived at this system.
42255 .endlist
42256
42257 .cindex SRS decoding
42258 To decode an address use this expansion condition:
42259 .vlist
42260 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42261 The first argument should be the recipient local prt as is was received.
42262 The second argument is the site secret.
42263
42264 If the messages is not for an SRS-encoded recipient the condition will
42265 return false.  If it is, the condition will return true and the variable
42266 &$srs_recipient$& will be set to the decoded (original) value.
42267 .endlist
42268
42269 Example usage:
42270 .code
42271   #macro
42272   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42273
42274   #routers
42275
42276   outbound:
42277     driver =    dnslookup
42278     # if outbound, and forwarding has been done, use an alternate transport
42279     domains =   ! +my_domains
42280     transport = ${if eq {$local_part@$domain} \
42281                         {$original_local_part@$original_domain} \
42282                      {remote_smtp} {remote_forwarded_smtp}}
42283
42284   inbound_srs:
42285     driver =    redirect
42286     senders =   :
42287     domains =   +my_domains
42288     # detect inbound bounces which are SRS'd, and decode them
42289     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42290     data =      $srs_recipient
42291
42292   inbound_srs_failure:
42293     driver =    redirect
42294     senders =   :
42295     domains =   +my_domains
42296     # detect inbound bounces which look SRS'd but are invalid
42297     condition = ${if inbound_srs {$local_part} {}}
42298     allow_fail
42299     data =      :fail: Invalid SRS recipient address
42300
42301   #... further routers here
42302
42303
42304   # transport; should look like the non-forward outbound
42305   # one, plus the max_rcpt and return_path options
42306   remote_forwarded_smtp:
42307     driver =              smtp
42308     # single-recipient so that $original_domain is valid
42309     max_rcpt =            1
42310     # modify the envelope from, for mails that we forward
42311     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42312 .endd
42313
42314
42315
42316
42317
42318 .section DMARC SECDMARC
42319 .cindex DMARC verification
42320
42321 DMARC combines feedback from SPF, DKIM, and header From: in order
42322 to attempt to provide better indicators of the authenticity of an
42323 email.  This document does not explain the fundamentals; you
42324 should read and understand how it works by visiting the website at
42325 &url(http://www.dmarc.org/).
42326
42327 If Exim is built with DMARC support,
42328 the libopendmarc library is used.
42329
42330 For building Exim yourself, obtain the library from
42331 &url(http://sourceforge.net/projects/opendmarc/)
42332 to obtain a copy, or find it in your favorite package
42333 repository.  You will need to attend to the local/Makefile feature
42334 SUPPORT_DMARC and the associated LDFLAGS addition.
42335 This description assumes
42336 that headers will be in /usr/local/include, and that the libraries
42337 are in /usr/local/lib.
42338
42339 .subsection Configuration SSECDMARCCONFIG
42340 .cindex DMARC configuration
42341
42342 There are three main-configuration options:
42343 .cindex DMARC "configuration options"
42344
42345 The &%dmarc_tld_file%& option
42346 .oindex &%dmarc_tld_file%&
42347 defines the location of a text file of valid
42348 top level domains the opendmarc library uses
42349 during domain parsing. Maintained by Mozilla,
42350 the most current version can be downloaded
42351 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42352 See also the util/renew-opendmarc-tlds.sh script.
42353 The default for the option is unset.
42354 If not set, DMARC processing is disabled.
42355
42356
42357 The &%dmarc_history_file%& option, if set
42358 .oindex &%dmarc_history_file%&
42359 defines the location of a file to log results
42360 of dmarc verification on inbound emails. The
42361 contents are importable by the opendmarc tools
42362 which will manage the data, send out DMARC
42363 reports, and expire the data. Make sure the
42364 directory of this file is writable by the user
42365 exim runs as.
42366 The default is unset.
42367
42368 The &%dmarc_forensic_sender%& option
42369 .oindex &%dmarc_forensic_sender%&
42370 defines an alternate email address to use when sending a
42371 forensic report detailing alignment failures
42372 if a sender domain's dmarc record specifies it
42373 and you have configured Exim to send them.
42374 If set, this is expanded and used for the
42375 From: header line; the address is extracted
42376 from it and used for the envelope from.
42377 If not set (the default), the From: header is expanded from
42378 the dsn_from option, and <> is used for the
42379 envelope from.
42380
42381 .subsection Controls SSECDMARCCONTROLS
42382 .cindex DMARC controls
42383
42384 By default, the DMARC processing will run for any remote,
42385 non-authenticated user.  It makes sense to only verify DMARC
42386 status of messages coming from remote, untrusted sources.  You can
42387 use standard conditions such as hosts, senders, etc, to decide that
42388 DMARC verification should *not* be performed for them and disable
42389 DMARC with an ACL control modifier:
42390 .code
42391   control = dmarc_disable_verify
42392 .endd
42393 A DMARC record can also specify a "forensic address", which gives
42394 exim an email address to submit reports about failed alignment.
42395 Exim does not do this by default because in certain conditions it
42396 results in unintended information leakage (what lists a user might
42397 be subscribed to, etc).  You must configure exim to submit forensic
42398 reports to the owner of the domain.  If the DMARC record contains a
42399 forensic address and you specify the control statement below, then
42400 exim will send these forensic emails.  It is also advised that you
42401 configure a &%dmarc_forensic_sender%& because the default sender address
42402 construction might be inadequate.
42403 .code
42404   control = dmarc_enable_forensic
42405 .endd
42406 (AGAIN: You can choose not to send these forensic reports by simply
42407 not putting the dmarc_enable_forensic control line at any point in
42408 your exim config.  If you don't tell exim to send them, it will not
42409 send them.)
42410
42411 There are no options to either control.  Both must appear before
42412 the DATA acl.
42413
42414 .subsection ACL SSECDMARCACL
42415 .cindex DMARC "ACL condition"
42416
42417 DMARC checks can be run on incoming SMTP  messages by using the
42418 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42419 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42420 condition.  Putting this condition in the ACLs is required in order
42421 for a DMARC check to actually occur.  All of the variables are set
42422 up before the DATA ACL, but there is no actual DMARC check that
42423 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42424
42425 The &"dmarc_status"& condition takes a list of strings on its
42426 right-hand side.  These strings describe recommended action based
42427 on the DMARC check.  To understand what the policy recommendations
42428 mean, refer to the DMARC website above.  Valid strings are:
42429 .itable none 0 0 2 20* left 80* left
42430 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42431 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42432 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42433 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42434 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42435 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42436 .irow &'temperror'&     "Library error or dns error"
42437 .irow &'off'&           "The DMARC check was disabled for this email"
42438 .endtable
42439 You can prefix each string with an exclamation mark to invert its
42440 meaning, for example "!accept" will match all results but
42441 "accept".  The string list is evaluated left-to-right in a
42442 short-circuit fashion.  When a string matches the outcome of the
42443 DMARC check, the condition succeeds.  If none of the listed
42444 strings matches the outcome of the DMARC check, the condition
42445 fails.
42446
42447 Of course, you can also use any other lookup method that Exim
42448 supports, including LDAP, Postgres, MySQL, etc, as long as the
42449 result is a list of colon-separated strings.
42450
42451 Performing the check sets up information used by the
42452 &%authresults%& expansion item.
42453
42454 Several expansion variables are set before the DATA ACL is
42455 processed, and you can use them in this ACL.  The following
42456 expansion variables are available:
42457
42458 .vlist
42459 .vitem &$dmarc_status$&
42460 .vindex &$dmarc_status$&
42461 .cindex DMARC result
42462 A one word status indicating what the DMARC library
42463 thinks of the email.  It is a combination of the results of
42464 DMARC record lookup and the SPF/DKIM/DMARC processing results
42465 (if a DMARC record was found).  The actual policy declared
42466 in the DMARC record is in a separate expansion variable.
42467
42468 .vitem &$dmarc_status_text$&
42469 .vindex &$dmarc_status_text$&
42470 Slightly longer, human readable status.
42471
42472 .vitem &$dmarc_used_domain$&
42473 .vindex &$dmarc_used_domain$&
42474 The domain which DMARC used to look up the DMARC policy record.
42475
42476 .vitem &$dmarc_domain_policy$&
42477 .vindex &$dmarc_domain_policy$&
42478 The policy declared in the DMARC record.  Valid values
42479 are "none", "reject" and "quarantine".  It is blank when there
42480 is any error, including no DMARC record.
42481 .endlist
42482
42483 .subsection Logging SSECDMARCLOGGING
42484 .cindex DMARC logging
42485
42486 By default, Exim's DMARC configuration is intended to be
42487 non-intrusive and conservative.  To facilitate this, Exim will not
42488 create any type of logging files without explicit configuration by
42489 you, the admin.  Nor will Exim send out any emails/reports about
42490 DMARC issues without explicit configuration by you, the admin (other
42491 than typical bounce messages that may come about due to ACL
42492 processing or failure delivery issues).
42493
42494 In order to log statistics suitable to be imported by the opendmarc
42495 tools, you need to:
42496 .ilist
42497 Configure the global option &%dmarc_history_file%&
42498 .next
42499 Configure cron jobs to call the appropriate opendmarc history
42500 import scripts and truncating the dmarc_history_file
42501 .endlist
42502
42503 In order to send forensic reports, you need to:
42504 .ilist
42505 Configure the global option &%dmarc_forensic_sender%&
42506 .next
42507 Configure, somewhere before the DATA ACL, the control option to
42508 enable sending DMARC forensic reports
42509 .endlist
42510
42511 .subsection Example SSECDMARCEXAMPLE
42512 .cindex DMARC example
42513
42514 Example usage:
42515 .code
42516 (RCPT ACL)
42517   warn    domains        = +local_domains
42518           hosts          = +local_hosts
42519           control        = dmarc_disable_verify
42520
42521   warn    !domains       = +screwed_up_dmarc_records
42522           control        = dmarc_enable_forensic
42523
42524   warn    condition      = (lookup if destined to mailing list)
42525           set acl_m_mailing_list = 1
42526
42527 (DATA ACL)
42528   warn    dmarc_status   = accept : none : off
42529           !authenticated = *
42530           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42531
42532   warn    dmarc_status   = !accept
42533           !authenticated = *
42534           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42535
42536   warn    dmarc_status   = quarantine
42537           !authenticated = *
42538           set $acl_m_quarantine = 1
42539           # Do something in a transport with this flag variable
42540
42541   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42542           condition      = ${if eq{$acl_m_mailing_list}{1}}
42543           message        = Messages from $dmarc_used_domain break mailing lists
42544
42545   deny    dmarc_status   = reject
42546           !authenticated = *
42547           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42548
42549   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42550 .endd
42551
42552
42553
42554
42555
42556 . ////////////////////////////////////////////////////////////////////////////
42557 . ////////////////////////////////////////////////////////////////////////////
42558
42559 .chapter "Proxies" "CHAPproxies" &&&
42560          "Proxy support"
42561 .cindex "proxy support"
42562 .cindex "proxy" "access via"
42563
42564 A proxy is an intermediate system through which communication is passed.
42565 Proxies may provide a security, availability or load-distribution function.
42566
42567
42568 .section "Inbound proxies" SECTproxyInbound
42569 .cindex proxy inbound
42570 .cindex proxy "server side"
42571 .cindex proxy "Proxy protocol"
42572 .cindex "Proxy protocol" proxy
42573
42574 Exim has support for receiving inbound SMTP connections via a proxy
42575 that uses &"Proxy Protocol"& to speak to it.
42576 To include this support, include &"SUPPORT_PROXY=yes"&
42577 in Local/Makefile.
42578
42579 It was built on the HAProxy specification, found at
42580 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42581
42582 The purpose of this facility is so that an application load balancer,
42583 such as HAProxy, can sit in front of several Exim servers
42584 to distribute load.
42585 Exim uses the local protocol communication with the proxy to obtain
42586 the remote SMTP system IP address and port information.
42587 There is no logging if a host passes or
42588 fails Proxy Protocol negotiation, but it can easily be determined and
42589 recorded in an ACL (example is below).
42590
42591 Use of a proxy is enabled by setting the &%hosts_proxy%&
42592 main configuration option to a hostlist; connections from these
42593 hosts will use Proxy Protocol.
42594 Exim supports both version 1 and version 2 of the Proxy Protocol and
42595 automatically determines which version is in use.
42596
42597 The Proxy Protocol header is the first data received on a TCP connection
42598 and is inserted before any TLS-on-connect handshake from the client; Exim
42599 negotiates TLS between Exim-as-server and the remote client, not between
42600 Exim and the proxy server. The Proxy Protocol header must be received
42601 within &%proxy_protocol_timeout%&, which defaults to 3s.
42602
42603 The following expansion variables are usable
42604 (&"internal"& and &"external"& here refer to the interfaces
42605 of the proxy):
42606 .itable none 0 0 2 30* left 70* left
42607 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42608 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42609 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42610 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42611 .irow $proxy_session            "boolean: SMTP connection via proxy"
42612 .endtable
42613 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42614 there was a protocol error.
42615 The variables &$sender_host_address$& and &$sender_host_port$&
42616 will have values for the actual client system, not the proxy.
42617
42618 Since the real connections are all coming from the proxy, and the
42619 per host connection tracking is done before Proxy Protocol is
42620 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42621 handle all of the parallel volume you expect per inbound proxy.
42622 With the option set so high, you lose the ability
42623 to protect your server from many connections from one IP.
42624 In order to prevent your server from overload, you
42625 need to add a per connection ratelimit to your connect ACL.
42626 A possible solution is:
42627 .display
42628   # Set max number of connections per host
42629   LIMIT   = 5
42630   # Or do some kind of IP lookup in a flat file or database
42631   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42632
42633   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42634           message        = Too many connections from this IP right now
42635 .endd
42636
42637
42638
42639 .section "Outbound proxies" SECTproxySOCKS
42640 .cindex proxy outbound
42641 .cindex proxy "client side"
42642 .cindex proxy SOCKS
42643 .cindex SOCKS proxy
42644 Exim has support for sending outbound SMTP via a proxy
42645 using a protocol called SOCKS5 (defined by RFC1928).
42646 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42647 Local/Makefile.
42648
42649 Use of a proxy is enabled by setting the &%socks_proxy%& option
42650 on an smtp transport.
42651 The option value is expanded and should then be a list
42652 (colon-separated by default) of proxy specifiers.
42653 Each proxy specifier is a list
42654 (space-separated by default) where the initial element
42655 is an IP address and any subsequent elements are options.
42656
42657 Options are a string <name>=<value>.
42658 The list of options is in the following table:
42659 .itable none 0 0 2 10* left 90* left
42660 .irow &'auth'&  "authentication method"
42661 .irow &'name'&  "authentication username"
42662 .irow &'pass'&  "authentication password"
42663 .irow &'port'&  "tcp port"
42664 .irow &'tmo'&   "connection timeout"
42665 .irow &'pri'&   "priority"
42666 .irow &'weight'& "selection bias"
42667 .endtable
42668
42669 More details on each of these options follows:
42670
42671 .ilist
42672 .cindex authentication "to proxy"
42673 .cindex proxy authentication
42674 &%auth%&: Either &"none"& (default) or &"name"&.
42675 Using &"name"& selects username/password authentication per RFC 1929
42676 for access to the proxy.
42677 Default is &"none"&.
42678 .next
42679 &%name%&: sets the username for the &"name"& authentication method.
42680 Default is empty.
42681 .next
42682 &%pass%&: sets the password for the &"name"& authentication method.
42683 Default is empty.
42684 .next
42685 &%port%&: the TCP port number to use for the connection to the proxy.
42686 Default is 1080.
42687 .next
42688 &%tmo%&: sets a connection timeout in seconds for this proxy.
42689 Default is 5.
42690 .next
42691 &%pri%&: specifies a priority for the proxy within the list,
42692 higher values being tried first.
42693 The default priority is 1.
42694 .next
42695 &%weight%&: specifies a selection bias.
42696 Within a priority set servers are queried in a random fashion,
42697 weighted by this value.
42698 The default value for selection bias is 1.
42699 .endlist
42700
42701 Proxies from the list are tried according to their priority
42702 and weight settings until one responds.  The timeout for the
42703 overall connection applies to the set of proxied attempts.
42704
42705 .section Logging SECTproxyLog
42706 To log the (local) IP of a proxy in the incoming or delivery logline,
42707 add &"+proxy"& to the &%log_selector%& option.
42708 This will add a component tagged with &"PRX="& to the line.
42709
42710 . ////////////////////////////////////////////////////////////////////////////
42711 . ////////////////////////////////////////////////////////////////////////////
42712
42713 .chapter "Internationalisation" "CHAPi18n" &&&
42714          "Internationalisation""
42715 .cindex internationalisation "email address"
42716 .cindex EAI
42717 .cindex i18n
42718 .cindex utf8 "mail name handling"
42719
42720 Exim has support for Internationalised mail names.
42721 To include this it must be built with SUPPORT_I18N and the libidn library.
42722 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42723
42724 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42725 instead of it) then IDNA2008 is supported; this adds an extra library
42726 requirement, upon libidn2.
42727
42728 .section "MTA operations" SECTi18nMTA
42729 .cindex SMTPUTF8 "ESMTP option"
42730 .cindex "ESMTP extensions" SMTPUTF8
42731 The main configuration option &%smtputf8_advertise_hosts%& specifies
42732 a host list.  If this matches the sending host and
42733 accept_8bitmime is true (the default) then the ESMTP option
42734 SMTPUTF8 will be advertised.
42735
42736 If the sender specifies the SMTPUTF8 option on a MAIL command
42737 international handling for the message is enabled and
42738 the expansion variable &$message_smtputf8$& will have value TRUE.
42739
42740 The option &%allow_utf8_domains%& is set to true for this
42741 message. All DNS lookups are converted to a-label form
42742 whatever the setting of &%allow_utf8_domains%&
42743 when Exim is built with SUPPORT_I18N.
42744
42745 Both localparts and domain are maintained as the original
42746 UTF-8 form internally; any comparison or regular-expression use will
42747 require appropriate care.  Filenames created, eg. by
42748 the appendfile transport, will have UTF-8 names.
42749
42750 HELO names sent by the smtp transport will have any UTF-8
42751 components expanded to a-label form,
42752 and any certificate name checks will be done using the a-label
42753 form of the name.
42754
42755 .cindex log protocol
42756 .cindex SMTPUTF8 logging
42757 .cindex i18n logging
42758 Log lines and Received-by: header lines will acquire a "utf8"
42759 prefix on the protocol element, eg. utf8esmtp.
42760
42761 The following expansion operators can be used:
42762 .code
42763 ${utf8_domain_to_alabel:str}
42764 ${utf8_domain_from_alabel:str}
42765 ${utf8_localpart_to_alabel:str}
42766 ${utf8_localpart_from_alabel:str}
42767 .endd
42768
42769 .cindex utf8 "address downconversion"
42770 .cindex i18n "utf8 address downconversion"
42771 The RCPT ACL
42772 may use the following modifier:
42773 .display
42774 control = utf8_downconvert
42775 control = utf8_downconvert/<value>
42776 .endd
42777 This sets a flag requiring that envelope addresses are converted to
42778 a-label form before smtp delivery.
42779 This is usually for use in a Message Submission Agent context,
42780 but could be used for any message.
42781
42782 If a value is appended it may be:
42783 .itable none 0 0 2 5* right 95* left
42784 .irow &`1`&     "mandatory downconversion"
42785 .irow &`0`&     "no downconversion"
42786 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42787 .endtable
42788 If no value is given, 1 is used.
42789
42790 If mua_wrapper is set, the utf8_downconvert control
42791 is initially set to -1.
42792
42793 The smtp transport has an option &%utf8_downconvert%&.
42794 If set it must expand to one of the three values described above,
42795 or an empty string.
42796 If non-empty it overrides value previously set
42797 (due to mua_wrapper or by an ACL control).
42798
42799
42800 There is no explicit support for VRFY and EXPN.
42801 Configurations supporting these should inspect
42802 &$smtp_command_argument$& for an SMTPUTF8 argument.
42803
42804 There is no support for LMTP on Unix sockets.
42805 Using the "lmtp" protocol option on an smtp transport,
42806 for LMTP over TCP, should work as expected.
42807
42808 There is no support for DSN unitext handling,
42809 and no provision for converting logging from or to UTF-8.
42810
42811
42812
42813 .section "MDA operations" SECTi18nMDA
42814 To aid in constructing names suitable for IMAP folders
42815 the following expansion operator can be used:
42816 .code
42817 ${imapfolder {<string>} {<sep>} {<specials>}}
42818 .endd
42819
42820 The string is converted from the charset specified by
42821 the "headers charset" command (in a filter file)
42822 or &%headers_charset%& main configuration option (otherwise),
42823 to the
42824 modified UTF-7 encoding specified by RFC 2060,
42825 with the following exception: All occurrences of <sep>
42826 (which has to be a single character)
42827 are replaced with periods ("."), and all periods and slashes that are not
42828 <sep> and are not in the <specials> string are BASE64 encoded.
42829
42830 The third argument can be omitted, defaulting to an empty string.
42831 The second argument can be omitted, defaulting to "/".
42832
42833 This is the encoding used by Courier for Maildir names on disk, and followed
42834 by many other IMAP servers.
42835
42836 Examples:
42837 .display
42838 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42839 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42840 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42841 .endd
42842
42843 Note that the source charset setting is vital, and also that characters
42844 must be representable in UTF-16.
42845
42846
42847 . ////////////////////////////////////////////////////////////////////////////
42848 . ////////////////////////////////////////////////////////////////////////////
42849
42850 .chapter "Events" "CHAPevents" &&&
42851          "Events"
42852 .cindex events
42853
42854 The events mechanism in Exim can be used to intercept processing at a number
42855 of points.  It was originally invented to give a way to do customised logging
42856 actions (for example, to a database) but can also be used to modify some
42857 processing actions.
42858
42859 Most installations will never need to use Events.
42860 The support can be left out of a build by defining DISABLE_EVENT=yes
42861 in &_Local/Makefile_&.
42862
42863 There are two major classes of events: main and transport.
42864 The main configuration option &%event_action%& controls reception events;
42865 a transport option &%event_action%& controls delivery events.
42866
42867 Both options are a string which is expanded when the event fires.
42868 An example might look like:
42869 .cindex logging custom
42870 .code
42871 event_action = ${if eq {msg:delivery}{$event_name} \
42872 {${lookup pgsql {SELECT * FROM record_Delivery( \
42873     '${quote_pgsql:$sender_address_domain}',\
42874     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42875     '${quote_pgsql:$domain}', \
42876     '${quote_pgsql:${lc:$local_part}}', \
42877     '${quote_pgsql:$host_address}', \
42878     '${quote_pgsql:${lc:$host}}', \
42879     '${quote_pgsql:$message_exim_id}')}} \
42880 } {}}
42881 .endd
42882
42883 Events have names which correspond to the point in process at which they fire.
42884 The name is placed in the variable &$event_name$& and the event action
42885 expansion must check this, as it will be called for every possible event type.
42886
42887 The current list of events is:
42888 .itable all 0 0 4 25* left 10* center 15* center 50* left
42889 .row auth:fail              after    both       "per driver per authentication attempt"
42890 .row dane:fail              after    transport  "per connection"
42891 .row msg:complete           after    main       "per message"
42892 .row msg:defer              after    transport  "per message per delivery try"
42893 .row msg:delivery           after    transport  "per recipient"
42894 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42895 .row msg:rcpt:defer         after    transport  "per recipient"
42896 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42897 .row msg:fail:delivery      after    transport  "per recipient"
42898 .row msg:fail:internal      after    main       "per recipient"
42899 .row tcp:connect            before   transport  "per connection"
42900 .row tcp:close              after    transport  "per connection"
42901 .row tls:cert               before   both       "per certificate in verification chain"
42902 .row tls:fail:connect       after    main       "per connection"
42903 .row smtp:connect           after    transport  "per connection"
42904 .row smtp:ehlo              after    transport  "per connection"
42905 .endtable
42906 New event types may be added in future.
42907
42908 The event name is a colon-separated list, defining the type of
42909 event in a tree of possibilities.  It may be used as a list
42910 or just matched on as a whole.  There will be no spaces in the name.
42911
42912 The second column in the table above describes whether the event fires
42913 before or after the action is associates with.  Those which fire before
42914 can be used to affect that action (more on this below).
42915
42916 The third column in the table above says what section of the configuration
42917 should define the event action.
42918
42919 An additional variable, &$event_data$&, is filled with information varying
42920 with the event type:
42921 .itable all 0 0 2 20* left 80* left
42922 .row auth:fail            "smtp response"
42923 .row dane:fail            "failure reason"
42924 .row msg:defer            "error string"
42925 .row msg:delivery         "smtp confirmation message"
42926 .row msg:fail:internal    "failure reason"
42927 .row msg:fail:delivery    "smtp error message"
42928 .row msg:host:defer       "error string"
42929 .row msg:rcpt:host:defer  "error string"
42930 .row msg:rcpt:defer       "error string"
42931 .row tls:cert             "verification chain depth"
42932 .row tls:fail:connect     "error string"
42933 .row smtp:connect         "smtp banner"
42934 .row smtp:ehlo            "smtp ehlo response"
42935 .endtable
42936
42937 The :defer events populate one extra variable: &$event_defer_errno$&.
42938
42939 For complex operations an ACL expansion can be used in &%event_action%&,
42940 however due to the multiple contexts that Exim operates in during
42941 the course of its processing:
42942 .ilist
42943 variables set in transport events will not be visible outside that
42944 transport call
42945 .next
42946 acl_m variables in a server context are lost on a new connection,
42947 and after smtp helo/ehlo/mail/starttls/rset commands
42948 .endlist
42949 Using an ACL expansion with the logwrite modifier can be
42950 a useful way of writing to the main log.
42951
42952 The expansion of the event_action option should normally
42953 return an empty string.  Should it return anything else the
42954 following will be forced:
42955 .itable all 0 0 2 20* left 80* left
42956 .row auth:fail        "log information to write"
42957 .row tcp:connect      "do not connect"
42958 .row tls:cert         "refuse verification"
42959 .row smtp:connect     "close connection"
42960 .endtable
42961 All other message types ignore the result string, and
42962 no other use is made of it.
42963
42964 For a tcp:connect event, if the connection is being made to a proxy
42965 then the address and port variables will be that of the proxy and not
42966 the target system.
42967
42968 For tls:cert events, if GnuTLS is in use this will trigger only per
42969 chain element received on the connection.
42970 For OpenSSL it will trigger for every chain element including those
42971 loaded locally.
42972
42973 . ////////////////////////////////////////////////////////////////////////////
42974 . ////////////////////////////////////////////////////////////////////////////
42975
42976 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42977          "Adding drivers or lookups"
42978 .cindex "adding drivers"
42979 .cindex "new drivers, adding"
42980 .cindex "drivers" "adding new"
42981 The following actions have to be taken in order to add a new router, transport,
42982 authenticator, or lookup type to Exim:
42983
42984 .olist
42985 Choose a name for the driver or lookup type that does not conflict with any
42986 existing name; I will use &"newdriver"& in what follows.
42987 .next
42988 Add to &_src/EDITME_& the line:
42989 .display
42990 <&'type'&>&`_NEWDRIVER=yes`&
42991 .endd
42992 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42993 code is not to be included in the binary by default, comment this line out. You
42994 should also add any relevant comments about the driver or lookup type.
42995 .next
42996 Add to &_src/config.h.defaults_& the line:
42997 .code
42998 #define <type>_NEWDRIVER
42999 .endd
43000 .next
43001 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43002 and create a table entry as is done for all the other drivers and lookup types.
43003 .next
43004 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43005 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43006 Add your &`NEWDRIVER`& to that list.
43007 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43008 simple form that most lookups have.
43009 .next
43010 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43011 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43012 driver or lookup type and add it to the definition of OBJ.
43013 .next
43014 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43015 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43016 .next
43017 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43018 &_src_&.
43019 .next
43020 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43021 as for other drivers and lookups.
43022 .endlist
43023
43024 Then all you need to do is write the code! A good way to start is to make a
43025 proforma by copying an existing module of the same type, globally changing all
43026 occurrences of the name, and cutting out most of the code. Note that any
43027 options you create must be listed in alphabetical order, because the tables are
43028 searched using a binary chop procedure.
43029
43030 There is a &_README_& file in each of the sub-directories of &_src_& describing
43031 the interface that is expected.
43032
43033
43034
43035
43036 . ////////////////////////////////////////////////////////////////////////////
43037 . ////////////////////////////////////////////////////////////////////////////
43038
43039 . /////////////////////////////////////////////////////////////////////////////
43040 . These lines are processing instructions for the Simple DocBook Processor that
43041 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43042 . PDFs than using xmlto and fop. They will be ignored by all other XML
43043 . processors.
43044 . /////////////////////////////////////////////////////////////////////////////
43045
43046 .literal xml
43047 <?sdop
43048   format="newpage"
43049   foot_right_recto="&chaptertitle;"
43050   foot_right_verso="&chaptertitle;"
43051 ?>
43052 .literal off
43053
43054 .makeindex "Options index"   "option"
43055 .makeindex "Variables index" "variable"
43056 .makeindex "Concept index"   "concept"
43057
43058
43059 . /////////////////////////////////////////////////////////////////////////////
43060 . /////////////////////////////////////////////////////////////////////////////